更新时间:2025-11-05 GMT+08:00
分享

查询导出任务列表

功能介绍

查询导出任务列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/export-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

表2 Query参数

参数

是否必选

参数类型

描述

file_name

String

文件名。

task_id

String

任务id。

status

String

导出任务的状态,取值为 CREATING, SUCCESS, FAIL, EXPIRED; CREATING为进行中,SUCCESS为成功,FAIL为失败,EXPIRED为过期。

is_download

Boolean

是否已下载,取值范围:true和false,默认值false。

sort_field

String

排序字段名称,需要结合sort_type字段一起使用。

  • create_time 创建时间。

sort_type

String

排序类型,默认升序,需要结合sort_field字段一起使用。

  • ASC 升序。

  • DESC 降序。

offset

Integer

分页偏移量,默认值:0。

limit

Integer

分页大小,取值范围1-100,默认值:20。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

export_tasks

Array of ExportTaskItem objects

导出任务列表。

count

Integer

导出任务列表总数。

表5 ExportTaskItem

参数

参数类型

描述

task_id

String

导出任务id。

file_name

String

导出文件名。

status

String

导出任务的状态,取值为 CREATING, SUCCESS, FAIL, EXPIRED; CREATING为进行中,SUCCESS为成功,FAIL为失败,EXPIRED为过期。

fail_reason

String

任务失败的原因。

error_code

String

任务失败错误码。

create_time

String

创建文件的时间, utc时间:yyyy-MM-dd'T'HH:mm:ss.SSSZ。

end_time

String

创建文件的时间, utc时间:yyyy-MM-dd'T'HH:mm:ss.SSSZ。

is_download

Boolean

是否已下载。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码:500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

响应示例

状态码:200

响应成功。

{
  "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
}

状态码

状态码

描述

200

响应成功。

400

客户端请求有误。

401

鉴权失败。

500

内部错误。

错误码

请参见错误码

相关文档