数据复制服务 DRS-查询租户任务列表:响应参数

时间:2024-10-18 19:41:52

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_record

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:启动失败。
  • PAUSING:已暂停。
  • FULL_TRANSFER_STARTED:全量开始,灾备场景下为初始化。
  • FULL_TRANSFER_FAILED:全量失败,灾备场景下为初始化失败。
  • FULL_TRANSFER_COMPLETE:全量完成,灾备场景下为初始化完成。
  • INCRE_TRANSFER_STARTED:增量开始,灾备场景下为灾备中。
  • INCRE_TRANSFER_FAILED:增量失败,灾备场景下为灾备异常。
  • RELEASE_RESOURCE_STARTED:结束任务中。
  • RELEASE_RESOURCE_FAILED:结束任务失败。
  • RELEASE_RESOURCE_COMPLETE:已结束。
  • REBUILD_NODE_STARTED:故障恢复中。
  • REBUILD_NODE_FAILED:故障恢复失败。
  • CHANGE_JOB_STARTED:任务变更中。
  • CHANGE_JOB_FAILED:任务变更失败。
  • DELETED:已删除。
  • CHILD_TRANSFER_STARTING:再编辑子任务启动中。
  • CHILD_TRANSFER_STARTED:再编辑子任务迁移中。
  • CHILD_TRANSFER_COMPLETE:再编辑子任务迁移完成。
  • CHILD_TRANSFER_FAILED:再编辑子任务迁移失败。
  • RELEASE_CHILD_TRANSFER_STARTED:再编辑子任务结束中。
  • RELEASE_CHILD_TRANSFER_COMPLETE:再编辑子任务已结束。
  • NODE_UPGRADE_START:升级开始。
  • NODE_UPGRADE_COMPLETE:升级完成。
  • NODE_UPGRADE_FAILED:升级失败。

枚举值:

  • CREATING
  • CREATE_FAILED
  • CONFIGURATION
  • STARTJOBING
  • WAITING_FOR_START
  • START_JOB_FAILED
  • PAUSING
  • FULL_TRANSFER_STARTED
  • FULL_TRANSFER_FAILED
  • FULL_TRANSFER_COMPLETE
  • INCRE_TRANSFER_STARTED
  • INCRE_TRANSFER_FAILED
  • RELEASE_RESOURCE_STARTED
  • RELEASE_RESOURCE_FAILED
  • RELEASE_RESOURCE_COMPLETE
  • REBUILD_NODE_STARTED
  • REBUILD_NODE_FAILED
  • CHANGE_JOB_STARTED
  • CHANGE_JOB_FAILED
  • DELETED
  • CHILD_TRANSFER_STARTING
  • CHILD_TRANSFER_STARTED
  • CHILD_TRANSFER_COMPLETE
  • CHILD_TRANSFER_FAILED
  • RELEASE_CHILD_TRANSFER_STARTED
  • RELEASE_CHILD_TRANSFER_COMPLETE
  • NODE_UPGRADE_START
  • NODE_UPGRADE_COMPLETE
  • NODE_UPGRADE_FAILED

description

String

任务描述。

create_time

String

任务创建时间。

engine_type

String

DRS任务引擎类型。取值:

  • mysql:MySQL到MySQL迁移,MySQL到MySQL同步
  • mongodb:MongoDB到DDS迁移
  • cloudDataGuard-mysql:MySQL到MySQL灾备
  • gaussdbv5 GaussDB 同步
  • mysql-to-kafka:MySQL到Kafka同步
  • taurus-to-kafka:GaussDB(for MySQL)到Kafka同步
  • gaussdbv5ha-to-kafkaGaussDB主备版到Kafka同步
  • postgresql:PostgreSQL到PostgreSQL同步

详细取值可参考引擎类型说明

net_type

String

网络类型。取值:

  • vpn
  • vpc
  • eip

billing_tag

Boolean

计费字段。

job_direction

String

任务方向。取值:

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

db_use_type

String

任务场景。取值:

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

task_type

String

任务模式。取值:

  • FULL_TRANS :全量。
  • FULL_INCR_TRANS:全量+增量。
  • INCR_TRANS:增量。

children

Array of objects

子任务信息体。

详情请参见表6

node_newFramework

Boolean

是否新框架。

job_action

Object

任务操作命令矩阵。

详情请参见表7

表6 children字段数据结构说明

参数

参数类型

描述

billing_tag

Boolean

计费字段。

create_time

String

任务创建时间。

db_use_type

String

复制场景。取值:

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

description

String

任务描述。

engine_type

String

DRS任务引擎类型。取值:

  • mysql:MySQL到MySQL迁移,MySQL到MySQL同步
  • mongodb:MongoDB到DDS迁移
  • cloudDataGuard-mysql:MySQL到MySQL灾备
  • gaussdbv5GaussDB同步
  • mysql-to-kafka:MySQL到Kafka同步
  • taurus-to-kafka:GaussDB(for MySQL)到Kafka同步
  • gaussdbv5ha-to-kafkaGaussDB主备版到Kafka同步
  • postgresql:PostgreSQL到PostgreSQL同步

详细取值可参考引擎类型说明

error_msg

String

任务失败原因。

id

String

任务ID。

job_direction

String

迁移方向。取值:

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

name

String

任务名称。

net_type

String

网络类型。取值:

  • vpc
  • vpn
  • eip

node_newFramework

Boolean

新框架。

status

String

任务状态。

  • CREATING:创建中。
  • CREATE_FAILED:创建失败。
  • CONFIGURATION:配置中。
  • STARTJOBING:启动中。
  • WAITING_FOR_START:等待启动中。
  • START_JOB_FAILED:启动失败。
  • PAUSING:已暂停。
  • FULL_TRANSFER_STARTED:全量开始,灾备场景下为初始化。
  • FULL_TRANSFER_FAILED:全量失败,灾备场景下为初始化失败。
  • FULL_TRANSFER_COMPLETE:全量完成,灾备场景下为初始化完成。
  • INCRE_TRANSFER_STARTED:增量开始,灾备场景下为灾备中。
  • INCRE_TRANSFER_FAILED:增量失败,灾备场景下为灾备异常。
  • RELEASE_RESOURCE_STARTED:结束任务中。
  • RELEASE_RESOURCE_FAILED:结束任务失败。
  • RELEASE_RESOURCE_COMPLETE:已结束。
  • REBUILD_NODE_STARTED:故障恢复中。
  • REBUILD_NODE_FAILED:故障恢复失败。
  • CHANGE_JOB_STARTED:任务变更中。
  • CHANGE_JOB_FAILED:任务变更失败。
  • DELETED:已删除。
  • CHILD_TRANSFER_STARTING:再编辑子任务启动中。
  • CHILD_TRANSFER_STARTED:再编辑子任务迁移中。
  • CHILD_TRANSFER_COMPLETE:再编辑子任务迁移完成。
  • CHILD_TRANSFER_FAILED:再编辑子任务迁移失败。
  • RELEASE_CHILD_TRANSFER_STARTED:再编辑子任务结束中。
  • RELEASE_CHILD_TRANSFER_COMPLETE:再编辑子任务已结束。
  • NODE_UPGRADE_START:升级开始。
  • NODE_UPGRADE_COMPLETE:升级完成。
  • NODE_UPGRADE_FAILED:升级失败。

枚举值:

  • CREATING
  • CREATE_FAILED
  • CONFIGURATION
  • STARTJOBING
  • WAITING_FOR_START
  • START_JOB_FAILED
  • PAUSING
  • FULL_TRANSFER_STARTED
  • FULL_TRANSFER_FAILED
  • FULL_TRANSFER_COMPLETE
  • INCRE_TRANSFER_STARTED
  • INCRE_TRANSFER_FAILED
  • RELEASE_RESOURCE_STARTED
  • RELEASE_RESOURCE_FAILED
  • RELEASE_RESOURCE_COMPLETE
  • REBUILD_NODE_STARTED
  • REBUILD_NODE_FAILED
  • CHANGE_JOB_STARTED
  • CHANGE_JOB_FAILED
  • DELETED
  • CHILD_TRANSFER_STARTING
  • CHILD_TRANSFER_STARTED
  • CHILD_TRANSFER_COMPLETE
  • CHILD_TRANSFER_FAILED
  • RELEASE_CHILD_TRANSFER_STARTED
  • RELEASE_CHILD_TRANSFER_COMPLETE
  • NODE_UPGRADE_START
  • NODE_UPGRADE_COMPLETE
  • NODE_UPGRADE_FAILED

task_type

String

任务模式。取值:

  • FULL_TRANS :全量。
  • FULL_INCR_TRANS:全量+增量。
  • INCR_TRANS:增量。

job_action

Object

任务操作命令矩阵。

详情请参见表7

表7 job_action字段数据结构说明

参数

参数类型

描述

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:oracle-GaussDB分布式:启动抓取
  • STOP_CAPTURE:oracle-GaussDB分布式:停止抓取
  • CONTINUE_APPLY:oracle-GaussDB分布式:启动回放
  • STOP_APPLY:oracle-GaussDB分布式:停止回放
  • 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:oracle-GaussDB分布式:启动抓取
  • STOP_CAPTURE:oracle-GaussDB分布式:停止抓取
  • CONTINUE_APPLY:oracle-GaussDB分布式:启动回放
  • STOP_APPLY:oracle-GaussDB分布式:停止回放
  • PAY_ORDER:包年包月支付订单
  • UNSUBSCRIBE:包年包月退订
  • TO_PERIOD:转包周期
  • TO_RENEW:包周期续费
  • ORDER_INFO:订单详情
  • CHANGE_FLAVOR:规格变更
  • CLONE:克隆任务

current_action

String

当前操作。取值:

  • SWITCH_OVER:灾备倒换中
  • STOP_JOB:任务暂停中
support.huaweicloud.com/api-drs/drs_03_0138.html