1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(AssociateNatGatewayAddress)用于NAT网关绑定弹性IP(EIP)。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AssociateNatGatewayAddress。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
NatGatewayId | 是 | String | NAT网关的ID,形如:nat-df45454 。示例值:nat-mdbjfr0y |
AddressCount | 否 | Integer | 需要申请的弹性IP个数,系统会按您的要求生产N个弹性IP, 其中AddressCount和PublicAddresses至少传递一个。 示例值:1 |
PublicIpAddresses.N | 否 | Array of String | 绑定NAT网关的弹性IP数组,其中AddressCount和PublicAddresses至少传递一个。 示例值:["139.199.232.212\n"] |
Zone | 否 | String | 弹性IP可用区,自动分配弹性IP时传递。 示例值:10003 |
StockPublicIpAddressesBandwidthOut | 否 | Integer | 绑定NAT网关的弹性IP带宽大小(单位Mbps),默认为当前用户类型所能使用的最大值。 示例值:77 |
PublicIpAddressesBandwidthOut | 否 | Integer | 需要申请公网IP带宽大小(单位Mbps),默认为当前用户类型所能使用的最大值。 示例值:77 |
PublicIpFromSameZone | 否 | Boolean | 公网IP是否强制与NAT网关来自同可用区,true表示需要与NAT网关同可用区;false表示可与NAT网关不是同一个可用区。此参数只有当参数Zone存在时才能生效。 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 NAT网关绑定弹性IP
NAT网关绑定弹性IP
输入示例
https://vpc.tencentcloudapi.com/?Action=AssociateNatGatewayAddress
&NatGatewayId=nat-mdbjfr0y
&PublicIpAddresses.0=139.199.232.212
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "dbffc3f0-1807-4683-89ee-2d2b96425ee1"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.ModuleError | 内部模块错误。 |
InvalidParameterValue.EIPBrandWidthOutInvalid | 值超过上限。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
LimitExceeded.AddressQuotaLimitExceeded | 租户申请的弹性IP超过上限。 |
LimitExceeded.DailyAllocateAddressQuotaLimitExceeded | 租户每天申请的弹性IP超过上限。 |
LimitExceeded.PublicIpAddressPerNatGatewayLimitExceeded | NAT网关绑定的弹性IP超过上限。 |
ResourceInUse | 资源被占用。 |
ResourceInUse.Address | 指定IP地址已经在使用中。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.InvalidState | 资源状态不合法。 |
UnsupportedOperation.MutexOperationTaskRunning | 资源互斥操作任务正在执行。 |
UnsupportedOperation.PublicIpAddressIsNotBGPIp | 绑定NAT网关的弹性IP不是BGP性质的IP。 |
UnsupportedOperation.PublicIpAddressIsNotExisted | 绑定NAT网关的弹性IP不存在。 |
UnsupportedOperation.PublicIpAddressNotBilledByTraffic | 绑定NAT网关的弹性IP不是按流量计费的。 |