tencent cloud

数据传输服务

查询订阅任务详情

下载
聚焦模式
字号
最后更新时间: 2026-11-17 11:16:54

1. 接口描述

接口请求域名: dts.intl.tencentcloudapi.com 。

本接口(DescribeSubscribeDetail)获取数据订阅实例的配置信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeSubscribeDetail。
Version 是 String 公共参数,本接口取值:2021-12-06。
Region 是 String 公共参数,详见产品支持的 地域列表。
SubscribeId 是 String

订阅实例ID,可通过DescribeSubscribeJobs接口获取。

3. 输出参数

参数名称 类型 描述
SubscribeId String

数据订阅的ID,形如subs-b6x64o31tm

SubscribeName String

数据订阅实例的名称

Product String

订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

InstanceId String

订阅的云数据库实例ID,只有订阅云数据库该值才有意义

InstanceStatus String

订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

Status String

订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

SubsStatus String

订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

ModifyTime String

修改时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。

CreateTime String

创建时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。

IsolateTime String

隔离时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。

ExpireTime String

包年包月任务的到期时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。

OfflineTime String

下线时间。当 DateTimeISOFormat=true 时返回 RFC 3339 格式(如 2026-04-23T20:21:35+08:00),否则返回 Y-m-d h:m:s(北京时间)。

PayType Integer

付费方式,可能值为:0-包年包月,1-按量计费

AutoRenewFlag Integer

自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

Region String

任务所在地域

Topic String

Kafka topic

Broker String

Kafka服务Broker地址

SubscribeMode String

数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

Protocol String

订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

SubscribeObjects Array of SubscribeObject

订阅的数据库表信息

KafkaConfig SubscribeKafkaConfig

kafka配置信息

KafkaVersion String

订阅内置kafka的版本信息

AccessType String

源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

Endpoints Array of EndpointItem

接入类型信息

PipelineInfo Array of PipelineInfo

mongo输出聚合设置

Tags Array of TagItem

标签

Errors Array of SubsErr

订阅任务报错信息

ExtraAttr Array of KeyValuePairOption

为业务添加的额外信息。参数名作key,参数值作value。
mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。
mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

SubscribeVersion String

数据订阅版本, 当前支持kafka和kafkaPro(专业版)

ConsumerVpcId String

消费端地址所在vpc

ConsumerSubnetId String

消费端地址所在子网

InstanceClass String

订阅实例规格

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询订阅任务详情

输入示例

POST / HTTP/1.1
Host: dts.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSubscribeDetail
<公共请求参数>

{
    "SubscribeId": "subs-p383pfn0"
}

输出示例

{
    "Response": {
        "AccessType": "cdb",
        "AutoRenewFlag": 1,
        "Broker": "21.84.0.234:9092",
        "ConsumerSubnetId": "subnet-hyscbnec",
        "ConsumerVpcId": "vpc-gvemho5j",
        "CreateTime": "2026-07-28 19:38:57",
        "Endpoints": [
            {
                "CcnId": "",
                "CcnOwnerUin": "",
                "ChildInstanceId": "",
                "ChildInstanceType": "",
                "CvmInstanceId": "",
                "DatabaseNetEnv": "",
                "DatabaseRegion": "ap-guangzhou",
                "EncryptConn": "",
                "ExtraAttr": [],
                "HostName": "",
                "InstanceId": "tdsqlshard-dg58wo8z",
                "Password": "",
                "Port": 0,
                "SubnetId": "",
                "UniqDcgId": "",
                "UniqVpnGwId": "",
                "User": "user_00",
                "VpcId": ""
            }
        ],
        "Errors": null,
        "ExpireTime": "2026-08-28 19:38:57",
        "ExtraAttr": [],
        "InstanceClass": "small",
        "InstanceId": "tdsqlshard-dg58wo8z",
        "InstanceStatus": "running",
        "IsolateTime": "0000-00-00 00:00:00",
        "KafkaConfig": {
            "DefaultRuleType": "",
            "DistributeRules": [],
            "NumberOfPartitions": 0
        },
        "KafkaVersion": "2.8.1",
        "ModifyTime": "2026-08-05 16:35:33",
        "OfflineTime": "2026-09-04 19:38:57",
        "PayType": 0,
        "PipelineInfo": [],
        "Product": "tdsqlpercona",
        "Protocol": "",
        "Region": "ap-guangzhou",
        "RequestId": "3c417b08-e79d-473a-9de6-8ce0883df94e",
        "Status": "normal",
        "SubsStatus": "running",
        "SubscribeId": "subs-p383pfn0",
        "SubscribeMode": "dml",
        "SubscribeName": "jf-order-center-new-cluster",
        "SubscribeObjects": [
            {
                "Database": "order_center",
                "ObjectType": "table",
                "Tables": [
                    "deal"
                ]
            }
        ],
        "SubscribeVersion": "kafkaPro",
        "Tags": [
            {
                "TagKey": "备份负责人",
                "TagValue": "leohlliu"
            },
            {
                "TagKey": "二级业务",
                "TagValue": "[交易][order_center]_1230743"
            },
            {
                "TagKey": "一级业务",
                "TagValue": "[N][腾讯云计费产品其它]_979685"
            },
            {
                "TagKey": "负责人",
                "TagValue": "shaynefei"
            },
            {
                "TagKey": "运营产品",
                "TagValue": "腾讯云计费产品其它_1649"
            },
            {
                "TagKey": "运营部门",
                "TagValue": "计费产品中心_1013"
            }
        ],
        "Topic": "topic-subs-p383pfn0"
    }
}

5. 开发者资源

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.AuthFailureError 认证失败。
FailedOperation 操作失败。
FailedOperation.FailedOperationError 操作失败。
InternalError 内部错误。
InternalError.InternalErrorError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidParameterError 参数无效。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidParameterValueError 非法参数。
OperationDenied 操作被拒绝。
OperationDenied.OperationDeniedError 操作被拒绝。
ResourceNotFound 资源不存在。
ResourceNotFound.ResourceNotFoundError 资源未找到。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.UnauthorizedOperationError 未授权的操作。
UnsupportedOperation 操作不支持。
UnsupportedOperation.UnsupportedOperationError 不支持的操作。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈