查询任务列表
功能介绍
查询租户任务列表,可以根据企业项目,引擎类型,网络类型,任务状态,任务名称,任务ID进行查询。
接口约束
- 目前仅支持Redis->GeminiDB Redis迁移、Redis集群->GeminiDB Redis迁移、MySQL->MySQL同步、Oracle->GaussDB分布式同步场景。
- 仅支持部分Region使用,详情参考终端节点。
URI
GET /v5/{project_id}/jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
job_type |
是 |
String |
任务场景。取值:
枚举值:
|
name |
否 |
String |
任务ID或名称。支持输入多个任务ID,逗号分隔,最多10个。 |
status |
否 |
String |
任务状态。取值:
枚举值:
|
engine_type |
否 |
String |
引擎类型。取值:
枚举值:
|
net_type |
否 |
String |
网络类型。取值:
枚举值:
|
enterprise_project_id |
否 |
String |
企业项目ID。 缺省值:"",表示查询所有企业项目任务。 |
offset |
否 |
Integer |
偏移量,表示查询该偏移量后面的记录。 |
limit |
否 |
Integer |
查询返回记录的数量限制。 |
sort_key |
否 |
String |
返回结果按该关键字排序,默认为“create_time”。 当前支持排序的关键字:
|
sort_dir |
否 |
String |
降序或升序(分别对应desc和asc,默认为“desc”)。 |
instance_ids |
否 |
Array of strings |
数据库实例ID列表,缺省值:null,表示不使用数据库实例ID过滤。 |
instance_ip |
否 |
String |
DRS绑定的数据库实例IP,缺省值:"",表示不使用DRS绑定数据库IP过滤。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
任务ID。 |
name |
String |
任务名称。 |
status |
String |
任务状态。取值:
枚举值:
|
description |
String |
任务描述。 |
create_time |
String |
任务创建时间。 |
engine_type |
String |
引擎类型。取值:
枚举值:
|
net_type |
String |
网络类型。取值:
枚举值:
|
charging_mode |
String |
计费模式。取值:
枚举值:
|
billing_tag |
Boolean |
是否计费。 |
job_direction |
String |
任务方向。取值:
枚举值:
|
job_type |
String |
任务场景。取值:
枚举值:
|
task_type |
String |
任务模式。取值:
枚举值:
|
enterprise_project_id |
String |
企业项目ID。 |
job_mode |
String |
任务模式。取值:
枚举值:
|
job_mode_role |
String |
任务角色。取值:
枚举值:
|
is_multi_az |
Boolean |
是否主备任务。 |
node_role |
String |
任务节点角色。 |
node_new_framework |
Boolean |
是否新框架。 |
job_action |
Object |
任务操作命令集合。 详情请参见表7。 |
children |
Array of objects |
子任务列表信息体。 详情请参见表6。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
任务ID。 |
name |
String |
任务名称。 |
status |
String |
任务状态。取值:
枚举值:
|
description |
String |
任务描述。 |
create_time |
String |
任务创建时间。 |
engine_type |
String |
引擎类型。取值:
枚举值:
|
net_type |
String |
网络类型。取值:
枚举值:
|
charging_mode |
String |
计费模式。取值:
枚举值:
|
billing_tag |
Boolean |
是否计费。 |
job_direction |
String |
任务方向。取值:
枚举值:
|
job_type |
String |
任务场景。取值:
枚举值:
|
task_type |
String |
任务模式。取值:
枚举值:
|
enterprise_project_id |
String |
企业项目ID。 |
job_mode |
String |
任务模式。取值:
枚举值:
|
job_mode_role |
String |
任务角色。取值:
枚举值:
|
is_multi_az |
Boolean |
是否主备任务。 |
node_role |
String |
任务节点角色。 |
node_new_framework |
Boolean |
是否新框架。 |
job_action |
Object |
任务操作命令集合。 详情请参见表7。 |
参数 |
参数类型 |
描述 |
---|---|---|
available_actions |
Array of strings |
任务可操作命令集合。 |
unavailable_actions |
Array of strings |
任务不可操作命令集合。 |
current_action |
String |
任务当前操作命令。取值:
枚举值:
|
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 最小长度:12 最大长度:12 |
error_msg |
String |
错误描述。 最小长度:1 最大长度:512 |
请求示例
- 查询实时灾备任务列表。
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=cloudDataGuard&name=&status=&engine_type=&net_type=&enterprise_project_id=&offset=0&limit=10&sort_key=create_time&sort_dir=desc
- 查询实时迁移任务列表。
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=migration&name=&status=&engine_type=&net_type=&enterprise_project_id=&offset=0&limit=10&sort_key=create_time&sort_dir=desc
- 查询实时同步任务列表。
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=sync&name=&status=&engine_type=&net_type=&enterprise_project_id=&offset=0&limit=10&sort_key=create_time&sort_dir=desc
- 通过数据库IP,查询实时灾备任务列表:
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=cloudDataGuard&name=&status=&engine_type=&net_type=&enterprise_project_id=&offset=0&limit=10&sort_key=create_time&sort_dir=desc&instance_ip=127.0.0.1
- 通过数据库ID,查询实时灾备任务列表:
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs?job_type=cloudDataGuard&name=&status=&engine_type=&net_type=&enterprise_project_id=&offset=0&limit=10&sort_key=create_time&sort_dir=desc&instance_ids=id1&instance_ids=id2
- 查询实时同步任务列表,多个任务ID。
https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs?name=bee869bc-15c0-4b3b-a34b-bf0d5efjb201,c2a61a77-6e55-4cd8-8be1-a562cc6jb201&job_type=sync
响应示例
状态码: 200
OK
{ "jobs" : [ { "id" : "c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r", "name" : "DRS-1234", "status" : "CONFIGURATION", "create_time" : "2022-11-07T16:15:18Z", "engine_type" : "oracle-to-gaussdbv5", "job_direction" : "up", "task_type" : "FULL_INCR_TRANS", "job_action" : { "available_actions" : [ "FREE_RESOURCE", "PRE_CHECK", "MODIFY_CONFIGURATION", "CHANGE" ], "unavailable_actions" : [ "CREATE", "START", "CHOOSE_OBJECT", "RETRY", "RESET", "DELETE", "QUERY_PRE_CHECK", "CHANGE_MODE", "MODIFY_DB_CONFIG", "SWITCH_OVER", "RESET_DB_PWD", "PAUSE", "JUMP_RETRY", "START_INCR", "MODIFY_TASK_NUMBER", "CONTINUE_JOB", "STOP_JOB", "CONTINUE_CAPTURE", "STOP_CAPTURE", "CONTINUE_APPLY", "API_CONFIGURATION_ACTION", "STOP_APPLY", "PAY_ORDER", "UNSUBSCRIBE", "TO_PERIOD", "TO_RENEW", "ORDER_INFO", "CLONE" ], "current_action" : null } } ], "total_count" : 1 }
状态码: 400
Bad Request
{ "error_code" : "DRS.10000001", "error_msg" : "Failed." }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
错误码
请参见错误码。