文档首页/ 数据复制服务 DRS/ API参考/ API v5/ 批量异步实例管理/ 查询批量异步创建的任务列表 - ListAsyncJobs
更新时间：2026-08-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询批量异步创建的任务列表 - ListAsyncJobs

功能介绍

查询租户批量异步创建的任务列表。

接口约束

  • 目前仅支持Redis单机/主备->GeminiDB Redis迁移、Redis集群->GeminiDB Redis迁移、MySQL->MySQL迁移与同步、Oracle->GaussDB分布式同步场景。
  • 仅支持部分Region使用，详情参考终端节点。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/batch-async-jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

async_job_id

否

String

参数解释：

批量异步创建的任务ID，用于按任务ID筛选查询结果。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

status

否

String

参数解释：

批量异步创建的任务状态，用于按任务状态筛选查询结果。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

domain_name

否

String

参数解释：

批量异步创建任务的租户名，用于按租户名筛选查询结果。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

user_name

否

String

参数解释：

批量异步创建任务的用户名，用于按用户名筛选查询结果。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Integer

参数解释：

偏移量，表示查询该偏移量后面的记录，用于分页查询。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

limit

否

Integer

参数解释：

查询返回记录的数量限制，用于分页查询时控制每页返回的数据条数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sort_key

否

String

参数解释：

返回结果按该关键字排序，指定批量异步任务列表的排序依据。

约束限制：

不涉及。

取值范围：

  • create_time：按创建时间排序

默认取值：

不涉及。

sort_dir

否

String

参数解释：

排序方向，指定返回结果按升序或降序排列。

约束限制：

不涉及。

取值范围：

  • desc：降序
  • asc：升序

默认取值：

desc

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

参数解释：

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

约束限制：

不涉及。

取值范围：

application/json

默认取值：

application/json

X-Auth-Token

是

String

参数解释：

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us：英语
  • zh-cn：中文

默认取值：

en-us

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：

列表中的项目总数，与分页无关。

约束限制：

不涉及。

取值范围：

不涉及。

jobs

Array of objects

参数解释：

批量异步创建任务响应列表，包含满足查询条件的所有异步任务信息。

详情请参见表5。
表5 jobs字段数据结构说明

参数

参数类型

描述

async_job_id

String

参数解释：

批量异步创建的任务ID，唯一标识一个批量异步创建任务。

约束限制：

不涉及。

取值范围：

不涉及。

status

String

参数解释：

批量异步创建的任务状态，表示异步任务的当前执行阶段。

约束限制：

不涉及。

取值范围：

  • ASYNC_JOB_VALIDATING：批量异步任务参数校验中。
  • ASYNC_JOB_VALIDATE_FAILED：批量异步任务参数校验失败。
  • AUTO_PARAM_VALIDATE_SUCCESS：批量异步任务参数校验成功
  • COMMIT_SUCCESS：批量异步任务提交成功。

domain_name

String

参数解释：

批量异步创建任务的租户名，标识创建该任务所属的租户（域名）。

约束限制：

不涉及。

取值范围：

不涉及。

user_name

String

参数解释：

批量异步创建任务的用户名，标识创建该任务的具体IAM用户。

约束限制：

不涉及。

取值范围：

不涉及。

create_time

String

参数解释：

批量异步创建任务的创建时间，表示任务首次被创建的时间戳。

约束限制：

不涉及。

取值范围：

不涉及。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码，当任务报错时返回的错误代码。

约束限制：

  • 最小长度：12
  • 最大长度：12

取值范围：

格式为DRS.XXXXXX。

error_msg

String

参数解释：

错误详细信息，当任务执行失败时返回的具体错误描述。

约束限制：

  • 最小长度：1
  • 最大长度：512

取值范围：

不涉及。

请求示例

查询租户批量异步创建的任务列表。

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/batch-async-jobs?async_job_id=&status=&domain_name=&user_name=&offset=0&limit=10&sort_key=&sort_dir=

响应示例

状态码：200

OK

{
  "jobs" : [ {
    "async_job_id" : "bd4193aa-072d-4ce6-beec-adffc7252341",
    "status" : "AUTO_PARAM_VALIDATE_SUCCESS",
    "domain_name" : "domain_name1",
    "user_name" : "user_name1",
    "create_time" : "2022-11-07T06:41:08Z"
  }, {
    "async_job_id" : "7b65d750-51e5-4647-a088-663d28152a3d",
    "status" : "COMMIT_SUCCESS",
    "domain_name" : "domain_name2",
    "user_name" : "user_name2",
    "create_time" : "2022-11-05T16:03:45Z"
  } ],
  "total_count" : 2
}

状态码：400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

状态码

状态码

描述

200

OK

400

Bad Request

其他状态请参见状态码。

错误码

请参见错误码。