On this page

Show all

Help Center/ KooDrive/ API Reference/ API/ Cloud Decompression/ Listing Directories in a Compressed Package

Listing Directories in a Compressed Package

Updated on 2025-03-07 GMT+08:00

View PDF

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.
X-User-Id	Yes	String	User ID, which is used for app authentication.
X-Date	Yes	String	Date, which is used for app authentication.
Host	Yes	String	Address, which is used for app authentication.

**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	UncompressedFileinfoList object	List of files in the compressed package, including all sub-files and sub-directories. This parameter is returned in synchronous mode.
taskKey	String	Asynchronous task key.
taskValue	Object	Returned in asynchronous mode.
progress	Integer	Task progress, which is a percentage.
taskId	String	Task ID, which is returned in asynchronous mode.

**Table 5** UncompressedFileinfoList
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

**Table 6** Response body parameters
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

Parent topic: Cloud Decompression

Previous topic: Cloud Decompression

Next topic: Batch Task Operations

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot