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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No DescribeCenRegionDomainRouteEntries

The operation that you want to perform. Set the value to DescribeCenRegionDomainRouteEntries.

CenId String Yes cen-7qthudw0ll6j****

The ID of the CEN instance.

CenRegionId String Yes cn-hangzhou

The ID of the region that you want to query.

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

PageNumber Integer No 1

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

PageSize Integer No 10

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

Status String No Active

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

Response parameters

Parameter Type Example Description
CenRouteEntries Array of CenRouteEntry

The array of routes.

CenRouteEntry
AsPaths List 65501

The AS paths of the routes.

CenOutRouteMapRecords Array of CenOutRouteMapRecord

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

CenOutRouteMapRecord
RegionId String ccn-cn-shanghai

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

RouteMapId String cenrmap-dbarzidzp7ek4k****

The ID of the route map.

CenRouteMapRecords Array of CenRouteMapRecord

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

CenRouteMapRecord
RegionId String cn-hangzhou

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

RouteMapId String cenrmap-cz5axczdxb7yfu****

The ID of the route map.

Communities List 65501:1

The community attributes of the routes.

DestinationCidrBlock String 192.168.1.0/24

The destination CIDR block of the route.

NextHopInstanceId String vpc-bp1j8728mm6pweeod****

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

NextHopRegionId String cn-hangzhou

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

NextHopType String VPC

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.
Preference Integer 50

The priority of the route.

A smaller value indicates a higher priority.

Status String Active

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.
ToOtherRegionStatus String Active

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.
Type String CEN

The type of the route. Valid values:

  • CEN: route that is advertised through CEN
  • Custom: custom route
  • System: system route
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 004E99FB-E996-5777-888E-BA1D8F215407

The ID of the request.

TotalCount Integer 4

The total number of entries returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCenRegionDomainRouteEntries
&CenId=cen-7qthudw0ll6j****
&CenRegionId=cn-hangzhou
&<Common request parameters>

Sample responses

XML format

<DescribeCenRegionDomainRouteEntriesResponse>
  <TotalCount>4</TotalCount>
  <RequestId>004E99FB-E996-5777-888E-BA1D8F215407</RequestId>
  <PageSize>10</PageSize>
  <PageNumber>1</PageNumber>
  <CenRouteEntries>
        <CenRouteEntry>
              <Status>Active</Status>
              <ToOtherRegionStatus>Active</ToOtherRegionStatus>
              <CenOutRouteMapRecords>
                    <CenOutRouteMapRecord>
                          <RegionId>ccn-cn-shanghai</RegionId>
                          <RouteMapId>cenrmap-dbarzidzp7ek4k****</RouteMapId>
                    </CenOutRouteMapRecord>
              </CenOutRouteMapRecords>
              <NextHopType>VPC</NextHopType>
              <NextHopRegionId>cn-hangzhou</NextHopRegionId>
              <Type>CEN</Type>
              <Preference>50</Preference>
              <Communities>
        </Communities>
              <CenRouteMapRecords>
        </CenRouteMapRecords>
              <DestinationCidrBlock>10.0.8.0/24</DestinationCidrBlock>
              <AsPaths>
        </AsPaths>
              <NextHopInstanceId>vpc-bp1j8728mm6pweeod****</NextHopInstanceId>
        </CenRouteEntry>
        <CenRouteEntry>
              <Status>Active</Status>
              <CenOutRouteMapRecords>
        </CenOutRouteMapRecords>
              <NextHopType>local_service</NextHopType>
              <NextHopRegionId>cn-hangzhou</NextHopRegionId>
              <Type>System</Type>
              <Preference>50</Preference>
              <Communities>
        </Communities>
              <CenRouteMapRecords>
        </CenRouteMapRecords>
              <DestinationCidrBlock>100.64.0.0/10</DestinationCidrBlock>
              <AsPaths>
        </AsPaths>
        </CenRouteEntry>
        <CenRouteEntry>
              <Status>Active</Status>
              <CenOutRouteMapRecords>
        </CenOutRouteMapRecords>
              <NextHopType>CCN</NextHopType>
              <NextHopRegionId>ccn-cn-shanghai</NextHopRegionId>
              <Type>CEN</Type>
              <Preference>50</Preference>
              <Communities>
        </Communities>
              <CenRouteMapRecords>
                    <CenRouteMapRecord>
                          <RegionId>cn-hangzhou</RegionId>
                          <RouteMapId>cenrmap-cz5axczdxb7yfu****</RouteMapId>
                    </CenRouteMapRecord>
              </CenRouteMapRecords>
              <DestinationCidrBlock>172.16.0.0/16</DestinationCidrBlock>
              <AsPaths>
        </AsPaths>
              <NextHopInstanceId>ccn-0q3b7oviikmm9h*****</NextHopInstanceId>
        </CenRouteEntry>
        <CenRouteEntry>
              <Status>Active</Status>
              <CenOutRouteMapRecords>
        </CenOutRouteMapRecords>
              <NextHopType>CCN</NextHopType>
              <NextHopRegionId>ccn-cn-shanghai</NextHopRegionId>
              <Type>CEN</Type>
              <Preference>50</Preference>
              <Communities>
        </Communities>
              <CenRouteMapRecords>
                    <CenRouteMapRecord>
                          <RegionId>cn-hangzhou</RegionId>
                          <RouteMapId>cenrmap-cz5axczdxb7yfu****</RouteMapId>
                    </CenRouteMapRecord>
              </CenRouteMapRecords>
              <DestinationCidrBlock>192.168.2.0/24</DestinationCidrBlock>
              <AsPaths>
        </AsPaths>
              <NextHopInstanceId>ccn-0q3b7oviikmm9h****</NextHopInstanceId>
        </CenRouteEntry>
  </CenRouteEntries>
</DescribeCenRegionDomainRouteEntriesResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.