该接口用于查询RDS的可用区资源。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
- RDS MariaDB
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:DescribeAvailableZones | READ |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域ID。可调用DescribeRegions获取。 | cn-hangzhou |
Engine | string | 是 | 数据库类型。取值:
| MySQL |
ZoneId | string | 否 | 可用区ID。多可用区的格式与单可用区不同,包含 | cn-hangzhou-e |
EngineVersion | string | 否 | 数据库版本。取值:
| 8.0 |
CommodityCode | string | 否 | 当前实例的商品码。根据输入的商品码查询可售卖的资源。取值:
| bards |
DispenseMode | string | 否 | 是否返回支持单可用区部署功能的可用区列表。取值:
说明单可用区部署功能支持将三节点企业版实例安装到单个可用区中。 | 0 |
DBInstanceName | string | 否 | 主实例ID。查询该主实例下可售卖的只读实例资源。 CommodityCode参数为如下值时必填:
| rm-uf6wjk5**** |
Category | string | 否 | 实例系列,取值:
| HighAvailability |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4256E149-C3C4-4FA7-BDEA-13CA415E8763",
"AvailableZones": [
{
"ZoneId": "cn-hangzhou-e",
"RegionId": "cn-hangzhou",
"SupportedEngines": [
{
"Engine": "MySQL",
"SupportedEngineVersions": [
{
"Version": "8.0",
"SupportedCategorys": [
{
"Category": "HighAvailability",
"SupportedStorageTypes": [
{
"StorageType": "local_ssd"
}
]
}
]
}
]
}
]
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ArticleNotFound | Article not found | 没有找到相关约束 |
404 | InvalidDBInstanceName.NotFound | DBInstanceName not found | - |
访问错误中心查看更多错误码。