查询企业版转发路由器路由表下的聚合路由。

接口说明

使用说明

您可以通过指定TransitRouteTableId参数和TransitRouteTableAggregationCidr参数的值，查询指定聚合路由的信息。如果您仅指定了TransitRouteTableId参数的值，则系统默认查询该企业版转发路由器路由表下所有聚合路由的信息。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
cen:DescribeTransitRouteTableAggregation	Read	CEN acs:cen::{#accountId}:transitrouterrouteentry/{#TransitRouterRouteEntryId} CEN acs:cen::{#accountId}:transitrouterroutetable/{#TransitRouterRouteTableId}	无	无

请求参数

名称	类型	必填	描述	示例值
TransitRouteTableId	string	是	企业版转发路由器路由表ID。	vtb-6ehgc262hr170qgyc****
TransitRouteTableAggregationCidr	string	否	聚合路由的目标网段。	192.168.10.0/24
ClientToken	string	否	客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。	02fb3da4-130e-11e9-8e44-001****
MaxResults	long	否	分批次查询时每次显示的条目数。默认值：20。	20
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次API调用返回的NextToken值。	FFmyTO70tTpLG6I3FmYAXGKPd****

返回参数

名称	类型	描述	示例值
	object	返回结果。
Data	array	聚合路由信息列表。
	object	聚合路由信息。
Name	string	聚合路由的名称。	nametest
TransitRouteTableAggregationCidr	string	聚合路由的目标网段。	192.168.10.0/24
Scope	string	聚合路由的传播范围。仅取值：VPC，表示向已与当前企业版转发路由器路由表创建关联转发关系并已开启路由同步功能的所有VPC实例传播聚合路由。	VPC
RouteType	string	聚合路由的路由类型。仅取值：Static，表示静态路由。聚合路由被传播至VPC实例后，默认为自定义路由条目。	Static
Description	string	聚合路由的描述信息。	desctest
TrRouteTableId	string	企业版转发路由器路由表ID。	vtb-6ehgc262hr170qgyc****
Status	string	聚合路由的传播状态。 AllConfigured：聚合路由已下发至全部VPC实例。 Configuring：聚合路由下发中。 ConfigFailed：聚合路由下发失败。 PartialConfigured：聚合路由部分下发失败。 Deleting：聚合路由删除中。	AllConfigured
Count	integer	分批次查询时每次显示的条目数。	20
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果NextToken为空表示没有下一次查询。如果NextToken有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
Total	integer	列表条目数。	1
RequestId	string	请求ID。	0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

示例

正常返回示例

JSON格式

{
  "Data": [
    {
      "Name": "nametest",
      "TransitRouteTableAggregationCidr": "192.168.10.0/24",
      "Scope": "VPC",
      "RouteType": "Static",
      "Description": "desctest",
      "TrRouteTableId": "vtb-6ehgc262hr170qgyc****",
      "Status": "AllConfigured"
    }
  ],
  "Count": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "Total": 1,
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParam.transitRouterRouteTableId	Missing the parameter transitRouter route table id.	缺少参数transitRouterRouteTableId。
400	IllegalParam.NextToken	The nextToken is illegal.	参数中指定的NextToken不合法。
400	InstanceNotExist.TransitRouterRouteTable	The transitRouter route table is not found.	-
400	InvalidParameter	Invalid parameter.	参数不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	账号无权限操作。

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

变更历史

变更时间

变更内容概要

操作

2023-03-22

OpenAPI 错误码发生变更

变更项	变更内容
错误码	OpenAPI 错误码发生变更
	错误码 400 变更