All Products
Search
Document Center

Cloud Enterprise Network:DescribeCenChildInstanceRouteEntries

Last Updated:Nov 18, 2024

Queries the routes of a network instance that is attached to 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:DescribeCenChildInstanceRouteEntriesget
*CenInstance
acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CenIdstringYes

The ID of the CEN instance.

cen-7qthudw0ll6jmc****
ChildInstanceIdstringYes

The ID of the network instance.

vpc-bp18sth14qii3pnvo****
ChildInstanceTypestringYes

The type of the network instance. Valid values:

  • VPC: virtual private cloud (VPC)
  • VBR: virtual border router (VBR)
  • CCN: Cloud Connect Network (CCN) instance
  • ECR: Express Connect Router (ECR)
VPC
StatusstringNo

The status of the route. Valid values:

  • Active: available
  • Candidate: standby
  • Rejected: rejected
  • Prohibited: prohibited
  • All (default): all routes
Active
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
ChildInstanceRegionIdstringYes

The ID of the region where the network instance is deployed.

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

cn-hangzhou
ChildInstanceRouteTableIdstringNo

The ID of the route table of the network instance. If you do not specify a route table ID, the system queries the routes in the system route tables of the VPCs by default.

vtb-p0wxx3apzgn6uqp3r****

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

17A57456-EF48-419D-9AE6-9B03D9996018
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries returned.

4
CenRouteEntriesarray<object>

The information about the route.

CenRouteEntryobject
Statusstring

The route status. Valid values:

  • Active: available routes
  • Candidate: standby routes
  • Rejected: rejected routes
  • Prohibited: prohibited routes
Active
Typestring

The route type. Valid values:

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

Indicates whether the route is advertised to the CEN instance. Valid values:

  • Published
  • NonPublished
Published
NextHopTypestring

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

  • Instance: an ECS instance
  • HaVip: an HAVIP
  • RouterInterface: a router interface
  • NetworkInterface: an ENI
  • VpnGateway: a VPN gateway
  • IPv6Gateway: an IPv6 gateway
  • Ipv4Gateway: an IPv4 gateway
  • NatGateway: a NAT gateway
  • Attachment: a network instance connection
  • service: a cloud service
  • VBR: a VBR
  • CCN: a CCN instance
  • VPC: a VPC
  • local: a system route (no next hop is specified)
  • TR: a transit router
  • BlackHole: a blackhole route (no next hop is specified)
  • EcRouterInterface: a router interface for Express Connect
  • HealthCheck: a health check
  • AS: an access gateway for CCN
  • classic: a classic network-type instance
  • GatewayEndpoint: a gateway endpoint
  • CPE: a data center connected to a VBR
VBR
OperationalModeboolean

Indicates whether the route is allowed to be advertised to or withdrawn from the CEN instance. Valid values:

  • true
  • false
true
NextHopRegionIdstring

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

cn-hangzhou
NextHopInstanceIdstring

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

vbr-bp13gtbhdp0pfqg6s****
DestinationCidrBlockstring

The destination CIDR block of the route.

10.0.0.0/24
RouteTableIdstring

The route table ID.

vtb-bp1r9pvl4xen8s9ju****
CenRouteMapRecordsarray<object>

The routing policy that the routes match.

CenRouteMapRecordobject
RouteMapIdstring

The routing policy ID.

cenrmap-w4yf7toozfol3q****
RegionIdstring

The region ID of the routing policy.

cn-hangzhou
Conflictsarray<object>

A list of overlapping routes.

Conflictobject
Statusstring

The cause of the route error. Valid values:

  • conflict: The routes have the same destination CIDR block.
  • overflow: The number of routes in the route table configured on another network instance has reached the upper limit.
conflict
DestinationCidrBlockstring

The destination CIDR block of the overlapping route.

192.168.1.0/24
InstanceIdstring

The ID of the peer network instance on which the overlapping routes are found.

ccn-0q3b7oviikmm9h****
InstanceTypestring

The type of the peer network instance on which the overlapping routes are found. Valid values:

  • VPC: VPC
  • VBR: VBR
  • CCN: CCN instance
  • ECR: ECR
CCN
RegionIdstring

The region ID of the peer network instance on which the overlapping routes are found.

ccn-cn-shanghai
Communitiesarray

The community attributes of the route entries.

Communitystring

The route community value.

65501:1
AsPathsarray

The AS paths of the routes.

AsPathstring

The route AS path value.

65501

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "17A57456-EF48-419D-9AE6-9B03D9996018",
  "PageNumber": 1,
  "TotalCount": 4,
  "CenRouteEntries": {
    "CenRouteEntry": [
      {
        "Status": "Active",
        "Type": "CEN",
        "PublishStatus": "Published",
        "NextHopType": "VBR",
        "OperationalMode": true,
        "NextHopRegionId": "cn-hangzhou",
        "NextHopInstanceId": "vbr-bp13gtbhdp0pfqg6s****",
        "DestinationCidrBlock": "10.0.0.0/24",
        "RouteTableId": "vtb-bp1r9pvl4xen8s9ju****",
        "CenRouteMapRecords": {
          "CenRouteMapRecord": [
            {
              "RouteMapId": "cenrmap-w4yf7toozfol3q****",
              "RegionId": "cn-hangzhou"
            }
          ]
        },
        "Conflicts": {
          "Conflict": [
            {
              "Status": "conflict",
              "DestinationCidrBlock": "192.168.1.0/24",
              "InstanceId": "ccn-0q3b7oviikmm9h****",
              "InstanceType": "CCN",
              "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.
404InvalidRouteTableId.NotFoundThe specified RouteTableId is not found.The specified route table ID does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-25The Error code has changedView Change Details
2023-12-26API Description Update. The Error code has changedView Change Details