接口功能介绍
查询租户可见的资源池列表。
接口约束
无
URI
GET /v4/region/list-regions
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionName | 否 | String | 资源池名称 | 内蒙 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码。为空表示成功。 | Openapi.Common.403 | |
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回参数 | returnObj | |
| error | String | 错误码，为product.module.code三段式码。请求成功时不返回该字段 | Openapi.Common.403 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionList | Array of Objects | 资源池对象 | regionList |
表 regionList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源池ID | 100054c0416811e9a6690242ac110002 | |
| regionParent | String | 资源池所属省份 | 河北 | |
| regionName | String | 资源池名称 | 保定 | |
| regionType | String | 资源池类型 | openstack | |
| isMultiZones | Boolean | 是否多可用区资源池 | true | |
| zoneList | Array of Strings | 可用区列表 | ['az1', 'az2'] |
枚举参数
无
请求示例
请求url
/v4/region/list-regions
请求头header
无
请求体body
无
响应示例
成功响应示例：
{
"returnObj": {
"regionList": [
{
"regionParent": "河北",
"regionID": "100054c0416811e9a6690242ac110002",
"regionType": "openstack",
"regionName": "保定",
"isMultiZones": true,
"zoneList": [
"az1",
"az2"
]
},
{
"regionParent": "北京",
"regionID": "a4e1e8ca370a11ec9d650242ac11000a",
"regionType": "openstack",
"regionName": "马驹桥OS",
"isMultiZones": false,
"zoneList": [
]
},
{
"regionParent": "广东",
"regionID": "99b9479ab3e011e9a45a0242ac110006",
"regionType": "cloudstack",
"regionName": "广州节点1",
"isMultiZones": false,
"zoneList": [
]
}
]
},
"message": "",
"errorCode": "",
"description": "",
"statusCode": 800
}
失败响应示例：
{
"errorCode": "Openapi.Common.403",
"error": "Openapi.Common.403",
"details": "",
"message": "user not found",
"description": "用户不存在",
"statusCode": 900
}
状态码
请参考 状态码
错误码
请参考 错误码
