DescribeCluster - 查询单个集群信息 - 弹性高性能计算E-HPC

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ehpc:DescribeCluster	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群 ID。您可以调用 ListClusters 查询指定地域下的集群列表。	ehpc-hz-QKKVqO****

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	04F0F334-1335-436C-A1D7-6C044FE73368
ClusterInfo	object	集群信息。
Status	string	集群状态。可能值： uninit：未初始化 creating：创建中 Init：初始化中 running：运行中 exception：异常 releasing：释放中	creating
VpcId	string	专有网络 ID。	vpc-bp1pxkcvmmz53ki89****
KeyPairName	string	密钥对名称。	test
EcsChargeType	string	集群实例付费类型。可能值： PostPaid：按量付费 PrePaid：包年包月	PostPaid
SecurityGroupId	string	安全组 ID。	sg-bp1asugr34gzn****
SccClusterId	string	集群使用的 SccCluster ID。如果集群不是 SCC 机型则为空。	00b648b****
CreateTime	string	集群创建时间。	2020-12-24T03:18:23.000Z
AccountType	string	账户服务器类型。可能值： nis ldap	nis
VolumeProtocol	string	网络共享存储协议。可能值： nfs smb	nfs
Description	string	集群描述。	cluster
VolumeId	string	阿里云 NAS 实例 ID。目前不支持自动创建阿里云 NAS 实例。	008b64****
HaEnable	boolean	是否开启高可用。说明若开启高可用，则集群中的每种管控角色将会使用主备 2 台实例。	false
BaseOsTag	string	集群基础镜像。	CentOS_7.2_64
Name	string	集群名称。	cluster
ImageId	string	镜像 ID。	centos_7_02_64_20G_alibase_20170818****
SchedulerType	string	调度服务器类型。可能值范围： pbs slurm opengridscheduler deadline	pbs
SchedulerVersion	string	调度器软件版本。	18.1.1
DeployMode	string	集群部署模式。可能值： Standard：账号节点、调度节点、登录节点、计算节点分离部署。 Advanced：HA 模式部署。 Simple：账号节点和调度节点混合部署在一个节点上，登录节点和计算节点分离部署。 Tiny：账号节点、调度节点、登录节点混合部署在一个节点上，计算节点分离部署。	Simple
ImageOwnerAlias	string	镜像类型。可能值： system：公共镜像 self：自定义镜像 others：共享镜像 marketplace：镜像市场镜像	system
OsTag	string	操作系统镜像标签。	CentOS_7.2_64
VolumeMountpoint	string	NAS 的 VPC 挂载点。目前不支持自动创建阿里云 NAS 挂载点。	008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com
RemoteDirectory	string	挂载共享存储的远程目录。	NasMountpoint:/RemoteDirectory
RegionId	string	地域 ID。	cn-hangzhou
VSwitchId	string	VPC 中交换机 ID。产品目前只支持 VPC 网络。	vsw-bp1e47optm9g58zcu****
ImageName	string	镜像名称。	test_for_Image
VolumeType	string	网络共享存储类型，目前仅支持阿里云 NAS。	NAS
Location	string	集群所在位置。可能值： OnPremise：混合云集群。 PublicCloud：公有云集群。	PublicCloud
Id	string	实例 ID。	i-bp15de54eet1c43f****
ClientVersion	string	集群所使用的客户端版本号。	1.0.1
ZoneId	string	可用区 ID。	cn-hangzhou-k
ResourceGroupId	string	资源组 ID。	rg-aek23szz5i2****
RamRoleName	string	实例 RAM 角色名称。	AliyunEHPCFullAccess
RamNodeTypes	string	授权实例角色的节点名称详情。	["manager", "compute"]
Applications	object []	集群应用软件列表，包含软件的名称和版本号。
Tag	string	应用软件标签。	OpenMPI_1.8.7
Name	string	应用软件名称。	openmpi
Version	string	应用软件版本。	1.10
PostInstallScripts	object []	安装后脚本列表。
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 实例规格。	ecs.n1.tiny
Count	integer	计算节点数量。	1
Login	object	登录节点信息。
InstanceType	string	登录节点实例规格。	ecs.n1.tiny
Count	integer	登录节点数量。	1
ProxyMgr	object	云上代理节点信息。仅当集群为混合云集群，并开启混合云代理模式时，返回该参数。
InstanceType	string	云上代理节点的实例类型。	ecs.n1.tiny
Count	integer	云上代理节点数量。	1
OnPremiseInfo	object []	本地集群管理节点信息。仅当集群为混合云集群，并开启混合云代理模式时，返回该参数。
Type	string	本地集群管理节点类型，可能值： scheduler account account，scheduler	scheduler
HostName	string	本地集群管理节点主机名。	testecs
IP	string	本地集群管理节点 IP 地址。	192.168..
AddOnsInfo	object []	自定义组件服务信息。
SoftwareId	string	组件的软件 ID。	CROMWELL_85
DeployMode	string	自定义组件的部署模式。可能值： local ecs	local
Port	integer	自定义组件的服务 TCP 端口号。	10000
Status	string	自定义组件的运行状态。可能值： running stopped exception	running
URL	string	自定义组件服务的访问链接。	http://172.16.10.12:10000/
ClusterVersion	string	集群版本号。	1.0
WithoutAgent	integer	是否不安装 Agent 客户端。	false
Plugin	string	插件模式配置，仅当 SchedulerType 为 custom 生效。格式为 JSON 字符串，包含 pluginMod、pluginLocalPath、pluginOssPath 三个参数，具体参数说明如下： pluginMod：插件模式，支持以下两种模式： oss 模式：将从 OSS 上下载插件解压到本地 pluginLocalPath 中。 image 模式：默认插件已经放置到 pluginLocalPath。 pluginLocalPath：插件存放的本地路径，建议在 oss 模式下选择共享存储目录，image 模式下选择非共享存储目录。 pluginOssPath：插件放置在 OSS 上的远程路径，仅当 pluginMod 等于 oss 生效。	{\"pluginMod\":\"image\",\"pluginLocalPath\":\"/opt/plugin\"}
SchedulerPreInstall	integer	业务镜像是否已预安装调度器。可能值： true：已预安装，创建或扩容节点时无需执行安装调度器流程。 false：未预安装，创建或扩容节点时需要执行安装调度器流程。	true
Domain	string	本地集群域名。仅当 AccoutType 取值为 Idap 时，支持配置该参数。	ldap
OpenldapPar	string	对接 OpenLDAP 服务器参数。	{ "LdapServerIp": "192.168.XX.XX", "BaseDn": "ehpctest", "FallbackHomeDir": "/home" }
WinAdPar	string	连接 Windows AD 参数。	{ "AdUser": "Administrator", "AdUserPasswd": "xxxxxx", "AdDc": "ad-hybrid001.ehpcad.com", "AdIp": "192.168.XX.XX"}
Period	string	购买集群节点的时长。单位由`PeriodUnit`指定，取值范围：当参数 PriceUnit 取值为 Year 时：1~3。当参数 PriceUnit 取值为 Month 时：1~9。当参数 PriceUnit 取值为 Hour 时：1。默认值：1。	1
PeriodUnit	string	购买集群节点的时长单位。取值范围： Year Month Hour 默认值：Month。	Month
AutoRenewPeriod	string	每次自动续费的时长。参数 AutoRenew 取值 true 时生效。 PeriodUnit 为 Week 时，AutoRenewPeriod 取值{"1", "2", "3"}。 PeriodUnit 为 Month 时，AutoRenewPeriod 取值{"1", "2", "3", "6", "12"}。默认值：1。	1
AutoRenew	string	是否自动续费，当参数 EcsChargeType 取值为 PrePaid 时才生效。取值范围： true：自动续费 false：不自动续费默认值：true	false
ComputeSpotStrategy	string	计算节点竞价策略。可能值： NoSpot：正常按量付费实例。 SpotWithPriceLimit：设置上限价格的抢占式实例。 SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。	NoSpot
ComputeSpotPriceLimit	string	计算节点每小时最高价格。最大支持 3 位小数，参数 ComputeSpotStrategy 取值为 SpotWithPriceLimit 时生效。	0.56
Nodes	object []	本地集群节点信息列表。
Role	string	本地集群节点的角色。可能值： Manager：管控节点 Login：登录节点 Compute：计算节点	Compute
HostName	string	本地集群节点的主机名称。	compute000
IpAddress	string	本地集群节点的 IP 地址。	192.168.XX.XX
AccountType	string	本地集群节点的域账号服务类型。可能值： nis ldap 默认值：nis	nis
Dir	string	本地集群节点的配置目录。	/opt/sge/default/
SchedulerType	string	本地集群节点的调度器类型。可能值： pbs slurm opengridscheduler deadline 默认值：pbs。	pbs
InitialImage	object	操作系统镜像信息汇总。
OsTag	string	E-HPC 支持的操作系统镜像。	CentOS_7.6_64
ImageOwnerAlias	string	镜像类型，可能值： system：公共镜像 self：自定义镜像 others：共享镜像 marketplace：镜像市场镜像	system
ImageId	string	镜像 ID。	centos_7_6_x64_20G_alibase_20211130.vhd

示例

正常返回示例

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",
    "SchedulerVersion": "18.1.1",
    "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",
    "ZoneId": "cn-hangzhou-k",
    "ResourceGroupId": "rg-aek23szz5i2****",
    "RamRoleName": "AliyunEHPCFullAccess",
    "RamNodeTypes": "[\"manager\", \"compute\"]",
    "Applications": {
      "ApplicationInfo": [
        {
          "Tag": "OpenMPI_1.8.7",
          "Name": "openmpi",
          "Version": "1.10"
        }
      ]
    },
    "PostInstallScripts": {
      "PostInstallScriptInfo": [
        {
          "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": {
      "OnPremiseInfo": [
        {
          "Type": "scheduler",
          "HostName": "testecs",
          "IP": "192.168.*.*"
        }
      ]
    },
    "AddOnsInfo": {
      "AddOnsInfo": [
        {
          "SoftwareId": "CROMWELL_85",
          "DeployMode": "local",
          "Port": 10000,
          "Status": "running",
          "URL": "http://172.16.10.12:10000/"
        }
      ]
    },
    "ClusterVersion": "1.0",
    "WithoutAgent": 0,
    "Plugin": "{\\\"pluginMod\\\":\\\"image\\\",\\\"pluginLocalPath\\\":\\\"/opt/plugin\\\"}",
    "SchedulerPreInstall": 0,
    "Domain": "ldap",
    "OpenldapPar": "{\n\t\"LdapServerIp\": \"192.168.XX.XX\",\n\t\"BaseDn\": \"ehpctest\",\n\t\"FallbackHomeDir\": \"/home\"\n}",
    "WinAdPar": "{\t\"AdUser\": \"Administrator\",\t\"AdUserPasswd\": \"xxxxxx\",\t\"AdDc\": \"ad-hybrid001.ehpcad.com\",\t\"AdIp\": \"192.168.XX.XX\"}",
    "Period": "1",
    "PeriodUnit": "Month",
    "AutoRenewPeriod": "1",
    "AutoRenew": "false",
    "ComputeSpotStrategy": "NoSpot",
    "ComputeSpotPriceLimit": "0.56",
    "Nodes": {
      "NodesInfo": [
        {
          "Role": "Compute",
          "HostName": "compute000",
          "IpAddress": "192.168.XX.XX",
          "AccountType": "nis",
          "Dir": "/opt/sge/default/",
          "SchedulerType": "pbs"
        }
      ]
    },
    "InitialImage": {
      "OsTag": "CentOS_7.6_64",
      "ImageOwnerAlias": "system",
      "ImageId": "centos_7_6_x64_20G_alibase_20211130.vhd"
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
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	AgentError	The agent service request failed.	集群侧命令运行失败
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	请求失败，服务暂时不可用

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

变更历史

变更时间

变更内容概要

操作

2023-12-08

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：404
	删除错误码：406
	删除错误码：407
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2023-05-26

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：404
	删除错误码：406
	删除错误码：407
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2023-05-25

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：404
	删除错误码：406
	删除错误码：407
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2023-04-21

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：404
	删除错误码：406
	删除错误码：407
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。