AssociateRouteTablesWithVpcGatewayEndpoint-阿里云帮助中心

Calls the AssociateRouteTablesWithVpcGatewayEndpoint operation to associate route tables with a gateway endpoint.

Operation description

Before you call this operation to associate route tables with a gateway endpoint, take note of the following information:

The gateway endpoint instance with which you want to associate route tables cannot be in a transient state, such as Creating, Modifying, Associating (attaching), Dissociating (detaching), or Deleting (deleting).
The route tables that you want to associate cannot be in a transient state, such as Creating, Modifying, Associating (attaching), Dissociating (detaching), or Deleting (deleting).
The route tables and the gateway endpoint must belong to the same VPC.
The route tables to be associated cannot be shared route tables.
Virtual Border Router (VBR) route tables are not supported.
You can associate up to 20 route tables at a time.
The AssociateRouteTablesWithVpcGatewayEndpoint operation is asynchronous. After you send a request, the system returns an endpoint instance ID, but the route tables have not been associated with the gateway endpoint yet. The association task is still running in the background. You can call GetVpcGatewayEndpointAttribute to query the association status of the route tables and the gateway endpoint:
- If the route tables and the gateway endpoint are in the Associating state, the route tables are being associated with the gateway endpoint.
- If the route tables and the gateway endpoint are in the Created state, the route tables have been associated with the gateway endpoint.
The AssociateRouteTablesWithVpcGatewayEndpoint operation does not support concurrent association of the same route table with a gateway endpoint.

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

vpc:AssociateRouteTablesWithVpcGatewayEndpoint

create

*GatewayEndpoint

acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}

None

Request parameters

Parameter	Type	Required	Description	Example
EndpointId	string	Yes	The ID of the gateway endpoint instance with which you want to associate route tables.	vpce-m5e371h5clm3uadih****
RouteTableIds	array	Yes	The ID of the route table to associate. Valid values of N: 1 to 20. You can associate up to 20 route tables at a time.	vtb-m5elgtm3aj586iitr****
	string	No	The ID of the route table to associate. Valid values of N: 1 to 20. You can associate up to 20 route tables at a time.	vtb-m5elgtm3aj586iitr****
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 ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. 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.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: sends a dry run request without associating route tables with the gateway endpoint. The system checks the AccessKey pair, the authorization of the Resource Access Management (RAM) user, and the required parameters. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): sends a normal request. After the request passes the dry run, a 2xx HTTP status code is returned and the route tables are associated.	false
RegionId	string	Yes	The region ID of the gateway endpoint with which you want to associate route tables. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	59BDDA2D-FB52-59F9-9DC5-5EA7D6808B8E

Examples

Success response

JSON format

{
  "RequestId": "59BDDA2D-FB52-59F9-9DC5-5EA7D6808B8E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationFailed.ConcurrentOperation	The operation is failed because of concurrent operation.
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
400	ResourceNotFound.GatewayEndpoint	The specified resource gateway endpoint is not found.	The error message returned because the specified gateway endpoint does not exist.
400	IncorrectStatus.GatewayEndpoint	The status of GatewayEndpoint [%s] is incorrect.
400	ResourceNotFound.ServiceName	The specified resource service name is not found.
400	ResourceNotFound.PrefixList	The specified resource prefixList is not found.
400	ResourceNotFound.RouteTable	The specified resource routetable is not found.
400	Mismatch.VpcAndRouteTable	The vpc and routetable are mismatched.
400	IncorrectStatus.RouteTable	The status of route table [%s] is incorrect.
400	ResourceAlreadyExist.Association	The specified resource of [%s] is already exist.
400	VPC_ROUTE_ENTRY_CIDR_BLOCK_DUPLICATE	Specified CIDR block is already exists.
400	VPC_SWITCH_STATUS_ERROR	vSwitch status error, %s
400	QuotaExceeded.VpcRouteEntryNum	The quota of vpc route entry num is exceeded, usage %s/%s.
400	OperationUnsupported.DestinationCidrBlockOverlapWithVSwitch	The operation is failed because of destination CIDR block is in the CIDR of the VSwitch.
400	SystemBusy	System is busy, please try again later.
400	Forbbiden	User not authorized to operate on the specified resource.
400	InvalidRegionId.NotFound	The regionId provided does not exist in our records.	The RegionId parameter is set to an invalid value. Specify a valid value and try again.
400	IncorrectStatus.Vpc	The status of vpc [%s] is incorrect.
400	IncorrectStatus.CenStatus	The status of vpc cenStatus [%s] is incorrect.
400	UnsupportedFeature.RouterTableType	The type of router table is not supported.	The specified route table type is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.