tencent cloud

APIs

DescribeClusterPodDetail

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:10:56

1. API Description

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

This API is used to query Pod details in A cluster. It is A new Type A API for the container asset revision and serves as the main entrance to the Pod Asset Details Page. The input parameter is only UniqueID. The output parameters cover asset information, cluster, namespace, node, Workload, as well as the number of risk events and alarm events grouped by four risk levels.

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

Pod unique ID

MemberId.N No Array of String

Group account member id

3. Output Parameters

Parameter Name Type Description
UniqueID String

Pod unique ID

AppID Integer

Primary Account AppID

PodName String

Pod name

PodIP String

Pod IP address

RunStatus String

Pod running state

Labels Array of AssetTag

Pod Labels list

StartTime Timestamp ISO8601

Pod startup time

StartupTime Integer

Start time (seconds)

RestartCount Integer

Pod restart count

ClusterName String

Cluster Name

ClusterID String

Cluster ID

ClusterType String

Cluster type

ClusterRunStatus String

Cluster operation status

Namespace String

Namespace

NodeName String

Node name where it resides.

NodeId String

Current node ID

WorkloadName String

Name of the associated Workload

WorkloadType String

Workload type

RiskEventCriticalCount Integer

Number of critical risk events

RiskEventHighCount Integer

Number of high-risk events

RiskEventMiddleCount Integer

Number of medium-risk events

RiskEventLowCount Integer

Number of low-risk events

AlarmEventCriticalCount Integer

Number of critical alarm events

AlarmEventHighCount Integer

Number of high-risk alarm events

AlarmEventMiddleCount Integer

Number of medium-risk alarm events

AlarmEventLowCount Integer

Number of low-risk alarm events

Region String

Region

NodeInternalIP String

Node private IP

NodeExternalIP String

Node public IP

ContainerCount Integer

Number of associated containers

ServiceCount Integer

Number of associated services

RegionName String

Region Chinese Name

RegionNameEn String

Region English name

AlarmCount Integer

Number of alarms.

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 1

Input Example

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

{
    "UniqueID": "474eda3f2befc4e3072c67adf9086ce1"
}

Output Example

{
    "Response": {
        "AlarmEventCriticalCount": 0,
        "AlarmEventHighCount": 0,
        "AlarmEventLowCount": 0,
        "AlarmEventMiddleCount": 0,
        "AppID": 260083796,
        "ClusterID": "cls-pde9e0s0",
        "ClusterName": "yancyw-standard cluster",
        "ClusterRunStatus": "Running",
        "ClusterType": "TKE_MANAGED_CLUSTER",
        "ContainerCount": 1,
        "Labels": [
            {
                "TagKey": "app",
                "TagValue": "openclaw-latest"
            }
        ],
        "Namespace": "openclaw",
        "NodeExternalIP": "",
        "NodeId": "ins-08eaqwmk",
        "NodeInternalIP": "172.16.1.36",
        "NodeName": "tke_cls-pde9e0s0_worker",
        "PodIP": "172.16.0.160",
        "PodName": "openclaw-latest-7ddc9cbdb7-22vnh",
        "Region": "ap-guangzhou",
        "RestartCount": 0,
        "RiskEventCriticalCount": 0,
        "RiskEventHighCount": 0,
        "RiskEventLowCount": 0,
        "RiskEventMiddleCount": 0,
        "RunStatus": "Running",
        "ServiceCount": 1,
        "StartTime": "2026-06-12T01:56:15Z",
        "StartupTime": 2073768,
        "UniqueID": "474eda3f2befc4e3072c67adf9086ce1",
        "WorkloadName": "openclaw-latest-7ddc9cbdb7",
        "WorkloadType": "ReplicaSet",
        "RequestId": "b426ae55-fdb0-4e29-82ae-d1259b12ca72"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback