接口功能介绍
查询资源池概况，比如地域，多az信息，支持的cpu架构，资源池占用类型，资源池版本信息等
接口约束
无
URI
GET /v4/region/get-summary
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码('800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | String | 错误码，为product.module.code三段式码。为空表示成功。 | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回参数 | returnObj | |
| error | String | 错误码，为product.module.code三段式码。请求成功时不返回该字段 | Unknown.Region.RegionIDError |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 资源池ID | ||
| regionParent | String | 资源池所属省份 | 河北 | |
| regionName | String | 资源池名称 | 保定 | |
| regionType | String | 资源池类型 | openstack | |
| isMultiZones | Boolean | 是否多可用区资源池 | ||
| zoneList | Array of Objects | 可用区列表 | zoneList | |
| cpuArches | Array of Strings | 资源池cpu架构信息 | ||
| regionVersion | String | 资源池版本 | ||
| dedicated | Boolean | 是否是专属资源池，账户可能访问的是一个自己可见的专属资源池 | ||
| province | String | 省份 | ||
| city | String | 城市 | ||
| openapiAvailable | Boolean | 是否支持通过OpenAPI访问 |
枚举参数
参数名 regionType
| 枚举值 | 类型 | 说明 |
|---|---|---|
| openstack | String | openstack资源池架构类型 |
| cloudstack | String | cloudstack资源池架构类型 |
参数名 cpuArches
| 枚举值 | 类型 | 说明 |
|---|---|---|
| x86_64 | String | x86_64体系结构 |
| ARM64 | String | ARM64体系结构 |
| RISC-V | String | RISC-V体系结构 |
请求示例
请求url
/v4/region/get-summary?regionID=a4e1e8ca370a11ec9d650242ac11000a
请求头header
无
请求体body
无
响应示例
成功响应示例：
{
"returnObj": {
"regionID": "81f7728662dd11ec810800155d307d5b",
"isMultiZones": false,
"regionParent": "河北",
"regionName": "保定资源池",
"regionType": "openstack",
"cpuArches": [
"x86_64"
],
"regionVersion": "v4.0",
"dedicated": false,
"province": "河北",
"openapiAvailable": true
},
"statusCode": 800,
"message": "",
"description": "",
"errorCode": ""
}
失败响应示例：
{
"errorCode": "Unknown.Region.RegionIDError",
"error": "Unknown.Region.RegionIDError",
"details": "",
"message": "Not found region by ID, check the ID and contact the admin",
"description": "没找到该资源池，请检查资源池ID是否正确，如资源池ID无误请联系管理员",
"statusCode": 900
}
状态码
请参考 状态码
错误码
请参考 错误码
