查询企业版转发路由器路由表中的路由条目信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:ListTransitRouterRouteEntries | List |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MaxResults | integer | 否 |
分批次查询时,每次显示的条目数。取值范围:1~100。默认值:20。 |
20 |
TransitRouterRouteEntryDestinationCidrBlock | string | 否 |
路由条目的目标网段。 |
192.168.0.0/24 |
TransitRouterRouteEntryStatus | string | 否 |
路由条目的状态。取值:
|
Active |
TransitRouterRouteTableId | string | 是 |
企业版转发路由器路由表ID。 |
vtb-bp1dudbh2d5na6b50**** |
NextToken | string | 否 |
是否拥有下一次查询的令牌(Token)。取值:
|
fce19**** |
TransitRouterRouteEntryNames | array | 否 |
路由条目的名称。 名称长度为0~128个字符,可包含英文字母、数字、中文、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。 一次最多支持查询20条路由条目的信息。
说明
系统仅支持通过本参数查询静态配置的路由。
|
|
string | 否 |
路由条目的名称。 名称长度为0~128个字符,可包含英文字母、数字、中文、半角逗号(,)、半角句号(.)、半角分号(;)、正斜线(/)、at(@)、下划线(_)和短划线(-)。 一次最多支持查询20条路由条目的信息。
说明
系统仅支持通过本参数查询静态配置的路由。
|
testname | |
TransitRouterRouteEntryIds | array | 否 |
路由条目ID。 一次最多支持查询20条路由条目的信息。
说明
系统仅支持通过本参数查询静态配置的路由。
|
|
string | 否 |
路由条目ID。 一次最多支持查询20条路由条目的信息。
说明
系统仅支持通过本参数查询静态配置的路由。
|
rte-oklkgwmj97z6dn**** |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "fce19****",
"RequestId": "C3835E5E-1504-4344-B1BB-98A4110F1079",
"TotalCount": 6,
"MaxResults": 20,
"TransitRouterRouteEntries": [
{
"TransitRouterRouteEntryId": "rte-oklkgwmj97z6dn****",
"TransitRouterRouteEntryDestinationCidrBlock": "192.168.0.0/24",
"TransitRouterRouteEntryType": "Static",
"CreateTime": "2021-06-15T07:01Z",
"TransitRouterRouteEntryName": "testname",
"TransitRouterRouteEntryStatus": "Active",
"TransitRouterRouteEntryNextHopType": "BlackHole",
"TransitRouterRouteEntryNextHopId": "tr-attach-vx6iwhjr1x1j78****",
"TransitRouterRouteEntryDescription": "CidrRoute",
"OperationalMode": true,
"Tag": "PermitVbr"
}
]
}
错误码
Http code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalParam.TransitRouterRouteTableId | TransitRouterRouteTableId is illegal. | 参数中指定的TransitRouterRouteTableId不合法。 |
400 | IllegalParam.TransitRouterRouteEntryStatus | TransitRouterRouteEntryStatus is illegal. | 参数中指定的TransitRouterRouteEntryStatus不合法。 |
400 | IllegalParam.NextToken | NextToken is illegal. | 参数中指定的NextToken不合法。 |
400 | ParamExclusive.RouteEntryIdsAndStatus | TransitRouterRouteEntryIds and TransitRouterRouteEntryStatus is mutually exclusive. | TransitRouterRouteEntryIds和TransitRouterRouteEntryStatus参数互斥。 |
400 | InvalidTransitRouterRouteTableId.NotFound | TransitRouterRouteTableId is not found. | 转发路由器路由表实例ID未找到。 |
404 | InvalidRouteTableId.NotFound | The specified RouteTableId is not found. | RouteTableId不存在。 |
访问错误中心查看更多错误码。