tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeClusterInstances

Last updated: 2024-11-14 14:50:05

    1. API Description

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

    This API is used to query information of node instances in a cluster.

    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: DescribeClusterInstances.
    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
    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.
    Filters.N No Array of Filter Filters include nodepool-id and nodepool-instance-type (how the instance is added to the pool). For nodepool-instance-type, the values can be MANUALLY_ADDED, AUTOSCALING_ADDED and ALL.

    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, 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 the information of instances in a cluster

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

    Input Example

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

    Output Example

    {
    "Response": {
        "InstanceSet": [
            {
                "InstanceAdvancedSettings": {
                    "DockerGraphPath": "/data/docker",
                    "Labels": [
                        {
                            "Name": "key",
                            "Value": "value"
                        }
                    ],
                    "ExtraArgs": {
                        "Kubelet": [
                            "--register-node=true"
                        ]
                    },
                    "Unschedulable": 0,
                    "UserScript": "ZWNobyAiMTAuMTA3LjEwMy41N",
                    "MountTarget": "/var/lib/docker",
                    "DataDisks": [
                        {
                            "DiskPartition": "",
                            "DiskType": "CLOUD_PREMIUM",
                            "DiskSize": 0,
                            "FileSystem": "ext4",
                            "AutoFormatAndMount": true,
                            "MountTarget": "/var/lib/docker"
                        }
                    ]
                },
                "InstanceId": "ins-wggphft5",
                "InstanceRole": "WORKER",
                "LanIP": "10.0.39.19",
                "DrainStatus": "drained",
                "AutoscalingGroupId": "asg-ewqsfgrt",
                "InstanceState": "running",
                "CreatedTime": "2021-02-22T07:14:11Z",
                "NodePoolId": "np-3j4elm0k",
                "FailedReason": "=Ready:True"
            }
        ],
        "TotalCount": 1,
        "RequestId": "f12a6e20-f950-4af9-8f8b-b6329a4961c2"
    }
}

    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.
    FailedOperation.Db Database error.
    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.
    UnsupportedOperation Unsupported operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy