调用ListTransitRouterCidr接口查询转发路由器实例下已添加的地址段。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListTransitRouterCidr

系统规定参数。取值：ListTransitRouterCidr。

ClientToken String 否 123e4567-e89b-12d3-a456-426****

客户端Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
TransitRouterId String 是 tr-p0w3x8c9em72a40nw****

转发路由器实例ID。
TransitRouterCidrId String 否 cidr-0zv0q9crqpntzz****

转发路由器地址段ID。
RegionId String 是 ap-southeast-2

转发路由器实例所属的地域ID。

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

DryRun Boolean 否 false

是否只预检此次请求。取值：

  • true：发送检查请求，不会查询转发路由器已添加的地址段。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后直接查询转发路由器下已添加的地址段。

返回数据

名称 类型 示例值 描述
RequestId String 0876E54E-3E36-5C31-89F0-9EE8A9266F9A

请求ID。
CidrLists Array of CidrLists

转发路由器地址段列表。
TransitRouterCidrId String cidr-0zv0q9crqpntzz****

转发路由器地址段ID。
Family String IPv4

转发路由器地址段类型。

仅取值：IPv4，表示转发路由器地址段为IPv4类型的地址段。

Name String nametest

转发路由器地址段的名称。
Description String desctest

转发路由器地址段的描述信息。
Cidr String 192.168.10.0/24

转发路由器地址段。
PublishCidrRoute Boolean true

是否允许系统自动在转发路由器路由表中添加转发路由器地址段的路由。

  • true：允许。

    如果当前参数的返回值为true，则在您创建了私网网关类型的VPN连接，并为私网网关类型的VPN连接创建了路由学习关系后，系统自动在与VPN连接建立路由学习关系的转发路由器路由表中添加一条路由条目：

    目标网段为转发路由器地址段的黑洞路由，其中转发路由器地址段指已为IPsec连接分配网关IP地址的地址段。

    该黑洞路由仅会被传播至转发路由器下VBR实例的路由表中。

  • false：不允许。
TransitRouterId String tr-p0w3x8c9em72a40nw****

转发路由器实例ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTransitRouterCidr
&ClientToken=123e4567-e89b-12d3-a456-426****
&TransitRouterId=tr-p0w3x8c9em72a40nw****
&TransitRouterCidrId=cidr-0zv0q9crqpntzz****
&RegionId=ap-southeast-2
&DryRun=false
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTransitRouterCidrResponse>
    <RequestId>0876E54E-3E36-5C31-89F0-9EE8A9266F9A</RequestId>
    <CidrLists>
        <TransitRouterCidrId>cidr-0zv0q9crqpntzz****</TransitRouterCidrId>
        <Family>IPv4</Family>
        <Name>nametest</Name>
        <Description>desctest</Description>
        <Cidr>192.168.10.0/24</Cidr>
        <PublishCidrRoute>true</PublishCidrRoute>
        <TransitRouterId>tr-p0w3x8c9em72a40nw****</TransitRouterId>
    </CidrLists>
</ListTransitRouterCidrResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0876E54E-3E36-5C31-89F0-9EE8A9266F9A",
  "CidrLists" : [ {
    "TransitRouterCidrId" : "cidr-0zv0q9crqpntzz****",
    "Family" : "IPv4",
    "Name" : "nametest",
    "Description" : "desctest",
    "Cidr" : "192.168.10.0/24",
    "PublishCidrRoute" : true,
    "TransitRouterId" : "tr-p0w3x8c9em72a40nw****"
  } ]
}

错误码

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