1. 接口描述
本接口(CreateNatGateway)用于创建 NAT 网关
接口请求域名:vpc.api.qcloud.com
使用该接口前请前往 NAT 网关说明了解 NAT 网关特性
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 CreateNatGateway。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
natName | 是 | string | NAT 网关名称,支持1-25个中文、英文大小写的字母、数字和下划线分隔符。 |
vpcId | 是 | string | 私有网络 ID 或者统一 ID,建议使用统一 ID,可通过 DescribeVpcEx 接口查询。 |
maxConcurrent | 是 | int | 网关并发连接上限,例如:1000000、3000000、10000000,具体支持数据请参见 私有网络网关说明。 |
bandwidth | 否 | int | 网关最大外网出带宽(单位:Mbps),默认: 100Mbps, 具体支持数据请参见 私有网络网关说明。 |
assignedEipSet.n | 否 | string | 绑定网关的弹性 IP 数组,assignedEipSet和autoAllocEipNum 至少传一个,例如 assignedEipSet.0=10.0.0.1 ,更多关于弹性 IP 的信息请参考 弹性 IP。 |
autoAllocEipNum | 否 | int | 需要新申请的弹性 IP 个数,系统会按您的要求生产 N 个弹性 IP,assignedEipSet 和autoAllocEipNum 至少传一个,更多关于弹性 IP 的信息请参考 弹性 IP。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | int | 错误码。0:成功, 其他值:失败 |
message | string | 错误信息 |
billId | string | 订单ID,创建结果可调用 查询 NAT 网关的生产状态 查询 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 VPC 错误码。
错误码 | 描述 |
---|---|
InvalidVpc.NotFound | 无效的 VPC,VPC 资源不存在。请再次核实您输入的资源信息是否正确,可通过 DescribeVpcEx 接口查询 VPC |
InvalidNatGatewayName | NAT 网关名称不合法。NAT 网关名称取值范围:1-60个中文、英文大小写的字母、数字和下划线分隔符 |
NatGatewayLimitExceeded | 创建的 NAT 网关数量超过上限。如果需要更多资源,请联系客服申请。更多 VPC 资源限制信息详见 VPC 使用限制 |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=CreateNatGateway &<公共请求参数> &natName=zhezhe &vpcId=314 &maxConcurrent=1000000 &bandwidth=10 &autoAllocEipNum=1
输出
{
"code":"0",
"message":"",
"billId":"20160415160000002485253313199244"
}