Query routing policy configurations by using DescribeCenRouteMaps - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries the configured information in route maps by calling the DescribeCenRouteMaps operation.

Operation description

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:DescribeCenRouteMaps

get

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Default value: 10.	10
CenId	string	Yes	The instance ID of the Cloud Enterprise Network (CEN) instance.	cen-wx12mmlt17ld82****
RouteMapId	string	No	The ID of the route map.	cenrmap-y40mxdvf7joc12****
CenRegionId	string	No	The ID of the region where the route map is applied. You can call the DescribeChildInstanceRegions operation to query region IDs.	cn-hangzhou
TransmitDirection	string	No	The direction in which the route map is applied. Valid values: RegionIn: Routes are advertised to the regional gateway of the CEN instance. For example, routes are advertised from a network instance in the local region to the local regional gateway, or routes are advertised from a regional gateway in another region to the local regional gateway. RegionOut: Routes are advertised from the regional gateway of the CEN instance. For example, routes are advertised from the local regional gateway to network instances in the local region, or routes are advertised from the local regional gateway to regional gateways in other regions.	RegionOut
TransitRouterRouteTableId	string	No	The ID of the transit router route table associated with the route map.	vtb-gw8nx3515m1mbd1z1****

Response elements

Element	Type	Description	Example
	object	The response parameters.
PageSize	integer	The number of entries per page in a paged query. This parameter is used for paging.	10
RequestId	string	The request ID.	24CE1987-D1D1-5324-9BAD-2750B60E6ABB
PageNumber	integer	The page number of the list.	1
TotalCount	integer	The total number of entries.	1
RouteMaps	object
RouteMap	array<object>	The list of route map information.
	array<object>	The route map information.
RouteMapId	string	The ID of the route map.	cenrmap-y40mxdvf7joc12****
Status	string	The status of the route map. Creating: The route map is being created. Active: The route map is available. Deleting: The route map is being deleted.	Active
TransmitDirection	string	The direction in which the route map is applied.	RegionOut
SourceInstanceIdsReverseMatch	boolean	Indicates whether the reverse match mode is used for the source instance ID list. false: The reverse match mode is not used. A route matches the condition if the source instance ID of the route is in SourceInstanceIds.N. true: The reverse match mode is used. A route matches the condition if the source instance ID of the route is not in SourceInstanceIds.N.	false
CenRegionId	string	The ID of the region where the route map is applied.	cn-hangzhou
CenId	string	The instance ID of the Cloud Enterprise Network (CEN) instance.	cen-wx12mmlt17ld82****
Priority	integer	The priority of the route map. A smaller value indicates a higher priority.	5000
TransitRouterRouteTableId	string	The ID of the transit router route table associated with the route map.	vtb-gw8nx3515m1mbd1z1****
CommunityOperateMode	string	The action to perform on the Community attribute. Valid values: Additive: adds the Community attribute to the route. Replace: replaces the existing Community attribute of the route. This parameter specifies the action to perform after a route matches the match conditions.	Additive
MapResult	string	The action to perform on a route that matches all match conditions. Valid values: Permit: allows the matched route to pass. Deny: rejects the matched route.	Deny
CommunityMatchMode	string	The match mode of the Community attribute. Valid values: Include: fuzzy match. A route matches the condition if the Community attribute of the route overlaps with the Community attribute specified in the match condition. Complete: exact match. A route matches the condition only if the Community attribute of the route is the same as the Community attribute specified in the match condition.	Include
Description	string	The description of the route map.	desctest
AsPathMatchMode	string	The match mode of the AS path list. Valid values: Include: fuzzy match. A route matches the condition if the AS path of the route overlaps with the AS path specified in the match condition. Complete: exact match. A route matches the condition only if the AS path of the route is the same as the AS path specified in the match condition.	Include
Preference	integer	The priority of the route to be modified. A smaller value indicates a higher priority. This parameter specifies the action to perform after a route matches the match conditions.	20
DestinationInstanceIdsReverseMatch	boolean	Indicates whether the reverse match mode is used for the destination instance ID list. false: The reverse match mode is not used. A route matches the condition if the destination instance ID of the route is in DestinationInstanceIds.N. true: The reverse match mode is used. A route matches the condition if the destination instance ID of the route is not in DestinationInstanceIds.N.	false
CidrMatchMode	string	The match mode of the prefix list. Valid values: Include: fuzzy match. A route matches the condition if the route prefix in the match condition contains the route prefix of the route to be matched. For example, if you set the match condition to 10.10.0.0/16, the route whose prefix is 10.10.1.0/24 matches the condition. Complete: exact match. A route matches the condition only if the route prefix in the match condition is the same as the route prefix of the route to be matched. For example, if you set the match condition to 10.10.0.0/16, only the route whose prefix is 10.10.0.0/16 matches the condition.	Include
NextPriority	integer	The priority of the next associated route map.	33
MatchAddressType	string	The IP address type that the route must match. Valid values: IPv4: matches only IPv4 routes. IPv6: matches only IPv6 routes. If this value is not returned, both IPv4 and IPv6 routes are matched.	IPv4
SourceRegionIds	object
SourceRegionId	array	The list of source region IDs that the route must match.
	string	The list of source region IDs that the route must match.	cn-hangzhou
SourceChildInstanceTypes	object
SourceChildInstanceType	array	The list of source instance types that the route must match. Valid values: VPC: virtual private cloud (VPC) instance. VBR: virtual border router (VBR) instance. CCN: Cloud Connect Network (CCN) instance. VPN: IPsec connection.
	string	The list of source instance types that the route must match. Valid values: VPC: virtual private cloud (VPC) instance. VBR: virtual border router (VBR) instance. CCN: Cloud Connect Network (CCN) instance. VPN: IPsec connection.	VPC
DestinationRouteTableIds	object
DestinationRouteTableId	array	The list of destination route table IDs that the route must match. A maximum of 32 route table IDs are supported. Note The destination route table ID list takes effect only when the route map is applied in the outbound direction from the regional gateway and the destination route table IDs belong to network instances in the local region.
	string	The list of destination route table IDs that the route must match. A maximum of 32 route table IDs are supported. Note The destination route table ID list takes effect only when the route map is applied in the outbound direction from the regional gateway and the destination route table IDs belong to network instances in the local region.	vtb-adefrgtr144vf****
SourceInstanceIds	object
SourceInstanceId	array	The list of source instance IDs that the route must match.
	string	The list of source instance IDs that the route must match.	vpc-adeg3544fdf34vf****
DestinationCidrBlocks	object
DestinationCidrBlock	array	The prefix list that the route must match. Both IPv4 and IPv6 formats are supported.
	string	The prefix list that the route must match. Both IPv4 and IPv6 formats are supported.	10.10.10.0/24
DestinationRegionIds	object
DestinationRegionId	array	The list of destination region IDs of the route map.
	string	The list of destination region IDs of the route map.	cn-beijing
SourceRouteTableIds	object
SourceRouteTableId	array	The list of source route table IDs that the route must match.
	string	The list of source route table IDs that the route must match.	vtb-adfr233vf34rvd4****
MatchCommunitySet	object
MatchCommunity	array	The Community set that the route must match.
	string	The Community set that the route must match.	65501:1
PrependAsPath	object
AsPath	array	The AS path that is prepended when the regional gateway receives or publishes a route entry. This parameter specifies the action to perform after a route matches the match conditions.
	string	The AS path that is prepended when the regional gateway receives or publishes a route entry. This parameter specifies the action to perform after a route matches the match conditions.	65501
RouteTypes	object
RouteType	array	The list of routing types that the route must match. Valid values: System: system routes that are automatically generated by the system. Custom: custom routes that are manually added by users. BGP: BGP routes that are propagated through the BGP routing protocol.
	string	The list of routing types that the route must match. Valid values: System: system routes that are automatically generated by the system. Custom: custom routes that are manually added by users. BGP: BGP routes that are propagated through the BGP routing protocol.	System
DestinationChildInstanceTypes	object
DestinationChildInstanceType	array	The list of destination instance types that the route must match. Valid values: VPC: virtual private cloud (VPC) instance. VBR: virtual border router (VBR) instance. CCN: Cloud Connect Network (CCN) instance. VPN: IPsec connection. Note The destination instance type list takes effect only when the route map is applied in the outbound direction from the regional gateway and the destination instance types belong to the local region.
	string	The list of destination instance types that the route must match. Valid values: VPC: virtual private cloud (VPC) instance. VBR: virtual border router (VBR) instance. CCN: Cloud Connect Network (CCN) instance. VPN: IPsec connection. Note The destination instance type list takes effect only when the route map is applied in the outbound direction from the regional gateway and the destination instance types belong to the local region.	VPC
DestinationInstanceIds	object
DestinationInstanceId	array	The list of destination instance IDs that the route must match. Note The destination instance ID list takes effect only when the route map is applied in the outbound direction from the regional gateway and the destination instance IDs belong to the local region.
	string	The list of destination instance IDs that the route must match. Note The destination instance ID list takes effect only when the route map is applied in the outbound direction from the regional gateway and the destination instance IDs belong to the local region.	vpc-afrfs434465fdf****
MatchAsns	object
MatchAsn	array	The AS path list that the route must match.
	string	The AS path list that the route must match.	65501
OperateCommunitySet	object
OperateCommunity	array	The Community set on which actions are performed.
	string	The Community set on which actions are performed.	65501:1

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "24CE1987-D1D1-5324-9BAD-2750B60E6ABB",
  "PageNumber": 1,
  "TotalCount": 1,
  "RouteMaps": {
    "RouteMap": [
      {
        "RouteMapId": "cenrmap-y40mxdvf7joc12****",
        "Status": "Active",
        "TransmitDirection": "RegionOut",
        "SourceInstanceIdsReverseMatch": false,
        "CenRegionId": "cn-hangzhou",
        "CenId": "cen-wx12mmlt17ld82****",
        "Priority": 5000,
        "TransitRouterRouteTableId": "vtb-gw8nx3515m1mbd1z1****",
        "CommunityOperateMode": "Additive",
        "MapResult": "Deny",
        "CommunityMatchMode": "Include",
        "Description": "desctest",
        "AsPathMatchMode": "Include",
        "Preference": 20,
        "DestinationInstanceIdsReverseMatch": false,
        "CidrMatchMode": "Include",
        "NextPriority": 33,
        "MatchAddressType": "IPv4",
        "SourceRegionIds": {
          "SourceRegionId": [
            "cn-hangzhou"
          ]
        },
        "SourceChildInstanceTypes": {
          "SourceChildInstanceType": [
            "VPC"
          ]
        },
        "DestinationRouteTableIds": {
          "DestinationRouteTableId": [
            "vtb-adefrgtr144vf****"
          ]
        },
        "SourceInstanceIds": {
          "SourceInstanceId": [
            "vpc-adeg3544fdf34vf****"
          ]
        },
        "DestinationCidrBlocks": {
          "DestinationCidrBlock": [
            "10.10.10.0/24"
          ]
        },
        "DestinationRegionIds": {
          "DestinationRegionId": [
            "cn-beijing"
          ]
        },
        "SourceRouteTableIds": {
          "SourceRouteTableId": [
            "vtb-adfr233vf34rvd4****"
          ]
        },
        "MatchCommunitySet": {
          "MatchCommunity": [
            "65501:1"
          ]
        },
        "PrependAsPath": {
          "AsPath": [
            "65501"
          ]
        },
        "RouteTypes": {
          "RouteType": [
            "System"
          ]
        },
        "DestinationChildInstanceTypes": {
          "DestinationChildInstanceType": [
            "VPC"
          ]
        },
        "DestinationInstanceIds": {
          "DestinationInstanceId": [
            "vpc-afrfs434465fdf****"
          ]
        },
        "MatchAsns": {
          "MatchAsn": [
            "65501"
          ]
        },
        "OperateCommunitySet": {
          "OperateCommunity": [
            "65501:1"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.