1. 接口描述
接口请求域名: bmvpc.tencentcloudapi.com 。
可用于将子网的部分IP绑定到NAT网关
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:BindIpsToNatGateway。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
NatId | 是 | String | NAT网关ID,例如:nat-kdm476mp |
VpcId | 是 | String | 私有网络ID,例如:vpc-kd7d06of |
IpInfoSet.N | 是 | Array of IpInfo | 部分IP信息,子网下只有该部分IP将加入NAT,仅当网关转发模式为IP方式有效 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | 任务ID |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 NAT网关绑定IP
输入示例
https://bmvpc.tencentcloudapi.com/?Action=BindIpsToNatGateway
&NatId=nat-1tw1oc0t
&VpcId=vpc-mi51u7gs
&IpInfoSet.0.SubnetId=subnet-qnh7qryt
&IpInfoSet.0.Ips.0=192.168.88.2
&IpInfoSet.1.SubnetId=subnet-o9lo3es1
&IpInfoSet.1.Ips.0=192.168.222.2
&IpInfoSet.1.Ips.1=192.168.222.3
&<公共请求参数>
输出示例
{
"Response": {
"TaskId": 18425,
"RequestId": "758c3c3b-1f86-4930-a533-99549fc14a2c"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
LimitExceeded | 超过配额限制。 |
UnsupportedOperation | 操作不支持。 |