查询集群节点信息

最近更新时间：2024-05-13 01:30:10

我的收藏

1. 接口描述

接口请求域名： tke.tencentcloudapi.com 。

查询集群下节点实例信息

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeClusterInstances。
Version	是	String	公共参数，本接口取值：2022-05-01。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID 示例值：cls-xxxxxx
Offset	否	Integer	偏移量，默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。示例值：20
Filters.N	否	Array of Filter	过滤条件列表: InstanceIds(实例ID),InstanceType(实例类型：Regular，Native，Virtual，External),VagueIpAddress(模糊匹配IP),Labels(k8s节点label),NodePoolNames(节点池名称),VagueInstanceName(模糊匹配节点名),InstanceStates(节点状态),Unschedulable(是否封锁),NodePoolIds(节点池ID)
SortBy	否	SortBy	排序信息

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	集群中实例总数示例值：1
InstanceSet	Array of Instance	集群中实例列表
Errors	Array of String	错误信息集合注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询集群实例信息

查询集群实例信息

输入示例

POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeClusterInstances
<公共请求参数>

{
    "ClusterId": "cls-7ph3twqe"
}

输出示例

{
    "Response": {
        "TotalCount": 4,
        "InstanceSet": [
            {
                "CreatedTime": "2023-08-17 13:17:57 +0000 UTC",
                "External": {
                    "CPU": 2,
                    "K8SVersion": "v1.26.1-tke.1",
                    "Memory": 1,
                    "Name": "node-10.0.6.x"
                },
                "FailedReason": "",
                "InstanceId": "node-10.0.6.x",
                "InstanceRole": "WORKER",
                "InstanceState": "running",
                "LanIP": "10.0.6.x",
                "Native": null,
                "NodePoolId": "np-xxxxx",
                "NodeType": "External",
                "Regular": null,
                "Super": null,
                "Unschedulable": false
            },
            {
                "CreatedTime": "2023-08-17 20:47:35 +0800 CST",
                "External": null,
                "FailedReason": null,
                "InstanceId": "eklet-subnet-xxxx-yyyy",
                "InstanceRole": "WORKER",
                "InstanceState": "running",
                "LanIP": "a.b.c.d",
                "Native": null,
                "NodePoolId": "np-yyyyy",
                "NodeType": "Super",
                "Regular": null,
                "Super": {
                    "ActiveAt": null,
                    "AutoRenewFlag": null,
                    "CPU": null,
                    "ExpireAt": null,
                    "InstanceAttribute": null,
                    "MaxCPUScheduledPod": null,
                    "Memory": null,
                    "Name": "",
                    "ResourceType": null,
                    "SubnetId": "subnet-xxxxx",
                    "UsedCPU": null,
                    "UsedMemory": null,
                    "VpcId": null,
                    "Zone": null
                },
                "Unschedulable": false
            },
            {
                "CreatedTime": "2023-08-17 12:46:40 +0000 UTC",
                "External": null,
                "FailedReason": "=",
                "InstanceId": "np-xxxx-yyyy",
                "InstanceRole": "WORKER",
                "InstanceState": "running",
                "LanIP": "10.0.0.x",
                "Native": {
                    "CPU": 2,
                    "CreatedAt": "2023-08-17 20:46:39",
                    "DisplayName": "tke-np-xxxx-worker",
                    "ExpiredTime": "",
                    "GPU": 0,
                    "InstanceChargeType": "POSTPAID_BY_HOUR",
                    "InstanceFamily": "S2",
                    "InstanceType": "S2.MEDIUM2",
                    "InternetAccessible": {
                        "BandwidthPackageId": "",
                        "ChargeType": "",
                        "MaxBandwidthOut": 0
                    },
                    "IsProtectedFromScaleIn": false,
                    "LanIp": "10.0.0.x",
                    "LoginStatus": "Opened",
                    "MachineName": "np-xxxx-yyyy",
                    "MachineState": "Running",
                    "Memory": 2,
                    "OsImage": "TencentOS Server 3.1 (Final)",
                    "PayMode": "POSTPAID_BY_HOUR",
                    "RenewFlag": "",
                    "SecurityGroupIDs": [
                        "sg-ccccc"
                    ],
                    "SubnetId": "subnet-nqx1ymwm",
                    "VpcId": "vpc-zzzzz",
                    "Zone": "ap-guangzhou-3"
                },
                "NodePoolId": "np-xxxx",
                "NodeType": "Native",
                "Regular": null,
                "Super": null,
                "Unschedulable": false
            },
            {
                "CreatedTime": "2023-08-17 12:35:42 +0000 UTC",
                "External": null,
                "FailedReason": "=Ready:True",
                "InstanceId": "ins-aaaaaa",
                "InstanceRole": "WORKER",
                "InstanceState": "running",
                "LanIP": "10.0.0.x",
                "Native": null,
                "NodePoolId": "",
                "NodeType": "Regular",
                "Regular": {
                    "AutoscalingGroupId": "",
                    "InstanceAdvancedSettings": {
                        "DesiredPodNumber": 64,
                        "ExtraArgs": {
                            "Kubelet": null
                        },
                        "PreStartUserScript": null,
                        "RuntimeConfig": null,
                        "UserScript": ""
                    }
                },
                "Super": null,
                "Unschedulable": false
            }
        ],
        "Errors": [],
        "RequestId": "42c27fd7-e2ca-48b2-9f4e-acdb9eef6ee7"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Db	db错误。
InternalError.DbAffectivedRows	DB错误。
InternalError.InitMasterFailed	初始化master失败。
InternalError.Param	Param。
InternalError.PublicClusterOpNotSupport	公共集群不支持扩展节点。
InternalError.UnexceptedInternal	内部错误。
InternalError.UnexpectedInternal	未知的内部错误。
InvalidParameter.ClusterNotFound	集群ID不存在。
InvalidParameter.Param	参数错误。
ResourceNotFound	资源不存在。
ResourceUnavailable.ClusterState	集群状态不支持该操作。

上一篇: 参数类型下一篇: 创建 TKE 节点池