tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeSubscribes

Last updated: 2022-05-12 10:02:16

1. API Description

Domain name for API request: dts.tencentcloudapi.com.

This API is used to get the information list of data subscription instances. Pagination is enabled by default with 20 results returned each time.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeSubscribes.
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 No String Data subscription instance ID
SubscribeName No String Data subscription instance name
InstanceId No String ID of bound database instance
ChannelId No String Data subscription instance channel ID
PayType No String Billing mode filter. Default value: 1 (pay-as-you-go)
Product No String Subscribed database product, such as MySQL
Status.N No Array of String Data subscription instance status. Valid values: creating, normal, isolating, isolated, offlining
SubsStatus.N No Array of String Data subscription instance configuration status. Valid values: unconfigure, configuring, configured
Offset No Integer Starting offset of returned results
Limit No Integer Number of results to be returned at a time
OrderDirection No String Sorting order. Valid values: DESC, ASC. Default value: DESC, indicating descending by creation time
TagFilters.N No Array of TagFilter Tag filtering condition
SubscribeVersion No String Subscription instance edition. txdts: legacy data subscription; kafka: data subscription in Kafka edition

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of eligible instances.
Items Array of SubscribeInfo Information list of data subscription instances
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying data subscription instance list

Input Example

https://dts.tencentcloudapi.com/?Action=DescribeSubscribes
&Status.0=isolate
&Offset=0
&Limit=1
&<Common request parameters>

Output Example

{
  "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": "Test instance",
        "UniqSubnetId": "subnet-4p1hpsj8",
        "UniqVpcId": "vpc-fbg8gh1j",
        "Vip": "192.168.1.143",
        "Vport": 7507
      }
    ],
    "RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure.UnauthorizedOperationError The current user is not allowed to perform this operation as the authentication failed.
InternalError An internal error occurred.
InvalidParameter A parameter error occurred.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy