ListTransitRouterCidr - 查询转发路由器下CIDR地址段 - 云企业网

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

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cen:ListTransitRouterCidr	get	TransitRouter acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}	无	无

请求参数

名称	类型	必填	描述	示例值
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426****
TransitRouterId	string	是	转发路由器实例 ID。	tr-p0w3x8c9em72a40nw****
TransitRouterCidrId	string	否	转发路由器地址段 ID。	cidr-0zv0q9crqpntzz****
RegionId	string	是	转发路由器实例所属的地域 ID。您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。	cn-hangzhou
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会查询转发路由器已添加的地址段。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后直接查询转发路由器下已添加的地址段。	false

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	0876E54E-3E36-5C31-89F0-9EE8A9266F9A
CidrLists	array<object>	转发路由器地址段列表。
CidrLists	object	转发路由器地址段信息。
TransitRouterCidrId	string	转发路由器地址段 ID。	cidr-0zv0q9crqpntzz****
Family	string	转发路由器地址段类型。仅取值：IPv4，表示转发路由器地址段为 IPv4 类型的地址段。	IPv4
Name	string	转发路由器地址段的名称。	nametest
Description	string	转发路由器地址段的描述信息。	desctest
Cidr	string	转发路由器地址段。	192.168.10.0/24
PublishCidrRoute	boolean	是否允许系统自动在转发路由器路由表中添加转发路由器地址段的路由。 true：允许。如果当前参数的返回值为 true，则在您创建了私网网关类型的 VPN 连接，并为私网网关类型的 VPN 连接创建了路由学习关系后，系统自动在与 VPN 连接建立路由学习关系的转发路由器路由表中添加一条路由条目：目标网段为转发路由器地址段的黑洞路由，其中转发路由器地址段指已为 IPsec 连接分配网关 IP 地址的地址段。该黑洞路由仅会被传播至转发路由器下 VBR 实例的路由表中。 false：不允许。	true
TransitRouterId	string	转发路由器实例 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	错误码	错误信息	描述
400	InvalidParameter	Invalid parameter.	参数不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	账号无权限操作。

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

变更历史

变更时间	变更内容概要	操作
2023-01-04	API 内部配置变更，不影响调用	查看变更详情