数据传输服务获取数据订阅实例列表-数据传输服务 API 2018-03-30-API 中心-腾讯云

1. 接口描述

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

本接口(DescribeSubscribes)获取数据订阅实例信息列表，默认分页，每次返回20条

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSubscribes。
Version	是	String	公共参数，本接口取值：2018-03-30。
Region	是	String	公共参数，详见产品支持的地域列表。
SubscribeId	否	String	数据订阅的实例ID 示例值：subs-fr19dk5e2y
SubscribeName	否	String	数据订阅的实例名称示例值：name-fr19dk5e2y
InstanceId	否	String	绑定数据库实例的ID 示例值：cdb-5gsip99h
ChannelId	否	String	数据订阅实例的通道ID 示例值：topic-subs-fr19dk5e2y-cdb-5gsip99h
PayType	否	String	计费模式筛选，可能的值：0-包年包月，1-按量计费示例值：1
Product	否	String	订阅的数据库产品，如mysql 示例值：mysql
Status.N	否	Array of String	数据订阅实例的状态，creating - 创建中，normal - 正常运行，isolating - 隔离中，isolated - 已隔离，offlining - 下线中示例值：["isolate\n"]
SubsStatus.N	否	Array of String	数据订阅实例的配置状态，unconfigure - 未配置， configuring - 配置中，configured - 已配置示例值：running
Offset	否	Integer	返回记录的起始偏移量，默认为0。请输入非负整数示例值：0
Limit	否	Integer	单次返回的记录数量，默认20。请输入1到100的整数示例值：1
OrderDirection	否	String	排序方向，可选的值为"DESC"和"ASC"，默认为"DESC"，按创建时间逆序排序示例值：DESC
TagFilters.N	否	Array of TagFilter	标签过滤条件
SubscribeVersion	否	String	订阅实例版本;txdts-旧版数据订阅，kafka-kafka版本数据订阅示例值：kafka

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	符合查询条件的实例总数示例值：2
Items	Array of SubscribeInfo	数据订阅实例的信息列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据订阅实例列表

输入示例

https://dts.tencentcloudapi.com/?Action=DescribeSubscribes
&Status.0=isolate
&Offset=0
&Limit=1
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 2,
        "Items": [
            {
                "ChannelId": "dts-channel-C9rS58f2rFx11ZEZ",
                "ConsumeStartTime": "2019-12-19 16:23:45",
                "CreateTime": "2019-12-20 14:59:07",
                "ExpireTime": "0000-00-00 00:00:00",
                "InstanceId": "cdb-forsubsc",
                "InstanceStatus": "running",
                "IsolateTime": "0000-00-00 00:00:00",
                "ModifyTime": "2019-12-20 18:06:26",
                "OfflineTime": "0000-00-00 00:00:00",
                "PayType": 1,
                "Product": "mysql",
                "Region": "ap-guangzhou",
                "SdkConsumedTime": "0000-00-00 00:00:00",
                "Status": "normal",
                "SubsStatus": "configured",
                "SubscribeId": "subs-58zcu8bax0",
                "SubscribeName": "测试实例",
                "UniqSubnetId": "subnet-4p1hpsj8",
                "UniqVpcId": "vpc-fbg8gh1j",
                "Vip": "192.168.1.143",
                "Vport": 7507,
                "SubscribeVersion": "kafka",
                "AutoRenewFlag": 0,
                "Tags": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ]
            }
        ],
        "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
    }
}

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.AuthFailureError	认证失败。
AuthFailure.UnauthorizedOperationError	鉴权失败，当前用户不允许执行该操作。
InternalError	内部错误。
InternalError.InternalErrorError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue.InvalidParameterValueError	非法参数。

获取数据订阅实例列表

本页目录：