ListClusters - 查询每个地域拥有的集群列表

查询用户账号中在每个地域拥有的所有集群的列表。

调试

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

授权信息

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

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

请求参数

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

显示的页码,起始值为 1。

1
PageSizeinteger

每页显示的条数。取值范围:1~50

默认值:10

10

返回参数

名称类型描述示例值
object
PageSizeinteger

本页条数。

1
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE73368
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目总数。

1
Clustersobject []

集群详细信息。

VpcIdstring

VPC ID。

vpc-b3f3edefefeep0760yju****
Statusstring

集群状态。可能值:

  • uninit:未初始化
  • creating:创建中
  • init:初始化中
  • running:运行中
  • exception:异常
  • releasing:释放中
running
CreateTimestring

集群创建时间。

2020-10-30T07:39:20.000Z
IsComputeEssboolean

是否启用弹性伸缩组。可能值:

  • true:启用
  • false:未启用
false
ComputeSpotStrategystring

计算节点竞价策略。可能值:

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格。
NoSpot
AccountTypestring

账户服务器类型。可能值:

  • nis
  • ldap
nis
Countinteger

集群计算节点数目。

3
EhpcVersionstring

EHPC 版本。

1.0.0
Descriptionstring

集群描述。

clusterdescription
BaseOsTagstring

基础镜像操作系统标签,仅管控节点使用。

CentOS_7.2_64
Namestring

集群名称。

test
ImageIdstring

镜像 ID。

wi_1607_x64_dtc_zh_40G_alibase****
ComputeSpotPriceLimitfloat

计算节点下 ECS 实例的每小时最高价格。返回值最多保留小数点后 3 位。

0.034
SchedulerTypestring

调度服务器类型。可能值:

  • pbs
  • slurm
  • opengridscheduler
  • deadline
pbs
DeployModestring

集群部署模式。可能值:

  • Standard:账号节点、调度节点、登录节点、计算节点分离部署。
  • Advanced:HA 模式部署。
  • Simple:账号节点和调度节点混合部署在一个节点上,登录节点和计算节点分离部署。
  • Tiny:账号节点、调度节点、登录节点混合部署在一个节点上,计算节点分离部署。
Standard
NodeSuffixstring

主机后缀名。

name
ImageOwnerAliasstring

镜像类型。可能值:

  • system:公共镜像
  • self:自定义镜像
  • others:共享镜像
  • marketplace:镜像市场镜像
system
OsTagstring

操作系统镜像标签。

CentOS_7.2_64
NodePrefixstring

主机前缀名。

test
InstanceTypestring

计算节点实例规格。

ecs.n1.tiny
RegionIdstring

地域 ID。

cn-hangzhou
InstanceChargeTypestring

集群实例付费类型。可能值:

  • PostPaid:按量付费
  • PrePaid:包年包月
PostPaid
VSwitchIdstring

交换机 ID。

vsw-bp1lfcjbfb099rrjn****
ZoneIdstring

可用区 ID。

cn-hangzhou-c
LoginNodesstring

登录节点列表。

{"Id": "i-bp13x4is8pvdhws7e****"}
Idstring

集群 ID。

ehpc-hz-jeJki6****
Locationstring

集群所在位置。可能值:

  • OnPremise:混合云集群。
  • PublicCloud:公有云集群。
PublicCloud
ClientVersionstring

集群客户端版本。

1.0.64
ResourceGroupIdstring

资源组 ID。您可以调用 ListResourceGroups 查询资源组 ID。

rg-acfmxazb4ph****
Managersobject

管理节点信息。

OperatingCountinteger

操作进行中的节点数量,包括初始化、安装中、释放中等状态的节点。

1
ExceptionCountinteger

异常节点数。

0
StoppedCountinteger

停止节点数。

0
Totalinteger

总管理节点数目。

2
NormalCountinteger

正常节点数。

1
Computesobject

计算节点信息。

OperatingCountinteger

操作进行中的节点数量,包括初始化、安装中、释放中等状态的节点。

1
ExceptionCountinteger

异常节点数。

0
StoppedCountinteger

停止节点数。

0
Totalinteger

总节点数。

2
NormalCountinteger

正常节点数。

1
TotalResourcesobject

集群资源总量。

Gpuinteger

GPU 资源。单位:卡。

0
Cpuinteger

CPU 资源。单位:核。

1
Memoryinteger

内存大小。单位为 MiB。

1024
UsedResourcesobject

集群资源使用量。

Gpuinteger

GPU 资源。单位:卡。

0
Cpuinteger

CPU 资源。单位:核。

1
Memoryinteger

内存大小。单位为 MiB。

1024
HasPluginboolean

集群是否使用了插件。取值范围:

  • true:是

  • false:否

默认值:false

false

示例

正常返回示例

JSON格式

{
  "PageSize": 1,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "TotalCount": 1,
  "Clusters": {
    "ClusterInfoSimple": [
      {
        "VpcId": "vpc-b3f3edefefeep0760yju****",
        "Status": "running",
        "CreateTime": "2020-10-30T07:39:20.000Z",
        "IsComputeEss": false,
        "ComputeSpotStrategy": "NoSpot",
        "AccountType": "nis",
        "Count": 3,
        "EhpcVersion": "1.0.0",
        "Description": "clusterdescription",
        "BaseOsTag": "CentOS_7.2_64",
        "Name": "test",
        "ImageId": "wi_1607_x64_dtc_zh_40G_alibase****",
        "ComputeSpotPriceLimit": 0.034,
        "SchedulerType": "pbs",
        "DeployMode": "Standard",
        "NodeSuffix": "name",
        "ImageOwnerAlias": "system",
        "OsTag": "CentOS_7.2_64",
        "NodePrefix": "test",
        "InstanceType": "ecs.n1.tiny",
        "RegionId": "cn-hangzhou",
        "InstanceChargeType": "PostPaid",
        "VSwitchId": "vsw-bp1lfcjbfb099rrjn****",
        "ZoneId": "cn-hangzhou-c",
        "LoginNodes": "{\"Id\": \"i-bp13x4is8pvdhws7e****\"}",
        "Id": "ehpc-hz-jeJki6****",
        "Location": "PublicCloud",
        "ClientVersion": "1.0.64",
        "ResourceGroupId": "rg-acfmxazb4ph****",
        "Managers": {
          "OperatingCount": 1,
          "ExceptionCount": 0,
          "StoppedCount": 0,
          "Total": 2,
          "NormalCount": 1
        },
        "Computes": {
          "OperatingCount": 1,
          "ExceptionCount": 0,
          "StoppedCount": 0,
          "Total": 2,
          "NormalCount": 1
        },
        "TotalResources": {
          "Gpu": 0,
          "Cpu": 1,
          "Memory": 1024
        },
        "UsedResources": {
          "Gpu": 0,
          "Cpu": 1,
          "Memory": 1024
        },
        "HasPlugin": false
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.无效的参数:%s
404ImageNotFoundThe specified image does not exist.指定的镜像不存在,请您检查该参数是否正确。
406AgentErrorThe agent service request failed.集群侧命令运行失败
406DbErrorA database service error occurred.数据库请求失败
406AliyunErrorAn Alibaba Cloud product error occurred.阿里云产品错误
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错
407NotAuthorizedYou are not authorized by RAM for this request.此请求未获得RAM授权
407EntityNotExist.RoleThe role does not exist.当前角色不存在
500UnknownErrorAn unknown error occurred.未知错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server请求失败,服务暂时不可用

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

变更历史

变更时间变更内容概要操作
2023-04-21OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:406
    删除错误码:407
    删除错误码:500
    删除错误码:503
出参OpenAPI 返回结构发生变更