查询批量异步创建的任务列表
功能介绍
查询租户批量异步创建的任务列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
接口约束
- 目前仅支持Redis->GeminiDB Redis迁移、Redis集群->GeminiDB Redis迁移、MySQL->MySQL同步、Oracle->GaussDB分布式同步场景。
- 仅支持部分Region使用，详情参考终端节点。
URI
GET /v5/{project_id}/batch-async-jobs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
async_job_id |
否 |
String |
批量异步创建的任务ID。 |
|
status |
否 |
String |
批量异步创建的任务状态。 |
|
domain_name |
否 |
String |
批量异步创建的任务的租户名。 |
|
user_name |
否 |
String |
批量异步创建的任务的用户名。 |
|
offset |
否 |
Integer |
偏移量，表示查询该偏移量后面的记录。 |
|
limit |
否 |
Integer |
查询返回记录的数量限制。 |
|
sort_key |
否 |
String |
返回结果按该关键字排序，默认为“create_time”。 |
|
sort_dir |
否 |
String |
降序或升序（分别对应desc和asc，默认为“desc”）。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 缺省值：application/json |
|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
|
X-Language |
否 |
String |
请求语言类型。 缺省值：en-us 枚举值：
|
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_count |
Integer |
列表中的项目总数，与分页无关。 |
|
jobs |
Array of objects |
所有批量异步创建任务响应体。 详情请参见表5。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
async_job_id |
String |
批量异步创建的任务ID。 |
|
status |
String |
批量异步创建的任务状态。取值：
枚举值：
|
|
domain_name |
String |
批量异步创建的任务的租户名。 |
|
user_name |
String |
批量异步创建的任务的用户名。 |
|
create_time |
String |
批量异步创建的任务的创建时间。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 最小长度：12 最大长度：12 |
|
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 |
错误码
请参见错误码。
