接口功能介绍
查询当前可选RDS地域和可用区信息。
接口约束
无
URI
GET /v1/open-api/instance/describe-regions
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
accountId | 是 | String | 账户ID | testaccount001 |
Query参数
无
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码 | 0 | |
message | 是 | String | 返回消息 | success | |
returnObj | 是 | Array of Objects | 返回对象 | region |
表 region
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionName | 是 | String | 区域名称 | 安徽 | |
zoneList | 是 | Array of Objects | 可用区列表 | zone |
表 zone
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
parentName | 是 | String | 所属区域名称 | 安徽 | |
zoneId | 是 | String | 可用区id | cn-ahwh1 | |
zoneName | 是 | String | 可用区名称 | 芜湖 | |
zoneUrl | 是 | String | 可用区URL |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"opMessage": null,
"returnObj": [
{
"zoneList": [
{
"parentName": "安徽",
"zoneId": "cn-ahwh1",
"zoneName": "芜湖",
"zoneUrl": "https://console2.ctyun.cn/console/?region=cn-ahwh1#/home"
}
],
"regionName": "安徽"
},
{
"zoneList": [
{
"parentName": "北京",
"zoneId": "d15ff6c8f92011e4a2fbe2ad47403cef",
"zoneName": "北京1",
"zoneUrl": "http://www.ctyun.cn/v3control?zoneId=d15ff6c8f92011e4a2fbe2ad47403cef"
},
{
"parentName": "北京",
"zoneId": "cn-bj1",
"zoneName": "北京2",
"zoneUrl": "https://console2.ctyun.cn/console/?region=cn-bj1#/home"
},
],
"regionName": "北京"
}
]
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
状态码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |