PublishRouteEntries - Cloud Enterprise Network - Alibaba Cloud Documentation Center

You can call the PublishRouteEntries operation to advertise routes from a virtual private cloud (VPC) or a virtual border router (VBR) to a Cloud Enterprise Network (CEN) instance. If no route conflicts occur, other network instances attached to the CEN instance can learn the advertised routes.

Operation description

The following table lists the default advertising status for different types of routes in CEN. You can call the PublishRouteEntries operation to advertise routes that are not advertised to CEN by default.

Route	Instance of the route	Advertised to CEN by default
Route to an ECS instance	VPC	No
Route to a VPN Gateway	VPC	No
Route to a high availability (HA) virtual IP address	VPC	No
Route to a router interface	VPC	No
Route to an Elastic Network Interface (ENI)	VPC	No
Route to an IPv6 Gateway	VPC	No
Route to a NAT Gateway	VPC	No
VPC system route	VPC	Yes
Route to a data center	VBR	Yes
Border Gateway Protocol (BGP) route	VBR	Yes

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 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 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:PublishRouteEntries

update

*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
CenId	string	Yes	The ID of the CEN instance.	cen-7qthudw0ll6jmc****
ChildInstanceId	string	Yes	The ID of the network instance.	vpc-rj9gt5nll27onu****
ChildInstanceType	string	Yes	The type of the network instance. Valid values: VPC: virtual private cloud. VBR: virtual border router.	VPC
ChildInstanceRegionId	string	Yes	The ID of the region where the network instance is deployed. You can call the DescribeChildInstanceRegions operation to query region IDs.	us-west-1
ChildInstanceRouteTableId	string	Yes	The ID of the route table of the network instance.	vtb-bp174d1gje7****
DestinationCidrBlock	string	Yes	The destination CIDR block of the route that you want to advertise.	172.16.1.0/24

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	FBDB18D8-E91E-4978-8D6C-6E2E3EE10133

Examples

Success response

JSON format

{
  "RequestId": "FBDB18D8-E91E-4978-8D6C-6E2E3EE10133"
}

Error response

JSON format

{
    "RequestId": "FBDB18D8-E91E-4978-8D6C-6E2E3EE10133"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterIllegal.AliUid	The parameter of aliUid is illegal.
400	InvalidOperation.UnsupportnexthopType	The nexthop type is unsupported	The error message returned because the next hop type does not support this operation.
400	InvalidOperation.NotFoundRoute	The specified route does not exist.	The error message returned because the route does not exist.
400	ParameterIllegal.CenInstanceId	The parameter of CEN instance id is illegal.
400	ParameterIllegal.ChildInstanceRegionId	The parameter of child instance region id is illegal.
400	ParameterIllegal.ChildInstanceType	The parameter of child instance type is illegal.
400	InvalidOperation.UnsupportRouteTableType	The route table type is unsupported	The error message returned because the specified route table type does not support this operation.
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.
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.