Cloud Enterprise Network:DescribePublishedRouteEntries - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries the publication status in Cloud Enterprise Network (CEN) for routes loaded to CEN network instances such as VPCs and VBRs, the instance type associated with the next hop of each route entry, and whether the route can be published to or withdrawn from CEN.

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 Resource Access Management (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 supports 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 Alibaba Cloud Resource Name (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.
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:DescribePublishedRouteEntries

get

*CenInstance

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

*virtualborderrouter

acs:vpc:*:{#accountId}:virtualborderrouter/{#virtualborderrouterId}

*VPC

acs:vpc:*:{#accountId}:vpc/{#vpcId}

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries to return per page in a paging query. Default value: 10. Valid values: 1 to 500.	10
CenId	string	Yes	The instance ID of the Cloud Enterprise Network (CEN).	cen-7qthudw0ll6jm****
ChildInstanceId	string	Yes	The instance 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	VPC
ChildInstanceRegionId	string	Yes	The region ID of the network instance. You can call the DescribeChildInstanceRegions operation to query the region ID.	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 entry to query.	172.16.0.0/16

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page in a paging query.	10
RequestId	string	The request ID.	FF1A7B2A-677F-4F71-96EA-6002B329F437
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries.	2
PublishedRouteEntries	object
PublishedRouteEntry	array<object>	The list of route entry information.
	array<object>
NextHopId	string	The instance ID associated with the next hop of the route entry.	ecs-bp18sth14qii3pn****
PublishStatus	string	The publication status in CEN. Valid values: Published: The route is published. NonPublished: The route is not published.	Published
ChildInstanceRouteTableId	string	The ID of the route table of the network instance.	vtb-il7qut3mjgtlcbpk2****
NextHopType	string	The instance type associated with the next hop of the route entry. Valid values: Instance: ECS instance HaVip: high-availability (active) virtual IP address RouterInterface: router interface NetworkInterface: elastic network interface controller (NIC) VpnGateway: VPN gateway IPv6Gateway: IPv6 gateway Ipv4Gateway: IPv4 gateway NatGateway: NAT gateway Attachment: network instance connection service: cloud service VBR: border router CCN: Cloud Connect Network VPC: VPC local: The current route entry is a system route of the network instance and has no next hop. TR: transit router BlackHole: The current route entry is a blackhole route and has no next hop. EcRouterInterface: Express Connect router interface HealthCheck: health check AS: Cloud Connect Network access gateway classicLink: classic network instance GatewayEndpoint: gateway endpoint CPE: on-premises data center connected to the border router	Instance
OperationalMode	boolean	Specifies whether the route is allowed to be published to or withdrawn from CEN. Valid values: true: The route can be published or withdrawn. false: The route cannot be published or withdrawn.	true
DestinationCidrBlock	string	The destination CIDR block of the route entry.	172.16.0.0/16
RouteType	string	The type of the route entry. Valid values: CEN: route propagated through CEN System: system route Custom: custom route	System
Conflicts	object
Conflict	array<object>	The list of conflicting route entry information.
	object
Status	string	The cause of the route entry conflict. Valid values: conflict: The conflict is caused by identical destination CIDR blocks of route entries. overflow: The conflict is caused by the number of route entries in the route table of another network instance exceeding the limit.	conflict
DestinationCidrBlock	string	The destination CIDR block of the conflicting route entry.	192.168.20.0/24
InstanceId	string	The instance ID of the peer network instance that causes the route conflict.	ccn-0q3b7oviikmm9h****
InstanceType	string	The type of the peer network instance that causes the route entry conflict. Valid values: VPC: VPC VBR: VBR CCN: Cloud Connect Network	CCN
RegionId	string	The region ID of the peer network instance that causes the route entry conflict.	ccn-cn-shanghai

Examples

Success response

JSON format

{
  "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.
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.
500	InternalError	Internal error.	The error message returned because an internal error occurred.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.