DescribeClusterInstances

Last updated: 2020-12-02 10:36:31

1. API Description

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

This API is used to query information of one or more instances in a cluster.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: tke.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeClusterInstances.
Version Yes String Common parameter. The value used for this API: 2018-05-25.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID
Offset No Integer Offset. Default value: 0
Limit No Integer Maximum number of output entries. Default value: 20
InstanceIds.N No Array of String List of instance IDs to be obtained. This parameter is empty by default, which indicates that all instances in the cluster will be pulled.
InstanceRole No String Node role. Valid values are MASTER, WORKER, ETCD, MASTER_ETCD, and ALL. Default value: WORKER.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of instances in the cluster
InstanceSet Array of Instance List of instances in the cluster
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying information of instances in a cluster

This example shows you how to query information of instances in a cluster.

Input Example

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

Output Example

{
  "Response": {
    "TotalCount": 1,
    "InstanceSet": [
      {
        "InstanceId": "ins-gsk7l6vw",
        "InstanceRole": "WORKER",
        "InstanceState": "running",
        "FailedReason": ""
      }
    ],
    "RequestId": "82f2fe9c-c5fa-4077-9236-f1341180a696"
  }
}

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 Operation failed.
InternalError Internal error.
InternalError.Db DB error.
InternalError.DbAffectivedRows Database error.
InternalError.InitMasterFailed Failed to initialize Master.
InternalError.Param Parameter error.
InternalError.PublicClusterOpNotSupport Cluster does not support the current operation.
InternalError.UnexceptedInternal Internal error.
InvalidParameter.ClusterNotFound The cluster ID does not exist.
InvalidParameter.Param Invalid parameter.
ResourceUnavailable.ClusterState The cluster’s status does support this operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help