接口功能介绍
根据资源池ID、集群uuid,查询集群详细信息。
接口约束
无
URI
GET /v4/cthpc/detail-cluster
路径参数
无
Query 参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池 ID | 8e3a382e241d11ed957c0242ac110006 | |
clusterUUID | 是 | String | 集群UUID | cl-zhqloubcsmycabomouuuwhgahwit |
请求参数
请求头 header 参数
无
请求体 body 参数
无
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 | |
errorCode | String | 业务细分码,为 product.module.code 三段式码 | 参考错误码 | |
message | String | 失败时的英文错误描述 | Param is null | |
description | String | 失败时的中文错误描述 | 请求为空 | |
returnObj | Object | 返回参数 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
clusterName | String | 集群名称 | PLATFORM | |
azName | String | 可用区名称 | cn-anshun-t1a | |
regionName | String | 资源池名 | cn-anshun-t1 | |
regionID | String | 资源池ID | 8e3a382e241d11ed957c0242ac110006 | |
ctyunID | String | 账户ID | 41f64827f25f468595ffa3a5deb5d15d | |
clusterUUID | String | 集群实例UUID | cl-g8igmlp1xchheqn6gskwucgg1wub | |
vpc | String | 私有云名称 | vpc-2483 | |
vpcUUID | String | 私有云UUID | c88c6d42-6c76-45d1-9eb7-fc5d3bed76b4 | |
subnet | String | 子网名称 | subnet-2483 | |
subnetUUID | String | 子网UUID | fd130a77-ebd9-4c3d-b47c-70650a409811 | |
clusterType | String | 集群类型名称, 目前只有slurm | slurm | |
clusterTypeUUID | String | 集群类型UUID | ct-jn8sm0bejygcdglhpljbddjll9ro | |
masterNodeQuantity | Integer | 集群内master节点个数 | 1 | |
computeNodeQuantity | Integer | 集群内compute节点个数 | 1 | |
cpuQuantity | Integer | 集群compute节点cpu总核数 | 0 | |
publicIP | String | 集群内master(管控节点)的公网ip(即弹性ip) | xxx.xxx.xxx.xxx | |
innerIP | String | 集群内master(管控节点)的内网ip | xxx.xxx.xxx.xxx | |
clusterDescription | String | 集群描述,不超过256位 | test-desc | |
clusterAvailableStatus | String | 集群可用状态描述 | 集群可用状态枚举 | |
clusterRunningStatus | String | 集群运行状态描述 | 集群运行状态枚举 | |
createTime | String | 创建时间 | 2022-10-26 18:54:53 |
请求示例
query
/v4/cthpc/detail-cluster?regionID=8e3a382e241d11ed957c0242ac110006&clusterUUID=cl-zhqloubcsmycabomouuuwhgahwit
请求头 header
无
请求体 body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"subnet": "subnet-5326",
"computeNodeQuantity": 0,
"masterNodeQuantity": 0,
"vpc": "vpc-5326",
"clusterName": "AB123456qw",
"clusterTypeUUID": "ct-jn8sm0bejygcdglhpljbddjll9ro",
"publicIP": "",
"regionName": "cn-anshun-t1",
"regionID": "8e3a382e241d11ed957c0242ac110006",
"subnetUUID": "dcdf90e1-34f6-4f73-8392-e72c4cffe3e9",
"clusterUUID": "cl-wkvfaqf2mqjcvhujdah0tq4oa8a4",
"createTime": "2022-11-02 09:35:29",
"clusterAvailableStatus": "unavailable",
"ctyunID": "41f64827f25f468595ffa3a5deb5d15d",
"azName": "cn-anshun-t1a",
"innerIP": "",
"vpcUUID": "7cd6144c-50ec-4e07-afb7-6deab4f7931a",
"clusterType": "slurm",
"cpuQuantity": 0,
"clusterRunningStatus": "uninitialized",
"clusterDescription": null
},
"errorCode": "",
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
错误码 | 描述 |
---|---|
Hpc.Cluster.NotValid | 请求参数非法 |
Hpc.Cluster.NotFound | 集群不存在 |
Hpc.Common.CheckError | 内部错误,请重试 |
附录
集群可用状态枚举
clusterAvailableStatus | 描述 |
---|---|
available | 可用 |
unavailable | 不可用 |
unknown | 异常 |
集群运行状态枚举
clusterRunningStatus | 说明 |
---|---|
uninitialized | 空集群待添加节点 |
creating | 集群下节点创建中 |
setupping | master节点和一个计算节点物理机资源准备完成, running之前 |
running | 集群的调度器状态为running时, 运行态为running |
updating | 集群内增删节点过程中 |
stopped | 所有物理机关机 |
unknown | 未知 |