查询指定地域下、指定产品类型和操作系统类型当前可选的可用区 ID 列表。
接口说明
使用说明
本接口根据地域、产品类型和操作系统类型,返回当前阿里云账号可选择的可用区 ID 列表。典型用途是在创建需要指定交换机(vSwitch)的资源前,先确认哪些可用区可选,再选择位于这些可用区内的交换机。
本接口仅查询信息,不创建资源、不产生费用。
使用前提
使用 RAM 用户或 STS 凭证调用时,需要具备
appstreaming:ListAppInstanceType权限;权限不足时返回错误码Forbidden.NoPermission。ProductType、BizRegionId和OsType均为必填。 任一参数缺失、为空,或取值无法识别时,返回错误码InvalidParameter.ValueInvalid。BizRegionId必须是无影云应用支持的地域 ID,可先调用 ListRegions 获取。
调用顺序
调用 ListRegions 获取支持的地域 ID。
以该地域 ID、目标产品类型和操作系统类型调用本接口,读取返回的
ListZonesModel.Zones。创建资源并需要指定交换机时,选择位于返回可用区内的交换机;例如调用 CreateAppInstanceGroup 或 CreateWuyingServer 时传入对应的交换机 ID。
返回的可用区列表由当前地域内可用资源决定,可能随时间变化,建议在创建资源前实时查询,不要长期缓存。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProductType |
string |
是 |
产品类型,必填。用于指定要查询可用区的产品,可用区列表按该产品在指定地域内的可用资源返回。取值不区分大小写,建议按以下写法传入。 取值:
枚举值:
|
CloudApp |
| BizRegionId |
string |
是 |
地域 ID,必填。指定要查询可用区的地域,返回的可用区均位于该地域内。 取值必须是无影云应用支持的地域 ID,可以调用 ListRegions 查询;传入不支持的地域时返回错误码 |
cn-hangzhou |
| OsType |
string |
是 |
操作系统类型,必填。指定资源所使用的操作系统,与 取值:
枚举值:
|
Windows |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
本次查询的结果,包括请求 ID 和可选可用区列表。 |
||
| ListZonesModel |
object |
可用区查询结果。 |
|
| Zones |
array |
当前地域内,指定产品类型和操作系统类型可选的可用区 ID 列表。创建资源并指定交换机时,请选择位于这些可用区内的交换机。 |
|
|
string |
可用区 ID,由地域 ID 加可用区字母后缀组成,例如 |
cn-hangzhou-h |
|
| RequestId |
string |
本次请求的唯一标识,可用于定位请求问题。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
示例
正常返回示例
JSON格式
{
"ListZonesModel": {
"Zones": [
"cn-hangzhou-h"
]
},
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。