高性能计算平台查询指定集群节点列表-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口 (DescribeNodes) 用于查询指定集群节点概览信息列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeNodes。
Version	是	String	公共参数，本接口取值：2023-03-21。
Region	是	String	公共参数，详见产品支持的地域列表。
ClusterId	是	String	集群ID。示例值：hpc-5lyv94lq
Filters.N	否	Array of Filter	queue-name 按照【队列名称】进行过滤。队列名称形如：compute。类型：String 必选：否 node-role 按照【节点角色】进行过滤。节点角色形如：Manager。（Manager：管控节点。Compute：计算节点。Login：登录节点。ManagerBackup：备用管控节点。）类型：String 必选：否 node-type 按照【节点类型】进行过滤。节点类型形如：STATIC。(STATIC：静态节点。DYNAMIC：弹性节点。) 类型：String 必选：否每次请求的`Filters`的上限为10，`Filter.Values`的上限为5。
Offset	否	Integer	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值：20

3. 输出参数

参数名称	类型	描述
NodeSet	Array of NodeOverview	节点概览信息列表。
TotalCount	Integer	符合条件的节点数量。示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询指定集群节点概览信息。

查询指定集群节点概览信息，集群ID为hpc-ggaqjyax。

输入示例

https://thpc.tencentcloudapi.com/?Action=DescribeNodes
&ClusterId=hpc-ggaqjyax
&Offset=0
&Limit=1
&<公共请求参数>

输出示例

{
    "Response": {
        "NodeSet": [
            {
                "NodeId": "node-2sh754ah",
                "InstanceId": "ins-j3n6kiae",
                "Zone": "ap-chongqing-1",
                "NodeState": "RUNNING",
                "ImageId": "img-l8og963d",
                "QueueName": "compute",
                "NodeRole": "Compute",
                "NodeType": "DYNAMIC"
            }
        ],
        "TotalCount": 3,
        "RequestId": "6793673e-3bce-4fbb-adea-923a82267da2"
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.Malformed	参数格式有误。
InvalidParameterValue	参数取值错误。
InvalidParameterValue.InvalidFilterNotSupportedName	不支持指定过滤器的键。
InvalidParameterValue.LimitExceeded	参数值数量超过限制。
InvalidParameterValue.TooLarge	参数值过大。
InvalidParameterValue.TooSmall	参数值过小。
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
RequestLimitExceeded	请求的次数超过了频率限制。
UnknownParameter	未知参数错误。
UnsupportedOperation.ParameterTooLarge	参数值过大，不支持此操作。
UnsupportedOperation.ParameterTooSmall	参数值过小，不支持此操作。

查询指定集群节点列表

本页目录：