All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenRegionDomainRouteEntries

Last Updated:Jan 11, 2023

Queries the routes of a Cloud Enterprise Network (CEN) instance in a specified region.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operate access level Resource type conditional keyword Association operation
cen:DescribeCenRegionDomainRouteEntries READ
  • CEN
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
    without
without

Request parameters

Parameter Type Required Description Example
CenId string Yes

The ID of the CEN instance.

cen-7qthudw0ll6j****
CenRegionId string Yes

The ID of the region that you want to query.

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

cn-hangzhou
PageNumber integer No

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

1
PageSize integer No

The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.

10
Status string No

The status of the routes that you want to query. Valid values:

  • Active (default value): active routes
  • Candidate: standby routes
  • Rejected: rejected routes
  • Prohibited: prohibited routes
  • All: all routes
Active

Response parameters

Parameter Type Description Example
object
PageSize integer

The number of entries returned per page.

10
RequestId string

The ID of the request.

004E99FB-E996-5777-888E-BA1D8F215407
PageNumber integer

The page number of the returned page.

1
TotalCount integer

The total number of entries returned.

4
CenRouteEntries array

The array of routes.

object
ToOtherRegionStatus string

Whether the route can be advertised to other regions. Valid values:

  • Active: The route can be advertised to other regions.
  • Prohibited: The route cannot be advertised to other regions.
Active
Type string

The type of the route. Valid values:

  • CEN: route that is advertised through CEN
  • Custom: custom route
  • System: system route
CEN
Status string

The status of the route. Valid values:

  • Active: The route is active.
  • Candidate: The route is a standby route.
  • Rejected: The route is rejected.
  • Prohibited: The route is prohibited.
Active
NextHopType string

The type of the network instance specified as the next hop in the route.

  • VPC
  • VBR
  • CCN
  • local_service: system route. No next hop is specified.
VPC
NextHopInstanceId string

The ID of the instance specified as the next hop in the route.

vpc-bp1j8728mm6pweeod****
NextHopRegionId string

The ID of the region where the network instance specified as the next hop in the route belongs.

cn-hangzhou
DestinationCidrBlock string

The destination CIDR block of the route.

192.168.1.0/24
Preference integer

The priority of the route.

Note A smaller value indicates a higher priority.
50
CenRouteMapRecords array

The route maps that the routes match in the inbound direction.

object
RouteMapId string

The ID of the route map.

cenrmap-cz5axczdxb7yfu****
RegionId string

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

cn-hangzhou
CenOutRouteMapRecords array

The route maps that the routes match in the outbound direction.

object
RouteMapId string

The ID of the route map.

cenrmap-dbarzidzp7ek4k****
RegionId string

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

ccn-cn-shanghai
Communities array

The community attributes of the routes.

string

The community attribute of the route.

65501:1
AsPaths array

The AS paths of the routes.

string

The AS path of the route.

65501

Example

Normal return example

JSONFormat

{
  "PageSize": 10,
  "RequestId": "004E99FB-E996-5777-888E-BA1D8F215407",
  "PageNumber": 1,
  "TotalCount": 4,
  "CenRouteEntries": {
    "CenRouteEntry": [
      {
        "ToOtherRegionStatus": "Active",
        "Type": "CEN",
        "Status": "Active",
        "NextHopType": "VPC",
        "NextHopInstanceId": "vpc-bp1j8728mm6pweeod****",
        "NextHopRegionId": "cn-hangzhou",
        "DestinationCidrBlock": "192.168.1.0/24",
        "Preference": 50,
        "CenRouteMapRecords": {
          "CenRouteMapRecord": [
            {
              "RouteMapId": "cenrmap-cz5axczdxb7yfu****",
              "RegionId": "cn-hangzhou"
            }
          ]
        },
        "CenOutRouteMapRecords": {
          "CenOutRouteMapRecord": [
            {
              "RouteMapId": "cenrmap-dbarzidzp7ek4k****",
              "RegionId": "ccn-cn-shanghai"
            }
          ]
        },
        "Communities": {
          "Community": [
            "65501:1"
          ]
        },
        "AsPaths": {
          "AsPath": [
            "65501"
          ]
        }
      }
    ]
  }
}

Error codes

For a list of error codes, visit the API error center.