tencent cloud

APIs

DescribeClusterDetail

Download
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-01 09:57:42

1. API Description

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

Querying Cluster Details

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: 2022-11-21.
Region No String Common Params. This parameter is not required.
MemberId.N No Array of String

Group account member id.

ClusterCaMD5 No String

Cluster ca certificate md5 value, the unique identifier of the cluster

3. Output Parameters

Parameter Name Type Description
ClusterBaseInfo ClusterListItem

Cluster basic information

RuntimeComponent String

Runtime component.

MasterIP String

master ip

NodeCount Integer

Number of nodes

NamespaceCount Integer

Number of namespaces

PodCount Integer

Number of pods

ContainerCount Integer

Number of containers

ServiceCount Integer

Number of services

IngressCount Integer

Number of ingresses

ImageCount Integer

Number of images.

SystemComponentCount Integer

Number of system components

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 Calling the API

Input Example

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

{
    "ClusterAssetId": "86693c5bf9e9fbdce993d557b1038fd8"
}

Output Example

{
    "Response": {
        "ClusterBaseInfo": {
            "AlarmEventCriticalCount": 0,
            "AlarmEventHighCount": 0,
            "AlarmEventLowCount": 0,
            "AlarmEventMiddleCount": 0,
            "AppID": 260083796,
            "AssetId": "86693c5bf9e9fbdce993d557b1038fd8",
            "AuditLogSwitchStatus": 0,
            "ClusterId": "cls-pde9e0s0",
            "ClusterName": "yancyw-standard cluster",
            "ClusterType": "TKE_MANAGED_CLUSTER",
            "DefendCoresCount": 0,
            "DefendStatus": "AccessedInstalled",
            "FailMessage": "",
            "LastAssetSyncTime": "2026-03-18T07:31:26Z",
            "LastRiskCheckTime": "2026-03-18T08:20:20Z",
            "NodeCount": 0,
            "OfflineNodeCount": 0,
            "OwnerName": "",
            "Region": "ap-guangzhou",
            "RiskEventCriticalCount": 0,
            "RiskEventHighCount": 0,
            "RiskEventLowCount": 0,
            "RiskEventMiddleCount": 0,
            "RiskStatus": "failed",
            "RunStatus": "Running",
            "Tags": [],
            "TotalCoresCount": 0,
            "UninstallNodeCount": 0,
            "Version": "1.30.0"
        },
        "ContainerCount": 0,
        "ImageCount": 0,
        "IngressCount": 0,
        "MasterIP": "",
        "NamespaceCount": 7,
        "NodeCount": 0,
        "PodCount": 0,
        "RuntimeComponent": "containerd",
        "ServiceCount": 0,
        "RequestId": "7da09158-1246-473d-852d-0b873a7b0900"
    }
}

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
InternalError Internal error.
InvalidParameter Parameter error.

Ajuda e Suporte

Esta página foi útil?

comentários