Queries the routing policies of a Cloud Enterprise Network (CEN) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCenRouteMaps

The operation that you want to perform. Set the value to DescribeCenRouteMaps.

PageNumber Integer No 1

The page number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10.

CenId String Yes cen-wx12mmlt17ld82****

The ID of the CEN instance.

RouteMapId String No cenrmap-y40mxdvf7joc12****

The ID of the routing policy.

CenRegionId String No cn-hangzhou

The ID of the region where the routing policy is applied.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

TransmitDirection String No RegionOut

The direction in which the routing policy is applied. Valid values:

  • RegionIn: Routes are advertised to the gateways in the regions that are connected by the CEN instance.

    For example, routes are advertised from network instances deployed in the current region or other regions to the gateway deployed in the current region.

  • RegionOut: Routes are advertised from the gateways in the regions that are connected by the CEN instance.

    For example, routes are advertised from the gateway deployed in the current region to network instances deployed in the same region, or to gateways deployed in other regions.

TransitRouterRouteTableId String No vtb-gw8nx3515m1mbd1z1****

The route table ID of the transit router with which the routing policy is associated.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

RequestId String 24CE1987-D1D1-5324-9BAD-2750B60E6ABB

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The number of entries returned.

RouteMaps Array of RouteMap

The information about the routing policy.

RouteMap
RouteMapId String cenrmap-y40mxdvf7joc12****

The ID of the routing policy.

Status String Active

The status of the routing policy. Valid values:

  • Creating: being created
  • Active: available
  • Deleting: being deleted
TransmitDirection String RegionOut

The direction in which the routing policy is applied.

SourceInstanceIdsReverseMatch Boolean false

Indicates whether the source network instance IDs are excluded.

  • false (default value): A route is a match if its source network instance ID is in the list specified by SourceInstanceIds.N.
  • true: A route is match if its source network instance ID is not in the list specified by SourceInstanceIds.N.
CenRegionId String cn-hangzhou

The ID of the region where the routing policy is applied.

CenId String cen-wx12mmlt17ld82****

The ID of the CEN instance.

Priority Integer 5000

The priority of the routing policy. A smaller value indicates a higher priority.

TransitRouterRouteTableId String vtb-gw8nx3515m1mbd1z1****

The route table ID of the transit router with which the routing policy is associated.

CommunityOperateMode String Additive

The action that is performed on the community of the route.

  • Additive: adds the community to the route.
  • Replace: replaces the original community of the route.

This parameter specifies the action to be performed when a route meets the match condition.

MapResult String Deny

The action performed on a route that meets the match conditions.

  • Permit: the route is permitted.
  • Deny: the route is denied.
CommunityMatchMode String Include

The match method that is used to match routes based on the community.

  • Include: fuzzy match. A route is a match if the community of the route overlaps with the community specified in the match condition.
  • Complete: exact match. A route is a match only if the community of the route is the same as the community specified in the match condition.
Description String desctest

Enter a description for the routing policy.

AsPathMatchMode String Include

The match method that is used to match routes based on the AS path.

  • Include: fuzzy match. A route is a match if the AS path of the route overlaps with the AS path specified in the match condition.
  • Complete: exact match. A route is a match only if the AS path of the route is the same as the AS path specified in the match condition.
Preference Integer 20

The new priority of the route.

A smaller value indicates a higher priority.

This parameter specifies the action to be performed when a route meets the match condition.

DestinationInstanceIdsReverseMatch Boolean false

Indicates whether the destination network instance IDs are excluded.

  • false (default value): A route is a match if its destination network instance ID is in the list specified by DestinationInstanceIds.N.
  • true: A route is a match if its destination network instance ID is not in the list specified by DestinationInstanceIds.N.
CidrMatchMode String Include

The match method that is used to match routes based on the prefix. Valid values:

  • Include: fuzzy match. A route is a match if the route prefix is included in the match conditions.

    For example, if you set the match condition to 10.10.0.0/16 and fuzzy match is enabled, the route whose prefix is 10.10.1.0/24 is a match.

  • Complete: exact match. A route is a match only if the route prefix is the same as the prefix specified in the match condition.

    For example, if you set the match condition to 10.10.0.0/16 and exact match is enabled, a route is a match only if the prefix is 10.10.0.0/16.

NextPriority Integer 33

Specify a priority for the routing policy that you want to associate with the current one.

SourceRegionIds Array of String cn-hangzhou

The IDs of the source regions to which the routes belong.

SourceChildInstanceTypes Array of String VPC

The types of source network instances to which the routes belong.

  • VPC: virtual private cloud (VPC)
  • VBR: virtual border router (VBR)
  • CCN: Cloud Connect Network (CCN) instance
DestinationRouteTableIds Array of String vtb-adefrgtr144vf****

The IDs of the destination route tables to which the routes belong. You can enter at most 32 route table IDs.

Note The destination route table IDs are valid only when the routing policy is applied to scenarios where routes are advertised from the gateway in the current region to route tables in the current region.
SourceInstanceIds Array of String vpc-adeg3544fdf34vf****

The IDs of the source network instances to which the routes belong.

DestinationCidrBlocks Array of String 10.10.10.0/24

The prefixes of the routes.

SourceRouteTableIds Array of String vtb-adfr233vf34rvd4****

The IDs of the source route tables to which the routes belong.

MatchCommunitySet Array of String 65501:1

The community set based on which the routes are compared.

PrependAsPath Array of String 65501

The AS paths that are prepended by using an action statement when regional gateways receive or advertise routes.

This parameter specifies the action to be performed when a route meets the match condition.

RouteTypes Array of String System

The type of route that is compared. Valid values:

  • System: system routes that are automatically generated by the system.
  • Custom: custom routes that are manually added.
  • BGP: routes that are advertised over Border Gateway Protocol (BGP).
DestinationChildInstanceTypes Array of String VPC

The types of destination network instances to which the routes belong.

  • VPC: VPC
  • VBR: VBR
  • CCN: CCN instance
Note The destination network instance types are valid only when the routing policy is applied to scenarios where routes are advertised from the gateway in the current region to network instances in the current region.
DestinationInstanceIds Array of String vpc-afrfs434465fdf****

The IDs of the destination network instances to which the routes belong.

Note The destination network instance IDs are valid only when the routing policy is applied to scenarios where routes are advertised from the gateway in the current region to network instances in the current region.
MatchAsns Array of String 65501

The AS paths based on which the routes are compared.

OperateCommunitySet Array of String 65501:1

The community set on which actions are performed.

Examples

Sample request

http(s)://[Endpoint]/?Action=DescribeCenRouteMaps
&PageNumber=1
&PageSize=10
&CenId=cen-wx12mmlt17ld82****
&RouteMapId=cenrmap-y40mxdvf7joc12****
&CenRegionId=cn-hangzhou
&TransmitDirection=RegionOut
&TransitRouterRouteTableId=vtb-gw8nx3515m1mbd1z1****
&Common request parameters

Sample responses

XML format

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 format

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

Error codes

For a list of error codes, visit the API Error Center.