文档

ListTransitRouterAvailableResource - 查询指定地域下企业版转发路由器支持的可用区信息

更新时间:

调用ListTransitRouterAvailableResource接口查询指定地域下企业版转发路由器支持的可用区信息。

接口说明

  • 您可以调用 ListTransitRouterAvailableResource 接口查询指定地域下企业版转发路由器支持的普通可用区的信息或者支持的组播功能的可用区的信息。
    • 如果您未指定 SupportMulticast 参数的值为 true,则系统默认只查询企业版转发路由器支持的普通可用区的信息。
    • 如果您指定 SupportMulticast 参数的值为 true,则系统只查询企业版转发路由器支持的组播功能的可用区的信息。
  • 2022 年 05 月 31 日云企业网对企业版转发路由器连接专有网络 VPC(Virtual Private Cloud)的模式进行了优化升级,升级后的企业版转发路由器连接 VPC 实例时无需指定主备可用区,可任意指定一个或多个可用区。
    • 如果您的企业版转发路由器未经历过升级,在企业版转发路由器连接 VPC 实例时,您需要指定主备可用区。调用 ListTransitRouterAvailableResource 接口后可以通过 MasterZonesSlaveZones 参数获取主备可用区的信息。
    • 如果您的企业版转发路由器经历过升级,在企业版转发路由器连接 VPC 实例时,您可以指定任意的可用区。调用 ListTransitRouterAvailableResource 接口后可通过 AvailableZones 参数获取企业版转发路由器支持的可用区的信息。

关于企业版转发路由器升级的信息,请参见企业版转发路由器连接 VPC 模式升级

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

企业版转发路由器所属的地域 ID。

您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。

cn-hangzhou
SupportMulticastboolean

是否只查询支持组播功能的可用区的信息。

  • true:是。

    开启查询功能后,如果 ListTransitRouterAvailableResource 接口返回结果为空,则表示当前地域的企业版转发路由器不支持组播功能。

  • false(默认值):否。

false

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

B4F480E0-4E76-5E43-9966-8322C28A158A
SlaveZonesarray

备可用区 ID 列表。

string

备可用区 ID 列表。

您可以调用 DescribeZones 接口查询可用区 ID 对应的可用区的信息。

cn-hangzhou
MasterZonesarray

主可用区 ID 列表。

string

主可用区 ID。

cn-hangzhou-h
AvailableZonesarray

可用区 ID 列表。

string

可用区 ID。

cn-hangzhou-i
SupportMulticastboolean

是否为支持组播功能的可用区信息。

false

示例

正常返回示例

JSON格式

{
  "RequestId": "B4F480E0-4E76-5E43-9966-8322C28A158A",
  "SlaveZones": [
    "cn-hangzhou"
  ],
  "MasterZones": [
    "cn-hangzhou-h"
  ],
  "AvailableZones": [
    "cn-hangzhou-i"
  ],
  "SupportMulticast": false
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-22OpenAPI 描述信息更新看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
2023-11-22API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-03-09OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-08-25OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更