DescribeCenRouteMaps - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Queries routing policies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cen:DescribeCenRouteMaps	get	CenInstance acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
CenId	string	Yes	The ID of the Cloud Enterprise Network (CEN) instance.	cen-wx12mmlt17ld82****
RouteMapId	string	No	The routing policy ID.	cenrmap-y40mxdvf7joc12****
CenRegionId	string	No	The region ID of the routing policy. You can call the DescribeChildInstanceRegions operation to query the most recent region list.	cn-hangzhou
TransmitDirection	string	No	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 current region, or to gateways deployed in other regions.	RegionOut
TransitRouterRouteTableId	string	No	The route table ID of the transit router with which the routing policy is associated.	vtb-gw8nx3515m1mbd1z1****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
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 of the returned page.	1
TotalCount	integer	The total number of entries returned.	1
RouteMaps	array<object>	The information about the routing policy.
RouteMap	object	The information about the routing policy.
RouteMapId	string	The routing policy ID.	cenrmap-y40mxdvf7joc12****
Status	string	The status of the routing policy. Valid values: Creating Active Deleting	Active
TransmitDirection	string	The direction in which the routing policy is applied.	RegionOut
SourceInstanceIdsReverseMatch	boolean	Indicates whether the source network instance IDs are excluded. false (default): 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.	false
CenRegionId	string	The region ID of the routing policy.	cn-hangzhou
CenId	string	The CEN instance ID.	cen-wx12mmlt17ld82****
Priority	integer	The priority of the routing policy. A smaller value indicates a higher priority.	5000
TransitRouterRouteTableId	string	The route table ID of the transit router with which the routing policy is associated.	vtb-gw8nx3515m1mbd1z1****
CommunityOperateMode	string	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.	Additive
MapResult	string	The action performed on a route that meets the match conditions. Permit: the route is permitted. Deny: the route is denied.	Deny
CommunityMatchMode	string	The match method that is used to match routes against 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 meets the match condition only if the community of the route is the same as the community specified in the match condition.	Include
Description	string	The description of the routing policy.	desctest
AsPathMatchMode	string	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 an AS path specified in the match condition.	Include
Preference	integer	The new priority of the route. A smaller value indicates a higher priority. This parameter indicates the action to be performed when a route meets the match condition.	20
DestinationInstanceIdsReverseMatch	boolean	Indicates whether the destination network instance IDs are excluded. false (default): 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.	false
CidrMatchMode	string	The match method that is used to evaluate 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 applied, the route whose prefix is 10.10.1.0/24 meets the match condition. 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.	Include
NextPriority	integer	The priority of the routing policy that you want to associate with the current one.	33
MatchAddressType	string	The type of IP address to be matched against the match condition. Valid values: IPv4: IPv4 addresses IPv6: IPv6 addresses If no value is returned, both IPv4 and IPv6 addresses are matched against the match condition.	IPv4
SourceRegionIds	array	The IDs of the source regions to which the routes belong.
SourceRegionId	string	The IDs of the source regions to which the routes belong.	cn-hangzhou
SourceChildInstanceTypes	array	The types of source network instances to which the routes belong. VPC VBR CCN VPN
SourceChildInstanceType	string	The types of source network instances to which the routes belong. VPC VBR CCN VPN	VPC
DestinationRouteTableIds	array	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 tables take effect only if the routing policy is applied to the egress gateway direction, and the destination route table IDs are in the current region.
DestinationRouteTableId	string	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 tables take effect only if the routing policy is applied to the egress gateway direction, and the destination route table IDs are in the current region.	vtb-adefrgtr144vf****
SourceInstanceIds	array	The IDs of the source network instances to which the routes belong.
SourceInstanceId	string	The IDs of the source network instances to which the routes belong.	vpc-adeg3544fdf34vf****
DestinationCidrBlocks	array	The prefix list against which routes are matched. IPv4 and IPv6 addresses are supported.
DestinationCidrBlock	string	The prefix list against which routes are matched. IPv4 and IPv6 addresses are supported.	10.10.10.0/24
DestinationRegionIds	array	The IDs of the destination regions for the routing policy.
DestinationRegionId	string	The IDs of the destination regions for the routing policy.	cn-beijing
SourceRouteTableIds	array	The IDs of the source route tables to which the routes belong.
SourceRouteTableId	string	The IDs of the source route tables to which the routes belong.	vtb-adfr233vf34rvd4****
MatchCommunitySet	array	The community set against which routes are matched.
MatchCommunity	string	The community set against which routes are matched.	65501:1
PrependAsPath	array	The AS paths that are prepended by using an action statement when regional gateways receive or advertise routes. This parameter indicates the action to be performed when a route meets the match condition.
AsPath	string	The AS paths that are prepended by using an action statement when regional gateways receive or advertise routes. This parameter indicates the action to be performed when a route meets the match condition.	65501
RouteTypes	array	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 BGP.
RouteType	string	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).	System
DestinationChildInstanceTypes	array	The types of destination network instances to which the routes belong. VPC VBR CCN VPN Note The destination route tables take effect only if the routing policy is applied to the egress gateway direction, and the type of the destination route tables is the same as that of the network instance in the current region.
DestinationChildInstanceType	string	The types of destination network instances to which the routes belong. VPC VBR CCN VPN Note The destination route tables take effect only if the routing policy is applied to the egress gateway direction, and the type of the destination route tables is the same as that of the network instance in the current region.	VPC
DestinationInstanceIds	array	The IDs of the destination network instances to which the routes point. Note The destination route tables take effect only if the routing policy is applied to the egress gateway direction, and the ID the destination instance is the same as that of the network instance in the current region.
DestinationInstanceId	string	The IDs of the destination network instances to which the routes point. Note The destination route tables take effect only if the routing policy is applied to the egress gateway direction, and the ID the destination instance is the same as that of the network instance in the current region.	vpc-afrfs434465fdf****
MatchAsns	array	The AS paths against which routes are matched.
MatchAsn	string	The AS paths against which routes are matched.	65501
OperateCommunitySet	array	The community set on which actions are performed.
OperateCommunity	string	The community set on which actions are performed.	65501:1

Examples

Sample success responses

JSONformat

{
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-18	The response structure of the API has changed	View Change Details
2024-09-10	The response structure of the API has changed	View Change Details
2024-09-10	The response structure of the API has changed	View Change Details