All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenRouteMaps

Last Updated:Mar 01, 2024

Queries routing policies.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cen:DescribeCenRouteMapsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

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

1
PageSizeintegerNo

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

10
CenIdstringYes

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

cen-wx12mmlt17ld82****
RouteMapIdstringNo

The routing policy ID.

cenrmap-y40mxdvf7joc12****
CenRegionIdstringNo

The region ID of the routing policy.

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

cn-hangzhou
TransmitDirectionstringNo

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
TransitRouterRouteTableIdstringNo

The route table ID of the transit router with which the routing policy is associated.

vtb-gw8nx3515m1mbd1z1****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The request ID.

24CE1987-D1D1-5324-9BAD-2750B60E6ABB
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries returned.

1
RouteMapsobject []

The information about the routing policy.

RouteMapIdstring

The routing policy ID.

cenrmap-y40mxdvf7joc12****
Statusstring

The status of the routing policy. Valid values:

  • Creating
  • Active
  • Deleting
Active
TransmitDirectionstring

The direction in which the routing policy is applied.

RegionOut
SourceInstanceIdsReverseMatchboolean

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
CenRegionIdstring

The region ID of the routing policy.

cn-hangzhou
CenIdstring

The CEN instance ID.

cen-wx12mmlt17ld82****
Priorityinteger

The priority of the routing policy. A smaller value indicates a higher priority.

5000
TransitRouterRouteTableIdstring

The route table ID of the transit router with which the routing policy is associated.

vtb-gw8nx3515m1mbd1z1****
CommunityOperateModestring

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
MapResultstring

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

  • Permit: the route is permitted.
  • Deny: the route is denied.
Deny
CommunityMatchModestring

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
Descriptionstring

The description of the routing policy.

desctest
AsPathMatchModestring

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
Preferenceinteger

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
DestinationInstanceIdsReverseMatchboolean

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
CidrMatchModestring

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
NextPriorityinteger

The priority of the routing policy that you want to associate with the current one.

33
MatchAddressTypestring

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
SourceRegionIdsarray

The IDs of the source regions to which the routes belong.

string

The IDs of the source regions to which the routes belong.

cn-hangzhou
SourceChildInstanceTypesarray

The types of source network instances to which the routes belong.

  • VPC
  • VBR
  • CCN
  • VPN
string

The types of source network instances to which the routes belong.

  • VPC
  • VBR
  • CCN
  • VPN
VPC
DestinationRouteTableIdsarray

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.
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****
SourceInstanceIdsarray

The IDs of the source network instances to which the routes belong.

string

The IDs of the source network instances to which the routes belong.

vpc-adeg3544fdf34vf****
DestinationCidrBlocksarray

The prefixes of the routes.

string

The prefixes of the routes.

10.10.10.0/24
SourceRouteTableIdsarray

The IDs of the source route tables to which the routes belong.

string

The IDs of the source route tables to which the routes belong.

vtb-adfr233vf34rvd4****
MatchCommunitySetarray

The community set against which routes are matched.

string

The community set against which routes are matched.

65501:1
PrependAsPatharray

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.

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
RouteTypesarray

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.
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
DestinationChildInstanceTypesarray

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.
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
DestinationInstanceIdsarray

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.
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****
MatchAsnsarray

The AS paths against which routes are matched.

string

The AS paths against which routes are matched.

65501
OperateCommunitySetarray

The community set on which actions are performed.

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"
          ]
        },
        "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 codeError codeError messageDescription
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe 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 timeSummary of changesOperation
No change history