文档中心

云服务器

请输入

高性能计算集群

DescribeHpcClusters - 查询高性能计算集群详情列表

调用 DescribeHpcClusters 接口查询符合条件的高性能计算集群详情列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeHpcClusters

要执行的操作，取值：DescribeHpcClusters。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

ClientToken string 可选示例值：333456899ff****

保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。

取值：仅支持ASCII字符，且不能超过64个字符。

HpcClusterIds.N string[] 可选示例值：HpcClusterIds.1=hpcCluster-ybo1y364wkf80o0m****&HpcClusterIds.2=hpcCluster-ybn3a2zyiib1wzr2****

高性能计算集群ID。

参数 - N：表示高性能计算集群的序号。

多个ID之间用&分隔。

MaxResults integer 可选示例值：10

分页查询时设置的每页行数。

最大值：100

默认值：10

Name string 可选示例值：hpcCluster-01

根据高性能计算集群名称过滤查询。

NextToken string 可选示例值：--

分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的NextToken参数值。

ProjectName string 可选示例值：project_a

资源所属项目，一个资源只能归属于一个项目。

只能包含字母、数字、下划线“_”、点“.”和中划线“-”。

长度限制在64个字符以内。

TagFilters.N.Key string[] 可选示例值：TagFilters.1.Key=k1

根据标签查询资源时指定的标签键。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。

不允许重复。

TagFilters.N.Values.N string[] 可选示例值：TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2

根据标签查询资源时指定的标签值。

第一个N：表示标签键的序号，取值范围：1～10。

第二个N：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。

多个标签值之间用&分隔。

说明

如果传入该参数，则必须先传入TagFilters.N.Key。

不传则表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

ZoneId string 可选示例值：cn-beijing-a

高性能计算集群所属可用区ID。

您可以调用DescribeZones查询一个地域下的可用区信息。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

HpcClusters object[] 示例值：--

符合条件的高性能计算集群信息。

ProjectName string 示例值：project_a

资源所属项目名称。

Tags object[] 示例值：--

资源的标签信息。

Key string 示例值：k1

资源的标签键。

Value string 示例值：v1

资源的标签值。

CreatedAt string 示例值：2024-07-26T21:55:12+08:00

创建时间，格式满足RFC3339。

Description string 示例值：HPC cluster for testing.

高性能计算集群描述。

HpcClusterId string 示例值：hpcCluster-ybo1y364wkf80o0m****

高性能计算集群ID。

Name string 示例值：hpcCluster-01

高性能计算集群名称。

UpdatedAt string 示例值：2024-07-26T21:55:12+08:00

更新时间，格式满足RFC3339。

VpcId string 示例值：vpc-3qd85471bl7nk7prml024****

私有网络ID。

ZoneId string 示例值：cn-beijing-a

高性能计算集群所属可用区ID。

NextToken string 示例值：bHpwdXJja2RxemU1eG5sb3NzdGcW1-RCEq******

本次调用返回的查询凭证值，返回为空表示该页为末页。

请求示例

GET /?Action=DescribeHpcClusters&Version=2020-04-01 HTTP/1.1​
Host: ecs.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: ecs​

返回示例

{​
  "ResponseMetadata": {​
    "RequestId": "20220518171951010211173098094C****",​
    "Action": "DescribeHpcClusters",​
    "Version": "2020-04-01",​
    "Service": "ecs",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "NextToken": "",​
    "HpcClusters": [​
      {​
        "HpcClusterId": "hpcCluster-ybo1y364wkf80o0m****",​
        "Name": "hpcCluster-01",​
        "VpcId": "vpc-3qd85471bl7nk7prml024****",​
        "Description": "HPC cluster for testing.",​
        "ZoneId": "cn-beijing-a",​
        "CreatedAt": "2022-05-07T00:42:43+08:00",​
        "UpdatedAt": "2022-05-07T15:17:21+08:00",​
        "Tags": [​
          {​
            "Key": "sys:tag:createdBy",​
            "Value": "IAMUser:3723****:****"​
          }​
        ],​
        "ProjectName": "default"​
      },​
      {​
        "HpcClusterId": "hpcCluster-ybmta3h9gwkrkfjr****",​
        "Name": "hpcCluster-02",​
        "VpcId": "",​
        "Description": "",​
        "ZoneId": "cn-beijing-a",​
        "CreatedAt": "2022-04-19T20:36:04+08:00",​
        "UpdatedAt": "2022-04-24T16:09:55+08:00",​
        "Tags": [​
          {​
            "Key": "sys:tag:createdBy",​
            "Value": "IAMUser:3723****:****"​
          }​
        ],​
        "ProjectName": "default"​
      }​
    ]​
  }​
}​

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2025.09.10 14:09:03

这个页面对您有帮助吗？

有用

无用