查询高性能集群信息

最近更新时间: 2026-09-17 00:04:16

1. 接口描述

接口请求域名： cvm.api3.fincloud.tencent.cn。

查询高性能集群信息

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

接口更新时间：2023-12-12 03:54:51。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeHpcClusters
Version 是 否 String 公共参数，本接口取值：2017-03-12
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
HpcClusterIds 否 否 Array of String 高性能计算集群ID数组。
示例值： ["hpc-p64fdfa9"]
Name 否 否 String 高性能计算集群名称。
示例值： MyCluster
Zone 否 否 String 可用区。
示例值： ap-region1-2
Offset 否 否 Uint64 偏移量, 默认值0。
示例值： 0
Limit 否 否 Uint64 本次请求量, 默认值20。
示例值： 20

3. 输出参数

参数名称 类型 描述
HpcClusterSet Array of HpcClusterInfo 高性能计算集群信息。
示例值：查看
TotalCount Uint64 高性能计算集群总数。
示例值： 1
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidZone.MismatchRegion 指定的zone不存在。
InternalError 内部错误

5. 示例

示例1 查询高性能集群信息

查询高性能集群信息

输入示例

https://cvm.cloudapi.com/?Action=DescribeHpcClusters
&Zone=ap-city1-3
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
  "Response": {
    "HpcClusterSet": [
      {
        "HpcClusterId": "hpc-dc4gcarp",
        "Name": "test_33311",
        "Remark": "remark 1",
        "CvmQuotaTotal": 50,
        "Zone": "ap-city1-3",
        "CurrentNum": 0,
        "InstanceIds": [],
        "HpcClusterNetMode": 30,
        "HpcClusterType": "STANDARD",
        "HpcClusterBusinessId": "cluster-ax457mhr",
        "CreateTime": "2020-06-02T07:55:05Z",
        "Tags": [
          {
            "Key": "tag_key",
            "Value": "tag_value"
          }
        ]
      },
      {
        "HpcClusterId": "hpc-p64fdfa9",
        "Name": "test_333333",
        "Remark": "remark 2",
        "CvmQuotaTotal": 50,
        "Zone": "ap-city1-3",
        "CurrentNum": 0,
        "InstanceIds": [],
        "HpcClusterNetMode": 30,
        "CreateTime": "2020-06-02T07:51:58Z",
        "Tags": [
          {
            "Key": "tag_key",
            "Value": "tag_value"
          }
        ]
      }
    ],
    "TotalCount": 2,
    "RequestId": "5834f1a5-cd9c-449d-acba-df1803a8583e"
  }
}