查询任务列表 - ListJobs

project_id

是

String

参数解释：

租户在某一Region下的Project ID。

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

job_type

是

String

参数解释：

DRS任务场景类型，用于区分不同的数据复制场景。

约束限制：

不涉及。

取值范围：

• migration：实时迁移
• sync：实时同步
• cloudDataGuard：实时灾备

默认取值：

不涉及。

name

否

String

参数解释：

任务ID或名称，用于按任务ID或名称过滤查询结果。

约束限制：

支持输入多个任务ID，以逗号分隔，最多10个。

取值范围：

不涉及。

默认取值：

不涉及

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。

默认取值：

不涉及。

engine_type

否

String

参数解释：

DRS任务引擎类型，用于按引擎类型过滤查询结果。

约束限制：

不涉及。

取值范围：

• oracle-to-gaussdbv5：Oracle同步到GaussDB分布式版，实时同步场景使用。
• mysql-to-mysql：MySQL到MySQL，实时迁移、实时同步场景使用。
• redis-to-gaussredis：Redis迁移到GeminiDB Redis，实时迁移场景使用。
• rediscluster-to-gaussredis：Redis集群迁移到GeminiDB Redis，实时迁移场景使用。

默认取值：

不涉及

net_type

否

String

参数解释：

任务使用的网络类型，用于按网络类型过滤查询结果。

约束限制：

不涉及。

取值范围：

• eip：公网网络
• vpc：VPC网络，灾备场景不支持选择VPC网络
• vpn：VPN、专线网络

默认取值：

不涉及

enterprise_project_id

否

String

参数解释：

企业项目ID，用于按企业项目过滤查询结果。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

空字符串""，表示查询所有企业项目任务

offset

否

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

0

limit

否

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及

sort_key

否

String

参数解释：

返回结果的排序关键字，指定任务列表的排序依据。

约束限制：

不涉及。

取值范围：

• name：按任务名称排序。
• status：按任务状态排序。
• create_time：按创建时间排序。
• net_type：按网络类型排序。
• job_direction：按任务方向排序。
• pay_mode：按付费模式排序。

默认取值：

create_time

sort_dir

否

String

参数解释：

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

约束限制：

不涉及。

取值范围：

• desc：降序
• asc：升序

默认取值：

desc

instance_ids

否

Array of strings

参数解释：

数据库实例ID列表，用于按数据库实例过滤查询结果。

约束限制：

• 最多支持10个实例ID。

取值范围：

不涉及。

默认取值：

null，表示不使用数据库实例ID过滤

instance_ip

否

String

参数解释：

DRS绑定的数据库实例IP，用于按数据库实例IP过滤查询结果。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

空字符串""，表示不使用DRS绑定数据库IP过滤

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

total_count

Integer

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

jobs

Array of objects

参数解释：

任务信息列表，详情请参见表5。

约束限制：

不涉及。

取值范围：

不涉及。

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：子任务已结束。

description

String

参数解释：

任务的描述信息。

约束限制：

不涉及。

取值范围：

不涉及。

create_time

String

参数解释：

任务的创建时间，表示任务首次被创建的时间戳。

约束限制：

不涉及。

取值范围：

不涉及。

engine_type

String

参数解释：

DRS任务引擎类型。

约束限制：

不涉及。

取值范围：

• oracle-to-gaussdbv5：Oracle同步到GaussDB分布式版，实时同步场景使用。
• mysql-to-mysql：MySQL到MySQL，实时迁移、实时同步场景使用。
• redis-to-gaussredis：Redis迁移到GeminiDB Redis，实时迁移场景使用。
• rediscluster-to-gaussredis：Redis集群迁移到GeminiDB Redis，实时迁移场景使用。

net_type

String

参数解释：

任务使用的网络类型。

约束限制：

灾备场景不支持选择VPC网络。

取值范围：

• eip：公网网络。
• vpc：VPC网络。
• vpn：VPN、专线网络。

charging_mode

String

参数解释：

任务的计费模式，指定数据复制任务的付费方式。

约束限制：

不涉及。

取值范围：

• period：包周期
• on_demand：按需

billing_tag

Boolean

参数解释：

任务的计费模式标识，用于标识该任务当前是否处于计费状态。

约束限制：

不涉及。

取值范围：

• true：计费中。
• false：不计费。

job_direction

String

参数解释：

任务的迁移方向。

约束限制：

不涉及。

取值范围：

• up：入云，灾备场景时对应本云为备
• down：出云，灾备场景时对应本云为主
• non-dbs：自建

job_type

String

参数解释：

DRS任务场景类型，用于区分不同的数据复制场景。

约束限制：

不涉及。

取值范围：

• migration：实时迁移
• sync：实时同步
• cloudDataGuard：实时灾备

task_type

String

参数解释：

任务迁移模式，指定数据复制任务的执行方式。

约束限制：

不涉及。

取值范围：

• FULL_TRANS：全量迁移，仅迁移历史数据
• FULL_INCR_TRANS：全量+增量迁移，先迁移历史数据再持续同步增量
• INCR_TRANS：增量迁移，仅同步数据变更

enterprise_project_id

String

参数解释：

企业项目ID，用于按企业项目过滤查询结果。

约束限制：

不涉及。

取值范围：

不涉及。

job_mode

String

参数解释：

任务模式，指定数据复制任务的执行组织方式。

约束限制：

不涉及。

取值范围：

• single：单任务
• sync_child：同步子任务
• multi_to_single：多对一任务

job_mode_role

String

参数解释：

任务角色，指定数据复制任务在多任务场景中的角色。

约束限制：

不涉及。

取值范围：

• parent：父任务
• child：子任务
• master：主任务
• slave：备任务

is_multi_az

Boolean

参数解释：

标识任务是否为跨可用区（AZ）部署的主备任务。

约束限制：

不涉及。

取值范围：

• true：跨AZ主备任务
• false：非跨AZ任务

node_role

String

参数解释：

任务节点角色，标识任务在集群部署中的角色。

约束限制：

不涉及。

取值范围：

不涉及。

node_new_framework

Boolean

参数解释：

标识任务是否使用新框架执行。

约束限制：

不涉及。

取值范围：

• true：使用新框架。
• false：使用旧框架。

job_action

Object

参数解释：

任务操作命令集合，包含任务当前可执行、不可执行和正在执行的操作命令。

详情请参见表7。

children

Array of objects

参数解释：

子任务列表信息体，包含当前任务下的所有子任务详情。

详情请参见表6。

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：子任务已结束。

description

String

参数解释：

任务的描述信息。

约束限制：

不涉及。

取值范围：

不涉及。

create_time

String

参数解释：

任务创建时间。

约束限制：

不涉及。

取值范围：

不涉及。

engine_type

String

参数解释：

DRS任务引擎类型。

约束限制：

不涉及。

取值范围：

• oracle-to-gaussdbv5：Oracle同步到GaussDB分布式版，实时同步场景使用。
• mysql-to-mysql：MySQL到MySQL，实时迁移、实时同步场景使用。
• redis-to-gaussredis：Redis迁移到GeminiDB Redis，实时迁移场景使用。
• rediscluster-to-gaussredis：Redis集群迁移到GeminiDB Redis，实时迁移场景使用。

net_type

String

参数解释：

任务使用的网络类型。

约束限制：

灾备场景不支持选择VPC网络。

取值范围：

• eip：公网网络。
• vpc：VPC网络。
• vpn：VPN、专线网络。

charging_mode

String

参数解释：

任务的计费模式，指定数据复制任务的付费方式。

约束限制：

不涉及。

取值范围：

• period：包周期
• on_demand：按需

billing_tag

Boolean

参数解释：

任务的计费模式标识，用于标识该任务当前是否处于计费状态。

约束限制：

不涉及。

取值范围：

• true：计费中
• false：不计费

job_direction

String

参数解释：

任务的迁移方向。

约束限制：

不涉及。

取值范围：

• up：入云，灾备场景时对应本云为备。
• down：出云，灾备场景时对应本云为主。
• non-dbs：自建。

job_type

String

参数解释：

DRS任务场景类型，用于区分不同的数据复制场景。

约束限制：

不涉及。

取值范围：

• migration：实时迁移
• sync：实时同步
• cloudDataGuard：实时灾备

task_type

String

参数解释：

任务迁移模式，指定数据复制任务的执行方式。

约束限制：

不涉及。

取值范围：

• FULL_TRANS：全量迁移，仅迁移历史数据。
• FULL_INCR_TRANS：全量+增量迁移，先迁移历史数据再持续同步增量。
• INCR_TRANS：增量迁移，仅同步数据变更。

enterprise_project_id

String

参数解释：

企业项目ID，用于按企业项目过滤查询结果。

约束限制：

不涉及。

取值范围：

不涉及。

job_mode

String

参数解释：

任务模式，指定数据复制任务的执行组织方式。

约束限制：

不涉及。

取值范围：

• single：单任务。
• sync_child：同步子任务。
• multi_to_single：多对一任务。

job_mode_role

String

参数解释：

任务角色，指定数据复制任务在多任务场景中的角色。

约束限制：

不涉及。

取值范围：

• parent：父任务
• child：子任务
• master：主任务
• slave：备任务

is_multi_az

Boolean

参数解释：

标识任务是否为跨可用区（AZ）部署的主备任务。

约束限制：

不涉及。

取值范围：

• true：跨AZ主备任务。
• false：非跨AZ任务。

node_role

String

参数解释：

任务节点角色，标识任务在集群部署中的角色。

约束限制：

不涉及。

取值范围：

不涉及。

node_new_framework

Boolean

参数解释：

标识任务是否使用新框架执行。

约束限制：

不涉及。

取值范围：

• true：使用新框架
• false：使用旧框架

job_action

Object

参数解释：

任务操作命令集合，包含任务当前可执行、不可执行和正在执行的操作命令。

详情请参见表7。

available_actions

Array of strings

参数解释：

任务当前可执行的操作命令集合，表示该任务当前允许进行的操作。

约束限制：

不涉及。

取值范围：

• CREATE：创建任务
• CHOOSE_OBJECT：选择对象，任务增量中再编辑
• PRE_CHECK：预检查
• CHANGE_MODE：修改任务模式
• FREE_RESOURCE：释放资源
• MODIFY_DB_CONFIG：修改数据库配置
• RESET_DB_PWD：重置数据库密码（源库、目标库）
• MODIFY_CONFIGURATION：修改任务配置
• PAUSE：暂停任务
• START：启动任务
• CHANGE：修改任务
• RETRY：重试任务
• RESET：重置任务
• DELETE：删除任务
• QUERY_PRE_CHECK：预检查
• SWITCH_OVER：容灾倒换
• START_INCR：CASSANDRA启动增量任务
• MODIFY_TASK_NUMBER：CASSANDRA修改线程数配置
• CONTINUE_JOB：oracle-GaussDB分布式:启动失败或者停止的任务
• STOP_JOB：oracle-GaussDB分布式:停止任务
• CONTINUE_CAPTURE：启动抓取
• STOP_CAPTURE：停止抓取
• CONTINUE_APPLY：启动回放
• STOP_APPLY：停止回放
• PAY_ORDER：包年包月支付订单
• UNSUBSCRIBE：包年包月退订
• TO_PERIOD：转包周期
• TO_RENEW：包周期续费
• ORDER_INFO：订单详情
• CHANGE_FLAVOR：规格变更
• CLONE：克隆任务

unavailable_actions

Array of strings

参数解释：

任务当前不可执行的操作命令集合，表示该任务当前不允许进行的操作。

约束限制：

不涉及。

取值范围：

• CREATE：创建任务
• CHOOSE_OBJECT：选择对象，任务增量中再编辑
• PRE_CHECK：预检查
• CHANGE_MODE：修改任务模式
• FREE_RESOURCE：释放资源
• MODIFY_DB_CONFIG：修改数据库配置
• RESET_DB_PWD：重置数据库密码（源库、目标库）
• MODIFY_CONFIGURATION：修改任务配置
• PAUSE：暂停任务
• START：启动任务
• CHANGE：修改任务
• RETRY：重试任务
• RESET：重置任务
• DELETE：删除任务
• QUERY_PRE_CHECK：预检查
• SWITCH_OVER：容灾倒换
• START_INCR：CASSANDRA启动增量任务
• MODIFY_TASK_NUMBER：CASSANDRA修改线程数配置
• CONTINUE_JOB：oracle-GaussDB分布式:启动失败或者停止的任务
• STOP_JOB：oracle-GaussDB分布式:停止任务
• CONTINUE_CAPTURE：启动抓取
• STOP_CAPTURE：停止抓取
• CONTINUE_APPLY：启动回放
• STOP_APPLY：停止回放
• PAY_ORDER：包年包月支付订单
• UNSUBSCRIBE：包年包月退订
• TO_PERIOD：转包周期
• TO_RENEW：包周期续费
• ORDER_INFO：订单详情
• CHANGE_FLAVOR：规格变更
• CLONE：克隆任务

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：包年/包月任务退订。

error_code

String

参数解释：

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

约束限制：

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

取值范围：

格式为DRS.XXXXXX。

error_msg

String

参数解释：

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

约束限制：

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

取值范围：

不涉及。

200

OK

400

Bad Request