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

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
CenId String Yes cen-7qthudw0ll6jmc****

The ID of the CEN instance.

ChildInstanceId String Yes vpc-bp18sth14qii3pnvo****

The ID of the network instance.

ChildInstanceRegionId String Yes cn-hangzhou

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

ChildInstanceType String Yes vpc

The type of the network instance. Valid values:

  • VPC: a virtual private cloud (VPC)
  • VBR: a virtual border router (VBR)
  • CCN: a Cloud Connect Network (CCN) instance
Action String No DescribeCenChildInstanceRouteEntries

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

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. Maximum value: 50. Default value: 10.

Status String No Active

The state of the route. Valid values:

  • Active: The route is active.
  • Backup: The route is a standby route.
  • Rejected: The route is rejected.
  • Prohibited: The route is prohibited.
  • All: All.

Response parameters

Parameter Type Example Description
CenRouteEntries Array

Detailed information about the routes.

CenRouteEntry

Detailed information about the route.

AsPaths List 65501

The AS Path attribute of BGP.

AsPath

The AS Path attribute of BGP.

CenRouteMapRecords Array

Detailed information about the route maps.

CenRouteMapRecord

Detailed information about the route map.

RegionId String cn-hangzhou

The ID of the region.

RouteMapId String cenrmap-w4yf7toozfol3q****

The ID of the route map.

Communities List 65501:1

The Communities attribute of BGP.

Community

The Communities attribute of BGP.

Conflicts Array

The conflicting routes.

Conflict

The conflicting route.

DestinationCidrBlock String 192.168.1.0/24

The destination CIDR block of the conflicting route.

InstanceId String ecs-xxdjakjdakhfkfka****

The ID of the conflicting instance.

InstanceType String ECS

The type of the network instance.

RegionId String cn-hangzhou

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

Status String conflict

The cause of the route error. Valid values:

  • conflict: The route is conflicting with another route.
  • overflow: The number of routes in the route table of another network instance has reached the upper limit.
  • prohibited: The route is prohibited by the VBR policies.
DestinationCidrBlock String 192.168.3.0/24

The destination CIDR block of the route.

NextHopInstanceId String vpc-o6woh5s494zueq40v****

The ID of the next hop. The next hop can be a VPC or VBR.

NextHopRegionId String cn-hangzhou

The ID of the region where the next hop is created.

NextHopType String VPC

The type of the next hop. Valid values:

  • VPC: a VPC
  • VBR: a VBR
OperationalMode Boolean true

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

  • true: The route is allowed to be advertised to or withdrawn from the CEN instance.
  • false: The route is not allowed to be advertised to or withdrawn from the CEN instance.
PublishStatus String Published

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

  • Published: The route is advertised to the CEN instance.
  • NonPublished: The route is not advertised to the CEN instance.
RouteTableId String vtb-bp1r9pvl4xen8s9ju****

The ID of the route table.

Status String Active

The state of the route.

Type String CBN

The type of the routes.

PageNumber Integer 1

The number of the returned page.

PageSize Integer 10

The number of entries returned per page.

RequestId String 4EC47282-1B74-4534-BD0E-403F3EE64CAF

The ID of the request.

TotalCount Integer 30

The number of routes.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeCenChildInstanceRouteEntries
&CenId=cen-7qthudw0ll6jmc****
&ChildInstanceId=vpc-bp18sth14qii3pnvo****
&ChildInstanceRegionId=cn-hangzhou
&ChildInstanceType=vpc
&<Common request parameters>

Sample success responses

XML format

<DescribeCenChildInstanceRouteEntriesResponse>
	  <PageNumber>1</PageNumber>
	  <TotalCount>4</TotalCount>
	  <PageSize>10</PageSize>
	  <RequestId>17A57456-EF48-419D-9AE6-9B03D9996018</RequestId>
	  <CenRouteEntries>
		    <CenRouteEntry>
			      <NextHopInstanceId>vbr-bp13gtbhdp0pfqg6s****</NextHopInstanceId>
			      <CenRouteMapRecords>
				        <CenRouteMapRecord>
					          <RouteMapId>cenrmap-4lcjxzo2zyqjd3****</RouteMapId>
					          <RegionId>cn-hangzhou</RegionId>
				        </CenRouteMapRecord>
			      </CenRouteMapRecords>
			      <OperationalMode>false</OperationalMode>
			      <Status>Active</Status>
			      <AsPaths></AsPaths>
			      <Communities></Communities>
			      <Type>CEN</Type>
			      <RouteTableId>vtb-bp1r9pvl4xen8s9ju****</RouteTableId>
			      <NextHopRegionId>cn-hangzhou</NextHopRegionId>
			      <NextHopType>VBR</NextHopType>
			      <Conflicts></Conflicts>
			      <DestinationCidrBlock>10.0.0.0/24</DestinationCidrBlock>
		    </CenRouteEntry>
		    <CenRouteEntry>
			      <CenRouteMapRecords></CenRouteMapRecords>
			      <OperationalMode>false</OperationalMode>
			      <Status>Active</Status>
			      <AsPaths></AsPaths>
			      <Communities></Communities>
			      <Type>System</Type>
			      <RouteTableId>vtb-bp1r9pvl4xen8s9ju****</RouteTableId>
			      <NextHopType>service</NextHopType>
			      <Conflicts></Conflicts>
			      <DestinationCidrBlock>100.64.0.0/10</DestinationCidrBlock>
			      <PublishStatus>NonPublished</PublishStatus>
		    </CenRouteEntry>
		    <CenRouteEntry>
			      <CenRouteMapRecords></CenRouteMapRecords>
			      <OperationalMode>true</OperationalMode>
			      <Status>Active</Status>
			      <AsPaths></AsPaths>
			      <Communities></Communities>
			      <Type>System</Type>
			      <RouteTableId>vtb-bp1r9pvl4xen8s9ju****</RouteTableId>
			      <NextHopType>local</NextHopType>
			      <Conflicts></Conflicts>
			      <DestinationCidrBlock>172.16.0.0/24</DestinationCidrBlock>
			      <PublishStatus>Published</PublishStatus>
		    </CenRouteEntry>
		    <CenRouteEntry>
			      <NextHopInstanceId>vbr-bp13gtbhdp0pfqg6s****</NextHopInstanceId>
			      <CenRouteMapRecords>
				        <CenRouteMapRecord>
					          <RouteMapId>cenrmap-4lcjxzo2zyqjd3****</RouteMapId>
					          <RegionId>cn-hangzhou</RegionId>
				        </CenRouteMapRecord>
			      </CenRouteMapRecords>
			      <OperationalMode>false</OperationalMode>
			      <Status>Active</Status>
			      <AsPaths></AsPaths>
			      <Communities></Communities>
			      <Type>CEN</Type>
			      <RouteTableId>vtb-bp1r9pvl4xen8s9ju****</RouteTableId>
			      <NextHopRegionId>cn-hangzhou</NextHopRegionId>
			      <NextHopType>VBR</NextHopType>
			      <Conflicts></Conflicts>
			      <DestinationCidrBlock>192.168.2.0/24</DestinationCidrBlock>
		    </CenRouteEntry>
	  </CenRouteEntries>
</DescribeCenChildInstanceRouteEntriesResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":4,
	"PageSize":10,
	"RequestId":"17A57456-EF48-419D-9AE6-9B03D9996018",
	"CenRouteEntries":{
		"CenRouteEntry":[
			{
				"NextHopInstanceId":"vbr-bp13gtbhdp0pfqg6s****",
				"Status":"Active",
				"OperationalMode":false,
				"CenRouteMapRecords":{
					"CenRouteMapRecord":[
						{
							"RouteMapId":"cenrmap-4lcjxzo2zyqjd3****",
							"RegionId":"cn-hangzhou"
						}
					]
				},
				"AsPaths":{
					"AsPath":[]
				},
				"Communities":{
					"Community":[]
				},
				"Type":"CEN",
				"NextHopType":"VBR",
				"NextHopRegionId":"cn-hangzhou",
				"RouteTableId":"vtb-bp1r9pvl4xen8s9ju****",
				"DestinationCidrBlock":"10.0.0.0/24",
				"Conflicts":{
					"Conflict":[]
				}
			},
			{
				"Status":"Active",
				"OperationalMode":false,
				"CenRouteMapRecords":{
					"CenRouteMapRecord":[]
				},
				"AsPaths":{
					"AsPath":[]
				},
				"Communities":{
					"Community":[]
				},
				"Type":"System",
				"NextHopType":"service",
				"RouteTableId":"vtb-bp1r9pvl4xen8s9ju****",
				"DestinationCidrBlock":"100.64.0.0/10",
				"Conflicts":{
					"Conflict":[]
				},
				"PublishStatus":"NonPublished"
			},
			{
				"Status":"Active",
				"OperationalMode":true,
				"CenRouteMapRecords":{
					"CenRouteMapRecord":[]
				},
				"AsPaths":{
					"AsPath":[]
				},
				"Communities":{
					"Community":[]
				},
				"Type":"System",
				"NextHopType":"local",
				"RouteTableId":"vtb-bp1r9pvl4xen8s9ju****",
				"DestinationCidrBlock":"172.16.0.0/24",
				"Conflicts":{
					"Conflict":[]
				},
				"PublishStatus":"Published"
			},
			{
				"NextHopInstanceId":"vbr-bp13gtbhdp0pfqg6s****",
				"Status":"Active",
				"OperationalMode":false,
				"CenRouteMapRecords":{
					"CenRouteMapRecord":[
						{
							"RouteMapId":"cenrmap-4lcjxzo2zyqjd3****",
							"RegionId":"cn-hangzhou"
						}
					]
				},
				"AsPaths":{
					"AsPath":[]
				},
				"Communities":{
					"Community":[]
				},
				"Type":"CEN",
				"NextHopType":"VBR",
				"NextHopRegionId":"cn-hangzhou",
				"RouteTableId":"vtb-bp1r9pvl4xen8s9ju****",
				"DestinationCidrBlock":"192.168.2.0/24",
				"Conflicts":{
					"Conflict":[]
				}
			}
		]
	}
}

Error codes

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