1. 接口描述
接口请求域名: bmvpc.tencentcloudapi.com 。
创建NAT网关接口,可针对网段方式、子网全部IP、子网部分IP这三种方式创建NAT网关
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateNatGateway。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ForwardMode | 是 | String | 转发模式,其中0表示IP方式,1表示网段方式;通过cidr方式可支持更多的IP接入到NAT网关 示例值:1 |
VpcId | 是 | String | 私有网络ID,例如:vpc-kd7d06of 示例值:vpc-mi51u7gs |
NatName | 是 | String | NAT名称 示例值:test |
MaxConcurrent | 是 | Integer | 并发连接数规格;取值为1000000、3000000、10000000,分别对应小型、中型、大型NAT网关 示例值:10000000 |
SubnetIds.N | 否 | Array of String | 子网ID列表,子网下全部IP将加入NAT,不区分网关转发方式 示例值:["subnet-d3668cur\r\n","subnet-dipbsl5n\r\n"] |
IpInfoSet.N | 否 | Array of IpInfo | 部分IP信息,子网下只有该部分IP将加入NAT,仅当网关转发模式为IP方式有效;IpInfoSet和SubnetIds中的子网ID不能同时存在 |
AssignedEips.N | 否 | Array of String | 已分配的EIP列表, AssignedEips和AutoAllocEipNum至少输入一个 示例值:["139.199.40.59\r\n"] |
AutoAllocEipNum | 否 | Integer | 新建EIP数目,系统将会按您的要求生产该数目个数EIP, AssignedEips和AutoAllocEipNum至少输入一个 示例值:1 |
Exclusive | 否 | Integer | 独占标识,取值为0和1,默认值为0;0和1分别表示创建共享型NAT网关和独占NAT型网关;由于同一个VPC网络内,指向NAT集群的默认路由只有一条,因此VPC内只能创建一种类型NAT网关;创建独占型NAT网关时,需联系对应架构师进行独占NAT集群搭建,否则无法创建独占型NAT网关。 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | 任务ID 示例值:18403 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 IP方式创建NAT网关
输入示例
https://bmvpc.tencentcloudapi.com/?Action=CreateNatGateway
&ForwardMode=0
&VpcId=vpc-mi51u7gs
&SubnetIds.0=subnet-kmoq5ugh
&SubnetIds.1=subnet-j74dmsz5
&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
&NatName=test
&MaxConcurrent=1000000
&AutoAllocEipNum=1
&<公共请求参数>
输出示例
{
"Response": {
"TaskId": 18405,
"RequestId": "7d18fca8-4b3c-4bc6-818e-ec291764b8fb"
}
}
示例2 网段方式创建NAT网关
输入示例
https://bmvpc.tencentcloudapi.com/?Action=CreateNatGateway
&ForwardMode=1
&VpcId=vpc-mi51u7gs
&NatName=test
&MaxConcurrent=10000000
&AssignedEips.0=139.199.40.59
&SubnetIds.0=subnet-d3668cur
&SubnetIds.1=subnet-dipbsl5n
&<公共请求参数>
输出示例
{
"Response": {
"TaskId": 18403,
"RequestId": "6e9f212d-b3cb-417e-b78e-3ae6ec690e4d"
}
}
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 | 超过配额限制。 |
ResourceInUse | 资源被占用。 |
UnsupportedOperation | 操作不支持。 |