1. Interface Description
Interface request domain name: vpc.api3.convergecloud.com.
This API (AssociateNatGatewayAddress) is used to bind an EIP to a NAT gateway.
Default interface request rate limit: 100 times per second.
Interface update time: 2019-08-02 17:58:23.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: AssociateNatGatewayAddress |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| NatGatewayId | Yes | No | String | NAT gateway ID, e.g., nat-df45454.Example: nat-mdbjfr0y |
| AddressCount | No | No | Uint64 | Number of EIPs to apply for. The system will produce N EIPs according to your request. At least either AddressCount or PublicAddresses must be input. Example: 1 |
| PublicIpAddresses | No | No | Array of String | Array of elastic IPs bound to NAT gateway, where either AddressCount or PublicAddresses must be provided. Example: ["139.199.232.212\n"] |
| Zone | No | No | String | EIP availability area, input when EIP is automatically allocated. Example: ap-region-2 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| taskId | Int64 | Des task taskId Example: 213415 |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue.Malformed | Invalid input format. |
| ResourceNotFound | The resource does not exist |
| ResourceInUse | Resources occupied |
| ResourceInUse.Address | The specified IP address is already in use. |
| UnsupportedOperation.InvalidState | The resource status is invalid. |
| UnsupportedOperation.MutexOperationTaskRunning | Exclusive operation task of resources is in progress. |
| LimitExceeded.PublicIpAddressPerNatGatewayLimitExceeded | The number of elastic IPs bound to the NAT gateway has exceeded the upper limit. |
| UnsupportedOperation.PublicIpAddressIsNotExisted | The elastic IP bound to the NAT gateway does not exist. |
| UnsupportedOperation | Operation unsupported. |