ListClustersMeta_集群管理_API 参考_弹性高性能计算E-HPC-阿里云

查询集群元列表。

描述

获取用户账号中在每个地域拥有的所有集群概要信息。查询集群列表前，您可以：

调用 ListRegions 查询可用地域列表

请求参数

名称	类型	是否必需	默认值	描述
Action	String	是	-	操作接口名，系统规定参数，取值：ListClustersMeta。
RegionId	String	是	-	地域 ID。
PageSize	Integer	否	10	每页显示的条数，1-100。
PageNumber	Integer	否	10	每页显示的条数，1-99。

返回参数

除公共返回参数外返回如下结果：

名称	类型	描述
Clusters	Array<ClusterInfoSimple>	集群简要信息数组，`ClusterInfoSimple` 结构见下面的对象描述。
TotalCount	Integer	列表条目总数。
PageNumber	Integer	当前页码。
PageSize	Integer	本页条数。

其中，每个 ClusterInfoSimple 结构包含以下字段：

名称	类型	描述
Id	String	集群 ID。
Name	String	集群名字。
Description	String	集群描述。
Status	String	集群状态。
Location	String	集群所在位置。`OnPremise`：本地集群（混合云），`PublicCloud`：公共云。

集群状态 Status 的可能取值：

取值	描述
Uninit	未初始化
Creating	创建中
Init	初始化中
Running	运行中
Exception	异常
Releasing	释放中

示例

请求示例

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=ListClustersMeta&RegionId=cn-hangzhou&<公共请求参数>

返回示例

XML格式

<ListClustersMetaResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>12</TotalCount>
    <Clusters>
        <ClusterInfoSimple>
            <Name>create-hybrid-from-api-1</Name>
            <Status>running</Status>
            <Description></Description>
            <Location>OnPremise</Location>
            <Id>ehpc-hz-rJxxxxxxZe6</Id>
        </ClusterInfoSimple>
    </Clusters>
    <PageSize>12</PageSize>
    <RequestId>DD517102-B314-4665-BDAC-A32DE7834D02</RequestId>
</ListClustersMetaResponse>

JSON格式

{
"PageNumber":1,
"TotalCount":12,
"Clusters":{
    "ClusterInfoSimple":[{
        "Name":"create-hybrid-from-api-1",
        "Status":"running",
        "Description":"",
        "Location":"OnPremise",
        "Id":"ehpc-hz-rJxxxxxxZe6"
     }]
},
"PageSize":12,
"RequestId":"DD517102-B314-4665-BDAC-A32DE7834D02"
}

错误码

查询 E-HPC 接口错误码请访问错误码。更多错误码，请访问 API 错误中心。