文档首页> 数据复制服务 DRS> API参考> API v5（公测中）> 实例管理> 查询任务列表

更新时间：2024-01-30 GMT+08:00

在线调试

CLI示例

查看PDF

查询任务列表

功能介绍

查询租户任务列表，可以根据企业项目，引擎类型，网络类型，任务状态，任务名称，任务ID进行查询。

接口约束

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

URI

GET /v5/{project_id}/jobs

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	租户在某一Region下的Project ID。获取方法请参见获取项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
job_type	是	String	任务场景。取值： migration：实时迁移。 sync：实时同步。 cloudDataGuard：实时灾备。枚举值： migration sync cloudDataGuard
name	否	String	任务ID或名称。
status	否	String	任务状态。取值： CREATING：创建中。 CREATE_FAILED：创建失败。 CONFIGURATION：配置中。 STARTJOBING：启动中。 WAITING_FOR_START：等待启动中。 START_JOB_FAILED：任务启动失败。 FULL_TRANSFER_STARTED：全量迁移中，灾备场景为初始化。 FULL_TRANSFER_FAILED：全量迁移失败，灾备场景为初始化失败。 FULL_TRANSFER_COMPLETE：全量迁移完成，灾备场景为初始化完成。 INCRE_TRANSFER_STARTED：增量迁移中，灾备场景为灾备中。 INCRE_TRANSFER_FAILED：增量迁移失败，灾备场景为灾备异常。 RELEASE_RESOURCE_STARTED：结束任务中。 RELEASE_RESOURCE_FAILED：结束任务失败。 RELEASE_RESOURCE_COMPLETE：已结束。 CHANGE_JOB_STARTED：任务变更中。 CHANGE_JOB_FAILED：任务变更失败。 CHILD_TRANSFER_STARTING：子任务启动中。 CHILD_TRANSFER_STARTED：子任务迁移中。 CHILD_TRANSFER_COMPLETE：子任务迁移完成。 CHILD_TRANSFER_FAILED：子任务迁移失败。 RELEASE_CHILD_TRANSFER_STARTED：子任务结束中。 RELEASE_CHILD_TRANSFER_COMPLETE：子任务已结束。其中，异常状态可单独查询，也可以通过以下方式查询全部异常任务：CREATE_FAILED，START_JOB_FAILED，FULL_TRANSFER_FAILED，INCRE_TRANSFER_FAILED，RELEASE_RESOURCE_FAILED，CHANGE_JOB_FAILED，CHILD_TRANSFER_FAILED。枚举值： CREATING CREATE_FAILED CONFIGURATION STARTJOBING WAITING_FOR_START START_JOB_FAILED FULL_TRANSFER_STARTED FULL_TRANSFER_FAILED FULL_TRANSFER_COMPLETE INCRE_TRANSFER_STARTED INCRE_TRANSFER_FAILED RELEASE_RESOURCE_STARTED RELEASE_RESOURCE_FAILED RELEASE_RESOURCE_COMPLETE CHANGE_JOB_STARTED CHANGE_JOB_FAILED CHILD_TRANSFER_STARTING CHILD_TRANSFER_STARTED CHILD_TRANSFER_COMPLETE CHILD_TRANSFER_FAILED RELEASE_CHILD_TRANSFER_STARTED RELEASE_CHILD_TRANSFER_COMPLETE
engine_type	否	String	引擎类型。取值： oracle-to-gaussdbv5：Oracle同步到GaussDB分布式版，实时同步场景使用。 redis-to-gaussredis：Redis迁移到GeminiDB Redis，实时迁移场景使用。 rediscluster-to-gaussredis：Redis集群迁移到GeminiDB Redis，实时迁移场景使用。枚举值： oracle-to-gaussdbv5 redis-to-gaussredis rediscluster-to-gaussredis
net_type	否	String	网络类型。取值： eip：公网网络。 vpc：VPC网络。 vpn：VPN、专线网络。枚举值： eip vpc vpn
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过滤。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
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 枚举值： en-us zh-cn

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
total_count	Integer	列表中的项目总数，与分页无关。
jobs	Array of objects	任务信息列表。详情请参见表5。

表5 jobs字段数据结构说明
参数	参数类型	描述
id	String	任务ID。
name	String	任务名称。
status	String	任务状态。取值： CREATING：创建中。 CREATE_FAILED：创建失败。 CONFIGURATION：配置中。 STARTJOBING：启动中。 WAITING_FOR_START：等待启动中。 START_JOB_FAILED：任务启动失败。 FULL_TRANSFER_STARTED：全量迁移中灾备场景为初始化。 FULL_TRANSFER_FAILED：全量迁移失败灾备场景为初始化失败。 FULL_TRANSFER_COMPLETE：全量迁移完成灾备场景为初始化完成。 INCRE_TRANSFER_STARTED：增量迁移中灾备场景为灾备中。 INCRE_TRANSFER_FAILED：增量迁移失败灾备场景为灾备异常。 RELEASE_RESOURCE_STARTED：结束任务中。 RELEASE_RESOURCE_FAILED：结束任务失败。 RELEASE_RESOURCE_COMPLETE：已结束。 CHANGE_JOB_STARTED：任务变更中。 CHANGE_JOB_FAILED：任务变更失败。 CHILD_TRANSFER_STARTING：子任务启动中。 CHILD_TRANSFER_STARTED：子任务迁移中。 CHILD_TRANSFER_COMPLETE：子任务迁移完成。 CHILD_TRANSFER_FAILED：子任务迁移失败。 RELEASE_CHILD_TRANSFER_STARTED：子任务结束中。 RELEASE_CHILD_TRANSFER_COMPLETE：子任务已结束。枚举值： CREATING CREATE_FAILED CONFIGURATION STARTJOBING WAITING_FOR_START START_JOB_FAILED FULL_TRANSFER_STARTED FULL_TRANSFER_FAILED FULL_TRANSFER_COMPLETE INCRE_TRANSFER_STARTED INCRE_TRANSFER_FAILED RELEASE_RESOURCE_STARTED RELEASE_RESOURCE_FAILED RELEASE_RESOURCE_COMPLETE CHANGE_JOB_STARTED CHANGE_JOB_FAILED CHILD_TRANSFER_STARTING CHILD_TRANSFER_STARTED CHILD_TRANSFER_COMPLETE CHILD_TRANSFER_FAILED RELEASE_CHILD_TRANSFER_STARTED RELEASE_CHILD_TRANSFER_COMPLETE
description	String	任务描述。
create_time	String	任务创建时间。
engine_type	String	引擎类型。取值： oracle-to-gaussdbv5：Oracle同步到GaussDB分布式版，实时同步场景使用。 redis-to-gaussredis：Redis迁移到GeminiDB Redis，实时迁移场景使用。 rediscluster-to-gaussredis：Redis集群迁移到GeminiDB Redis，实时迁移场景使用。枚举值： oracle-to-gaussdbv5 redis-to-gaussredis rediscluster-to-gaussredis
net_type	String	网络类型。取值： eip：公网网络。 vpc：VPC网络，灾备场景不支持选择VPC网络。 vpn：VPN、专线网络。枚举值： eip vpc vpn
charging_mode	String	计费模式。取值： period：包周期。 on_demand：按需。枚举值： period on_demand
billing_tag	Boolean	是否计费。
job_direction	String	任务方向。取值： up：入云，灾备场景时对应本云为备。 down：出云，灾备场景时对应本云为主。 non-dbs：自建。枚举值： up down non-dbs
job_type	String	任务场景。取值： migration：实时迁移。 sync：实时同步。 cloudDataGuard：实时灾备。枚举值： migration sync cloudDataGuard
task_type	String	任务模式。取值： FULL_TRANS ：全量。 FULL_INCR_TRANS：全量+增量。 INCR_TRANS：增量。枚举值： FULL_TRANS FULL_INCR_TRANS INCR_TRANS
enterprise_project_id	String	企业项目ID。
job_mode	String	任务模式。取值： single：单任务。 sync_child：同步子任务。 multi_to_single：多对一任务。枚举值： single sync_child multi_to_single
job_mode_role	String	任务角色。取值： parent：父任务。 child：子任务。 master：主任务。 slave：备任务。枚举值： parent child master slave
is_multi_az	Boolean	是否主备任务。
node_role	String	任务节点角色。
node_new_framework	Boolean	是否新框架。
job_action	Object	任务操作命令集合。详情请参见表7。
children	Array of objects	子任务列表信息体。详情请参见表6。

表6 children字段数据结构说明
参数	参数类型	描述
id	String	任务ID。
name	String	任务名称。
status	String	任务状态。取值： CREATING：创建中。 CREATE_FAILED：创建失败。 CONFIGURATION：配置中。 STARTJOBING：启动中。 WAITING_FOR_START：等待启动中。 START_JOB_FAILED：任务启动失败。 FULL_TRANSFER_STARTED：全量迁移中灾备场景为初始化。 FULL_TRANSFER_FAILED：全量迁移失败灾备场景为初始化失败。 FULL_TRANSFER_COMPLETE：全量迁移完成灾备场景为初始化完成。 INCRE_TRANSFER_STARTED：增量迁移中灾备场景为灾备中。 INCRE_TRANSFER_FAILED：增量迁移失败灾备场景为灾备异常。 RELEASE_RESOURCE_STARTED：结束任务中。 RELEASE_RESOURCE_FAILED：结束任务失败。 RELEASE_RESOURCE_COMPLETE：已结束。 CHANGE_JOB_STARTED：任务变更中。 CHANGE_JOB_FAILED：任务变更失败。 CHILD_TRANSFER_STARTING：子任务启动中。 CHILD_TRANSFER_STARTED：子任务迁移中。 CHILD_TRANSFER_COMPLETE：子任务迁移完成。 CHILD_TRANSFER_FAILED：子任务迁移失败。 RELEASE_CHILD_TRANSFER_STARTED：子任务结束中。 RELEASE_CHILD_TRANSFER_COMPLETE：子任务已结束。枚举值： CREATING CREATE_FAILED CONFIGURATION STARTJOBING WAITING_FOR_START START_JOB_FAILED FULL_TRANSFER_STARTED FULL_TRANSFER_FAILED FULL_TRANSFER_COMPLETE INCRE_TRANSFER_STARTED INCRE_TRANSFER_FAILED RELEASE_RESOURCE_STARTED RELEASE_RESOURCE_FAILED RELEASE_RESOURCE_COMPLETE CHANGE_JOB_STARTED CHANGE_JOB_FAILED CHILD_TRANSFER_STARTING CHILD_TRANSFER_STARTED CHILD_TRANSFER_COMPLETE CHILD_TRANSFER_FAILED RELEASE_CHILD_TRANSFER_STARTED RELEASE_CHILD_TRANSFER_COMPLETE
description	String	任务描述。
create_time	String	任务创建时间。
engine_type	String	引擎类型。取值： oracle-to-gaussdbv5：Oracle同步到GaussDB分布式版，实时同步场景使用。 redis-to-gaussredis：Redis迁移到GeminiDB Redis，实时迁移场景使用。 rediscluster-to-gaussredis：Redis集群迁移到GeminiDB Redis，实时迁移场景使用。枚举值： oracle-to-gaussdbv5 redis-to-gaussredis rediscluster-to-gaussredis
net_type	String	网络类型。取值： eip：公网网络。 vpc：VPC网络，灾备场景不支持选择VPC网络。 vpn：VPN、专线网络。枚举值： eip vpc vpn
charging_mode	String	计费模式。取值： period：包周期。 on_demand：按需。枚举值： period on_demand
billing_tag	Boolean	是否计费。
job_direction	String	任务方向。取值： up：入云，灾备场景时对应本云为备。 down：出云，灾备场景时对应本云为主。 non-dbs：自建。枚举值： up down non-dbs
job_type	String	任务场景。取值： migration：实时迁移。 sync：实时同步。 cloudDataGuard：实时灾备。枚举值： migration sync cloudDataGuard
task_type	String	任务模式。取值： FULL_TRANS ：全量。 FULL_INCR_TRANS：全量+增量。 INCR_TRANS：增量。枚举值： FULL_TRANS FULL_INCR_TRANS INCR_TRANS
enterprise_project_id	String	企业项目ID。
job_mode	String	任务模式。取值： single：单任务。 sync_child：同步子任务。 multi_to_single：多对一任务。枚举值： single sync_child multi_to_single
job_mode_role	String	任务角色。取值： parent：父任务。 child：子任务。 master：主任务。 slave：备任务。枚举值： parent child master slave
is_multi_az	Boolean	是否主备任务。
node_role	String	任务节点角色。
node_new_framework	Boolean	是否新框架。
job_action	Object	任务操作命令集合。详情请参见表7。

表7 job_action字段数据结构说明
参数	参数类型	描述
available_actions	Array of strings	任务可操作命令集合。
unavailable_actions	Array of strings	任务不可操作命令集合。
current_action	String	任务当前操作命令。取值： API_CONFIGURATION_ACTION：OPEN API配置中的任务能调用。 CHANGE：修改任务。 CHANGE_MODE：修改任务模式。 CHOOSE_OBJECT：选择对象。 CLONE：克隆任务。 CONTINUE_APPLY：启动回放，Oracle同步到GaussDB分布式适用。 CONTINUE_CAPTURE：启动抓取，Oracle同步到GaussDB分布式适用。 CONTINUE_JOB：启动失败或者停止的任务，Oracle同步到GaussDB分布式适用。 CREATE：创建任务。 DELETE：删除任务。 FREE_RESOURCE：释放资源。 JUMP_RETRY：跳跃续传任务。 MODIFY_CONFIGURATION：修改任务配置。 MODIFY_DB_CONFIG：修改数据库配置。 MODIFY_TASK_NUMBER：修改线程数配置。 NODE_FLAVOR_MODIFY：规格变更。 ORDER_INFO：订单详情。 PAUSE：暂停任务。 PAY_ORDER：包年/包月支付订单。 PRE_CHECK：预检查。 QUERY_PRE_CHECK：查询预检查结果。 RESET：重置任务。 RESET_DB_PWD：重置数据库密码（源库、目标库）。 RETRY：重试任务。 START：启动任务。 START_INCR：启动增量任务。 STOP_APPLY：停止回放，Oracle同步到GaussDB分布式适用。 STOP_CAPTURE：停止抓取，Oracle同步到GaussDB分布式适用。 STOP_JOB：停止任务，Oracle同步到GaussDB分布式适用。 SWITCH_OVER：灾备倒换。 TO_PERIOD：转包年/包月任务。 TO_RENEW：包年/包月任务续费。 UNSUBSCRIBE：包年/包月任务退订。枚举值： API_CONFIGURATION_ACTION CHANGE CHANGE_MODE CHOOSE_OBJECT CLONE CONTINUE_APPLY CONTINUE_CAPTURE CONTINUE_JOB CREATE DELETE FREE_RESOURCE JUMP_RETRY MODIFY_CONFIGURATION MODIFY_DB_CONFIG MODIFY_TASK_NUMBER NODE_FLAVOR_MODIFY ORDER_INFO PAUSE PAY_ORDER PRE_CHECK QUERY_PRE_CHECK RESET RESET_DB_PWD RETRY START START_INCR STOP_APPLY STOP_CAPTURE STOP_JOB SWITCH_OVER TO_PERIOD TO_RENEW UNSUBSCRIBE

状态码： 400

表8 响应Body参数
参数	参数类型	描述
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

响应示例

状态码： 200

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

错误码

请参见错误码。

父主题： 实例管理

上一篇：创建任务

下一篇：更新指定ID任务详情

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消