文档首页/ 数据复制服务 DRS/ API参考/ API v5（公测中）/ 实例详情/ 查询订阅任务详情 - ShowSubscriptionDetail
更新时间：2026-05-11 GMT+08:00
查看PDF
分享

查询订阅任务详情 - ShowSubscriptionDetail

功能介绍

查询订阅任务详情，可以根据企业项目和任务ID查询各订阅任务详情。

授权信息

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

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

URI

GET /v5/{project_id}/subscriptions/{job_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

job_id

是

String

任务ID。

请求参数

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

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

id

String

任务id

name

String

任务名称

约束：任务名称在4位到50位之间，不区分大小写，可以包含字母、数字、中划线或下划线，不能包括其他特殊字符。

  • 最小长度：4

  • 最大长度：50

ip

String

内网ip

enterprise_project_id

String

企业项目id

status

String

任务状态，取值：

CONFIGURATION：配置中

CREATING：创建中

CREATE_FAILED：创建失败

STARTJOBING：启动中

STARTJOB_FAILED：任务启动失败

SUBSCRIPTION_STARTED：正常

SUBSCRIPTION_FAILED：异常

DELETED：已删除

FROZEN：冻结状态

REBUILD_NODE_STARTED：订阅任务恢复中

REBUILD_NODE_FAILED：订阅任务恢复失败

NODE_UPGRADE_START：升级开始

NODE_UPGRADE_COMPLETE：升级完成

NODE_UPGRADE_FAILED：升级失败

subscription_data_type

object

订阅的数据类型，包含数据操作语言（DDL）和数据定义语言（DML）。

详情请参看SubscriptionDataType。

source_endpoint

object

订阅源数据库实例信息。

详情请参看SubscriptionEndpointInfo。

created_time

String

创建时间，以时间戳表示

begin_time

String

开始时间，以时间戳表示

now_time

String

当前时间，以时间戳表示

engine_type

String

链路类型，当前仅支持“mysql”

charge_info

object

计费方式，不收费时为NULL。

详情请参看ChargeInfoVo。

description

String

描述
表4 SubscriptionDataType

参数

参数类型

描述

is_dml_subscribed

Boolean

数据操作语言，取值：

true：订阅DML

false：不订阅DML

is_ddl_subscribed

Boolean

数据定义语言，取值：

true：订阅DDL

false：不订阅DDL
表5 SubscriptionEndpointInfo

参数

参数类型

描述

db_instance_id

String

数据库实例id

name

String

数据库名称

ip

String

数据库内网ip

port

Integer

数据库端口

type

String

数据库类型

user_name

String

数据库用户名
表6 ChargeInfoVo

参数

参数类型

描述

charge_mode

String

计费模式，取值：

  • on_demand: 按需

  • period: 包周期

period_type

String

订购周期类型，“charge_mode”为“period”时生效，且为必选值。取值：

  • month: 包月

  • year: 包年

period_num

Integer

订购时长，“charge_mode”为“period”时生效，且为必选值，指定订购的时间。

当“period_type”为“month”时，取值为1~9。

当“period_type”为“year”时，取值为1~3和5。

is_auto_renew

Boolean

是否自动续订，创建包周期实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。取值：

  • true: 自动续订

  • false: 不自动续订

is_auto_pay

Boolean

是否自动支付，创建包周期时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。

  • true: 自动支付

  • false: 手动支付

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询订阅任务详情。

https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/subscriptions/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r

响应示例

状态码：200

{
  "id" : "a66f645f-ca53-4fe6-95c7-415bffb52b30",
  "name" : "DRS-12352",
  "ip" : "192.168.40.161",
  "enterprise_project_id" : "0",
  "status" : "CONFIGURATION",
  "created_time" : "1769850901972",
  "begin_time" : null,
  "now_time" : "1769869904969",
  "subscription_data_type" : {
    "is_dml_subscribed" : true,
    "is_ddl_subscribed" : true
  },
  "source_endpoint" : {
    "db_instance_id" : "7e1124d2-c876-43a5-b7e9-6c893b946fdd",
    "ip" : "192.168.38.23",
    "endpoint_type" : "mysql",
    "port" : 3306,
    "user_name" : "drsFull",
    "name" : "test-ha-src-56-migration-instance1"
  }
}

状态码：400

Bad Request

{
  "error_code" : "DRS.10000023",
  "error_msg" : "program exception"
}

状态码

状态码

描述

200

OK

400

Bad Request

其他状态请参见状态码。

错误码

请参见错误码。

父主题： 实例详情

相关文档