接口请求域名： dts.intl.tencentcloudapi.com 。
本接口（DescribeSubscribeConf）用于查询订阅实例配置
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeSubscribeConf。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| SubscribeId | 是 | String | 订阅实例ID |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SubscribeId | String | 订阅实例ID |
| SubscribeName | String | 订阅实例名称 |
| ChannelId | String | 订阅通道 |
| Product | String | 订阅数据库类型 |
| InstanceId | String | 被订阅的实例 |
| InstanceStatus | String | 被订阅的实例的状态，可能的值有running,offline,isolate |
| SubsStatus | String | 订阅实例状态，可能的值有unconfigure-未配置，configuring-配置中，configured-已配置 |
| Status | String | 订阅实例生命周期状态，可能的值有：normal-正常，isolating-隔离中，isolated-已隔离，offlining-下线中 |
| CreateTime | String | 订阅实例创建时间 |
| IsolateTime | String | 订阅实例被隔离时间 |
| ExpireTime | String | 订阅实例到期时间 |
| OfflineTime | String | 订阅实例下线时间 |
| ConsumeStartTime | String | 订阅实例消费时间起点。 |
| PayType | Integer | 订阅实例计费类型，1-小时计费，0-包年包月 |
| Vip | String | 订阅通道Vip |
| Vport | Integer | 订阅通道Port |
| UniqVpcId | String | 订阅通道所在VpcId |
| UniqSubnetId | String | 订阅通道所在SubnetId |
| SdkConsumedTime | String | 当前SDK消费时间位点 |
| SdkHost | String | 订阅SDK IP地址 |
| SubscribeObjectType | Integer | 订阅对象类型0-全实例订阅，1-DDL数据订阅，2-DML结构订阅，3-DDL数据订阅+DML结构订阅 |
| SubscribeObjects | Array of SubscribeObject | 订阅对象，当SubscribeObjectType 为0时，此字段为空数组 |
| ModifyTime | String | 修改时间 |
| Region | String | 地域 |
| Tags | Array of TagItem | 订阅实例的标签 |
| AutoRenewFlag | Integer | 自动续费标识,0-不自动续费，1-自动续费 |
| SubscribeVersion | String | 数据订阅版本。老版订阅填txdts，kafka版填kafka |
| Errors | Array of SubsErr | 错误信息 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
https://dts.intl.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": []
}
],
"UniqSubnetId": "subnet-4p1hpsj8",
"SubscribeVersion": "kafka",
"UniqVpcId": "vpc-fbg8gh1j",
"Vip": "192.168.1.143",
"Vport": 7507,
"AutoRenewFlag": 0,
"Errors": [
{
"Message": ""
}
],
"Tags": [
{
"TagKey": "userDefineKey",
"TagValue": "userDefineValue"
}
]
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.InvalidParameterValue | 参数值错误。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.BizResourceNotFoundError | 未找到资源。 |
| ResourceNotFound.ResourceNotFound | 实例未找到。 |
| ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
文档反馈