tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClusters

Last updated: 2024-07-24 10:20:52

    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.

    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: DescribeClusters.
    Version Yes String Common Params. The value used for this API: 2019-08-23.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    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
    Ipv6Enable No Integer Whether to enable IPv6 address access

    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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying the cluster list

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

    Input Example

    https://tcaplusdb.tencentcloudapi.com/?Action=DescribeClusters
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 2,
        "RequestId": "xx",
        "Clusters": [
            {
                "ApiAccessIpv6": "xx",
                "DbaUins": [
                    "xx"
                ],
                "KafkaInfo": {
                    "IsVpc": true,
                    "Topic": "xx",
                    "Password": "xx",
                    "User": "xx",
                    "Address": "xx",
                    "Instance": "ckafka-l4xpzgpz"
                },
                "PasswordStatus": "xx",
                "CreatedTime": "2020-09-22 00:00:00",
                "WriteCapacityUnit": 0,
                "IdlType": "xx",
                "VpcId": "xx",
                "ApiAccessIp": "xx",
                "ClusterId": "xx",
                "ProxyList": [
                    {
                        "ProcessSpeed": 0,
                        "AverageProcessDelay": 0,
                        "MachineType": "xx",
                        "ProxyUid": "xx",
                        "SlowProcessSpeed": 0
                    }
                ],
                "Censorship": 0,
                "SubnetId": "xx",
                "Password": "xx",
                "ApiAccessId": "xx",
                "DiskVolume": 0,
                "DataFlowStatus": 0,
                "Region": "xx",
                "ClusterType": 0,
                "NetworkType": "xx",
                "OldPasswordExpireTime": "xx",
                "ServerList": [
                    {
                        "MachineType": "xx",
                        "ServerUid": "xx",
                        "ReadNum": 0,
                        "WriteNum": 0,
                        "MemoryRate": 0,
                        "DiskRate": 0
                    }
                ],
                "ApiAccessPort": 9999,
                "ClusterName": "xx",
                "ClusterStatus": 0,
                "ReadCapacityUnit": 0
            },
            {
                "ApiAccessIpv6": "xx",
                "DbaUins": [
                    "342",
                    "432432",
                    "342342"
                ],
                "PasswordStatus": "xx",
                "KafkaInfo": {
                    "IsVpc": true,
                    "Topic": "xx",
                    "Password": "xx",
                    "User": "xx",
                    "Address": "xx",
                    "Instance": "ckafka-l4xpzgpz"
                },
                "CreatedTime": "2020-09-22 00:00:00",
                "WriteCapacityUnit": 0,
                "IdlType": "xx",
                "VpcId": "xx",
                "ApiAccessIp": "xx",
                "ClusterId": "xx",
                "ClusterStatus": 0,
                "ProxyList": [
                    {
                        "MachineType": "xx",
                        "AverageProcessDelay": 0,
                        "ProcessSpeed": 0,
                        "ProxyUid": "xx",
                        "SlowProcessSpeed": 0
                    }
                ],
                "Censorship": 1,
                "SubnetId": "xx",
                "Password": "xx",
                "ApiAccessId": "xx",
                "DiskVolume": 0,
                "DataFlowStatus": 0,
                "Region": "xx",
                "ClusterType": 0,
                "OldPasswordExpireTime": "xx",
                "ServerList": [
                    {
                        "ServerUid": "xx",
                        "ReadNum": 0,
                        "DiskRate": 0,
                        "WriteNum": 0,
                        "MemoryRate": 0,
                        "MachineType": "xx"
                    }
                ],
                "ApiAccessPort": 9999,
                "ClusterName": "xx",
                "NetworkType": "xx",
                "ReadCapacityUnit": 0
            }
        ]
    }
}

    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.UnauthorizedOperation API operation authentication error.
    FailedOperation.RegionMismatch The requested region does not match.
    InternalError Internal error.
    InvalidParameterValue Incorrect parameter value.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy