Queries the 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-wx12mmlt17ld82****

The ID of the CEN instance.

CenRegionId String No cn-hangzhou

The ID of the region where the route map is applied.

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

RouteMapId String No cenrmap-y40mxdvf7joc12****

The ID of the route map.

TransmitDirection String No RegionOut

The direction in which the route map 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.

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. Default value: 10.

Response parameters

Parameter Type Example Description
RouteMaps Array of RouteMap

The route map returned.

RouteMap
AsPathMatchMode String Include

The match method that is used to evaluate routes based on the AS path. Valid values:

  • Include: fuzzy match. A route meets the match condition if the AS path of the route overlaps with the AS path specified in the match condition.
  • Complete: exact match. A route meets the match condition only if the AS path of the route is the same as the AS path specified in the match condition.
CenId String cen-wx12mmlt17ld82****

The ID of the CEN instance.

CenRegionId String cn-hangzhou

The ID of the region where the route map is applied.

CidrMatchMode String Include

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

  • Include: fuzzy match. A route meets the match condition if the route prefix specified in the match condition contains the prefix of the route.

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

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

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

CommunityMatchMode String Include

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

  • Include: fuzzy match. A route meets the match condition if the community of the route overlaps with the community specified in the match condition.
  • Complete: exact match. A route meets the match condition only if the community of the route is the same as the community specified in the match condition.
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.

The parameter indicates the action performed when a route meets the match condition.

Description String desctest

The description of the route map.

DestinationChildInstanceTypes List VPC

The types of destination network instances to which routes are evaluated.

  • VPC
  • VBR
  • CCN
Note The destination network instance types are valid only when the route map is applied to scenarios where routes are advertised from the gateway in the current region to network instances in the current region.
DestinationCidrBlocks List 10.10.10.0/24

The prefixes of matching routes.

DestinationInstanceIds List vpc-afrfs434465fdf****

The IDs of the destination network instances to which routes are evaluated.

Note The destination network instance IDs are valid only when the route map is applied to scenarios where routes are advertised from the gateway in the current region to network instances in the current region.
DestinationInstanceIdsReverseMatch Boolean false

Indicates whether the destination network instance IDs are excluded.

  • false (default value): A route meets the match condition if its destination network instance ID is in the list specified by DestinationInstanceIds.N.
  • true: A route meets the match condition if its destination network instance ID is not in the list specified by DestinationInstanceIds.N.
DestinationRouteTableIds List vtb-adefrgtr144vf****

The IDs of the destination route tables to which routes are evaluated. A maximum of 32 route table IDs are supported.

Note The destination route table IDs are valid only when the route map is applied to scenarios where routes are advertised from the gateway in the current region to route tables in the current region.
MapResult String Deny

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

  • Permit: the route is permitted.
  • Deny: the route is denied.
MatchAsns List 65501

The AS paths based on which routes are evaluated.

MatchCommunitySet List 65501:1

The community set based on which routes are evaluated.

NextPriority Integer 33

The priority of the next associated route map.

OperateCommunitySet List 65501:1

The community set on which actions are performed.

Preference Integer 20

The new priority of the route.

A smaller value indicates a higher priority.

The parameter indicates the action performed when a route meets the match condition.

PrependAsPath List 65501

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

The parameter indicates the action performed when a route meets the match condition.

Priority Integer 5000

The priority of the route map. A smaller value indicates a higher priority.

RouteMapId String cenrmap-y40mxdvf7joc12****

The ID of the route map.

RouteTypes List System

The type of route that is evaluated. 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).
SourceChildInstanceTypes List VPC

The types of source network instances from which routes are evaluated.

  • VPC
  • VBR
  • CCN
SourceInstanceIds List vpc-adeg3544fdf34vf****

The IDs of the source network instances from which routes are evaluated.

SourceInstanceIdsReverseMatch Boolean false

Indicates whether the source network instance IDs are excluded.

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

The IDs of the source regions from which routes are evaluated.

SourceRouteTableIds List vtb-adfr233vf34rvd4****

The IDs of the source route tables from which routes are evaluated.

Status String Active

The status of the route map. Valid values:

  • Creating
  • Active
  • Deleting
TransmitDirection String RegionOut

The direction in which the route map is applied.

PageSize Integer 10

The number of entries returned per page.

PageNumber Integer 1

The page number of the returned page.

TotalCount Integer 1

The total number of entries returned.

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

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>
  <TotalCount>1</TotalCount>
  <RequestId>24CE1987-D1D1-5324-9BAD-2750B60E6ABB</RequestId>
  <PageSize>10</PageSize>
  <PageNumber>1</PageNumber>
  <RouteMaps>
        <RouteMap>
              <Status>Active</Status>
              <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

{
    "TotalCount": 1,
    "RequestId": "24CE1987-D1D1-5324-9BAD-2750B60E6ABB",
    "PageSize": 10,
    "PageNumber": 1,
    "RouteMaps": {
        "RouteMap": [
            {
                "Status": "Active",
                "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.