调用DescribeCluster查询指定集群信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeCluster

系统规定参数。取值:DescribeCluster

ClusterId String ehpc-hz-QKKVqO****

集群ID。您可以调用ListClusters查询指定地域下的集群列表。

返回数据

名称 类型 示例值 描述
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

请求ID。

ClusterInfo Object

集群信息。

Status String creating

集群状态。可能值:

  • uninit:未初始化
  • creating:创建中
  • Init:初始化中
  • running:运行中
  • exception:异常
  • releasing:释放中
VpcId String vpc-bp1pxkcvmmz53ki89****

专有网络ID。

KeyPairName String test

密钥对名称。

EcsChargeType String PostPaid

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

  • PostPaid:按量付费
  • PrePaid:包年包月
SecurityGroupId String sg-bp1asugr34gzn****

安全组ID。

SccClusterId String 00b648b****

集群使用的SccCluster ID。如果集群不是SCC机型则为空。

CreateTime String 2020-12-24T03:18:23.000Z

集群创建时间。

AccountType String nis

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

  • nis
  • ldap
VolumeProtocol String nfs

网络共享存储协议。可能值:

  • nfs
  • smb
Description String cluster

集群描述。

VolumeId String 008b64****

阿里云NAS实例ID。目前不支持自动创建阿里云NAS实例。

HaEnable Boolean false

是否开启高可用。

说明 若开启高可用,则集群中的每种管控角色将会使用主备2台实例。
BaseOsTag String CentOS_7.2_64

集群基础镜像。

Name String cluster

集群名称。

ImageId String centos_7_02_64_20G_alibase_20170818****

镜像ID。

SchedulerType String pbs

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

  • pbs
  • slurm
  • opengridscheduler
  • deadline
DeployMode String Simple

集群部署模式。可能值:

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

镜像类型。可能值:

  • system:公共镜像
  • self:自定义镜像
  • others:共享镜像
  • marketplace:镜像市场镜像
OsTag String CentOS_7.2_64

操作系统镜像标签。

VolumeMountpoint String 008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com

NAS的VPC挂载点。目前不支持自动创建阿里云NAS挂载点。

RemoteDirectory String NasMountpoint:/RemoteDirectory

挂载共享存储的远程目录。

RegionId String cn-hangzhou

地域ID。

VSwitchId String vsw-bp1e47optm9g58zcu****

VPC中交换机ID。产品目前只支持VPC网络。

ImageName String test_for_Image

镜像名称。

VolumeType String NAS

网络共享存储类型,目前仅支持阿里云NAS。

Location String PublicCloud

集群所在位置。可能值:

  • OnPremise:混合云集群。
  • PublicCloud:公有云集群。
Id String i-bp15de54eet1c43f****

实例ID。

ClientVersion String 1.0.1

集群所使用的客户端版本号。

Applications Array of ApplicationInfo

集群应用软件列表,包含软件的名称和版本号。

ApplicationInfo
Tag String OpenMPI_1.8.7

应用软件标签。

Name String openmpi

应用软件名称。

Version String 1.10

应用软件版本。

PostInstallScripts Array of PostInstallScriptInfo

安装后脚本列表。

PostInstallScriptInfo
Url String example.com

脚本下载路径。

Args String bash file.sh

脚本执行参数。

EcsInfo Object

描述集群中ECS数量和规格的数据结构。

Manager Object

管控节点信息。

InstanceType String ecs.n1.tiny

管控节点实例规格。

Count Integer 1

管控节点的数量。

Compute Object

计算节点信息。

InstanceType String ecs.n1.tiny

计算节点ECS实例规格。

Count Integer 1

计算节点数量。

Login Object

登录节点信息。

InstanceType String ecs.n1.tiny

登录节点实例规格。

Count Integer 1

登录节点数量。

ProxyMgr Object

云上代理节点信息。

仅当集群为混合云集群,并开启混合云代理模式时,返回该参数。

InstanceType String ecs.n1.tiny

云上代理节点的实例类型。

Count Integer 1

云上代理节点数量。

OnPremiseInfo Array of OnPremiseInfo

本地集群管理节点信息。

仅当集群为混合云集群,并开启混合云代理模式时,返回该参数。

OnPremiseInfo
Type String scheduler

本地集群管理节点类型,可能值:

  • scheduler
  • account
  • account,scheduler
HostName String testecs

本地集群管理节点主机名。

IP String 192.168.*.*

本地集群管理节点IP地址。

示例

请求示例

https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeCluster
&ClusterId=ehpc-hz-QKKVqO****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeClusterResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <ClusterInfo>
        <Status>creating</Status>
        <VpcId>vpc-bp1pxkcvmmz53ki89****</VpcId>
        <KeyPairName>test</KeyPairName>
        <EcsChargeType>PostPaid</EcsChargeType>
        <SecurityGroupId>sg-bp1asugr34gzn****</SecurityGroupId>
        <SccClusterId>00b648b****</SccClusterId>
        <CreateTime>2020-12-24T03:18:23.000Z</CreateTime>
        <AccountType>nis</AccountType>
        <VolumeProtocol>nfs</VolumeProtocol>
        <Description>cluster</Description>
        <VolumeId>008b64****</VolumeId>
        <HaEnable>false</HaEnable>
        <BaseOsTag>CentOS_7.2_64</BaseOsTag>
        <Name>cluster</Name>
        <ImageId>centos_7_02_64_20G_alibase_20170818****</ImageId>
        <SchedulerType>pbs</SchedulerType>
        <DeployMode>Simple</DeployMode>
        <ImageOwnerAlias>system</ImageOwnerAlias>
        <OsTag>CentOS_7.2_64</OsTag>
        <VolumeMountpoint>008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com</VolumeMountpoint>
        <RemoteDirectory>NasMountpoint:/RemoteDirectory</RemoteDirectory>
        <RegionId>cn-hangzhou</RegionId>
        <VSwitchId>vsw-bp1e47optm9g58zcu****</VSwitchId>
        <ImageName>test_for_Image</ImageName>
        <VolumeType>NAS</VolumeType>
        <Location>PublicCloud</Location>
        <Id>i-bp15de54eet1c43f****</Id>
        <ClientVersion>1.0.1</ClientVersion>
        <Applications>
            <Tag>OpenMPI_1.8.7</Tag>
            <Name>openmpi</Name>
            <Version>1.10</Version>
        </Applications>
        <PostInstallScripts>
            <Url>example.com</Url>
            <Args>bash file.sh</Args>
        </PostInstallScripts>
        <EcsInfo>
            <Manager>
                <InstanceType>ecs.n1.tiny</InstanceType>
                <Count>1</Count>
            </Manager>
            <Compute>
                <InstanceType>ecs.n1.tiny</InstanceType>
                <Count>1</Count>
            </Compute>
            <Login>
                <InstanceType>ecs.n1.tiny</InstanceType>
                <Count>1</Count>
            </Login>
            <ProxyMgr>
                <InstanceType>ecs.n1.tiny</InstanceType>
                <Count>1</Count>
            </ProxyMgr>
        </EcsInfo>
        <OnPremiseInfo>
            <Type>scheduler</Type>
            <HostName>testecs</HostName>
            <IP>192.168.*.*</IP>
        </OnPremiseInfo>
    </ClusterInfo>
</DescribeClusterResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368",
  "ClusterInfo" : {
    "Status" : "creating",
    "VpcId" : "vpc-bp1pxkcvmmz53ki89****",
    "KeyPairName" : "test",
    "EcsChargeType" : "PostPaid",
    "SecurityGroupId" : "sg-bp1asugr34gzn****",
    "SccClusterId" : "00b648b****",
    "CreateTime" : "2020-12-24T03:18:23.000Z",
    "AccountType" : "nis",
    "VolumeProtocol" : "nfs",
    "Description" : "cluster",
    "VolumeId" : "008b64****",
    "HaEnable" : false,
    "BaseOsTag" : "CentOS_7.2_64",
    "Name" : "cluster",
    "ImageId" : "centos_7_02_64_20G_alibase_20170818****",
    "SchedulerType" : "pbs",
    "DeployMode" : "Simple",
    "ImageOwnerAlias" : "system",
    "OsTag" : "CentOS_7.2_64",
    "VolumeMountpoint" : "008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com",
    "RemoteDirectory" : "NasMountpoint:/RemoteDirectory",
    "RegionId" : "cn-hangzhou",
    "VSwitchId" : "vsw-bp1e47optm9g58zcu****",
    "ImageName" : "test_for_Image",
    "VolumeType" : "NAS",
    "Location" : "PublicCloud",
    "Id" : "i-bp15de54eet1c43f****",
    "ClientVersion" : "1.0.1",
    "Applications" : [ {
      "Tag" : "OpenMPI_1.8.7",
      "Name" : "openmpi",
      "Version" : "1.10"
    } ],
    "PostInstallScripts" : [ {
      "Url" : "example.com",
      "Args" : "bash file.sh"
    } ],
    "EcsInfo" : {
      "Manager" : {
        "InstanceType" : "ecs.n1.tiny",
        "Count" : 1
      },
      "Compute" : {
        "InstanceType" : "ecs.n1.tiny",
        "Count" : 1
      },
      "Login" : {
        "InstanceType" : "ecs.n1.tiny",
        "Count" : 1
      },
      "ProxyMgr" : {
        "InstanceType" : "ecs.n1.tiny",
        "Count" : 1
      }
    },
    "OnPremiseInfo" : [ {
      "Type" : "scheduler",
      "HostName" : "testecs",
      "IP" : "192.168.*.*"
    } ]
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The specified parameter %s is invalid. 无效的参数:%s
404 ClusterNotFound The specified cluster does not exist. 指定的集群不存在,请您检查该参数是否正确。
404 ImageNotFound The specified image does not exist. 指定的镜像不存在,请您检查该参数是否正确。
406 EcsError An error occurred while calling the ECS API operation. ECS API调用出错
406 NasError NAS API request failed. NAS接口请求失败
406 DbError A database service error occurred. 数据库请求失败
406 RedisError A Redis service error occurred. Redis请求失败
406 AliyunError An Alibaba Cloud product error occurred. 阿里云产品错误
407 NotAuthorized You are not authorized by RAM for this request. 此请求未获得RAM授权
500 UnknownError An unknown error occurred. 未知错误,请您稍后再试,若还出现相同的错误请提交工单处理。
503 ServiceUnavailable The request has failed due to a temporary failure of the server 请求失败,服务暂时不可用

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