文档首页/ 数据复制服务 DRS/ API参考/ API v5（公测中）/ 实例管理/ 查询订阅任务列表 - ShowSubscriptionLists
更新时间：2026-02-04 GMT+08:00
查看PDF
分享

查询订阅任务列表 - ShowSubscriptionLists

功能介绍

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/subscriptions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

查询返回记录的数量限制，默认为10。

offset

否

Integer

偏移量，表示查询该偏移量后面的记录，默认为0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

否

String

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

X-Auth-Token

是

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

枚举值：

  • en-us

  • zh-cn
表4 请求Body参数

参数

是否必选

参数类型

描述

job_type

是

String

任务场景

engine_type

否

String

引擎类型。

net_type

否

String

网络类型。

name

否

String

任务ID或名称。

status

否

String

任务状态。

enterprise_project_id

否

String

企业项目ID。 缺省值：""，表示查询所有企业项目任务。

sort_key

否

String

返回结果按该关键字排序，默认为“create_time”。

sort_dir

否

String

降序或升序（分别对应desc和asc，默认为“desc”）。

instance_ids

否

Array of strings

数据库实例ID列表，最多支持10个。

instance_ip

否

String

数据库实例IP

tags

否

Map<String,String>

标签

service_name

否

String

服务名称

description

否

String

描述

is_billing

否

Boolean

计费模式，包括是、否以及全部三种情况，不填默认为全部

begin_at

否

String

消费时间

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

total_count

Integer

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

jobs

SubscriptionListResp object

任务信息列表
表6 SubscriptionListResp

参数

参数类型

描述

id

String

任务ID。

name

String

任务名称。

status

String

任务状态。

create_time

String

任务创建时间。

begin_time

String

消费开始时间。

description

String

任务描述。

now_time

String

当前时间。

job_action

JobActions object

任务操作命令集合。

enterprise_project_id

String

企业项目ID。
表7 JobActions

参数

参数类型

描述

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

枚举值：

  • 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

错误码。

error_msg

String

错误描述。

请求示例

查询订阅任务列表。

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/subscriptions?limit=10&offset=0

{
  "db_use_type" : "subscription",
  "engine_type" : "",
  "net_type" : "",
  "status" : "",
  "sort_key" : "",
  "sort_dir" : "",
  "enterprise_project_id" : "",
  "is_billing" : "false",
  "begin_at" : "",
  "description" : ""
}

响应示例

状态码：200

OK

{
  "total_count" : 2,
  "jobs" : [ {
    "id" : "a24fd980-92cb-4fbb-ab0a-34815115b14d",
    "name" : "DRS-4885",
    "status" : "CONFIGURATION",
    "create_time" : "1764225816102",
    "begin_time" : null,
    "description" : null,
    "now_time" : "1764300104574",
    "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
    },
    "enterprise_project_id" : "0"
  }, {
    "id" : "09f1b3a6-e69f-4f07-aad9-1dd6b40b0d87",
    "name" : "DRS-8845",
    "status" : "STARTJOBING",
    "createtime" : "1758857715673",
    "begintime" : "1758859045000",
    "description" : "RDS实例名称：Auto-Single-src-57-dr-1",
    "nowtime" : "1764300104574",
    "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
    },
    "enterprise_project_id" : "0"
  } ]
}

状态码：400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 实例管理

相关文档