资源池列表查询
接口功能介绍
查询租户可见的资源池列表。
接口约束
无
请求定义
URI
GET /v4/region/list-regions
路径参数
无
请求Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
---|---|---|---|---|
regionName | 否 | String | 资源池名称 | 内蒙 |
请求Json Body参数
无
请求header参数
无
响应定义
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码('800为成功,900为失败) ,默认值:800 | 800 | |
errorCode | 是 | String | 错误码,为product.module.code三段式码。为空表示成功。 | ||
message | 是 | String | 失败时的错误描述,一般为英文描述 | ||
description | 是 | String | 失败时的错误描述,一般为中文描述 | ||
returnObj | 是 | Object | 返回参数 | returnObj |
returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionList | 是 | Array of Objects | 资源池对象 | 资源池列表项 |
资源池列表项
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 100054c0416811e9a6690242ac110002 | |
regionParent | 是 | String | 资源池所属省份 | 河北 | |
regionName | 是 | String | 资源池名称 | 保定 | |
regionType | 是 | String | 资源池类型 | openstack | 资源池类型 |
isMultiZones | 是 | Boolean | 是否多可用区资源池 | true | |
zoneList | 是 | Array of Strings | 可用区列表 | ['az1', 'az2'] |
请求示例
请求头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",
"details": "",
"message": "user not found",
"description": "用户不存在",
"statusCode": 900
}
资源池类型
值 | 说明 |
---|---|
openstack | openstack资源池架构类型 |
cloudstack | cloudstack资源池架构类型 |
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
接口错误码
errorCode | 含义 |
---|---|
Openapi.Common.403 | 用户不存在, user not found |