文档

ListTransitRouterCidr - 查询转发路由器下CIDR地址段

更新时间:

调用ListTransitRouterCidr接口查询转发路由器下CIDR地址段的信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:ListTransitRouterCidrRead
  • TransitRouter
    acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

请求参数

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

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 可能不一样。
123e4567-e89b-12d3-a456-426****
TransitRouterIdstring

转发路由器实例 ID。

tr-p0w3x8c9em72a40nw****
TransitRouterCidrIdstring

转发路由器地址段 ID。

cidr-0zv0q9crqpntzz****
RegionIdstring

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

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

ap-southeast-2
DryRunboolean

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

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

0876E54E-3E36-5C31-89F0-9EE8A9266F9A
CidrListsobject []

转发路由器地址段列表。

TransitRouterCidrIdstring

转发路由器地址段 ID。

cidr-0zv0q9crqpntzz****
Familystring

转发路由器地址段类型。

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

IPv4
Namestring

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

nametest
Descriptionstring

转发路由器地址段的描述信息。

desctest
Cidrstring

转发路由器地址段。

192.168.10.0/24
PublishCidrRouteboolean

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

  • true:允许。

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

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

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

  • false:不允许。

true
TransitRouterIdstring

转发路由器实例 ID。

tr-p0w3x8c9em72a40nw****

示例

正常返回示例

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****"
    }
  ]
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-01-04API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈