1. 接口描述
接口请求域名: omics.tencentcloudapi.com 。
查询HPC节点列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeHPCNodes。 |
| Version | 是 | String | 公共参数,本接口取值:2022-11-28。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ClusterId | 否 | String | 集群ID。 |
| Limit | 否 | Integer | 返回数量,默认为20,最大值为100。 |
| Offset | 否 | Integer | 偏移量,默认为0。 |
| Filters.N | 否 | Array of Filter | 过滤器,支持过滤字段: - ClusterId:集群ID - QueueId:队列ID - NodeId:节点ID - Name:名称 - Role:角色 - Type:类型 - Zone:可用区 - InstanceState:实例状态 - InstanceType:实例机型 - InstanceFamily:实例机型族 - InstanceChargeType:实例计费类型 - Tag:标签,Value格式为tagKey:tagValue |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Nodes | Array of HPCNode | HPC节点。 注意:此字段可能返回 null,表示取不到有效值。 |
| TotalCount | Integer | 符合条件的数量。 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询HPC节点列表
查询HPC节点列表。
输入示例
POST / HTTP/1.1
Host: omics.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeHPCNodes
<公共请求参数>
{
"ClusterId": "hpc-an7qz1jg"
}
输出示例
{
"Response": {
"Nodes": [
{
"ClusterId": "hpc-an7qz1jg",
"ImageId": "img-l8og963d",
"Instance": {
"CPU": 2,
"ChargeType": "POSTPAID_BY_HOUR",
"CreateTime": "2024-07-09T16:53:15+08:00",
"ExpireTime": "2024-08-09T16:53:15+08:00",
"InstanceId": "ins-hsjwv87a",
"Memory": 4,
"Name": "未命名",
"OSName": "CentOS 7.9 64位",
"PrivateIPAddresses": [
"10.1.0.91"
],
"PublicIPAddresses": [],
"State": "RUNNING",
"SystemDisk": {
"DiskId": "disk-hajjdzfu",
"Size": 50,
"Type": "CLOUD_PREMIUM"
},
"Type": "SA2.MEDIUM4"
},
"NodeId": "node-exg8nn7f",
"QueueId": "",
"Role": "MANAGER",
"Tags": [],
"Type": "STATIC",
"Zone": "ap-guangzhou-6"
},
{
"ClusterId": "hpc-an7qz1jg",
"ImageId": "img-l8og963d",
"Instance": {
"CPU": 2,
"ChargeType": "POSTPAID_BY_HOUR",
"CreateTime": "2024-07-09T16:52:46+08:00",
"ExpireTime": "2024-08-09T16:52:46+08:00",
"InstanceId": "ins-hwifb6n8",
"Memory": 4,
"Name": "未命名",
"OSName": "CentOS 7.9 64位",
"PrivateIPAddresses": [
"10.1.8.62"
],
"PublicIPAddresses": [
"106.53.59.92"
],
"State": "RUNNING",
"SystemDisk": {
"DiskId": "disk-dvfroio2",
"Size": 50,
"Type": "CLOUD_PREMIUM"
},
"Type": "SA2.MEDIUM4"
},
"NodeId": "node-ifrzwo4f",
"QueueId": "queue-dq1spf9m",
"Role": "COMPUTE",
"Tags": [],
"Type": "DYNAMIC",
"Zone": "ap-guangzhou-6"
},
{
"ClusterId": "hpc-an7qz1jg",
"ImageId": "img-l8og963d",
"Instance": {
"CPU": 4,
"ChargeType": "POSTPAID_BY_HOUR",
"CreateTime": "2024-07-16T18:14:07+08:00",
"ExpireTime": "2024-08-09T16:52:46+08:00",
"InstanceId": "ins-8rrp4n6s",
"Memory": 8,
"Name": "未命名",
"OSName": "CentOS 7.9 64位",
"PrivateIPAddresses": [
"10.1.3.200"
],
"PublicIPAddresses": [],
"State": "RUNNING",
"SystemDisk": {
"DiskId": "disk-ofrnd2a4",
"Size": 50,
"Type": "CLOUD_PREMIUM"
},
"Type": "SA2.LARGE8"
},
"NodeId": "node-cqjk6pbz",
"QueueId": "queue-dq1spf9m",
"Role": "COMPUTE",
"Tags": [],
"Type": "STATIC",
"Zone": "ap-guangzhou-6"
}
],
"RequestId": "1ab0bd99-190f-4419-b048-8bf798164944",
"TotalCount": 3
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| OperationDenied | 操作被拒绝。 |
| ResourceNotFound | 资源不存在。 |