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.
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 |
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. |
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"
}
{
"Response": {
"RequestId": "1ac0d3ae-063e-4789-93fe-3c73e93191b9",
"TotalCount": 1,
"Nodes": [
{
"Name": "eklet-subnet-abcd1234-0",
"SubnetId": "subnet-abcd1234",
"Phase": "Running"
}
]
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?