tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AssociateNatGatewayAddress

Last updated: 2023-08-23 14:11:28

1. API Description

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

This API is used to bind an EIP to a 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 No String Common Params. This parameter is not required for this API.
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. 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 size of the public network IP bandwidth to be applied for (in Mbps), which defaults to the maximum value applicable for the current user type.
PublicIpFromSameZone No Boolean Whether the public IP and the NAT gateway must be in the same availability zone. Valid values: true and false. This parameter is valid only when Zone is specified.

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 EIP to a NAT gateway

Binding an EIP to a NAT gateway

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
InternalError.ModuleError Internal module error
InvalidParameterValue.EIPBrandWidthOutInvalid Exceeded the upper limit.
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 per day exceeds the upper limit.
LimitExceeded.PublicIpAddressPerNatGatewayLimitExceeded The number of EIPs bound to the NAT gateway has reached the upper limit.
ResourceInUse The resource is occupied.
ResourceInUse.Address The specified IP address is already in use.
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.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy