- 产品文档
- > 计算服务
- > 云服务器
- > 开发指南
- > 云服务器 OpenAPI
- > 辅助 IP 接口
辅助 IP 接口
创建辅助IP
所属服务
nvm
Action
AssignSecondaryPrivateIpAddress
Version
2017-12-14
Method
GET
描述
从网卡上分配一个辅助私有IP地址
请求参数
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| NetworkInterfaceId | 网卡ID，可以通过接口DescribeInstance获取 | string | 是 | |
| SecondaryPrivateIpAddress | 指定分配的私有ip地址，不传则自动分配 | string | 否 | |
| Action | AssignSecondaryPrivateIpAddress | string | 是 | |
| Version | 2017-12-14 | string | 是 |
返回参数
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| Code | 仅返回http status code非200时有效 指示错误类型 | string | 否 | |
| Message | 仅返回http status code非200时有效 指示详细错误信息 | string | 否 | |
| RequestId | 请求Id | string | 是 |
状态码
| 错误码（Code） | 错误提示（Message） | http status code | 说明 |
|---|---|---|---|
| RequestFailed | fail | 400 | 请求失败(一般为底层向底层请求失败) |
| NoSuchPort | no such port | 404 | 无效网卡信息 |
| StatusConflict | instance status conflict with the operation | 409 | 云服务器状态与当前操作冲突(主网卡，实例状态必须为active/shutoff) |
| SecondaryPrivateIpQuotaLimit | secondary private ip over quota | 400 | 已到可绑定限额（目前一个网卡上最多分配1个辅助IP） |
| InvalidParam | invalid param | 400 | 请求参数错误(一般参数为空) |
请求示例
curl -X GET -H "X-Product-Id:54d4e01051e642c386e40d942bcedf0b" -H "Content-Type:application/json" -H "X-Request-Id:TEST-REQUEST-ID" -H "X-163-AcceptLanguage:zh" -H "X-ORIGIN-GW:G0" -H "X-163-DebugMode:true" 'http://127.0.0.1:8188/nvm?Version=2017-12-14&Action=AssignSecondaryPrivateIpAddress&NetworkInterfaceId=a52523ab-dbc1-4b1d-922a-9e8668183852&SecondaryPrivateIpAddress=172.16.55.4'
返回示例
{"RequestId":"TEST-REQUEST-ID"}
删除辅助IP
所属服务
nvm
Action
UnassignSecondaryPrivateIpAddress
Version
2017-12-14
Method
GET
描述
从网卡上退还一个辅助私有ip地址
请求参数
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| NetworkInterfaceId | 网卡ID，可以通过接口DescribeInstance获取 | string | 是 | |
| SecondaryPrivateIpAddress | 指定分配的私有ip地址 | string | 是 | |
| Action | UnassignSecondaryPrivateIpAddress | string | 是 | |
| Version | 2017-12-14 | string | 是 |
返回参数
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| Code | 仅返回http status code非200时有效 指示错误类型 | string | 否 | |
| Message | 仅返回http status code非200时有效 指示详细错误信息 | string | 否 | |
| RequestId | 请求Id | string | 是 |
状态码
| 错误码（Code） | 错误提示（Message） | http status code | 说明 |
|---|---|---|---|
| RequestFailed | fail | 400 | 请求失败(一般为向底层请求失败) |
| NoSuchSecondaryPrivateIp | no such secondary private ip | 404 | 无效辅助私有ip信息 |
| ClearFloatingIpFail | clear floating ip failed | 400 | 清理Eip失败 |
| StatusConflict | instance status conflict with the operation | 409 | 云服务器状态与当前操作冲突(主网卡，实例状态必须是active/shutoff) |
| InvalidParam | invalid param | 400 | 请求参数错误（参数格式不对，一般参数为空） |
请求示例
curl -X GET -H "X-Product-Id:54d4e01051e642c386e40d942bcedf0b" -H "Content-Type:application/json" -H "X-Request-Id:TEST-REQUEST-ID" -H "X-163-AcceptLanguage:zh" -H "X-ORIGIN-GW:G0" -H "X-163-DebugMode:true" 'http://127.0.0.1:8188/nvm?Version=2017-12-14&Action=UnassignSecondaryPrivateIpAddress&NetworkInterfaceId=a52523ab-dbc1-4b1d-922a-9e8668183852&SecondaryPrivateIpAddress=172.16.55.3'
返回示例
{"RequestId":"TEST-REQUEST-ID"}
迁移辅助 IP
所属服务
nvm
Action
MoveSecondaryPrivateIpAddress
Version
2017-12-14
请求url
/nvm?Action=MoveSecondaryPrivateIpAddress&Version=2017-12-14&PrivateIpAddress=&OldNetworkInterfaceId=&NewNetworkInterfaceId=
Method
GET
描述
暂无描述
请求参数
query
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| PrivateIpAddress | 私有网ip（主ip不能迁移，只能迁移辅助ip） | string | 是 | |
| OldNetworkInterfaceId | 原网卡ID，可以通过接口DescribeInstance获取 | string | 是 | 原云服务器实例必须为active/shutoff状态 |
| NewNetworkInterfaceId | 迁移的新网卡ID（两网卡必须在同一VPC子网内，否则无法迁移），可以通过接口DescribeInstance获取 | string | 是 | 目的云服务器实例必须为active/shutoff状态 |
| Action | MoveSecondaryPrivateIpAddress | string | 是 | |
| Version | 2017-12-14 | string | 是 |
返回参数
| 参数名称 | 说明 | 参数类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| Code | 仅返回http status code非200时有效 指示错误类型 | string | 否 | |
| Message | 仅返回http status code非200时有效 指示详细错误信息 | string | 否 | |
| RequestId | 请求id | string | 是 |
状态码
| 错误码（Code） | 错误提示（Message） | http status code | 说明 |
|---|---|---|---|
| NoSuchSecondaryPrivateIp | no such secondary private ip | 404 | 无效辅助私有ip信息 |
| NoSuchInstance | no such instance of source network interface | 404 | 源网卡所在主机不存在 |
| SourceStatusConflict | source instance status conflict with the operation | 409 | 当前云服务器状态与当前操作冲突 |
| SecondaryPrivateIpQuotaLimit | secondary private ip over quota | 400 | 已到网卡可绑定限额 |
| NoSuchPort | no such port | 404 | 无效网卡信息 |
| InvalidDestinationNetworkInterface | invalid destination primary private ip to source secondary private ip | 400 | 目的网卡主ip与待迁移辅助ip子网不符 |
| NoSuchInstance | no such instance of destination network interface | 404 | 目的网卡所在主机不存在 |
| DestinationStatusConflict | destination instance status conflict with the operation | 409 | 目的云服务器状态与当前操作冲突 |
| ServiceBusy | service busy please retry later | 409 | 请稍后重试 |
| RequestFailed | fail | 400 | 请求失败 |
请求示例
curl -X GET -H "X-Product-Id:4575f0f1063b484982bad09ddc5736c6" -H "Content-Type:application/json" -H "X-Request-Id:TEST-REQUEST-ID" -H "X-163-AcceptLanguage:zh" -H "X-ORIGIN-GW:G0" -H "X-163-DebugMode:true" 'http://127.0.0.1:8188/nvm?Version=2017-12-14&Action=MoveSecondaryPrivateIp&PrivateIpAddress=172.16.1.208&OldNetworkInterfaceId=c53e7c3e-e8cc-490a-a8e9-d3350d75c051&NewNetworkInterfaceId=d52f50df-683d-4dea-8651-cfcc722e73bf'
返回示例
{"RequestId":"TEST-REQUEST-ID"}
