1. 接口描述
接口请求域名： dts.tencentcloudapi.com 。
本接口(DescribeSubscribes)获取数据订阅实例信息列表，默认分页，每次返回20条
默认接口请求频率限制：100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSubscribeJobs。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SubscribeId | 否 | String | 订阅 ID 筛选，精确匹配 示例值：subs-9jyki7hniw |
| SubscribeName | 否 | String | 订阅名称，前缀模糊匹配 示例值：test |
| InstanceId | 否 | String | 订阅的云上数据库实例的 ID，精确匹配 示例值：cdb-kdxona7h |
| Topic | 否 | String | 订阅的topicName 示例值：topic-subs-g9k9ct7gmc--6itdltb8 |
| PayType | 否 | Integer | 计费模式筛选，可能的值：0-包年包月，1-按量计费 示例值：1 |
| Product | 否 | String | 订阅的数据库产品，目前支持 cynosdbmysql,mariadb,mongodb,mysql,percona,tdpg,tdsqlpercona(tdsqlmysql) 示例值：mysql |
| Status.N | 否 | Array of String | 数据订阅生命周期状态，可能的值为：正常 normal, 隔离中 isolating, 已隔离 isolated, 下线中 offlining，按量转包年包月中 post2PrePayIng |
| SubsStatus.N | 否 | Array of String | 数据订阅状态，可能的值为：未启动 notStarted, 校验中 checking, 校验不通过 checkNotPass, 校验通过 checkPass, 启动中 starting, 运行中 running, 异常出错 error |
| Offset | 否 | Integer | 返回记录的起始偏移量。默认0 示例值：0 |
| Limit | 否 | Integer | 单次返回的记录数量。默认20，最大100 示例值：20 |
| OrderDirection | 否 | String | 排序方向，可选的值为"DESC"和"ASC"，默认为"DESC"，按创建时间逆序排序 示例值：ASC |
| TagFilters.N | 否 | Array of TagFilter | tag 过滤条件，多个 TagFilter 之间关系为且 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合查询条件的实例总数 示例值：1 |
| Items | Array of SubscribeInfo | 数据订阅实例的信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询订阅任务列表
输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSubscribeJobs
<公共请求参数>
{
"Offset": 0,
"Limit": 10
}输出示例
{
"Response": {
"TotalCount": 1,
"Items": [
{
"SubscribeId": "subs-5ft0e2nrc0",
"SubscribeName": "name-5ft0e2nrc0",
"Topic": "topic-subs-5ft0e2nrc0-cdb-kdxona7h",
"Product": "mysql",
"InstanceId": "cdb-kdxona7h",
"InstanceStatus": "running",
"Status": "normal",
"SubsStatus": "running",
"ModifyTime": "2023-10-01 12:00:00",
"CreateTime": "2023-09-01 12:00:00",
"IsolateTime": "0000-00-00 00:00:00",
"ExpireTime": "2023-11-01 12:00:00",
"OfflineTime": "0000-00-00 00:00:00",
"PayType": 0,
"AutoRenewFlag": 0,
"Region": "ap-guangzhou",
"AccessType": "cdb",
"Endpoints": [
{
"DatabaseRegion": "ap-guangzhou",
"InstanceId": "cdb-kdxona7h",
"EncryptConn": "Encrypted",
"User": "root"
}
],
"SubscribeVersion": "kafka"
}
],
"RequestId": "cd6eebd0-9405-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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.AuthFailureError | 认证失败。 |
| FailedOperation | 操作失败。 |
| FailedOperation.FailedOperationError | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.InternalErrorError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidParameterError | 参数无效。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |
