DescribePublishedRouteEntries - API Reference| Alibaba Cloud Documentation Center

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-7qthudw0ll6jm****	The ID of the CEN instance that you want to query.
ChildInstanceId	String	Yes	vpc-bp18sth14qii3pnv****	The ID of the network instance.
ChildInstanceRegionId	String	Yes	cn-hangzhou	The ID of the region that you want to query.
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	DescribePublishedRouteEntries	The operation that you want to perform. Set the value to DescribePublishedRouteEntries.
ChildInstanceRouteTableId	String	No	vtb-bp174d1gje79u1g4****	The ID of the route table of the attached network instance.
DestinationCidrBlock	String	No	172.xx.xx.xx/24	The CIDR block that you want to query.
PageNumber	Integer	No	1	The number of the page to return. Default value: 1.
PageSize	Integer	No	2	The number of entries to return on each page. Maximum value: 50. Default value: 10.

Response parameters


Parameter	Type	Example	Description
PageNumber	Integer	1	The number of the returned page.
PageSize	Integer	2	The number of entries returned per page.
PublishedRouteEntries	Array		The routes that are advertised to the CEN instance in the specified region.
PublishedRouteEntry			The route that is advertised to the CEN instance in the specified region.
ChildInstanceRouteTableId	String	vtb-il7qut3mjgtlcbpk****	The ID of the route table.
Conflicts	Array		The conflicting routes.
Conflict			The conflicting route.
DestinationCidrBlock	String	192.168.10.0/24	The conflicting destination CIDR block.
InstanceId	String	ecs-xxdjakjdakhfkfka****	The ID of the conflicting network instance.
InstanceType	String	Instance	The type of the network instance.
RegionId	String	cn-hangzhou	The ID of the region where the conflicting network instance is created.
Status	String	conflict	The cause of the exception. Valid values: conflict: The route conflicts 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	172.16.xx.xx/24	The conflicting destination CIDR block.
NextHopId	String	ecs-bp18sth14qii3pn****	The ID of the next hop.
NextHopType	String	Instance	The type of the next hop. Default values: Instance (default): an Elastic Compute Service (ECS) instance. HaVip: a high-availability virtual IP address (HAVIP). RouterInterface: a router interface.
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	The state of the route in the CEN instance. Valid values: Published: The route is advertised. NonPublished: The route is not advertised.
RouteType	String	System	The type of the route. Valid values: System: The route is generated by the system. Custom: The route is manually added. BGP: The route is a Border Gateway Protocol (BGP) route.
RequestId	String	FF1A7B2A-677F-4F71-96EA-6002B329F437	The ID of the request.
TotalCount	Integer	10	The number of entries returned.

Examples

Sample requests


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

Sample success responses

XML format

<DescribeRouteConflictResponse>
	  <TotalCount>2</TotalCount>
	  <PublishRouteEntries>
		    <PublishRouteEntries>
			      <DestinationCidrBlock>100.64.0.0/10</DestinationCidrBlock>
			      <NextHopId></NextHopId>
			      <NextHopType>service</NextHopType>
			      <ChildInstanceRouteTableId>vtb-il7qut3mjgtlcbpk2****</ChildInstanceRouteTableId>
			      <PublishStatus>NonPublished</PublishStatus>
			      <RouteConflicts></RouteConflicts>
			      <RouteType>System</RouteType>
		    </PublishRouteEntries>
		    <PublishRouteEntries>
			      <DestinationCidrBlock>192.168.10.0/24</DestinationCidrBlock>
			      <NextHopId></NextHopId>
			      <NextHopType>local</NextHopType>
			      <ChildInstanceRouteTableId>vtb-il7qut3mjgtlcbpk2****</ChildInstanceRouteTableId>
			      <PublishStatus>Published</PublishStatus>
			      <RouteConflicts></RouteConflicts>
			      <RouteType>System</RouteType>
		    </PublishRouteEntries>
	  </PublishRouteEntries>
	  <PageNumber>1</PageNumber>
	  <RequestId>FF1A7B2A-677F-4F71-96EA-6002B329F437</RequestId>
	  <PageSize>10</PageSize>
</DescribeRouteConflictResponse>

JSON format

{
	"PageNumber":1,
	"PublishRouteEntries":{
		"PublishRouteEntries":[
			{
				"RouteType":"System",
				"ChildInstanceRouteTableId":"vtb-il7qut3mjgtlcbpk2****",
				"NextHopId":"",
				"NextHopType":"service",
				"RouteConflicts":{
					"RouteConflicts":[]
				},
				"DestinationCidrBlock":"100.64.0.0/10",
				"PublishStatus":"NonPublished"
			},
			{
				"RouteType":"System",
				"ChildInstanceRouteTableId":"vtb-il7qut3mjgtlcbpk2****",
				"NextHopId":"",
				"NextHopType":"local",
				"RouteConflicts":{
					"RouteConflicts":[]
				},
				"DestinationCidrBlock":"192.168.10.0/24",
				"PublishStatus":"Published"
			}
		]
	},
	"TotalCount":2,
	"PageSize":10,
	"RequestId":"FF1A7B2A-677F-4F71-96EA-6002B329F437"
}

Error codes


HttpCode	Error code	Error message	Description
400	ParameterIllegal.CenInstanceId	The parameter of CEN instance id is illegal.	The error message returned because the ID of the CEN instance is invalid.
400	ParameterIllegal.ChildInstanceRegionId	The parameter of child instance region id is illegal.	The error message returned because the region to which the network instance belongs is invalid.
409	InvalidOperation.ChildInstanceStatus	The child-instance is not in a valid state for the operation.	The error message returned because the operation is not allowed when the network instance is being processed.
409	InvalidOperation.CenInstanceStatus	The CEN instance is not in a valid state for the operation.	The error message returned because the operation is not allowed when the CEN instance is being processed.
400	ParameterIllegal.ChildInstanceType	The parameter of child instance type is illegal.	The error message returned because the type of the network instance is invalid.
500	InternalError	Internal error.	The error message returned because an internal error occurred.

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