数据传输服务查询订阅任务详情-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： dts.tencentcloudapi.com 。

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSubscribeDetail。
Version	是	String	公共参数，本接口取值：2021-12-06。
Region	是	String	公共参数，详见产品支持的地域列表。
SubscribeId	是	String	订阅实例ID 示例值：subs-xxxxxx

3. 输出参数

参数名称	类型	描述
SubscribeId	String	数据订阅的ID，形如subs-b6x64o31tm 示例值：subs-xxxxxx
SubscribeName	String	数据订阅实例的名称示例值：test
Product	String	订阅的数据库类型，目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版) 示例值：mysql
InstanceId	String	订阅的云数据库实例ID，只有订阅云数据库该值才有意义注意：此字段可能返回 null，表示取不到有效值。示例值：cdb-xxxxxx
InstanceStatus	String	订阅的云数据库实例状态，只有订阅云数据库该值才有意义。可能值为：running, isolated, offline 注意：此字段可能返回 null，表示取不到有效值。示例值：running
Status	String	订阅任务计费状态，可能值为：正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng 示例值：normal
SubsStatus	String	订阅任务状态，可能值为：未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error 示例值：running
ModifyTime	String	修改时间，时间格式如：Y-m-d h:m:s 注意：此字段可能返回 null，表示取不到有效值。示例值：2023-06-30 12:00:00
CreateTime	String	创建时间，时间格式如：Y-m-d h:m:s 注意：此字段可能返回 null，表示取不到有效值。示例值：2023-06-30 12:00:00
IsolateTime	String	隔离时间，时间格式如：Y-m-d h:m:s。默认：0000-00-00 00:00:00 注意：此字段可能返回 null，表示取不到有效值。示例值：0000-00-00 00:00:00
ExpireTime	String	包年包月任务的到期时间，时间格式如：Y-m-d h:m:s。默认：0000-00-00 00:00:00 注意：此字段可能返回 null，表示取不到有效值。示例值：2023-07-30 12:00:00
OfflineTime	String	下线时间，时间格式如：Y-m-d h:m:s。默认：0000-00-00 00:00:00 注意：此字段可能返回 null，表示取不到有效值。示例值：0000-00-00 00:00:00
PayType	Integer	付费方式，可能值为：0-包年包月，1-按量计费示例值：0
AutoRenewFlag	Integer	自动续费标识。只有当 PayType=0，该值才有意义。枚举值：0-不自动续费，1-自动续费示例值：1
Region	String	任务所在地域示例值：ap-guangzhou
Topic	String	Kafka topic 注意：此字段可能返回 null，表示取不到有效值。示例值：topic-subs-9n0q6o7tok-cdb-ixunfa27
Broker	String	Kafka服务Broker地址注意：此字段可能返回 null，表示取不到有效值。示例值：guangzhoutest-kafka-5.cdb-dts.tencentcs.com.cn:32339
SubscribeMode	String	数据订阅的类型，当 Product 不为 mongodb 时，可能值为：all-全实例更新；dml-数据更新；ddl-结构更新；dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时，可能值为 all-全实例更新；database-订阅单库；collection-订阅单集合注意：此字段可能返回 null，表示取不到有效值。示例值：dmlAndDdl
Protocol	String	订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf，mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议：protobuf\avro\json。数据格式详情参考官网的消费demo文档注意：此字段可能返回 null，表示取不到有效值。示例值：protobuf
SubscribeObjects	Array of SubscribeObject	订阅的数据库表信息注意：此字段可能返回 null，表示取不到有效值。
KafkaConfig	SubscribeKafkaConfig	kafka配置信息注意：此字段可能返回 null，表示取不到有效值。
KafkaVersion	String	订阅内置kafka的版本信息注意：此字段可能返回 null，表示取不到有效值。示例值：2.6.0
AccessType	String	源数据库接入类型，如：extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力注意：此字段可能返回 null，表示取不到有效值。示例值：cdb
Endpoints	Array of EndpointItem	接入类型信息注意：此字段可能返回 null，表示取不到有效值。
PipelineInfo	Array of PipelineInfo	mongo输出聚合设置注意：此字段可能返回 null，表示取不到有效值。
Tags	Array of TagItem	标签注意：此字段可能返回 null，表示取不到有效值。
Errors	Array of SubsErr	订阅任务报错信息注意：此字段可能返回 null，表示取不到有效值。
ExtraAttr	Array of KeyValuePairOption	为业务添加的额外信息。参数名作key，参数值作value。 mysql选填参数：ProcessXA-是否处理XA事务，为true处理，其他不处理。 mongo选填参数：SubscribeType-订阅类型，目前只支持changeStream。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询订阅任务详情

输入示例

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

{
    "SubscribeId": "subs-0b2up6hk4u"
}

输出示例

{
    "Response": {
        "Region": "ap-guangzhou",
        "AccessType": "cdb",
        "AutoRenewFlag": 0,
        "Broker": "guangzhoutest-kafka-3.cdb-dts.tencentcs.com.cn:32339",
        "CreateTime": "2023-12-06 14:31:27",
        "Endpoints": [
            {
                "DatabaseRegion": "ap-guangzhou",
                "EncryptConn": "UnEncrypted",
                "InstanceId": "cdb-kdxona7h",
                "User": "root"
            }
        ],
        "ExpireTime": "0000-00-00 00:00:00",
        "InstanceId": "cdb-kdxona7h",
        "InstanceStatus": "running",
        "IsolateTime": "0000-00-00 00:00:00",
        "KafkaConfig": {
            "DistributeRules": [
                {
                    "DbPattern": "db1",
                    "RuleType": "cols",
                    "TablePattern": "table1",
                    "Columns": [
                        "id"
                    ]
                },
                {
                    "DbPattern": ".*",
                    "RuleType": "table",
                    "TablePattern": ".*",
                    "Columns": null
                }
            ],
            "NumberOfPartitions": 8
        },
        "ModifyTime": "2023-12-06 14:33:47",
        "OfflineTime": "0000-00-00 00:00:00",
        "PayType": 0,
        "Product": "mysql",
        "Protocol": "json",
        "Status": "normal",
        "SubsStatus": "running",
        "SubscribeId": "subs-0b2up6hk4u",
        "SubscribeName": "test",
        "SubscribeMode": "all",
        "Topic": "topic-subs-0b2up6hk4u-cdb-kdxona7h",
        "RequestId": "7bd11a40-9406-11ee-9689-216abbbe2107"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

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	不支持的操作。

查询订阅任务详情

本页目录：