弹性网卡申请内网IP
最近更新时间: 2024-10-17 17:10:00
1. 接口描述
本接口(AssignPrivateIpAddresses)用于弹性网卡申请内网 IP。 接口请求域名:vpc.api.qcloud.com
1) 一个弹性网卡支持绑定的IP地址是有限制的,更多vpc资源限制信息详见VPC使用限制。 2) 可以指定内网IP地址申请,内网IP地址类型不能为主IP,主IP已存在,不能修改,内网IP必须要弹性网卡所在子网内,而且不能被占用。 3) 在弹性网卡上申请一个到多个辅助内网IP,接口会在弹性网卡所在子网网段内返回指定数量的辅助内网IP。
2. 输入参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的Action字段为AssignPrivateIpAddresses。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
vpcId | 是 | String | 弹性网卡对应的私用网络ID,例如:vpc-7t9nf3pu |
networkInterfaceId | 是 | String | 弹性网卡ID,例如:eni-m6dyj72l |
privateIpAddressSet.n | 否 | Array | 申请内网ip时,指定IP地址申请,可以指定主IP,是个可选项。 |
privateIpAddressSet.n.primary | 是 | Bool | 是否为主IP,只能设置一个主IP。 |
privateIpAddressSet.n.privateIpAddress | 是 | String | 指定的内网IP地址。 |
secondaryPrivateIpAddressCount | 否 | Int | 申请内网ip时,只指定数量,由系统自动生成IP,可选项。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 错误码。0:成功, 其他值:失败 |
message | String | 错误信息 |
taskId | Int | 任务ID,操作结果可以用taskId查询,详见查询任务执行结果接口。 |
4. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见公共错误码。
错误码 | 描述 |
---|---|
InvalidVpc.NotFound | 无效的VPC,VPC资源不存在。请再次核实您输入的资源信息是否正确,可通过 DescribeVpcEx 接口查询VPC |
InvalidNetworkInterface.NotFound | 无效的弹性网卡,弹性网卡资源不存在。请再次核实您输入的资源信息是否正确,可通过 DescribeNetworkInterfaces 接口查询弹性网卡 |
InvalidPrivateIpAddress.InUse | 内网IP已经被占用 |
5. 示例
输入
https://vpc.api.qcloud.com/v2/index.php?Action=AssignPrivateIpAddresses &<公共请求参数> &vpcId=vpc-7t9nf3pu &networkInterfaceId=eni-m6dyj72l &secondaryPrivateIpAddressCount=1
输出
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data":
{
"taskId": 16284
}
}