Queries route maps 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 No DescribeCenRouteMaps

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

CenId String Yes cen-7qthudw0ll6jmc****

The ID of the Cloud Enterprise Network (CEN) instance.

CenRegionId String No cn-beijing

The region where the CEN instance is deployed. You can call the DescribeRegions operation to query region IDs.

RouteMapId String No cenrmap-abcdedfghij****

The ID of the route map.

TransmitDirection String No RegionIn

The direction to which the route map is applied. Valid values:

  • RegionIn: Routes are advertised to CEN gateways.

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

  • RegionOut: Routes are advertised from CEN gateways.

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

PageNumber Integer No 1

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

PageSize Integer No 10

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

Response parameters

Parameter Type Example Description
RouteMaps Array

The information about the route map.

RouteMap
AsPathMatchMode String Include

Match statements are used to match the AS paths. Valid values:

  • Include: uses fuzzy match. If the AS path in the condition overlaps with the AS path in the route, the match is successful.
  • Complete: uses exact match. Only when the AS path in the condition is the same as the AS path in the route, the match is successful.
CenId String cen-7qthudw0ll6jmc****

The ID of the CEN instance.

CenRegionId String cn-hangzhou

The ID of the region where the CEN instance is deployed.

CidrMatchMode String Include

Match statements are used to match the prefixes.

  • Include: uses fuzzy match. If the routing prefix in the condition contains the routing prefix of the route, the match is successful.

    For example, the 1.1.0.0/16 policy can match the 1.1.1.0/24 route.

  • Complete: uses exact match. Only when the routing prefix in the condition is the same as the routing prefix of the route, the match is successful.

    For example, the 1.1.0.0/16 policy can match the 1.1.0.0/16 route.

CommunityMatchMode String Include

Match statements are used to match the Communities.

  • Include: uses fuzzy match. If the Community in the condition overlaps with the Community of the route, the match is successful.
  • Complete: uses exact match. Only when the Community in the condition is the same as the Community of the route, the match is successful.
CommunityOperateMode String Additive

Action statements are used to operate the Communities. Valid values:

  • Additive: adds.
  • Replace: replaces.
Description String abc

The description of the route map.

DestinationChildInstanceTypes List VPC

Match statements are used to match the destination instance types.

  • VPC: virtual private clouds(VPCs).
  • VBR: virtual border routers (VBRs).
  • CCN: Cloud Connect Network (CCN) instances in mainland China.

The destination instance types are valid only when the route map is applied to scenarios where routes are advertised from gateways in the current region to instances in the current region.

DestinationCidrBlocks List 1.1.1.0/10

Match statements are used to match the routing prefixes.

DestinationInstanceIds List vpc-a

Match statements are used to match the destination instance IDs.

The destination instance IDs are valid only when the route map is applied to scenarios where routes are advertised from gateways in the current region to instances in the current region.

DestinationInstanceIdsReverseMatch Boolean false

The IDs of destination instances to be advertised do not support match statements.

  • false(default value): If the ID of the destination instance to be advertised is in the DestinationInstanceIds field, the match is successful.
  • true: If the ID of the destination instance to be advertised is not in the DestinationInstanceIds filed, the match is successful.
DestinationRouteTableIds List vtb-a

Match statements are used to match the IDs of the destination route tables.

The destination route IDs are valid only when the route map is applied to scenarios where routes are advertised from gateways in the current region to route tables in the current region.

MapResult String Permit

The route map behavior after all conditions are matched. Valid values:

  • Permit: allows the routes that are matched.
  • Deny: rejects the routes that are matched.
MatchAsns List 65501

Match statements are used to match AS paths of the routes.

MatchCommunitySet List 65501:1

Match statements are used to match the Communities.

NextPriority Integer 33

The priority of the next associated route map. Valid values: 1 to 100.

  • If the priority is not set, no next route map is associated with the current route map.
  • If the priority is set to 1, the next route map is associated with the current route map.
  • If the priority is set and the value is not 1. The priority of the associated route map must be higher than that of the current route map.

Only when the MapResult parameter is set to Permit, the matched routes continue to match the next associated route maps.

OperateCommunitySet List 65501:1

Action statements are used to modify the Community attribute.

Preference Integer 20

Action statements are used to modify the route priority.

PrependAsPath List 65501

AS paths are attached when regional gateways receive or advertise routes.

Priority Integer 22

The priority of the route map.

RouteMapId String cenrmap-abcdedfghij****

The ID of the route map.

RouteTypes List System

Match statements are used to match the route types.

  • System: system routes routes that are generated by the system.
  • Custom: custom routes that are created by users.
  • BGP: Border Gateway Protocol (BGP) routes that are advertised to BGP.
SourceChildInstanceTypes List VPC

Match statements are used to match source instance types of the routes.

  • VPC: VPCs.
  • VBR: VBRs.
  • CCN: CCN instances.
SourceInstanceIds List vpc-a

Match statements are used to match source instance IDs of the routes.

SourceInstanceIdsReverseMatch Boolean false

The IDs of source instances to be advertised do not support match statements.

  • false (default value): If the source instance ID is in the SourceInstanceIds field, the match is successful.
  • true: If the source instance ID is not in the SourceInstanceIds field, the match is successful.
SourceRegionIds List cn-beijing

Match statements are used to match source region IDs of the routes.

SourceRouteTableIds List vtb-a

Match statements are used to match source route table IDs of the routes.

Status String Active

The status of the route map. Valid values:

  • Active: The route map is available.
  • Creating: The route map is being created.
TransmitDirection String RegionIn

The direction in which the route map is applied. Valid values:

  • RegionIn: Routes are advertised to CEN gateways.

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

  • RegionOut: Routes are advertised from CEN gateways.

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

PageSize Integer 10

The number of entries returned per page.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 10

The total number of entries.

RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B45

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeCenRouteMaps
&CenId=cen-7qthudw0ll6jmc****
&<Common request parameters>

Sample success responses

XML format

<DescribeCenRouteMapsResponse>
      <RouteMaps>
            <RouteMap>
                  <Status>Active</Status>
                  <CenRegionId>cn-beijing</CenRegionId>
                  <RouteMapId>cenrmap-jumdfzmj5sgggl****</RouteMapId>
                  <MapResult>Permit</MapResult>
                  <TransmitDirection>RegionIn</TransmitDirection>
                  <CenId>cen-nh98vzx8gfhlwn****</CenId>
                  <Priority>20</Priority>
            </RouteMap>
      </RouteMaps>
      <PageNumber>1</PageNumber>
      <TotalCount>1</TotalCount>
      <PageSize>10</PageSize>
</DescribeCenRouteMapsResponse>

JSON format

{
    "RouteMaps": {
        "RouteMap": [
            {
                "Status": "Active",
                "CenRegionId": "cn-beijing",
                "RouteMapId": "cenrmap-jumdfzmj5sgggl****",
                "MapResult": "Permit",
                "TransmitDirection": "RegionIn",
                "CenId": "cen-nh98vzx8gfhlwn****",
                "Priority": 20
            }
        ]
    },
    "PageNumber": 1,
    "TotalCount": 1,
    "PageSize": 10
}

Error codes

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