Queries the details of a cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeCluster |
The operation that you want to perform. Set the value to DescribeCluster. |
ClusterId | String | Yes | ehpc-hz-QKKVqO**** |
The ID of the cluster. You can call the ListClusters operation to query the list of clusters in a region. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 04F0F334-1335-436C-A1D7-6C044FE73368 |
The ID of the request. |
ClusterInfo | Object |
The information about the cluster. |
|
Status | String | creating |
The status of the cluster. Valid values:
|
VpcId | String | vpc-bp1pxkcvmmz53ki89**** |
The ID of the VPC. |
KeyPairName | String | test |
The name of the AccessKey pair. |
EcsChargeType | String | PostPaid |
The billing method of the nodes in the cluster. Valid values:
|
SecurityGroupId | String | sg-bp1asugr34gzn**** |
The ID of the security group. |
SccClusterId | String | 00b648b**** |
The ID of the Super Computing Cluster (SCC) instance. If the cluster is not an SCC instance, a null string is returned. |
CreateTime | String | 2020-12-24T03:18:23.000Z |
The time when the cluster was created. |
AccountType | String | nis |
The service type of the domain account. Valid values:
|
VolumeProtocol | String | nfs |
The type of the protocol that is used by the file system. Valid values:
|
Description | String | cluster |
The description of the cluster. |
VolumeId | String | 008b64**** |
The ID of the Apsara File Storage NAS file system. NAS file systems cannot be automatically created. |
HaEnable | Boolean | false |
Indicates whether the high availability feature is enabled. Note If high availability is enabled, a primary management node and a secondary management
node are used.
|
BaseOsTag | String | CentOS_7.2_64 |
The image of the cluster. |
Name | String | cluster |
The name of the cluster. |
ImageId | String | centos_7_02_64_20G_alibase_20170818**** |
The ID of the image. |
SchedulerType | String | pbs |
The type of the scheduler. Valid values:
|
DeployMode | String | Simple |
The mode in which the cluster is deployed. Valid values:
|
ImageOwnerAlias | String | system |
The type of the image. Valid values:
|
OsTag | String | CentOS_7.2_64 |
The image tag of the operating system. |
VolumeMountpoint | String | 008b648bcb-s****.cn-hangzhou.nas.aliyuncs.com |
The mount target of the file system. Mount targets cannot be automatically created for NAS file systems. |
RemoteDirectory | String | NasMountpoint:/RemoteDirectory |
The remote directory on which the file system is mounted. |
RegionId | String | cn-hangzhou |
The region ID of the security group. |
VSwitchId | String | vsw-bp1e47optm9g58zcu**** |
The ID of the vSwitch. E-HPC can be deployed only in VPCs. |
ImageName | String | test_for_Image |
The name of the image. |
VolumeType | String | NAS |
The type of the network shared storage. Valid value: NAS. |
Location | String | PublicCloud |
The location where the cluster is deployed. Valid values:
|
Id | String | i-bp15de54eet1c43f**** |
The ID of the Elastic Compute Service (ECS) instance. |
ClientVersion | String | 1.0.1 |
The version of the E-HPC client. |
Applications | Array of ApplicationInfo |
The array of the software in the cluster. The array contains the name and version of the software. |
|
ApplicationInfo | |||
Tag | String | OpenMPI_1.8.7 |
The tag of the software. |
Name | String | openmpi |
The name of the software. |
Version | String | 1.10 |
The version of the software. |
PostInstallScripts | Array of PostInstallScriptInfo |
The list of scripts downloaded after the cluster was created. |
|
PostInstallScriptInfo | |||
Url | String | example.com |
The URL that was used to download the script. |
Args | String | bash file.sh |
The runtime parameter of the script. |
EcsInfo | Object |
The list of ECS instance specifications and quantity. |
|
Manager | Object |
The list of management nodes. |
|
InstanceType | String | ecs.n1.tiny |
The instance type of the management nodes. |
Count | Integer | 1 |
The number of management nodes. |
Compute | Object |
The list of compute nodes. |
|
InstanceType | String | ecs.n1.tiny |
The instance type of the compute nodes. |
Count | Integer | 1 |
The number of compute nodes. |
Login | Object |
The list of logon nodes. |
|
InstanceType | String | ecs.n1.tiny |
The instance type of the logon nodes. |
Count | Integer | 1 |
The number of logon nodes. |
ProxyMgr | Object |
The list of proxy nodes on the cloud. This parameter is returned only when the cluster is deployed across hybrid environments and the hybrid-cloud proxy mode is enabled for the cluster. |
|
InstanceType | String | ecs.n1.tiny |
The instance type of the proxy node. |
Count | Integer | 1 |
The number of proxy nodes. |
OnPremiseInfo | Array of OnPremiseInfo |
The list of on-premises management nodes. This parameter is returned only when the cluster is deployed across hybrid environments and the hybrid-cloud proxy mode is enabled for the cluster. |
|
OnPremiseInfo | |||
Type | String | scheduler |
The type of on-premises management nodes. Valid values:
|
HostName | String | testecs |
The hostname of the on-premises management nodes. |
IP | String | 192.168.*.* |
The IP address of the on-premises management nodes. |
Examples
Sample requests
https://ehpc.cn-hangzhou.aliyuncs.com/?Action=DescribeCluster
&ClusterId=ehpc-hz-QKKVqO****
&<Common request parameters>
Sample success responses
XML
format
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
format
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.*.*"
} ]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidParams | The specified parameter %s is invalid. | The error message returned because the %s parameter is invalid. |
404 | ClusterNotFound | The specified cluster does not exist. | The error message returned because the specified cluster does not exist. |
404 | ImageNotFound | The specified image does not exist. | The error message returned because the specified image does not exist. |
406 | EcsError | An error occurred while calling the ECS API operation. | The error message returned because the ECS API call has failed. |
406 | NasError | NAS API request failed. | The error message returned because the NAS API call has failed. |
406 | DbError | A database service error occurred. | The error message returned because the database request has failed. |
406 | RedisError | A Redis service error occurred. | The error message returned because the Redis request has failed. |
406 | AliyunError | An Alibaba Cloud product error occurred. | The error message returned because the operation has failed to call another Alibaba Cloud service. |
407 | NotAuthorized | You are not authorized by RAM for this request. | The error message returned because you are not authorized by RAM for this request. |
500 | UnknownError | An unknown error occurred. | The error message returned because an unknown error has occurred. Try again later. If the error persists, submit a ticket. |
503 | ServiceUnavailable | The request has failed due to a temporary failure of the server | The error message returned because the request has failed. The service is temporarily unavailable. |
For a list of error codes, visit the API Error Center.