查询指定集群信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| ehpc:DescribeCluster | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClusterId | string | 是 | 集群 ID。您可以调用 ListClusters 查询指定地域下的集群列表。 | ehpc-hz-QKKVqO**** |
返回参数
示例
正常返回示例
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.1
}
]
},
"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,
"WithoutAgent": 0,
"Plugin": "{\\\"pluginMod\\\":\\\"image\\\",\\\"pluginLocalPath\\\":\\\"/opt/plugin\\\"}",
"SchedulerPreInstall": 0,
"Domain": "ldap",
"OpenldapPar": {
"LdapServerIp": "192.168.XX.XX",
"BaseDn": "ehpctest",
"FallbackHomeDir": "/home"
},
"WinAdPar": {
"AdUser": "Administrator",
"AdUserPasswd": "xxxxxx",
"AdDc": "ad-hybrid001.ehpcad.com",
"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调用出错. %s |
| 406 | NasError | NAS API request failed. | NAS接口请求失败 |
| 406 | AgentError | The agent service request failed. | 集群侧命令运行失败。%s |
| 406 | DbError | A database service error occurred. | 数据库请求失败 |
| 406 | RedisError | A Redis service error occurred. | Redis请求失败 |
| 406 | AliyunError | An Alibaba Cloud product error occurred. | 阿里云产品错误。%s |
| 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 返回结构发生变更 | 查看变更详情 |
| 2023-05-26 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-05-25 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2023-04-21 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |