全部产品
Search
文档中心

云服务器 ECS:DescribeHpcClusters - 查询HPC集群

更新时间:Mar 19, 2024

调用DescribeHpcClusters查询您可用的HPC集群。请求参数作为筛选器(Filter)使用,筛选关系为逻辑与关系,参数之间无依赖关系。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:DescribeHpcClustersRead
  • HpcCluster
    acs:ecs:{#regionId}:{#accountId}:hpc/*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参见如何保证幂等性

123e4567-e89b-12d3-a456-426655440000
HpcClusterIdsstring

HPC 集群 ID。 取值可以由多个 HPC 集群 ID 组成一个 JSON 数组,最多支持 100 个 ID,ID 之间用半角逗号(,)隔开。

["hpc-xxxxxxxxx", "hpc-yyyyyyyyy", … "hpc-zzzzzzzzz"]
PageNumberinteger

HPC 集群列表的页码。

起始值:1

默认值:1

1
PageSizeinteger

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

最大值:100

默认值:10

10

返回参数

名称类型描述示例值
object
PageSizeinteger

输入时设置的每页行数。

10
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumberinteger

HPC 集群列表的页码。

1
TotalCountinteger

HPC 集群总个数。

2
HpcClustersobject []

由 HpcCluster 组成的数组格式,返回 HPC 集群的信息。

HpcClusterIdstring

HPC 集群 ID。

hpc-bp1a5zr3u7nq9cx****
Namestring

HPC 集群的名称。

testName
Descriptionstring

HPC 集群的描述。

testDescription

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "HpcClusters": {
    "HpcCluster": [
      {
        "HpcClusterId": "hpc-bp1a5zr3u7nq9cx****",
        "Name": "testName",
        "Description": "testDescription"
      }
    ]
  }
}

JSON格式

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "HpcClusters": {
    "HpcCluster": [
      {
        "HpcClusterId": "hpc-bp1a5zr3u7nq9cx****",
        "Name": "testName",
        "Description": "testDescription"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidRegionId.NotFoundThe specified parameter "RegionId" is not valid.-
400MissingParameter.HpcClusterIdThe input parameter HpcClusterId that is mandatory for processing this request is not supplied.参数 HpcClusterId 不能为空。
400InvalidHpcClusterIds.ExceedLimitThe amount of specified specified hpc cluster ids exceeds the limit.参数 HpcClusterIds 中的数据量不在规定的范围内。
400InvalidHpcClusterIds.MalformedThe amount of specified specified hpc cluster ids is invalid.参数 HpcClusterIds 中的数据量不在规定的范围内。
400Invalid.ParameterInvalid parameters.参数无效。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史