Help Center/ KooDrive/ API Reference/ API/ Cloud Decompression/ Listing Directories in a Compressed Package
Updated on 2024-07-30 GMT+08:00
View PDF
Share

Listing Directories in a Compressed Package

Function

List file directories in a compressed package.

URI

POST /koodrive/ose/v1/archive/listFile

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

Authorization

Yes

String

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}.

X-Traceid

No

String

Service trace ID, which contains 58 bits.

language

No

String

Language code, which complies with the internationalization specifications. For example, en-US indicates English (United States). English (United States) is used by default.
Table 2 Request body parameters

Parameter

Mandatory

Type

Description

containerId

Yes

String

Space ID.

fileId

Yes

String

File ID.

pwd

No

String

Compressed package password.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Response code.

msg

String

Response message.

data

data object

Response for listing directories in a compressed package.
Table 4 data

Parameter

Type

Description

uncompressedFileList

Array of UncompressedFileInfo objects

List of files in the compressed package, including all sub-files and sub-directories. This parameter is returned in synchronous mode.

taskId

String

Task ID, which is returned in asynchronous mode.
Table 5 UncompressedFileInfo

Parameter

Type

Description

containerId

String

Space ID after decompression. This parameter is returned only for decompression.

fileId

String

ID of the decompressed file. This parameter is returned only for decompression.

name

String

Full path of the file or folder in the compressed package.

fileSize

Long

File size, in bytes.

type

Integer

For details, see the definition of fileType. 1: content. 2: directory.

updatedAt

Long

Millisecond timestamp of file modification.

subFileList

Array of UncompressedFileInfo objects

List of sub-files and sub-directories (expanded only for directories).

reason

String

Failure cause. If the operation is successful, this parameter is null.

code

String

Error code.

reservatioinInfo

Object

Reserved field.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error description.

Minimum: 2

Maximum: 512

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
Parent topic: Cloud Decompression