容器服务查询原生节点列表

1. 接口描述

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

查询托原生点列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeClusterMachines。
Version	是	String	公共参数，本接口取值：2022-05-01。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群 ID 示例值：cls-xxxxxx
Filters.N	否	Array of Filter	节点过滤条件，支持以下过滤条件： · NodePoolsName 按照【节点池名】进行过滤。类型：String 必选：否 · NodePoolsId 按照【节点池id】进行过滤。类型：String 必选：否 · tags 按照【标签键值对】进行过滤。类型：String 必选：否 · tag:tag-key 按照【标签键值对】进行过滤。类型：String 必选：否
Limit	否	Integer	偏移量，默认0 示例值：10
Offset	否	Integer	最大输出条数，默认20，最大为100 示例值：0

3. 输出参数

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

4. 示例

示例1 查询原生节点列表

输入示例

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

{
    "Limit": 0,
    "ClusterId": "cls-123",
    "Filters": [
        {
            "Values": [
                "789"
            ],
            "Name": "cls-123"
        }
    ],
    "Offset": 0
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "1231",
        "Machines": [
            {
                "ExpiredTime": "123",
                "SystemDisk": {
                    "AutoFormatAndMount": true,
                    "MountTarget": "123",
                    "DiskSize": 0,
                    "FileSystem": "123",
                    "DiskType": "123"
                },
                "LanIP": "123",
                "DisplayName": "123",
                "InstanceType": "123",
                "Zone": "123",
                "InstanceFamily": "123",
                "MachineName": "123",
                "IsProtectedFromScaleIn": true,
                "InternetAccessible": {
                    "BandwidthPackageId": "123",
                    "MaxBandwidthOut": 0,
                    "ChargeType": "123"
                },
                "PayMode": "123",
                "InstanceChargeType": "123",
                "RenewFlag": "123",
                "LoginStatus": "123",
                "Memory": 1,
                "GPU": 1,
                "MachineState": "123",
                "CPU": 1,
                "CreatedAt": "123"
            }
        ]
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError.DbRecordNotFound	记录未找到。
InternalError.Param	参数错误。
InternalError.UnexpectedInternal	未知的内部错误。
InvalidParameter.Param	参数错误。
ResourceNotFound.ClusterNotFound	集群不存在。

查询原生节点列表

本页目录：