资源池可用区查询
接口功能介绍
查询单个资源池的可用区信息
接口约束
仅对支持多可用区的资源池有效
请求定义
URI
GET /v4/region/get-zones
路径参数
无
请求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
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
zoneList | 是 | Array of Objects | 可用区列表 | 可用区列表项 |
可用区列表项
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 可用区名称,其他需要可用区参数的接口需要依赖该名称结果 | ||
azDisplayName | 是 | String | 可用区展示名 |
请求示例
请求头header
无
请求体body
{
"regionID": "a4e1e8ca370a11ec9d650242ac11000a"
}
响应示例
成功响应示例
{
"statusCode": 800,
"message": "success",
"returnObj": {
"zoneList":[
{
"name": "az1",
"azDisplayName": "西北-内蒙演示1"
},
{
"name": "az2",
"azDisplayName": "西北-内蒙演示2"
}
]
}
}
失败响应示例
{
"errorCode": "Unknown.Parameter.Invaliderror",
"details": "",
"message": "request param error: regionID is required",
"description": "请求参数错误: 缺少regionID字段",
"statusCode": 900
}
接口错误码
errorCode | 含义 |
---|---|
Unknown.Parameter.Invaliderror | 请求参数错误: 缺少regionID字段 |
Unknown.Region.RegionIDError | 没找到该资源池,请检查资源池ID是否正确 |