接口功能介绍
查询对应资源池 ID 下集群列表
接口约束
无
URI
GET /v4/hpfs/list-cluster
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | 81f7728662dd11ec810800155d307d5b | |
| sfsType | 否 | String | 类型，hpfs_perf(HPC性能型) | hpfs_perf | |
| azName | 否 | String | 多可用区下的可用区名字 | az2 | |
| ebmDeviceType | 否 | String | 裸金属设备规格 | physical.lcas910b.2xlarge1 | |
| pageNo | 否 | Integer | 列表的分页页码，默认值为1 | 1 | |
| pageSize | 否 | Integer | 每页包含的元素个数范围(1-50)，默认值为10 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800 为成功，900 为失败) | 800 | |
| message | String | 响应描述 | SUCCESS | |
| description | String | 响应描述 | 成功 | |
| returnObj | Object | 返回对象 | 参考returnObj | |
| errorCode | String | 业务细分码，为 product.module.code 三段式码 | sfs.parameter.sfsType | |
| error | String | 业务细分码，为product.module.code三段式大驼峰码 | Sfs.Parameter.SfsType |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| clusterList | Array of Objects | 返回的集群列表 | 参考 clusterList | |
| totalCount | Integer | 某资源池指定条件下集群总数 | 1 | |
| currentCount | Integer | 当前页码下查询回来的集群数 | 10 | |
| pageSize | Integer | 每页包含的元素个数范围(1-50) | 10 | |
| pageNo | Integer | 列表的分页页码 | 1 |
表 clusterList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| clusterName | String | 集群名称 | nm0001 | |
| remainingStatus | Boolean | 该集群是否可以售卖 | true | |
| storageType | String | 集群的存储类型 | hpfs_perf | |
| azName | String | 多可用区下的可用区名字 | az1 | |
| protocolType | Array of Strings | 集群支持的协议列表 | ["nfs","hpfs"] | |
| baselines | Array of Strings | 集群支持的性能基线列表（仅当资源池支持性能基线时返回） | ["100","200","400"] | |
| networkType | String | 集群的网络类型（tcp/o2ib） | tcp | |
| ebmDeviceTypes | Array of Strings | 集群支持的裸金属设备规格列表 | ["physical.lcas910b.2xlarge1", "physical.lcas910b.2xlarge11"] |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"sfsType": "hpfs_perf",
"azName": "az1",
"pageNo": 1,
"pageSize": 10
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"currentCount": 2,
"clusterList": [
{
"clusterName": "nm0001",
"storageType": "hpfs_perf",
"remainingStatus": true,
"azName": "az1",
"protocolType": ["hpfs", "nfs"],
"baselines": ["100", "200", "400"],
"networkType": "tcp",
"ebmDeviceTypes": ["physical.lcas910b.2xlarge1", "physical.lcas910b.2xlarge11"]
},
{
"clusterName": "st0001",
"storageType": "hpfs_perf",
"remainingStatus": true,
"azName": "az1",
"protocolType": ["hpfs", "nfs"],
"baselines": ["100", "200"],
"networkType": "o2ib",
"ebmDeviceTypes": ["physical.lcas910b.2xlarge1", "physical.h6ns.2xlarge1"]
}
],
"pageSize": 10,
"pageNo": 1,
"totalCount": 2
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码
