Domain name for API request: dts.tencentcloudapi.com.
This API is used to query the subscription instance configuration.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: DescribeSubscribeConf. |
Version | Yes | String | Common Params. The value used for this API: 2018-03-30. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
SubscribeId | Yes | String | Subscription instance ID |
Parameter Name | Type | Description |
---|---|---|
SubscribeId | String | Subscription instance ID |
SubscribeName | String | Subscription instance name |
ChannelId | String | Subscription channel |
Product | String | Subscribed database type |
InstanceId | String | Subscribed instance |
InstanceStatus | String | Subscribed instance status. Valid values: running, offline, isolate |
SubsStatus | String | Subscription instance status. Valid values: unconfigure, configuring, configured |
Status | String | Subscription instance lifecycle status. Valid values: normal, isolating, isolated, offlining |
CreateTime | String | Subscription instance creation time |
IsolateTime | String | Subscription instance isolation time |
ExpireTime | String | Subscription instance expiration time |
OfflineTime | String | Subscription instance deactivation time |
ConsumeStartTime | String | Consumption starting time point of subscription instance |
PayType | Integer | Subscription instance billing mode. 1: hourly billing |
Vip | String | Subscription channel VIP |
Vport | Integer | Subscription channel port |
UniqVpcId | String | Subscription channel VpcId |
UniqSubnetId | String | Subscription channel SubnetId |
SdkConsumedTime | String | Current SDK consumption time point |
SdkHost | String | Subscription SDK IP address |
SubscribeObjectType | Integer | Subscription object type. 0: full instance subscription, 1: DDL data subscription, 2: DML structure subscription, 3: DDL data subscription + DML structure subscription |
SubscribeObjects | Array of SubscribeObject | Subscription object, which is an empty array if SubscribeObjectType is 0 |
ModifyTime | String | Modification time |
Region | String | Region |
Tags | Array of TagItem | Tags of the subscription Note: this field may return null , indicating that no valid values can be obtained. |
AutoRenewFlag | Integer | Whether auto-renewal is enabled. 0: do not enable, 1: enable Note: this field may return null , indicating that no valid values can be obtained. |
SubscribeVersion | String | Data subscription edition. txdts : Legacy edition; kafka : Kafka edition. |
Errors | Array of SubsErr | Error message. Note: This field may return null , indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://dts.tencentcloudapi.com/?Action=DescribeSubscribeConf
&SubscribeId=subs-ieuwi83j2e
&<Common request parameters>
{
"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": "Test instance",
"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"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | An internal error occurred. |
InvalidParameter | A parameter error occurred. |
InvalidParameterValue.InvalidParameterValue | Incorrect parameter value. |
ResourceNotFound | The resource does not exist. |
ResourceNotFound.BizResourceNotFoundError | Resource not found. |
ResourceNotFound.ResourceNotFound | The instance is not found. |
Was this page helpful?