All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenRegionDomainRouteEntries

Last Updated:Oct 22, 2024

Queries the details about routes in a region for a Cloud Enterprise Network (CEN) instance.

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
CenIdstringYes

The CEN instance ID.

cen-7qthudw0ll6j****
CenRegionIdstringYes

The region ID.

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 per page. Valid values: 1 to 500. Default value: 10.

10
StatusstringNo

The route status. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

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

The page number of the returned page.

1
TotalCountinteger

The total number of entries returned.

4
CenRouteEntriesarray<object>

A list of route entries.

CenRouteEntryobject
ToOtherRegionStatusstring

Indicates 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 route type. Valid values:

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

The route status. Valid values:

  • Active: available
  • Candidate: standby
  • Rejected: rejected
  • Prohibited: prohibited
Active
NextHopTypestring

The type of the instance specified as the next hop in the route. Valid values:

  • VPC: virtual private cloud (VPC)
  • VBR: virtual border router (VBR)
  • CCN: Cloud Connect Network (CCN) instance
  • 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 to which 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 route priority.

A smaller value indicates a higher priority.

50
CenRouteMapRecordsarray<object>

The routing policy that the routes match in the inbound direction.

CenRouteMapRecordobject
RouteMapIdstring

The ID of the routing policy.

cenrmap-cz5axczdxb7yfu****
RegionIdstring

The ID of the region where the routing policy is applied.

cn-hangzhou
CenOutRouteMapRecordsarray<object>

The routing policy that the routes match in the outbound direction.

CenOutRouteMapRecordobject
RouteMapIdstring

The ID of the routing policy.

cenrmap-dbarzidzp7ek4k****
RegionIdstring

The ID of the region where the routing policy is applied.

ccn-cn-shanghai
Communitiesarray

The communities of the route.

Communitystring

The community of the route.

65501:1
AsPathsarray

The AS paths of the route.

AsPathstring

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.