接口功能介绍
根据资源池ID，查询集群列表信息。
准备工作：
构造请求：在调用前需要了解如何构造请求，详情查看构造请求
认证鉴权：openapi请求需要进行加密调用，详细查看认证鉴权
注意事项：
分页查询：当前查询结果以分页形式进行展示，单次查询最多显示1000条数据
匹配查找：可以通过部分字段进行匹配筛选数据，无符合条件的为空，在指定多个集群UUID的情况下，只返回匹配到的集群信息，推荐每次使用单个条件查找
接口约束
无
URI
GET /v4/cthpc/list-cluster
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID，您可以查看地域和可用区来了解资源池 获取： 查 查询支持超算的地域列表 |
8e3a382e241d11ed957c0242ac110006 | |
| clusterUUIDList | 否 | String | 集群UUID列表， 多个使用英文逗号分隔，如有clusterNameList则取交集 获取： 创 创建集群 |
uuid-1,uuid-2 | |
| clusterNameList | 否 | String | 集群名称，多个以逗号分隔，如有clusterUUIDList则取交集 | name-1,name-2 | |
| pageNo | 否 | Integer | 页码，取值范围：正整数（≥1），注：默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页记录数目，取值范围:[1, 1000]，默认值:10，单页最大记录不超过1000 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 | |
| errorCode | String | 错误码，为product.module.code 三段式码 | Hpc.Cluster.NotValid | |
| error | String | 错误码，为product.module.code 三段式码 | Hpc.Cluster.NotValid | |
| message | String | 失败时的英文错误描述 | Param is null | |
| description | String | 失败时的中文错误描述 | 请求为空 | |
| returnObj | Object | 返回参数 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| currentCount | Integer | 当前页记录数目 | 1 | |
| totalCount | Integer | 总记录数 | 1 | |
| totalPage | Integer | 总页数 | 1 | |
| resultList | Array of Objects | 分页明细,元素类型是result,定义请参考result对象结构 | result |
表 result
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| clusterName | String | 集群名称 | al | |
| azName | String | 可用区名称 | cn-anshun-t1a | |
| regionName | String | 资源池名 | cn-anshun-t1 | |
| regionID | String | 资源池ID | 8e3a382e241d11ed957c0242ac110006 | |
| ctyunID | String | 账户ID | 41f64827f25f468595ffa3a5deb5d15d | |
| clusterUUID | String | 集群实例UUID | cl-drggwgpe6zevs133eubdlnt3psgg | |
| vpc | String | 虚拟私有云名称 | vpc-2483 | |
| vpcUUID | String | 虚拟私有云UUID | c88c6d42-6c76-45d1-9eb7-fc5d3bed76b4 | |
| subnet | String | 子网名称 | subnet-5326 | |
| subnetUUID | String | 子网UUID | fd130a77-ebd9-4c3d-b47c-70650a409811 | |
| clusterType | String | 集群类型名称, 目前只有slurm | slurm | |
| clusterTypeUUID | String | 集群类型UUID | ct-jn8sm0bejygcdglhpljbddjll9ro | |
| masterNodeQuantity | Integer | 集群内master节点个数 | 0 | |
| computeNodeQuantity | Integer | 集群内compute节点个数 | 0 | |
| 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 | 集群可用状态，取值如下： available：可用 unavailable：不可用 unknown：异常 |
available | |
| clusterRunningStatus | String | 集群运行状态，取值如下： uninitialized：空集群待添加节点 creating：集群下节点创建中 setupping：master节点和一个计算节点物理机资源准备完成, running之前 running：集群的调度器状态为running时, 运行态为running updating：集群内增删节点过程中 stopped：所有物理机关机 unknown：未知 |
uninitialized | |
| createTime | String | 创建时间 | 2022-10-27 18:32:13 |
枚举参数
无
请求示例
请求url
示例：查询内蒙6资源池的集群列表
/v4/cthpc/list-cluster?regionID=6019b5007a0b11eab5db0242ac110002
请求头header
无
请求体body
无
响应示例
{
"returnObj": {
"currentCount": 1,
"totalCount": 1,
"totalPage": 1,
"resultList": [{
"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
}
状态码
请参考 状态码
错误码
请参考 错误码
