tencent cloud

All product documents
APIs
DocumentationAPIsTencent Kubernetes EngineNode Pool APIsDescribeClusterNodePoolDetail
DescribeClusterNodePoolDetail
Last updated: 2024-11-14 14:52:45
DescribeClusterNodePoolDetail
Last updated: 2024-11-14 14:52:45

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 Yes String Common Params. For more information, please see the list of regions supported by the product.
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, 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 details of a node pool

This example shows you how to query 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": {
            "AutoscalingGroupId": "asg-xxx",
            "AutoscalingGroupStatus": "disabled",
            "ClusterInstanceId": "cls-xxx",
            "DataDisks": null,
            "DeletionProtection": true,
            "DesiredNodesNum": 2,
            "DesiredPodNum": 64,
            "DockerGraphPath": "",
            "ExtraArgs": {
                "Kubelet": []
            },
            "GPUArgs": {
                "CUDA": {
                    "Name": "",
                    "Version": ""
                },
                "CUDNN": {
                    "DevName": "",
                    "DocName": "",
                    "Name": "",
                    "Version": ""
                },
                "CustomDriver": {
                    "Address": ""
                },
                "Driver": {
                    "Name": "",
                    "Version": ""
                },
                "MIGEnable": false
            },
            "ImageId": "",
            "Labels": [],
            "Annotations": [],
            "LaunchConfigurationId": "asc-xxx",
            "LifeState": "normal",
            "MaxNodesNum": 3,
            "MinNodesNum": 0,
            "Name": "xxx",
            "NodeCountSummary": {
                "AutoscalingAdded": {
                    "Initializing": 0,
                    "Joining": 0,
                    "Normal": 2,
                    "Total": 2
                },
                "ManuallyAdded": {
                    "Initializing": 0,
                    "Joining": 0,
                    "Normal": 1,
                    "Total": 1
                }
            },
            "NodePoolId": "np-xxx",
            "NodePoolOs": "tlinux_xxx",
            "OsCustomizeType": "GENERAL",
            "PreStartUserScript": "#!/bin/sh\ntouch /tmp/before",
            "RuntimeConfig": {
                "RuntimeType": "containerd",
                "RuntimeVersion": "1.6.9"
            },
            "Tags": null,
            "Taints": [],
            "Unschedulable": 0,
            "UserScript": "#!/bin/sh\ntouch /tmp/after"
        },
        "RequestId": "68b7b080-7c57-4869-bc54-a518b4902b2d"
    }
}

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.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support