NAT网关绑定EIP

最近更新时间: 2024-10-17 17:10:00

1. 接口描述

本接口(EipBindNatGateway)用于NAT网关绑定EIP 接口请求域名:vpc.api.qcloud.com

2. 输入参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为EipBindNatGateway。

参数名称 必选 类型 描述
natId string 高可用网关统一ID,例如:nat-df5dfd
vpcId string 私有网络ID或统一ID,建议使用统一ID,例如:vpc-dfd5dfgd
assignedEipSet.n array 弹性IP。assignedEipSet 和 autoAllocEipNum 这两个入参需至少传一个,例如:assignedEipSet.0=183.23.0.0.1
autoAllocEipNum int 需要新申请的弹性IP个数, 取值范围[0, 3]。assignedEipSet 和 autoAllocEipNum 这两个入参需至少传一个

3. 输出参数

参数名称 类型 描述
code Int 错误码。0: 成功, 其他值: 失败
message String 错误信息
taskId Int 任务ID,操作结果可以用taskId查询,详见查询任务执行结果接口。

4. 错误码表

以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见公共错误码

错误码 描述
InvalidVpc.NotFound 无效的VPC,VPC资源不存在。请再次核实您输入的资源信息是否正确,可通过 DescribeVpcEx 接口查询VPC
InvalidNatGatewayId.NotFound 无效的NAT网关,NAT网关资源不存在。请再次核实您输入的资源信息是否正确,可通过 DescribeNatGateway 接口查询NAT网关

5. 示例

输入

https://vpc.api.qcloud.com/v2/index.php?Action=EipBindNatGateway
&<公共请求参数>
&natId=nat-8pbrkzh6
&vpcId=314
&autoAllocEipNum=1

输出

{
    "code":"0",
    "message":"",
    "taskId":16167
}