Domain name for API request: csip.intl.tencentcloudapi.com.
Query cluster overview data
A maximum of 20 requests can be initiated per second for this API.
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: DescribeClusterSummary. |
| Version | Yes | String | Common Params. The value used for this API: 2022-11-21. |
| Region | No | String | Common Params. This parameter is not required. |
| MemberId.N | No | Array of String | Group account member id. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalClusterCount | Integer | Total number of clusters |
| TotalNodeCount | Integer | Total nodes |
| TotalCoreCount | Integer | Total cores. |
| UsedCoreQuota | Integer | Used core amount limit |
| PurchasedCoreQuota | Integer | Number of purchased cores limit |
| ElasticCoreQuota | Integer | Elastic Billing Cores |
| UnprotectedCoreCount | Integer | Unprotected cores in the cluster |
| ProtectedCoreCount | Integer | Number of protected cores in the cluster |
| UnprotectedClusterCount | Integer | Number of unprotected clusters |
| ProtectedClusterCount | Integer | Number of protected clusters |
| TkeClusterCount | Integer | Number of Tencent Cloud TKE clusters |
| SelfBuiltClusterCount | Integer | Number of self-built clusters |
| UnboundUltimateNodeCount | Integer | Number of nodes not bound to the Ultimate Edition |
| 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. |
POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterSummary
<Common request parameters>
{}{
"Response": {
"AlarmClusterCount": 0,
"AlarmEventCount": 0,
"CriticalAlarmClusterCount": 0,
"CriticalAlarmEventCount": 0,
"CriticalRiskClusterCount": 0,
"CriticalRiskEventCount": 44,
"ElasticCoreQuota": 0,
"HighAlarmClusterCount": 0,
"HighAlarmEventCount": 0,
"HighRiskClusterCount": 0,
"HighRiskEventCount": 47,
"LowAlarmEventCount": 0,
"LowRiskEventCount": 0,
"MiddleAlarmEventCount": 0,
"MiddleRiskEventCount": 0,
"ProtectedClusterCount": 0,
"ProtectedCoreCount": 0,
"PurchasedCoreQuota": 0,
"RiskClusterCount": 0,
"RiskEventCount": 91,
"SelfBuiltClusterCount": 2,
"TkeClusterCount": 6,
"TotalClusterCount": 8,
"TotalCoreCount": 0,
"TotalNodeCount": 15,
"UnprotectedClusterCount": 0,
"UnprotectedCoreCount": 0,
"UsedCoreQuota": 0,
"RequestId": "6c8827c8-d279-482e-be86-457f160e655d"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback