Call CreateTransitRouterPrefixListAssociation to associate a prefix list with a transit router route table - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Associates a prefix list with an Enterprise Edition transit router route table.

Operation description

Before you associate a prefix list with an Enterprise Edition transit router route table, make sure that the following conditions are met:

You understand the limits and routing compatibility information of prefix lists. For more information, see Prefix lists.
You have created a prefix list. For more information, see CreateVpcPrefixList.
If you want to associate a cross-account prefix list with an Enterprise Edition transit router route table, make sure that the prefix list is shared with the Alibaba Cloud account that owns the Enterprise Edition transit router route table. For more information about how to share a prefix list, see Overview of resource sharing and API reference (Resource Sharing).

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-4266****
RegionId	string	Yes	The region ID of the transit router instance. You can call the DescribeChildInstanceRegions operation to query the region ID.	cn-hangzhou
TransitRouterId	string	Yes	The ID of the transit router instance.	tr-6ehx7q2jze8ch5ji0****
NextHopType	string	No	The next hop type. Valid values: BlackHole: specifies that all CIDR blocks in the prefix list are blackhole routes. All traffic destined for the CIDR blocks in the prefix list is dropped. VPC: specifies that the next hop of the CIDR blocks in the prefix list is a Virtual Private Cloud (VPC) connection. VBR: specifies that the next hop of the CIDR blocks in the prefix list is a Virtual Border Router (VBR) connection. TR: specifies that the next hop of the CIDR blocks in the prefix list is an inter-region connection. ECR: specifies that the next hop of the CIDR blocks in the prefix list is an Express Connect Router (ECR) instance.	VPC
PrefixListId	string	Yes	The ID of the prefix list.	pl-6ehtn5kqxgeyy08fi****
TransitRouterTableId	string	Yes	The ID of the transit router route table.	vtb-6ehgc262hr170qgyc****
NextHop	string	Yes	The ID of the next hop connection. To configure all CIDR blocks in the prefix list as blackhole routes, set this parameter to BlackHole.	tr-attach-flbq507rg2ckrj****
OwnerUid	integer	No	The ID of the Alibaba Cloud account that owns the prefix list.	1210123456123456
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without creating the association. The system checks the required parameters, request syntax, and business restrictions. If the check fails, the corresponding error is returned. If the check succeeds, the error code `DryRunOperation` is returned. false (default): performs a dry run and creates the association after the check succeeds. Note This parameter is currently not available.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50

Examples

Success response

JSON format

{
  "RequestId": "0C2EE7A8-74D4-4081-8236-CEBDE3BBCF50"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission.AliyunServiceRolePolicyForCEN	You are not authorized to create the service linked role. Role Name: AliyunServiceRolePolicyForCEN. Service Name: cen.aliyuncs.com. Make sure that the user has been granted the ram:CreateServiceLinkedRole permission.	The error message returned because you do not have the permissions to create the service-linked role whose role name is AliyunServiceRolePolicyForCEN and service name is cen.aliyuncs.com. You must acquire the ram:CreateServiceLinkedRole permission before you can create the service-linked role.
400	ResourceNotSupport.CCN	CCN not support prefix list.	The error message returned because prefix lists are not supported by CCN instances.
400	ResourceNotFound.PrefixlistCidrs	Can not find any cidr of specified prefix list.	The error message returned because the specified prefix list does not contain a CIDR block.
400	ResourceNotFound.Nexthop	The specified nexthop instance is not exsit.	The error message returned because the specified next hop does not exist.
400	ResourceExisted.PrefixlistAssociation	The prefix list has been already associated with this route table.	The error message returned because the specified prefix list is already associated with a route table.
400	ResourceNotFound.PrefixlistAssociation	The prefix list is not associated with this route table.
400	ResourceConflict.Route	Some of the prefixes of the prefix list are conflicted with exsited routes.
400	MultipleFound.PrefixlistAssociation	multiple same prefix association record found.	The error message returned because multiple configuration duplicates exist in the system.
400	QuotaReached.Route	The quota of the route table is not enough for the request prefix list.
400	InvalidStatus.PrefixlistAssociation	The prefix list association is not in a valid state for the operation.	The error message returned because the status of the specified prefix list does not support this operation. Try again later.
400	NotSupport.TrType	The basic tr type is not support for this operation.	The error message returned because this operation is not supported by Basic Edition transit routers.
400	InvalidValue.PrefixlistCidr	Invalid cidr exist in the specified prefixlist.	The error message returned because the specified prefix list contains an invalid CIDR block.
400	ResourceNotSupport.Nexthop	The specified nexthop instance type is not support for the operation.	The error message returned because this operation is not supported by the specified next hop.
400	ResourceMismatch.Nexthop	The specified nexthop and nexthop type mismatched.	The error message returned because the specified next hop or next hop type is invalid.
400	ResourceNotFound.PrefixList	The specified prefixlist does not found.	The error message returned because the specified prefix list does not exist.
400	OperationDenied.SystemPrefixList	SystemPrefixList can not be operated.	The error message returned because this operation is not supported by the system prefix list.
400	OperationFailed.OperateShareResource	Operate share prefixlist failed.	The error message returned because the specified prefix list failed to be shared.
400	InvalidStatus.Prefixlist	Prefixlist is not in a operate status.	The error message returned because the status of the specified prefix list does not support this operation.
400	RegionNotSupport.Prefixlist	Prefixlist association are not supported in this region.	The error message returned because the feature is not supported in the specified region.
400	OperationFailed.TransitRouterNotExist	Operation failed because transit router not exist.	The error message returned because the specified transit router does not exist.
400	IncorrectStatus.RouteTable	RouteTable status is invalid.	The error message returned because the operation is not supported when the specified route table is in an unstable state.
400	IllegalParam.TransitRouterTableId	The specified Route Table ID is invalid.	The Route Table ID is invalid.
400	OperationDenied.ECSPrefixList	Associate ECS PrefixList is not supported.	Associate ECS PrefixList is not supported.
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.
400	InvalidParameter.TransitRouterTableId	The specified parameter TransitRouterTableId is invalid.	The parameter TransitRouterTableId entered is illegal.
400	InvalidParameter.NextHop	The specified parameter NextHop is invalid.	The parameter NextHop entered is illegal.
400	InvalidParameter.TransitRouterId	The specified parameter TransitRouterId is invalid.	The parameter TransitRouterId entered is illegal.
404	InvalidRouteTableId.NotFound	The specified RouteTableId is not found.	The specified route table ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.