All Products
Search

This Product

    Virtual Private Cloud:AssociateRouteTablesWithVpcGatewayEndpoint

    Document Center

    Virtual Private Cloud:AssociateRouteTablesWithVpcGatewayEndpoint

    Last Updated:Nov 13, 2024

    Associates a route table with a gateway endpoint.

    Operation description

    When you call this operation, take note of the following limits:

    • The gateway endpoint to be associated with the route table cannot be in one of the following states: Creating, Modifying, Associating, Dissociating, or Deleting.

    • The route table cannot be in one of the following states: Creating, Modifying, Associating, Dissociating, or Deleting.

    • The gateway endpoint and route table must belong to the same virtual private cloud (VPC).

    • The route table cannot be shared.

    • You cannot associate a gateway endpoint with a virtual border router (VBR) route table.

    • You can associate a gateway endpoint with at most 20 route tables at a time.

    • AssociateRouteTablesWithVpcGatewayEndpoint is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetVpcGatewayEndpointAttribute operation to query whether a route table is associated with a gateway endpoint.

      • If the Associating status is returned, the route table is being associated with the gateway endpoint.
      • If the Created status is returned, the route table is associated with the gateway endpoint.

    • You cannot repeatedly call the AssociateRouteTablesWithVpcGatewayEndpoint operation within a specific period of time.

    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:AssociateRouteTablesWithVpcGatewayEndpointcreate
    • GatewayEndpoint
      acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    EndpointIdstringYes

    The ID of the gateway endpoint to be associated with the route table.

    		vpce-m5e371h5clm3uadih****
    RouteTableIdsarrayYes

    The ID of the route table. Valid values of N are 1 to 20, which specifies that you can associate a gateway endpoint with at most 20 route tables at a time.

    stringYes

    The ID of the route table. Valid values of N are 1 to 20, which specifies that you can associate a gateway endpoint with at most 20 route tables at a time.

    		vtb-m5elgtm3aj586iitr****
    ClientTokenstringNo

    The client token that is used to ensure the idempotence of the request. You can use the client to generate a client token. Make sure that a unique client token is used for each request. The token 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 request ID as the client token. The request ID may be different for each request.
    		5A2CFF0E-5718-45B5-9D4D-70B3FF3898
    DryRunbooleanNo

    Specifies whether to perform only a dry run, without performing the actual request. Valid values:

    • true: performs only a dry run. The system checks your AccessKey pair, the RAM user permissions, and the required parameters. If the request fails the dry run, the DryRunOperation error code is returned. If the request passes the dry run, the DryRunOperation error code is returned.
    • false (default): performs a dry run and sends the request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
    		false
    RegionIdstringYes

    The region ID of the gateway endpoint.

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

    		cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object

    Schema of Response

    RequestIdstring

    The request ID.

    		59BDDA2D-FB52-59F9-9DC5-5EA7D6808B8E

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400OperationFailed.ConcurrentOperationThe operation is failed because of concurrent operation.-
    400IdempotentParameterMismatchThe 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.-
    400ResourceNotFound.GatewayEndpointThe specified resource gateway endpoint is not found.The error message returned because the specified gateway endpoint does not exist.
    400IncorrectStatus.GatewayEndpointThe status of GatewayEndpoint [%s] is incorrect.-
    400ResourceNotFound.ServiceNameThe specified resource service name is not found.-
    400ResourceNotFound.PrefixListThe specified resource prefixList is not found.-
    400ResourceNotFound.RouteTableThe specified resource routetable is not found.-
    400Mismatch.VpcAndRouteTableThe vpc and routetable are mismatched.-
    400IncorrectStatus.RouteTableThe status of route table [%s] is incorrect.-
    400ResourceAlreadyExist.AssociationThe specified resource of [%s] is already exist.-
    400VPC_ROUTE_ENTRY_CIDR_BLOCK_DUPLICATESpecified CIDR block is already exists.-
    400VPC_SWITCH_STATUS_ERRORvSwitch status error, %s-
    400QuotaExceeded.VpcRouteEntryNumThe quota of vpc route entry num is exceeded, usage %s/%s.-
    400OperationUnsupported.DestinationCidrBlockOverlapWithVSwitchThe operation is failed because of destination CIDR block is in the CIDR of the VSwitch.-
    400SystemBusySystem is busy, please try again later.-
    400ForbbidenUser not authorized to operate on the specified resource.User not authorized to operate on the specified resource.
    400InvalidRegionId.NotFoundThe regionId provided does not exist in our records.The RegionId parameter is set to an invalid value. Specify a valid value and try again.
    400IncorrectStatus.VpcThe status of vpc [%s] is incorrect.-
    400IncorrectStatus.CenStatusThe status of vpc cenStatus [%s] is incorrect.-

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

    Change history

    Change timeSummary of changesOperation
    2023-12-07The Error code has changedView Change Details