DescribeDedicatedClusterOverview

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

Tencent Cloud CLI 3.0

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

tencent cloud

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the overview of the CDC

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Image Creation

Internet of Things

Stream Services

Cloud Real-time Rendering

Management and Audit Tools

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Developer Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Tencent Big Model

Natural Language Processing

Communication

Media Process Services

Education Sevices

Monitor and Operation

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Voice Technology

Optical Character Recognition

Interactive Video Services

Media SDK

Cloud Resource Management

More

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying the overview of the CDC

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code

About Tencent Cloud

Help & Support

Resources

User Center