一、1. 接口描述
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. 错误码表
以下错误码表仅列出了该接口的业务逻辑错误码,更多公共错误码详见 VPC 错误码。
| 错误码 | 描述 |
| 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 }}