DescribeCenRouteMaps - Cloud Enterprise Network - Alibaba Cloud Documentation Center

You can call the DescribeCenRouteMaps operation to query the configurations of routing policies.

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 support 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. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
CenId	string	Yes	The ID of the Cloud Enterprise Network (CEN) instance.	cen-wx12mmlt17ld82****
RouteMapId	string	No	The ID of the routing policy.	cenrmap-y40mxdvf7joc12****
CenRegionId	string	No	The ID of the region where the routing policy is applied. You can call the DescribeChildInstanceRegions operation to query region IDs.	cn-hangzhou
TransmitDirection	string	No	The direction in which the routing policy is applied. Valid values: RegionIn: Inbound. The routing policy is applied to routes that are advertised to the gateway of a region. For example, routes are advertised from network instances in the current region to the gateway of the current region, or routes from other regions are advertised to the gateway of the current region. RegionOut: Outbound. The routing policy is applied to routes that are advertised from the gateway of a region. For example, routes are advertised from the gateway of the current region to network instances in the current region, or to gateways in other regions.	RegionOut
TransitRouterRouteTableId	string	No	The ID of the route table of the transit router that is associated with the routing policy.	vtb-gw8nx3515m1mbd1z1****

Response parameters

Parameter	Type	Description	Example
	object	The response.
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The request ID.	24CE1987-D1D1-5324-9BAD-2750B60E6ABB
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries returned.	1
RouteMaps	object
RouteMap	array<object>	A list of routing policies.
	object	The information about the routing policy.
RouteMapId	string	The ID of the routing policy.	cenrmap-y40mxdvf7joc12****
Status	string	The status of the routing policy. Creating: The routing policy is being created. Active: The routing policy is available. Deleting: The routing policy is being deleted.	Active
TransmitDirection	string	The direction in which the routing policy is applied.	RegionOut
SourceInstanceIdsReverseMatch	boolean	Indicates whether the source instance IDs are excluded. false: The match is successful if the source instance ID of the route is in the SourceInstanceIds.N list. true: The match is successful if the source instance ID of the route is not in the SourceInstanceIds.N list.	false
CenRegionId	string	The ID of the region where the routing policy is applied.	cn-hangzhou
CenId	string	The ID of the CEN instance.	cen-wx12mmlt17ld82****
Priority	integer	The priority of the routing policy. A smaller value indicates a higher priority.	5000
TransitRouterRouteTableId	string	The ID of the route table of the transit router that is associated with the routing policy.	vtb-gw8nx3515m1mbd1z1****
CommunityOperateMode	string	The action to be performed on the community. Additive: adds the community to the route. Replace: replaces the original community of the route. This parameter specifies the action to be performed after a route meets the match conditions.	Additive
MapResult	string	The action that is performed after all match conditions are met. Permit: allows the matched route. Deny: denies the matched route.	Deny
CommunityMatchMode	string	The match mode for the community. Include: fuzzy match. The match is successful if the community of the route overlaps with the community in the match condition. Complete: exact match. The match is successful only if the community of the route is the same as the community in the match condition.	Include
Description	string	The description of the routing policy.	desctest
AsPathMatchMode	string	The match mode for the AS-path. Include: fuzzy match. The match is successful if the AS-path of the route overlaps with the AS-path in the match condition. Complete: exact match. The match is successful only if the AS-path of the route is the same as the AS-path in the match condition.	Include
Preference	integer	The new priority of the route. A smaller value indicates a higher priority. This parameter specifies the action to be performed after a route meets the match conditions.	20
DestinationInstanceIdsReverseMatch	boolean	Indicates whether the destination instance IDs are excluded. false: The match is successful if the destination instance ID of the route is in the DestinationInstanceIds.N list. true: The match is successful if the destination instance ID of the route is not in the DestinationInstanceIds.N list.	false
CidrMatchMode	string	The match mode for the prefix list. Valid values: Include: fuzzy match. The match is successful if the route prefix in the match condition includes the route prefix of the route. For example, a policy with the 10.10.0.0/16 route prefix matches the 10.10.1.0/24 route. Complete: exact match. The match is successful only if the route prefix in the match condition is the same as the route prefix of the route. For example, a policy with the 10.10.0.0/16 route prefix matches only the 10.10.0.0/16 route.	Include
NextPriority	integer	The priority of the next routing policy that is associated with the current routing policy.	33
MatchAddressType	string	The IP address family of the route. IPv4: matches only IPv4 routes. IPv6: matches only IPv6 routes. If this parameter is not returned, both IPv4 and IPv6 routes are matched.	IPv4
SourceRegionIds	object
SourceRegionId	array	A list of source region IDs to be matched.
	string	A list of source region IDs to be matched.	cn-hangzhou
SourceChildInstanceTypes	object
SourceChildInstanceType	array	A list of source instance types to be matched. VPC: virtual private cloud (VPC). VBR: virtual border router (VBR). CCN: Cloud Connect Network (CCN). VPN: IPsec connection.
	string	A list of source instance types to be matched. VPC: VPC. VBR: VBR. CCN: CCN. VPN: IPsec connection.	VPC
DestinationRouteTableIds	object
DestinationRouteTableId	array	A list of destination route table IDs to be matched. You can enter up to 32 route table IDs. Note This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination route table belongs to a network instance in the current region.
	string	A list of destination route table IDs to be matched. You can enter up to 32 route table IDs. Note This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination route table belongs to a network instance in the current region.	vtb-adefrgtr144vf****
SourceInstanceIds	object
SourceInstanceId	array	A list of source instance IDs to be matched.
	string	A list of source instance IDs to be matched.	vpc-adeg3544fdf34vf****
DestinationCidrBlocks	object
DestinationCidrBlock	array	A list of prefixes to be matched. Both IPv4 and IPv6 prefixes are supported.
	string	A list of prefixes to be matched. Both IPv4 and IPv6 prefixes are supported.	10.10.10.0/24
DestinationRegionIds	object
DestinationRegionId	array	A list of destination region IDs.
	string	A list of destination region IDs.	cn-beijing
SourceRouteTableIds	object
SourceRouteTableId	array	A list of source route table IDs to be matched.
	string	A list of source route table IDs to be matched.	vtb-adfr233vf34rvd4****
MatchCommunitySet	object
MatchCommunity	array	The community to be matched.
	string	The community to be matched.	65501:1
PrependAsPath	object
AsPath	array	The AS-path that is prepended when the regional gateway receives or advertises a route. This parameter specifies the action to be performed after a route meets the match conditions.
	string	The AS-path that is prepended when the regional gateway receives or advertises a route. This parameter specifies the action to be performed after a route meets the match conditions.	65501
RouteTypes	object
RouteType	array	A list of route types to be matched. System: system routes that are automatically generated by the system. Custom: custom routes that are manually added. BGP: routes that are advertised through Border Gateway Protocol (BGP).
	string	A list of route types to be matched. System: system routes that are automatically generated by the system. Custom: custom routes that are manually added. BGP: routes that are advertised through BGP.	System
DestinationChildInstanceTypes	object
DestinationChildInstanceType	array	A list of destination instance types to be matched. VPC: VPC. VBR: VBR. CCN: CCN. VPN: IPsec connection. Note This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination instance is in the current region.
	string	A list of destination instance types to be matched. VPC: VPC. VBR: VBR. CCN: CCN. VPN: IPsec connection. Note This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination instance is in the current region.	VPC
DestinationInstanceIds	object
DestinationInstanceId	array	A list of destination instance IDs to be matched. Note This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination instance is in the current region.
	string	A list of destination instance IDs to be matched. Note This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination instance is in the current region.	vpc-afrfs434465fdf****
MatchAsns	object
MatchAsn	array	A list of AS-paths to be matched.
	string	A list of AS-paths to be matched.	65501
OperateCommunitySet	object
OperateCommunity	array	The community to be operated.
	string	The community to be operated.	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.