DescribePublishedRouteEntries - Cloud Enterprise Network

Queries whether the routes of virtual private clouds (VPCs) and virtual border routers (VBRs) are advertised to the Cloud Enterprise Network (CEN) instance to which the VCPs and VBRs are attached.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cen:DescribePublishedRouteEntries	get	CenInstance acs:cen::{#accountId}:ceninstance/{#ceninstanceId} virtualborderrouter acs:vpc::{#accountId}:virtualborderrouter/{#virtualborderrouterId} VPC acs:vpc:*:{#accountId}:vpc/{#vpcId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.	10
CenId	string	Yes	The ID of the CEN instance.	cen-7qthudw0ll6jm****
ChildInstanceId	string	Yes	The ID of the network instance.	vpc-bp18sth14qii3pnv****
ChildInstanceType	string	Yes	The type of the network instance. Valid values: VPC: VPC VBR: VBR CCN: Cloud Connect Network (CCN) instance	VPC
ChildInstanceRegionId	string	Yes	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.	vtb-bp174d1gje79u1g4****
DestinationCidrBlock	string	No	The destination CIDR block of the route that you want to query.	172.16.0.0/16

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	10
RequestId	string	The ID of the request.	FF1A7B2A-677F-4F71-96EA-6002B329F437
PageNumber	integer	The page number of the returned page.	1
TotalCount	integer	The total number of entries returned.	2
PublishedRouteEntries	array<object>	A list of routes.
PublishedRouteEntry	object
NextHopId	string	The ID of the instance specified as the next hop in the route.	ecs-bp18sth14qii3pn****
PublishStatus	string	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.	Published
ChildInstanceRouteTableId	string	The ID of the route table configured on the network instance.	vtb-il7qut3mjgtlcbpk2****
NextHopType	string	The type of the instance specified as the next hop in the route. Instance: ECS instance HaVip: high-availability virtual IP address (HAVIP). RouterInterface: router interface. NetworkInterface: elastic network interface (ENI). VpnGateway: VPN gateway. IPv6Gateway: IPv6 gateway. NatGateway: NAT gateway. Attachment: network instance connection service: cloud service VBR: VBR CCN: CCN instance VPC: VPC local: system route. No next hop is specified. TR: transit router BlackHole: blackhole route. No next hop is specified. EcRouterInterface: router interface for Express Connect HealthCheck: health check AS: access gateway for CCN classicLink: classic network-type instance GatewayEndpoint: gateway endpoint CPE: data center connected to the VBR	Instance
OperationalMode	boolean	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.	true
DestinationCidrBlock	string	The destination CIDR block of the route.	172.16.0.0/16
RouteType	string	The type of the route. Valid values: CEN: route that is advertised through CEN System: system route Custom: custom route	System
Conflicts	array<object>	A list of conflicting routes.
Conflict	object
Status	string	The cause of the route confliction. 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 conflicting route.	192.168.20.0/24
InstanceId	string	The ID of the peer network instance on which conflicting routes are found.	ccn-0q3b7oviikmm9h****
InstanceType	string	The type of the peer network instance on which the conflicting routes are found. Valid values: VPC: VPC VBR: VBR CCN: CCN instance	CCN
RegionId	string	The ID of the region where the peer network instance on which the conflicting routes are found is deployed.	ccn-cn-shanghai

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "FF1A7B2A-677F-4F71-96EA-6002B329F437",
  "PageNumber": 1,
  "TotalCount": 2,
  "PublishedRouteEntries": {
    "PublishedRouteEntry": [
      {
        "NextHopId": " ecs-bp18sth14qii3pn****",
        "PublishStatus": "Published",
        "ChildInstanceRouteTableId": "vtb-il7qut3mjgtlcbpk2****",
        "NextHopType": "Instance",
        "OperationalMode": true,
        "DestinationCidrBlock": "172.16.0.0/16",
        "RouteType": "System",
        "Conflicts": {
          "Conflict": [
            {
              "Status": "conflict",
              "DestinationCidrBlock": "192.168.20.0/24",
              "InstanceId": "ccn-0q3b7oviikmm9h****",
              "InstanceType": "CCN",
              "RegionId": "ccn-cn-shanghai"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterIllegal.CenInstanceId	The parameter of CEN instance id is illegal.	The error message returned because the specified 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 ID of the region where the network instance is created is invalid.
400	VRC_ERROR	VRC error	-
400	ParameterIllegal.ChildInstanceType	The parameter of child instance type is illegal.	The error message returned because the specified type of network instance is invalid.
400	ParameterIllegal	The parameter is illegal.	The error message returned because a parameter is set to an invalid value.
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	Instance.NotExist	The instance is not exist.	The error message returned because the specified instance does not exist.
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. Try again later.
409	InvalidOperation.CenInstanceStatus	The CEN instance is not in a valid state for the operation.	The error message returned because the status of the CEN instance does not support this operation.
500	InternalError	Internal error.	The error message returned because an internal error occurred.

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