tencent cloud

APIs

DescribeClusterSuperNodeInfo

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

1. API Description

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

This API is used to query super node details in a cluster and return basic info (region, availability zone, last asset update time, node origin, subnet, and core count) and cluster information (cluster name, Cluster ID, cluster status, Kubernetes version, and Kubelet version).

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

Unique ID of the super node (corresponds to unique_id in the cluster node table).
Value reference: obtained from the UniqueID field returned by the DescribeClusterNodeList API (nodes with node type SUPER)

MemberId.N No Array of String

Group account member id

3. Output Parameters

Parameter Name Type Description
Region String

Region code (unchanged, for example, ap-chengdu).

RegionName String

Region Chinese Name (for example, Southwest China (Chengdu); obtained by translating the region code using the dictionary).

RegionNameEn String

Region English name (for example, Southwest China (Chengdu); obtained by translating the region code using a dictionary).

Zone String

Availability zone (Chinese name, obtained by translating the AZ code via dictionary).

AssetSyncTime Timestamp ISO8601

Last update time of the asset.
Parameter format: YYYY-MM-DDTHH:mm:ssZ (ISO8601 format, UTC time zone)

NodeSource String

Node origin (cluster type).
Enumeration values:
TKE_MANAGED_CLUSTER: Tencent Cloud Standard Cluster
TKE_INDEPENDENT_CLUSTER: Tencent Cloud Standard Cluster (Master Self-maintenance)
TKE_SERVERLESS_CLUSTER: Tencent Cloud Serverless cluster
TKE_EDGE_CLUSTER: Tencent Cloud edge cluster
SELF_BUILT: Self-built cluster within Tencent Cloud
SELF_BUILT_OTHER: Self-built cluster outside Tencent Cloud (hybrid cloud)

SubNetName String

Subnet name.

SubNetId String

Subnet ID.

SubNetCIDR String

Subnet segment (CIDR).

CoresCount Integer

Number of cores (obtained by dividing cpu_request by 1000).
Unit: core

ClusterName String

Cluster Name.

ClusterId String

Cluster ID.

Status String

Cluster operation status.
Enumeration values:
Running: running
Exception: exception
Unknown: unknown
Creating: creating
Destroyed: terminated

ClusterVersion String

Kubernetes version.

KubeletVersion String

Kubelet version.

AppID Integer

APPID of the account associated with the super node

InstanceId String

Super node instance ID

NodeName String

Super node name.

VpcId String

VPCID

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 Super Node Detail Information

Input Example

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

{
    "NodeUniqueID": "208a70484c9f8ac0ce43d896d406081d"
}

Output Example

{
    "Response": {
        "AppID": 260083796,
        "AssetSyncTime": "2026-08-09T06:05:40Z",
        "ClusterId": "cls-pde9e0s0",
        "ClusterName": "yancyw-standard cluster",
        "ClusterVersion": "1.30.0",
        "CoresCount": 4000,
        "InstanceId": "kn-1ogxmons",
        "KubeletVersion": "v2.16.78",
        "NodeName": "Unnamed",
        "NodeSource": "TKE_MANAGED_CLUSTER",
        "Region": "ap-guangzhou",
        "RegionName": "South China region (Guangzhou)",
        "RegionNameEn": "South China (Guangzhou)",
        "Status": "Running",
        "SubNetCIDR": "172.16.0.0/20",
        "SubNetId": "subnet-9hwe9oeo",
        "SubNetName": "",
        "VpcId": "vpc-nk47l8at",
        "Zone": "Guangzhou Zone 2",
        "RequestId": "b7effa7d-34b0-4e7a-a3f8-b4b1943fa383"
    }
}

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