tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeClusterVirtualNode

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

1. API Description

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

This API is used to query the list of virtual nodes.

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: DescribeClusterVirtualNode.
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 No String Node pool ID
NodeNames.N No Array of String Node name

3. Output Parameters

Parameter Name Type Description
Nodes Array of VirtualNode List of nodes
Note: This field may return null, indicating that no valid values can be obtained.
TotalCount Integer Total number of nodes
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the list of virtual nodes

Input Example

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

{
    "ClusterId": "cls-abcd1234",
    "NodePoolId": "np-abcd1234"
}

Output Example

{
    "Response": {
        "RequestId": "1ac0d3ae-063e-4789-93fe-3c73e93191b9",
        "TotalCount": 1,
        "Nodes": [
            {
                "Name": "eklet-subnet-abcd1234-0",
                "SubnetId": "subnet-abcd1234",
                "Phase": "Running"
            }
        ]
    }
}

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
FailedOperation.KubernetesListOperationError Failed to obtain the kubernetes resource list.
InternalError.KubernetesListOperationError Failed to obtain the kubernetes resource list.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter.Param Invalid parameter.
ResourceUnavailable.ClusterState The cluster’s status does support this operation.
UnauthorizedOperation.CamNoAuth The API has no CAM permissions.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款