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