接口功能介绍
查询RDS可用区资源信息。
接口约束
无
URI
GET /v1/open-api/instance/describe-available-zones
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionName | 是 | String | 区域名称,需通过urlEncode编码 | 安徽 | |
accountId | 是 | String | 账户id | testaccount001 | |
zoneId | 否 | String | 可用区id | cn-ahwh1 | |
engineVersion | 否 | String | 引擎版本,可选 5.7 或 8.0 | 8.0 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | success | |
returnObj | 是 | Object | 返回对象 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionName | 是 | String | 区域名称 | 安徽 | |
zoneId | 是 | String | 可用区id | cn-ahwh1 | |
zoneName | 是 | String | 可用区名称 | 芜湖 | |
zoneUrl | 是 | String | 可用区URL | ||
supportedEngineVersions | 是 | Array of Objects | 支持的引擎版本列表 | engineVersion |
表 engineVersion
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
version | 是 | String | 引擎版本 | 8.0 | |
supportedProducts | 是 | Array of Objects | 支持的产品信息 | supportedProduct |
表 supportedProduct
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
productVersion | 是 | String | 产品版本 | highAvailability | |
productVersionText | 是 | String | 产品版本名称 | 主备版 | |
diskType | 是 | Array of Strings | 硬盘类型 |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": [
{
"regionName": "安徽",
"supportedEngineVersions": [
{
"supportedProducts": [
{
"productVersion": "highAvailability",
"productVersionText": "主备版",
"diskType": [
"SATA"
]
},
{
"productVersion": "advanced",
"productVersionText": "一主两备版",
"diskType": [
"SATA"
]
},
{
"productVersion": "basic",
"productVersionText": "单机版",
"diskType": [
"SATA"
]
}
],
"version": "8.0"
}
],
"zoneId": "cn-ahwh1",
"zoneName": "芜湖",
"zoneUrl": "https://console2.ctyun.cn/console/?region=cn-ahwh1#/home"
}
]
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
状态码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |