DescribeCenChildInstanceRouteEntries - Cloud Enterprise Network

Queries the routes of a network instance that is attached to a Cloud Enterprise Network (CEN) instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a RAM policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding ARN in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services. For more information, see Common condition keys.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:DescribeCenChildInstanceRouteEntries

get

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	Yes	The ID of the CEN instance.	cen-7qthudw0ll6jmc****
ChildInstanceId	string	Yes	The ID of the network instance.	vpc-bp18sth14qii3pnvo****
ChildInstanceType	string	Yes	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
Status	string	No	The status of the route. Valid values: Active: available Candidate: standby Rejected: rejected Prohibited: prohibited All (default): all routes	Active
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 500. Default value: 10.	10
ChildInstanceRegionId	string	No	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
ChildInstanceRouteTableId	string	No	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

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	17A57456-EF48-419D-9AE6-9B03D9996018
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The total number of entries returned.	4
CenRouteEntries	object
CenRouteEntry	array	The information about the route.
	object
Status	string	The route status. Valid values: Active: available routes Candidate: standby routes Rejected: rejected routes Prohibited: prohibited routes	Active
Type	string	The route type. Valid values: CEN: route that is advertised through CEN System: system route Custom: custom route	CEN
PublishStatus	string	Indicates whether the route is advertised to the CEN instance. Valid values: Published NonPublished	Published
NextHopType	string	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
OperationalMode	boolean	Indicates whether the route is allowed to be advertised to or withdrawn from the CEN instance. Valid values: true false	true
NextHopRegionId	string	The region ID of the instance specified as the next hop in the route.	cn-hangzhou
NextHopInstanceId	string	The ID of the instance specified as the next hop in the route.	vbr-bp13gtbhdp0pfqg6s****
DestinationCidrBlock	string	The destination CIDR block of the route.	10.0.0.0/24
RouteTableId	string	The route table ID.	vtb-bp1r9pvl4xen8s9ju****
CenRouteMapRecords	object
CenRouteMapRecord	array	The routing policy that the routes match.
	object
RouteMapId	string	The routing policy ID.	cenrmap-w4yf7toozfol3q****
RegionId	string	The region ID of the routing policy.	cn-hangzhou
Conflicts	object
Conflict	array	A list of overlapping routes.
	object
Status	string	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
DestinationCidrBlock	string	The destination CIDR block of the overlapping route.	192.168.1.0/24
InstanceId	string	The ID of the peer network instance on which the overlapping routes are found.	ccn-0q3b7oviikmm9h****
InstanceType	string	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
RegionId	string	The region ID of the peer network instance on which the overlapping routes are found.	ccn-cn-shanghai
Communities	object
Community	array	The community attributes of the route entries.
	string	The route community value.	65501:1
AsPaths	object
AsPath	array	The AS paths of the routes.
	string	The route AS path value.	65501

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.
404	InvalidRouteTableId.NotFound	The specified RouteTableId is not found.	The specified route table ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.