Listing Export Tasks

Function

Lists export tasks.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:tenants:listExportTasks	List	-	-	-	-

URI

GET /v2/{project_id}/export-tasks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
file_name	No	String	File name.
task_id	No	String	Task ID.
status	No	String	Export task status. The value can be CREATING, SUCCESS, FAIL, or EXPIRED.
is_download	No	Boolean	Whether the file has been downloaded. The value can be true or false (default).
sort_field	No	String	Sorting field, which must be used together with sort_type. create_time: creation time
sort_type	No	String	Sorting type. The default value is ascending. This parameter must be used together with sort_field. ASC ascending order. DESC: descending order.
offset	No	Integer	Paging offset. The default value is 0.
limit	No	Integer	Page size. The value ranges from 1 to 100. The default value is 20.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
export_tasks	Array of ExportTaskItem objects	Export task list.
count	Integer	Total number of export tasks.

**Table 4** ExportTaskItem
Parameter	Type	Description
task_id	String	ID of the export task.
file_name	String	Name of the exported file.
status	String	Export task status. The value can be CREATING, SUCCESS, FAIL, or EXPIRED.
fail_reason	String	Task failure cause.
error_code	String	Error code of a task failure.
create_time	String	UTC time when the export task is started. The format is yyyy-MM-dd'T'HH:mm:ss.SSSZ.
end_time	String	UTC time when the export task is ended. The format is yyyy-MM-dd'T'HH:mm:ss.SSSZ.
is_download	Boolean	Whether the file is downloaded.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

None

Example Responses

Status code: 200

Succeeded.

{
  "export_tasks" : [ {
    "task_id" : "string",
    "file_name" : "string",
    "status" : "CREATING",
    "fail_reason" : "string",
    "error_code" : "string",
    "create_time" : "2022-03-28'T'00:00:00.000Z",
    "end_time" : "2022-03-28'T'00:00:00.000Z",
    "is_download" : true
  } ],
  "count" : 1
}