tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClusterDetail

Last updated: 2024-12-06 15:48:53

    1. API Description

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

    This API is used to query the details of a cluster.

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

    3. Output Parameters

    Parameter Name Type Description
    ClusterId String Cluster ID
    ClusterName String Cluster name
    ScanTaskProgress Integer Progress of the current cluster scan task. 100 indicates that the scan is completed.
    ClusterVersion String Cluster version
    ContainerRuntime String Runtime component
    ClusterNodeNum Integer Number of nodes in the cluster
    ClusterStatus String Cluster status. Valid values: Running, Creating, Abnormal.
    ClusterType String Cluster type. Valid values: MANAGED_CLUSTER (managed cluster); INDEPENDENT_CLUSTER (self-deployed cluster).
    Region String Cluster region
    SeriousRiskCount Integer Number of critical check items
    HighRiskCount Integer Number of high-risk check items
    MiddleRiskCount Integer Number of medium-risk check items
    HintRiskCount Integer Number of prompt-risk check items
    CheckStatus String Status of the check task
    DefenderStatus String Status of the defender
    TaskCreateTime String Creation time of the scan task
    NetworkType String Network type. Valid values: PublicNetwork (public network); VPCNetwork (VPC).
    ApiServerAddress String API server address
    NodeCount Integer Number of nodes
    NamespaceCount Integer Number of namespaces
    WorkloadCount Integer Number of workloads
    PodCount Integer Number of Pods
    ServiceCount Integer Number of Services
    IngressCount Integer Number of Ingresses
    MasterIps String IPs of the primary nodes
    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 details of a cluster

    The following example shows how to query the details of a cluster.

    Input Example

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

{
    "ClusterId": "b6ebf065d08563396da66bf0950cba8c"
}

    Output Example

    {
    "Response": {
        "RequestId": "6c4a3216-1849-48d1-b02c-bb83801044b6",
        "ClusterId": "b6ebf065d08563396da66bf0950cba8c",
        "ClusterName": "wk-usercluster-test",
        "ScanTaskProgress": 0,
        "ClusterVersion": "v1.20.6-tke.12",
        "ContainerRuntime": "docker://19.3.9",
        "ClusterNodeNum": 4,
        "ClusterStatus": "Running",
        "DefenderStatus": "Defender_Normal",
        "ClusterType": "Kubernetes",
        "Region": "ap-guangzhou",
        "SeriousRiskCount": 0,
        "HighRiskCount": 0,
        "MiddleRiskCount": 0,
        "HintRiskCount": 0,
        "CheckStatus": "Task_Running",
        "TaskCreateTime": "2022-05-06 11:03:19",
        "NetworkType": "PublicNetwork",
        "ApiServerAddress": "https://xxxx:60002",
        "NodeCount": 4,
        "NamespaceCount": 0,
        "WorkloadCount": 0,
        "PodCount": 0,
        "ServiceCount": 0,
        "IngressCount": 0,
        "MasterIps": "127.0.0.1;127.0.0.2;"
    }
}

    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