DescribeClusters

Last updated: 2020-05-09 14:20:51

PDF

1. API Description

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

This API is used to query the TcaplusDB cluster list, including cluster details.

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

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 parameter. The value used for this API: DescribeClusters.
Version Yes String Common parameter. The value used for this API: 2019-08-23.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-seoul, ap-shanghai, ap-singapore, ap-taipei, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley
ClusterIds.N No Array of String List of IDs of clusters to be queried
Filters.N No Array of Filter Query filter
Offset No Integer Query list offset
Limit No Integer Number of returned results in query list. Default value: 20

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of cluster instances
Clusters Array of ClusterInfo Cluster instance list
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying cluster list

This example shows you how to query your list of clusters.

Input Example

https://tcaplus.tencentcloudapi.com/?Action=DescribeClusters
&<common request parameters>

Output Example

{
  "Response": {
    "Clusters": [
      {
        "ApiAccessId": "8",
        "ApiAccessIp": "10.18.7.15",
        "ApiAccessPort": 9999,
        "ClusterId": "5462425805",
        "ClusterName": "gz test application",
        "CreatedTime": "2019-12-04 11:28:16",
        "IdlType": "PROTO",
        "NetworkType": "vpc-normal",
        "OldPasswordExpireTime": "",
        "Password": "gz123AppTest56",
        "PasswordStatus": "modifiable",
        "Region": "ap-guangzhou",
        "SubnetId": "subnet-jq2cqev2",
        "VpcId": "vpc-oezt2hwl"
      },
      {
        "ApiAccessId": "2",
        "ApiAccessIp": "10.18.7.9",
        "ApiAccessPort": 9999,
        "ClusterId": "6032569361",
        "ClusterName": "Thunder Fighter Test",
        "CreatedTime": "2019-12-25 11:54:02",
        "IdlType": "PROTO",
        "NetworkType": "vpc-normal",
        "OldPasswordExpireTime": "",
        "Password": "ltzj123123X",
        "PasswordStatus": "modifiable",
        "Region": "ap-guangzhou",
        "SubnetId": "subnet-jq2cqev2",
        "VpcId": "vpc-oezt2hwl"
      }
    ],
    "RequestId": "34680b61-9836-44d9-bae9-e231f4b61a48",
    "TotalCount": 2
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.UnauthorizedOperation API operation authentication error.
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.