tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClusterSummary

Last updated: 2024-07-22 11:09:27

    1. API Description

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

    This API is used to query the overview of cluster assets.

    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: DescribeClusterSummary.
    Version Yes String Common Params. The value used for this API: 2020-11-01.
    Region No String Common Params. This parameter is not required.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of clusters
    RiskClusterCount Integer Number of clusters at risk
    UncheckClusterCount Integer Number of clusters not checked
    ManagedClusterCount Integer Number of managed clusters
    IndependentClusterCount Integer Number of self-deployed clusters
    NoRiskClusterCount Integer Number of clusters involving no risks
    CheckedClusterCount Integer Number of checked clusters
    AutoCheckClusterCount Integer Number of clusters automatically checked
    ManualCheckClusterCount Integer Number of clusters manually checked
    FailedClusterCount Integer Number of clusters that failed the check
    NotImportedClusterCount Integer Number of clusters not imported
    ServerlessClusterCount Integer Number of EKS clusters
    TkeClusterCount Integer
    UserCreateTencentClusterCount Integer
    UserCreateHybridClusterCount 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 cluster assets

    This example shows you how to query the cluster assets.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "NoRiskClusterCount": 1,
        "ManagedClusterCount": 1,
        "AutoCheckClusterCount": 1,
        "UncheckClusterCount": 1,
        "IndependentClusterCount": 1,
        "TotalCount": 1,
        "CheckedClusterCount": 1,
        "RequestId": "fb31a6a7-4cdc-4984-9a3e-df780a7d7bf4",
        "FailedClusterCount": 1,
        "ManualCheckClusterCount": 1,
        "RiskClusterCount": 1,
        "NotImportedClusterCount": 1,
        "ServerlessClusterCount": 3
    }
}

    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 A CAM signature/authentication error occurred.
    FailedOperation The operation failed.
    InternalError An internal error occurred.
    InvalidParameter The parameter is incorrect.
    OperationDenied The operation was denied.
    RequestLimitExceeded The number of requests exceeds the frequency limit.
    UnauthorizedOperation The operation is unauthorized.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy