All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenRegionDomainRouteEntries

Last Updated:Mar 01, 2024

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

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:DescribeCenRegionDomainRouteEntriesREAD
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CenIdstringYes

The ID of the CEN instance.

cen-7qthudw0ll6j****
CenRegionIdstringYes

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
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. Valid values: 1 to 50.

10
StatusstringNo

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

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

004E99FB-E996-5777-888E-BA1D8F215407
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries returned.

4
CenRouteEntriesobject []

The array of routes.

ToOtherRegionStatusstring

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
Typestring

The type of the route. Valid values:

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

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
NextHopTypestring

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
NextHopInstanceIdstring

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

vpc-bp1j8728mm6pweeod****
NextHopRegionIdstring

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

cn-hangzhou
DestinationCidrBlockstring

The destination CIDR block of the route.

192.168.1.0/24
Preferenceinteger

The priority of the route.

Note A smaller value indicates a higher priority.
50
CenRouteMapRecordsobject []

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

RouteMapIdstring

The ID of the route map.

cenrmap-cz5axczdxb7yfu****
RegionIdstring

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

cn-hangzhou
CenOutRouteMapRecordsobject []

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

RouteMapIdstring

The ID of the route map.

cenrmap-dbarzidzp7ek4k****
RegionIdstring

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

ccn-cn-shanghai
Communitiesarray

The community attributes of the routes.

string

The community attribute of the route.

65501:1
AsPathsarray

The AS paths of the routes.

string

The AS path of the route.

65501

Examples

Sample success responses

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

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.