ListClustersMeta - 查询集群元列表

查询集群元数据列表。

调试

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

授权信息

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

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

请求参数

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

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

1
PageSizeinteger

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

默认值:10

10

返回参数

名称类型描述示例值
object
PageSizeinteger

每页显示的条数。可能值:1~50

10
RequestIdstring

请求 ID。

DD517102-B314-4665-BDAC-A32DE7834D02
PageNumberinteger

当前页码。

1
TotalCountinteger

列表条目总数。

1
Clustersarray<object>

集群简要信息数组。

ClusterInfoSimpleobject
Statusstring

集群状态。可能值:

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

VPC ID。

vpc-b3f3edefefeep0760yju****
SchedulerTypestring

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

  • pbs
  • slurm
  • opengridscheduler
  • deadline
pbs
DeployModestring

集群部署模式。可能值:

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

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

  • true:启用
  • false:未启用
false
OsTagstring

操作系统镜像标签。

CentOS_7.2_64
AccountTypestring

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

  • nis
  • ldap
nis
Descriptionstring

集群描述。

clusterdescription
Namestring

集群名称。

cluster1
Idstring

集群 ID。

ehpc-hz-jeJki6****
Locationstring

集群所在位置。可能值:

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

集群客户端版本。

1.0.64
HasPluginboolean

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

  • true:是

  • false:否

默认值:false

false
EhpcVersionstring

EHPC 版本。

1.0.0

示例

正常返回示例

JSON格式

{
  "PageSize": 10,
  "RequestId": "DD517102-B314-4665-BDAC-A32DE7834D02",
  "PageNumber": 1,
  "TotalCount": 1,
  "Clusters": {
    "ClusterInfoSimple": [
      {
        "Status": "running",
        "VpcId": "vpc-b3f3edefefeep0760yju****",
        "SchedulerType": "pbs",
        "DeployMode": "Standard",
        "IsComputeEss": false,
        "OsTag": "CentOS_7.2_64",
        "AccountType": "nis",
        "Description": "clusterdescription",
        "Name": "cluster1",
        "Id": "ehpc-hz-jeJki6****",
        "Location": "PublicCloud",
        "ClientVersion": "1.0.64",
        "HasPlugin": false,
        "EhpcVersion": "1.0.0"
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-11-03OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情