阿里云弹性高性能计算E-HPCListClusters

查询集群列表。

描述

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

调用 ListRegions 查询可用地域列表

请求参数

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

返回参数

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

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

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

名称	取值	描述
Id	String	集群 ID。
RegionId	String	地域 ID。
Name	String	集群名字。
Description	String	集群描述。
Status	String	集群状态。
OsTag	String	操作系统镜像标签，可以通过 ListImages 查询操作系统详情。
AccountType	String	账户服务器类型，现在仅支持 `nis`。
SchedulerType	String	调度服务器类型，现在仅支持 `pbs`。
Count	Integer	集群中计算节点的数目。
InstanceType	String	集群中计算节点的规格，例如 ecs.n1.large。
CreateTime	String	创建时间。
ImageOwnerAlias	String	镜像类型，取值：`system`、`self`、`others` 或 `marketplace`
ImageId	String	镜像 Id。
Location	String	集群所在位置。`OnPremise`：本地集群（混合云），`PublicCloud`：公共云。
DeployMode	String	部署模式： `Standard`: 账号节点 + 调度节点 + 登录节点 + 计算节点 `Advanced`: HA模式 `Simple`: （账号 + 调度）节点 + 登录节点 + 计算节点 `Tiny`:（账号 + 调度 + 登录）节点 + 计算节点 `OneBox`:（账号 + 调度 + 登录 + 计算）节点 + 更多计算节点
LoginNodes	String	登录节点列表， [{Id:}]
TotalResources	ResourceType	集群资源总量。
UsedResources	ResourceType	集群资源使用量。
Managers	NodeResourceInfo	管理节点统计信息。
Computes	NodeResourceInfo	计算节点统计信息。

集群状态 Status 的可能取值：

取值	描述
uninit	未初始化
creating	创建中
init	初始化中
running	运行中
exception	异常
releasing	释放中

ResourceType 结构包含以下字段：

名称	取值	描述
Cpu	Integer	CPU资源，单位：核
Memory	Integer	内存资源，单位：MB
Gpu	Integer	GPU资源，单位：卡

NodeResourceInfo 结构包含以下字段：

名称	取值	描述
Total	Integer	总的节点数
NormalCount	Integer	正常节点数
OperatingCount	Integer	操作进行中的节点数（初始化，安装中，释放中等状态）
StoppedCount	Integer	停止的节点数
ExceptionCount	Integer	异常节点数

示例

请求示例

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

返回示例

XML格式

<ListClustersResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>1</PageSize>
    <Clusters>
        <ClusterInfoSimple>
            <Id>ehpc-hz-4VMqwGqwbj</Id>
            <RegionId>cn-hangzhou</RegionId>
            <ZoneId>cn-hangzhou-e</ZoneId>
            <Name>Example-cluster-name</Name>
            <Description>Example cluster description</Description>
            <Status>running</Status>
            <AccountType>nis</AccountType>
            <SchedulerType>pbs</SchedulerType>
            <DeployMode>Standard</DeployMode>
            <Count>1</Count>
            <InstanceType>ecs.n1.tiny</InstanceType>
            <LoginNodes>[{"Id":"i-bp19oxc76s5iggdgudgw"}]</LoginNodes>
            <CreateTime>2018-05-30T03:08:06.000Z</CreateTime>
            <ImageOwnerAlias>system</ImageOwnerAlias>
            <ImageId>centos_7_02_64_20G_alibase_20170818.vhd</ImageId>
            <Location>public_cloud</Location>
            <Managers>
                <Total>2</Total>
                <NormalCount>2</NormalCount>
                <OperationCount>0</OperationCount>
                <StoppedCount>0</StoppedCount>
                <ExceptionCount>0</ExceptionCount>
            </Managers>
            <Computes>
                <Total>1</Total>
                <NormalCount>1</NormalCount>
                <OperationCount>0</OperationCount>
                <StoppedCount>0</StoppedCount>
                <ExceptionCount>0</ExceptionCount>
            </Computes>
            <TotalResources>
                <Cpu>1</Cpu>
                <Memory>1024</Memory>
                <Gpu>0</Gpu>
            </TotalResources>
            <UsedResources>
                <Cpu>0</Cpu>
                <Memory>0</Memory>
                <Gpu>0</Gpu>
            </UsedResources>
        </ClusterInfoSimple>
    </Clusters>
</ListClustersResponse>

JSON格式

{
    "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
    "TotalCount": 1,
    "PageNumber": 1,
    "PageSize": 1,
    "Clusters": {
        "ClusterInfoSimple" : [
            {
                "Id": "ehpc-hz-4VMqwGqwbj",
                "RegionId": "cn-hangzhou",
                "ZoneId": "cn-hangzhou-e",
                "Name": "Example-cluster-name",
                "Description": "Example cluster description",
                "Status": "running",
                "AccountType": "nis",
                "SchedulerType": "pbs",
                "DeployMode": "Standard",
                "Count": 1,
                "InstanceType": "ecs.n1.tiny",
                "LoginNodes": "[{‘Id’:‘i-bp19oxc76s5iggdgudgw’}]"，
                "CreateTime": "2018-05-30T03:08:06.000Z",
                "ImageOwnerAlias": "system",
                "ImageId": "centos_7_02_64_20G_alibase_20170818.vhd",
                "Location": "public_cloud",
                "Managers" : {
                    "Total": 2,
                    "NormalCount": 2,
                    "OperationCount": 0,
                    "StoppedCount": 0,
                    "ExceptionCount": 0
                },
                "Computes" : {
                    "Total": 1,
                    "NormalCount": 1,
                    "OperationCount": 0,
                    "StoppedCount": 0,
                    "ExceptionCount": 0
                },
                "TotalResources": {
                    "Cpu": 1,
                    "Memory": 1024,
                    "Gpu": 0
                },
                "UsedResources": {
                    "Cpu": 0,
                    "Memory": 0,
                    "Gpu": 0
                }
            }
        ]
    }
}

错误码

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

原创文章，作者：网友投稿，如若转载，请注明出处：https://www.cloudads.cn/archives/33386.html