文档首页/ 数据复制服务 DRS/ API参考/ API v5（公测中）/ 实例操作/ 获取指定任务允许操作信息
更新时间：2023-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取指定任务允许操作信息

功能介绍

获取指定任务允许、不允许、当前操作信息。

接口约束

仅支持部分Region使用，详情参考终端节点。

URI

GET /v5/{project_id}/jobs/{job_id}/actions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

job_id

是

String

任务ID。

请求参数

表2 请求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

表3 响应Body参数

参数

参数类型

描述

job_action

Object

允许、不允许的操作集合。

详情请参见表4。
表4 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：启动抓取
  • 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

当前操作。

状态码： 422

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：1

最大长度：512

请求示例

获取指定任务操作信息请求示例。

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/163b98e8-6088-46c3-8b86-c18fea6jb502/actions

响应示例

状态码： 200

OK 
{
  "job_action": {
    "available_actions": [
      "CREATE",
      "CHOOSE_OBJECT",
      "PRE_CHECK"
    ],
    "unavailable_actions": [
      "START",
      "QUICK_START",
      "CHANGE",
      "RETRY"
    ],
    "current_action": "SWITCH_OVER"
  }
}

状态码： 400

Bad Request

{
  "error_code": "DRS.10000001",
  "error_msg": "Failed."
}

错误码

请参见错误码。

父主题： 实例操作