tencent cloud

Feedback

AssociateNatGatewayAddress

Last updated: 2022-06-23 15:21:10

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to bind an EIP to NAT Gateway.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: AssociateNatGatewayAddress.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
NatGatewayId Yes String The ID of the NAT gateway, such as nat-df45454.
AddressCount No Integer The number of EIPs you want to apply for. The system will create the same number of EIPs as you require. Either AddressCount or PublicAddresses must be passed in.
PublicIpAddresses.N No Array of String Array of the EIPs bound to the NAT gateway. Either AddressCount or PublicAddresses must be passed in.
Zone No String The availability zone of the EIP, which is passed in when the EIP is automatically assigned.
StockPublicIpAddressesBandwidthOut No Integer The bandwidth size (in Mbps) of the EIP bound to the NAT gateway, which defaults to the maximum value applicable for the current user type.
PublicIpAddressesBandwidthOut No Integer The requested size of the public network IP bandwidth (in Mbps), which defaults to the maximum value applicable for the current user type.
PublicIpFromSameZone No Boolean

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Binding an NAT gateway with an EIP

Input Example

https://vpc.tencentcloudapi.com/?Action=AssociateNatGatewayAddress
&NatGatewayId=nat-mdbjfr0y
&PublicIpAddresses.0=139.199.232.212
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "dbffc3f0-1807-4683-89ee-2d2b96425ee1"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue.EIPBrandWidthOutInvalid
InvalidParameterValue.Malformed Invalid input parameter format.
LimitExceeded.AddressQuotaLimitExceeded The number of EIPs applied for exceeds the upper limit.
LimitExceeded.DailyAllocateAddressQuotaLimitExceeded The number of EIPs applied for exceeds the daily upper limit.
LimitExceeded.PublicIpAddressPerNatGatewayLimitExceeded The number of EIPs bound to the NAT gateway has reached the upper limit.
ResourceInUse The resource is occupied.
ResourceNotFound The resource does not exist.
UnsupportedOperation Unsupported operation.
UnsupportedOperation.InvalidState Invalid resource status.
UnsupportedOperation.MutexOperationTaskRunning The resource mutual exclusion operation is being executed.
UnsupportedOperation.PublicIpAddressIsNotBGPIp The EIP bound to the NAT gateway is not a BGP IP.
UnsupportedOperation.PublicIpAddressIsNotExisted The EIP bound to the NAT gateway does not exist.
UnsupportedOperation.PublicIpAddressNotBilledByTraffic The EIP bound to the NAT gateway is not bill-by-traffic.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support