All Products
Search
Document Center

Virtual Private Cloud:AssociateRouteTableWithGateway

Last Updated:Nov 13, 2024

Associates a gateway route table with an IPv4 gateway in the same virtual private cloud (VPC).

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:AssociateRouteTableWithGatewaycreate
  • Ipv4Gateway
    acs:vpc:{#regionId}:{#accountId}:ipv4gateway/{#ipv4gatewayId}
  • RouteTable
    acs:vpc:{#regionId}:{#accountId}:routetable/{#routetableId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the IPv4 gateway with which you want to associate the gateway route table.

You can call the DescribeRegions operation to query the most recent region list.

ap-southeast-6
RouteTableIdstringYes

The ID of the gateway route table.

vtb-5ts0ohchwkp3dydt2****
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId of each API request may be different.
123e4567-e89b-12d3-a456-426655440000
DryRunbooleanNo

Specifies whether to check the request without performing the operation. Valid values:

  • true: prechecks the request without performing the operation. The system prechecks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): sends the request. After the request passes the precheck, a 2xx HTTP status code is returned and the operation is performed.
false
GatewayIdstringYes

The ID of the IPv4 gateway.

The IPv4 gateway must be in the Activated state.

ipv4gw-5tsnc6s4ogsedtp3k****
GatewayTypestringNo

The type of a gateway to be associated with a route table.

Ipv4Gateway

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

F89C2176-8F10-55EF-90CF-CF99D1E3F816

Examples

Sample success responses

JSONformat

{
  "RequestId": "F89C2176-8F10-55EF-90CF-CF99D1E3F816"
}

Error codes

HTTP status codeError codeError messageDescription
400ResourceNotFound.Ipv4GatewayThe specified resource ipv4Gateway is not found.The IPv4 gateway is not found and cannot be deleted.
400IncorrectStatus.Ipv4GatewayThe status of %s [%s] is incorrect.The IPv4 gateway is in an invalid state. Try again later.
400ResourceAlreadyAssociated.Ipv4GatewayThe specified resource %s is already associated.The IPv4 gateway is already associated.
400ResourceNotFound.GatewayRouteTableThe specified resource GatewayRouteTable is not found.The gateway route table cannot be found.
400IncorrectStatus.GatewayRouteTableThe status of %s [%s] is incorrect.The gateway route table is in an invalid state. Try again later.
400ResourceAlreadyAssociated.GatewayRouteTableThe specified resource %s is already associated.The gateway route table is already associated with a gateway of the same type.
400OperationDenied.Ipv4GatewayNotActiveThe operation is not allowed because of ipv4Gateway [%s] is not active.The operation is not allowed because the IPv4 gateway is not activated.
400OperationDenied.RouteTableTypeIncorrectThe operation is not allowed because of routeTableType is incorrect.The operation is not allowed because the type of route table is not supported.
400ResourceNotFound.RouteTableThe specified resource gatewayRouteTable is not found.The gateway route table does not exist.
400OperationDenied.GatewayAndTableNotInOneVpcThe operation is not allowed because of GatewayAndTableNotInOneVpc.The gateway route table and gateway do not belong to the same VPC.
400IncorrectStatus.RouteTableThe status of the specified route table is incorrect.The route table is in an invalid state.
400IllegalParam.GatewayTypeThe param of %s is illegal.Invalid GatewayType value.
400UnsupportedFeature.Ipv6GatewayRouteTableThe feature of %s is not supported.The border gateway route table cannot be associated with the gateway.

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

Change history

Change timeSummary of changesOperation
2023-08-30API Description Update. The Error code has changedView Change Details
2023-06-30The Error code has changedView Change Details