tencent cloud

All product documents
APIs
DocumentationAPIsCloud Dedicated ClusterCloud Dedicated Cluster (CDC) APIsDescribeDedicatedClusterOverview
DescribeDedicatedClusterOverview
Last updated: 2024-11-27 15:19:20
DescribeDedicatedClusterOverview
Last updated: 2024-11-27 15:19:20

1. API Description

Domain name for API request: cdc.intl.tencentcloudapi.com.

This API is used to query the overview of the CDC

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: DescribeDedicatedClusterOverview.
Version Yes String Common Params. The value used for this API: 2020-12-14.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DedicatedClusterId Yes String Cluster id

3. Output Parameters

Parameter Name Type Description
CvmCount Integer Number of CVMs
HostCount Integer Number of hosts
VpnConnectionState String VPN channel status
Note: The returned value of this field may be null, indicating that no valid value is obtained.
VpngwBandwidthData VpngwBandwidthData VPN gateway monitoring data
Note: The returned value of this field may be null, indicating that no valid value is obtained.
LocalNetInfo LocalNetInfo Local gateway information
Note: The returned value of this field may be null, indicating that no valid value is obtained.
VpnConnectionBandwidthData Array of VpngwBandwidthData VPN gateway channel monitoring data
Note: The returned value of this field may be null, indicating that no valid value is obtained.
HostDetailInfo Array of HostDetailInfo
HostStandbyCount Integer
HostNormalCount Integer
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 overview of the CDC

This example shows you how to query the overview of the CDC

Input Example

POST / HTTP/1.1
Host: cdc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDedicatedClusterOverview
<Common request parameters>

{
    "DedicatedClusterId": "cluster-nk6e8j6c"
}

Output Example

{
    "Response": {
        "CvmCount": 36,
        "HostCount": 2,
        "VpnConnectionState": "AVAILABLE",
        "VpngwBandwidthData": {},
        "LocalNetInfo": {},
        "VpnConnectionBandwidthData": [],
        "RequestId": "ab5e5574-121b-4b5a-992c-fab691ac6737"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support