调用DescribeCenRouteMaps接口查询路由策略信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeCenRouteMaps |
系统规定参数。取值:DescribeCenRouteMaps。 |
| PageNumber | Integer | 否 | 1 |
列表的页码。默认值:1。 |
| PageSize | Integer | 否 | 10 |
分页查询时每页显示的条目数。默认值:10。 |
| CenId | String | 是 | cen-wx12mmlt17ld82**** |
云企业网实例ID。 |
| RouteMapId | String | 否 | cenrmap-y40mxdvf7joc12**** |
路由策略ID。 |
| CenRegionId | String | 否 | cn-hangzhou |
路由策略应用的地域ID。 您可以通过调用DescribeChildInstanceRegions接口获取地域ID。 |
| TransmitDirection | String | 否 | RegionOut |
路由策略的应用方向。取值:
|
| TransitRouterRouteTableId | String | 否 | vtb-gw8nx3515m1mbd1z1**** |
路由策略关联的转发路由器路由表ID。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PageSize | Integer | 10 |
分页查询时每页显示的条目数。 |
| RequestId | String | 24CE1987-D1D1-5324-9BAD-2750B60E6ABB |
请求ID。 |
| PageNumber | Integer | 1 |
列表的页码。 |
| TotalCount | Integer | 1 |
列表条目数。 |
| RouteMaps | Array of RouteMap |
路由策略信息列表。 |
|
| RouteMap | |||
| RouteMapId | String | cenrmap-y40mxdvf7joc12**** |
路由策略ID。 |
| Status | String | Active |
路由策略的状态。
|
| TransmitDirection | String | RegionOut |
路由策略的应用方向。 |
| SourceInstanceIdsReverseMatch | Boolean | false |
是否使用了源实例ID列表的排除匹配模式。
|
| CenRegionId | String | cn-hangzhou |
路由策略应用的地域ID。 |
| CenId | String | cen-wx12mmlt17ld82**** |
云企业网实例ID。 |
| Priority | Integer | 5000 |
路由策略的优先级。优先级数字越小,代表优先级越高。 |
| TransitRouterRouteTableId | String | vtb-gw8nx3515m1mbd1z1**** |
路由策略关联的转发路由器路由表ID。 |
| CommunityOperateMode | String | Additive |
Community的执行模式。
本参数表示路由通过匹配条件后,要执行的操作。 |
| MapResult | String | Deny |
所有匹配条件都通过后的策略行为。
|
| CommunityMatchMode | String | Include |
Community的匹配模式。
|
| Description | String | desctest |
路由策略的描述信息。 |
| AsPathMatchMode | String | Include |
AS Path列表的匹配模式。
|
| Preference | Integer | 20 |
要修改的路由的优先级。 优先级数字越小表示优先级越高。 本参数表示路由通过匹配条件后,要执行的操作。 |
| DestinationInstanceIdsReverseMatch | Boolean | false |
是否使用了目的实例ID列表的排除匹配模式。
|
| CidrMatchMode | String | Include |
前缀列表的匹配模式。取值:
|
| NextPriority | Integer | 33 |
关联的下一条路由策略的优先级。 |
| MatchAddressType | String | IPv4 |
路由需匹配的IP地址类型。
|
| SourceRegionIds | Array of String | cn-hangzhou |
路由需匹配的源地域ID列表。 |
| SourceChildInstanceTypes | Array of String | VPC |
路由需匹配的源实例类型列表。
|
| DestinationRouteTableIds | Array of String | vtb-adefrgtr144vf**** |
路由需匹配的目的路由表ID列表。最多支持输入32个路由表ID。 说明 仅路由策略的应用方向为出地域网关方向,且目的路由表ID为本地域下网络实例的路由表ID时,目的路由表ID列表才会生效。
|
| SourceInstanceIds | Array of String | vpc-adeg3544fdf34vf**** |
路由需匹配的源实例ID列表。 |
| DestinationCidrBlocks | Array of String | 10.10.10.0/24 |
路由需匹配的前缀列表。 |
| SourceRouteTableIds | Array of String | vtb-adfr233vf34rvd4**** |
路由需匹配的源路由表ID列表。 |
| MatchCommunitySet | Array of String | 65501:1 |
路由需匹配的Community集合。 |
| PrependAsPath | Array of String | 65501 |
地域网关接收或发布路由时附加的AS Path。 本参数表示路由通过匹配条件后,要执行的操作。 |
| RouteTypes | Array of String | System |
路由需匹配的路由类型列表。
|
| DestinationChildInstanceTypes | Array of String | VPC |
路由需匹配的目的实例类型列表。
说明 仅路由策略的应用方向为出地域网关方向,且目的实例类型为本地域下的实例类型时,目的实例类型列表才会生效。
|
| DestinationInstanceIds | Array of String | vpc-afrfs434465fdf**** |
路由需匹配的目的实例ID列表。 说明 仅路由策略的应用方向为出地域网关方向,且目的实例ID为本地域下的实例ID时,目的实例ID列表才会生效。
|
| MatchAsns | Array of String | 65501 |
路由需匹配的AS Path列表。 |
| OperateCommunitySet | Array of String | 65501:1 |
要执行的Community集合。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeCenRouteMaps
&PageNumber=1
&PageSize=10
&CenId=cen-wx12mmlt17ld82****
&RouteMapId=cenrmap-y40mxdvf7joc12****
&CenRegionId=cn-hangzhou
&TransmitDirection=RegionOut
&TransitRouterRouteTableId=vtb-gw8nx3515m1mbd1z1****
&公共请求参数
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeCenRouteMapsResponse>
<TotalCount>1</TotalCount>
<RequestId>24CE1987-D1D1-5324-9BAD-2750B60E6ABB</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<RouteMaps>
<RouteMap>
<Status>Active</Status>
<TransitRouterRouteTableId>vtb-gw8nx3515m1mbd1z1****</TransitRouterRouteTableId>
<Priority>5000</Priority>
<SourceChildInstanceTypes>
<SourceChildInstanceType>VBR</SourceChildInstanceType>
<SourceChildInstanceType>CCN</SourceChildInstanceType>
</SourceChildInstanceTypes>
<CenId>cen-wx12mmlt17ld82****</CenId>
<TransmitDirection>RegionOut</TransmitDirection>
<CenRegionId>cn-hangzhou</CenRegionId>
<RouteMapId>cenrmap-y40mxdvf7joc12****</RouteMapId>
<MapResult>Deny</MapResult>
<DestinationChildInstanceTypes>
<DestinationChildInstanceType>VBR</DestinationChildInstanceType>
<DestinationChildInstanceType>CCN</DestinationChildInstanceType>
</DestinationChildInstanceTypes>
</RouteMap>
</RouteMaps>
</DescribeCenRouteMapsResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 1,
"RequestId" : "24CE1987-D1D1-5324-9BAD-2750B60E6ABB",
"PageSize" : 10,
"PageNumber" : 1,
"RouteMaps" : {
"RouteMap" : [ {
"Status" : "Active",
"TransitRouterRouteTableId" : "vtb-gw8nx3515m1mbd1z1****",
"Priority" : 5000,
"SourceChildInstanceTypes" : {
"SourceChildInstanceType" : [ "VBR", "CCN" ]
},
"CenId" : "cen-wx12mmlt17ld82****",
"TransmitDirection" : "RegionOut",
"CenRegionId" : "cn-hangzhou",
"RouteMapId" : "cenrmap-y40mxdvf7joc12****",
"MapResult" : "Deny",
"DestinationChildInstanceTypes" : {
"DestinationChildInstanceType" : [ "VBR", "CCN" ]
}
} ]
}
}
错误码
访问错误中心查看更多错误码。