Listing Directories in a Compressed Package
Function
List file directories in a compressed package. Data files need to be loaded to the Singapore node for processing.
URI
POST /koodrive/ose/v1/archive/listFile
Request Parameters
Parameter | Mandatory | Type | Description |
|---|---|---|---|
Authorization | Yes | String | Definition: Access token. Token authentication is used to call KooDrive APIs. A token indicates the permission. When an API is called, the token is added to the request header to obtain the operation permission. For details about how to obtain an access token, see the corresponding developer guide. The format is Bearer+{access_token}. Constraints: N/A Range: N/A Default Value: N/A |
X-Traceid | No | String | Definition: Service trace ID, which contains 58 bits. Constraints: N/A Range: The value contains 58 bits. Default Value: N/A |
language | No | String | Definition: Language code. Constraints: The value must comply with the internationalization specifications. For example, en_us indicates English (United States). Range: The value must comply with the internationalization specifications. Default Value: en-US |
X-User-Id | Yes | String | Definition: User ID on KooDrive, which is used for app authentication. Constraints: N/A Range: N/A Default Value: N/A |
X-Date | Yes | String | Definition: Date, which is used for app authentication. Constraints: The format is yyyyMMDD'T'HHmmss'Z', for example, 20251103T070140Z. Range: The value must be within 15 minutes from the current time and cannot be later than the current time. Default Value: N/A |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
containerId | Yes | String | Definition: Space ID. Constraints: N/A Range: N/A Default Value: N/A |
fileId | Yes | String | Definition: File ID. Constraints: N/A Range: N/A Default Value: N/A |
pwd | No | String | Definition: Compressed package password. If the compressed package has a password and it is not entered, an error will occur when listing the contents. If the compressed package does not have a password, no error will be reported even if no password is entered. Constraints: N/A Range: N/A Default Value: N/A |
Response Parameters
Status code: 200
Parameter | Type | Description |
|---|---|---|
code | String | Response code. |
msg | String | Response message. |
data | data object | Response for listing directories in a compressed package. |
Parameter | Type | Description |
|---|---|---|
uncompressedFileList | UncompressedFileinfoList object | List of files in the compressed package, including all sub-files and sub-directories. This parameter is returned in synchronous mode. |
progress | Integer | Task progress, which is a percentage. |
taskId | String | Task ID, which is returned in asynchronous mode. |
Parameter | Type | Description |
|---|---|---|
code | String | Error code. |
name | String | File name. |
type | String | File type. 1: content; 2: directory |
updateAt | String | File modification timestamp, in milliseconds. |
fileSize | String | Size of a file or folder, in bytes. |
Status code: 400
Parameter | Type | Description |
|---|---|---|
code | String | Error code. |
msg | String | Description. |
Example Requests
Lists file directories in a compressed package.
POST /ose/v1/archive/listFile
Authorization:Bearer+10f88**********4791e9ff
{
"containerId": "IAADfsBFCO6WtAtuAe3ab00aac61c45e18b0896269d5efb",
"fileId": "FvW8fIQFZmz6Fu-lZ-7pKt6wtJISsW0C-",
"pwd": " "
} Example Responses
Status code: 200
Response for listing directories in a compressed package.
{
"data" : {
"taskId" : "1428103989525998336"
},
"code" : 0,
"msg" : "OK"
} Status Codes
Status Code | Description |
|---|---|
200 | Response for listing directories in a compressed package. |
400 | Error response |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
