tencent cloud

文档反馈

DescribeClusterNodePoolDetail

最后更新时间:2023-09-18 16:00:20

1. API Description

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

This API is used to query detailed information of a node pool.

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: DescribeClusterNodePoolDetail.
Version Yes String Common Params. The value used for this API: 2018-05-25.
Region No String Common Params. This parameter is not required for this API.
ClusterId Yes String Cluster ID
NodePoolId Yes String Node pool ID

3. Output Parameters

Parameter Name Type Description
NodePool NodePool Node pool details
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying details of a node pool

This example shows you how to query the details of a node pool.

Input Example

https://tke.tencentcloudapi.com/?Action=DescribeClusterNodePoolDetail
&ClusterId=cls-xxxxxx
&NodePoolId=np-xxxxxxxx
&<Common request parameters>

Output Example

{
    "Response": {
        "NodePool": {
            "NodePoolId": "xx",
            "Name": "xx",
            "ClusterInstanceId": "xx",
            "LifeState": "xx",
            "LaunchConfigurationId": "xx",
            "AutoscalingGroupId": "xx",
            "Labels": [
                {
                    "Name": "xx",
                    "Value": "xx"
                }
            ],
            "Taints": [
                {
                    "Key": "xx",
                    "Value": "xx",
                    "Effect": "xx"
                }
            ],
            "NodeCountSummary": {
                "ManuallyAdded": {
                    "Joining": 0,
                    "Initializing": 0,
                    "Normal": 0,
                    "Total": 0
                },
                "AutoscalingAdded": {
                    "Joining": 0,
                    "Initializing": 0,
                    "Normal": 0,
                    "Total": 0
                }
            },
            "AutoscalingGroupStatus": "xx",
            "MaxNodesNum": 0,
            "MinNodesNum": 0,
            "DesiredNodesNum": 0,
            "NodePoolOs": "xx",
            "OsCustomizeType": "xx",
            "ImageId": "xx",
            "DesiredPodNum": 0,
            "UserScript": "xx",
            "Tags": [
                {
                    "Key": "xx",
                    "Value": "xx"
                }
            ],
            "DeletionProtection": true
        },
        "RequestId": "xx"
    }
}

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.ClusterNotFound Cluster not found.
InternalError.DbRecordNotFound Record not found.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter.Param Invalid parameter.
ResourceNotFound.ClusterNotFound The cluster does not exist.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持