1. 接口描述
接口请求域名: dts.tencentcloudapi.com 。
本接口(DescribeSubscribeConf)用于查询订阅实例配置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSubscribeConf。 |
Version | 是 | String | 公共参数,本接口取值:2018-03-30。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SubscribeId | 是 | String | 订阅实例ID 示例值:subs-ieuwi83j2e |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SubscribeId | String | 订阅实例ID 示例值:subs-58zcu8bax0 |
SubscribeName | String | 订阅实例名称 示例值:测试实例 |
ChannelId | String | 订阅通道 示例值:dts-channel-C9rS58f2rFx11ZEZ |
Product | String | 订阅数据库类型 示例值:mysql |
InstanceId | String | 被订阅的实例 示例值:cdb-forsubsc |
InstanceStatus | String | 被订阅的实例的状态,可能的值有running,offline,isolate 示例值:running |
SubsStatus | String | 订阅实例状态,可能的值有unconfigure-未配置,configuring-配置中,configured-已配置 示例值:configured |
Status | String | 订阅实例生命周期状态,可能的值有:normal-正常,isolating-隔离中,isolated-已隔离,offlining-下线中 示例值:normal |
CreateTime | String | 订阅实例创建时间 示例值:2019-12-20 14:59:07 |
IsolateTime | String | 订阅实例被隔离时间 示例值:0000-00-00 00:00:00 |
ExpireTime | String | 订阅实例到期时间 示例值:0000-00-00 00:00:00 |
OfflineTime | String | 订阅实例下线时间 示例值:0000-00-00 00:00:00 |
ConsumeStartTime | String | 订阅实例消费时间起点。 示例值:2019-12-19 16:23:45 |
PayType | Integer | 订阅实例计费类型,1-小时计费,0-包年包月 示例值:1 |
Vip | String | 订阅通道Vip 示例值:192.168.1.143 |
Vport | Integer | 订阅通道Port 示例值:7507 |
UniqVpcId | String | 订阅通道所在VpcId 示例值:vpc-fbg8gh1j |
UniqSubnetId | String | 订阅通道所在SubnetId 示例值:subnet-4p1hpsj8 |
SdkConsumedTime | String | 当前SDK消费时间位点 示例值:0000-00-00 00:00:00 |
SdkHost | String | 订阅SDK IP地址 示例值:192.168.1.143 |
SubscribeObjectType | Integer | 订阅对象类型0-全实例订阅,1-DDL数据订阅,2-DML结构订阅,3-DDL数据订阅+DML结构订阅 示例值:3 |
SubscribeObjects | Array of SubscribeObject | 订阅对象,当SubscribeObjectType 为0时,此字段为空数组 |
ModifyTime | String | 修改时间 示例值:2019-12-20 18:06:26 |
Region | String | 地域 示例值:ap-guangzhou |
Tags | Array of TagItem | 订阅实例的标签 注意:此字段可能返回 null,表示取不到有效值。 |
AutoRenewFlag | Integer | 自动续费标识,0-不自动续费,1-自动续费 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
SubscribeVersion | String | 数据订阅版本。老版订阅填txdts,kafka版填kafka 示例值:txdts |
Errors | Array of SubsErr | 错误信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看订阅配置详情
输入示例
https://dts.tencentcloudapi.com/?Action=DescribeSubscribeConf
&SubscribeId=subs-ieuwi83j2e
&<公共请求参数>
输出示例
{
"Response": {
"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",
"RequestId": "e580eac0-26c7-11ea-8e66-910ac0afe95e",
"SdkConsumedTime": "0000-00-00 00:00:00",
"SdkHost": "",
"Status": "normal",
"SubsStatus": "configured",
"SubscribeId": "subs-58zcu8bax0",
"SubscribeName": "测试实例",
"SubscribeObjectType": 3,
"SubscribeObjects": [
{
"DatabaseName": "dts",
"ObjectsType": 0,
"TableNames": null
}
],
"UniqSubnetId": "subnet-4p1hpsj8",
"SubscribeVersion": "kafka",
"UniqVpcId": "vpc-fbg8gh1j",
"Vip": "192.168.1.143",
"Vport": 7507,
"AutoRenewFlag": 0,
"Errors": [
{
"Message": ""
}
],
"Tags": [
{
"TagKey": "userDefineKey",
"TagValue": "userDefineValue"
}
]
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.InvalidParameterValue | 参数值错误。 |
InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.BizResourceNotFoundError | 未找到资源。 |
ResourceNotFound.ResourceNotFound | 实例未找到。 |
ResourceNotFound.ResourceNotFoundError | 资源未找到。 |