虚拟IP
创建虚拟IP（CreateVip）
管理员可以使用CreateVip创建虚拟IP。例如：
CreateVip name=vip1 l3NetworkUuid=a3b2fce8f82b4422a575220a35d6ebbd参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| name | 虚拟IP名称 | 0.6 | ||
| description | 虚拟IP的详细描述 | 是 | 0.6 | |
| l3NetworkUuid | 三层网络uuid | 0.6 | ||
| ipRangeUuid | IP段UUID | 3.9.0 | ||
| allocatorStrategy | 分配策略 | 是 |
|
0.6 |
| requiredIp | 请求的IP | 是 | 0.6 | |
| resourceUuid | 资源uuid | 是 | 0.6 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VipVO | 是 | 0.6 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VipVO | 是 | 0.6 | |
| timeout | 是 |
删除虚拟IP（DeleteVip）
管理员可以使用DeleteVip删除虚拟IP。例如：
DeleteVip uuid=a9cca051d90348a7b7acdabba96865e9参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 虚拟IP的uuid | 0.6 | ||
| deleteMode | 请参见 删除资源(Delete Resources) | 是 |
|
0.6 |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VipVO | 是 | 0.6 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VipVO | 是 | 0.6 | |
| timeout | 是 |
查询虚拟IP（QueryVip）
管理员可以使用QueryVip查询虚拟IP。例如：
QueryVip l3NetworkUuid=a3b2fce8f82b4422a575220a35d6ebbdQueryVip l3Network.uuid=a3b2fce8f82b4422a575220a35d6ebbd原生域查询（Primitive Fields of Query）
请参见 vip inventory
嵌套和扩展域查询（Nested and Expanded Fields of Query）
| 域（Field） | 清单（Inventory） | 描述 | 起始支持版本 |
|---|---|---|---|
| l3Network | l3network inventory | 0.6 | |
| eip | eip inventory | 0.6 | |
| loadBalancer | load balancer inventory | 0.6 | |
| peerL3Network | l3network inventory | 0.6 | |
| portForwarding | port forwarding inventory | 0.6 |
检查虚拟IP端口可用性（CheckVipPortAvailability）
用户可以使用CheckVipPortAvailability检查虚拟IP端口可用性。例如：
CheckVipPortAvailability vipUuid=e6ac71f8cf433c51822bedea67cf4781 protocolType=TCP port=5参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| vipUuid | 资源的UUID，唯一标示该资源 | 4.7.21 | ||
| protocolType | 协议类型 | 4.7.21 | ||
| port | 查询端口 | 4.7.21 | ||
| timeout | 是 |
获取虚拟IP可用端口(GetVipAvailablePort)
用户可以使用GetVipAvailablePort获取虚拟IP可用端口。例如：
GetVipAvailablePort vipUuid=e6ac71f8cf433c51822bedea67cf4781 protocolType=TCP参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| vipUuid | 资源的UUID，唯一标示该资源 | 4.7.21 | ||
| protocolType | 协议类型 | 4.7.21 | ||
| start | 查询开始下标 | 是 | ||
| limit | 查询长度 | 是 | ||
| timeout | 是 |
更新虚拟IP（UpdateVip）
管理员可以使用UpdateVip更新虚拟IP。例如：
UpdateVip uuid=bc6277e31a904c46a506e8031b1cef65参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 虚拟IP的uuid | 0.6 | ||
| name | 虚拟IP的名称 | 是 | 0.6 | |
| description | 虚拟IP的详细描述 | 是 | 0.6 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VipVO | 是 | 0.6 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VipVO | 是 | 0.6 | |
| timeout | 是 |
更改虚拟IP启用状态（ChangeVipState）
管理员可以使用ChangeVipState更新虚拟IP启用状态。例如：
ChangeVipState uuid=bc6277e31a904c46a506e8031b1cef65 stateEvent=disable参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 虚拟IP的uuid | 0.6 | ||
| stateEvent | 状态事件 |
|
0.6 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VipVO | 是 | 0.6 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VipVO | 是 | 0.6 | |
| timeout | 是 |
获取虚拟IP所有业务端口列表（GetVipUsedPorts）
管理员可以使用GetVipUsedPorts获取虚拟IP所有业务端口列表。例如：
GetVipUsedPorts protocol=TCP uuid=8bf4d57854ec42dbbdcc5b1424a243d9参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 虚拟IP的uuid | 2.2 | ||
| protocol | 网络协议 |
|
2.2 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VipVO | 是 | 2.2 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VipVO | 是 | 2.2 | |
| timeout | 是 |
设置虚拟IP限速（SetVipQos）
管理员可以使用SetVipQos设置虚拟IP限速。例如：
SetVipQos uuid=0ba6619eaede41d1ab506e33f6125b34 \
outboundBandwidth=1048576 inboundBandwidth=1048576参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源uuid | 2.3 | ||
| port | 端口 | 是 | 2.3 | |
| outboundBandwidth | 出流量带宽限制 | 是 | 2.3 | |
| inboundBandwidth | 入流量带宽限制。对于参数 inboundBandwidth 和 outboundBandwidth ，两者至少要设置一个。 | 是 | 2.3 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VipVO | 是 | 2.3 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VipVO | 是 | 2.3 | |
| timeout | 是 |
获取虚拟IP限速（GetVipQos）
管理员可以使用GetVipQos获取虚拟IP限速。例如：
GetVipQos uuid=5ffea72b469549a1bcb2ce0788cccb26参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源uuid | 2.3 | ||
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VipVO | 是 | 2.3 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VipVO | 是 | 2.3 | |
| timeout | 是 |
取消虚拟IP限速（DeleteVipQos）
管理员可以使用DeleteVipQos取消虚拟IP限速。例如：
DeleteVipQos uuid=1dbb011e3fc24dba8831cc7d7cc702ce port=80参数（Parameters）
| 名字 | 描述 | 可选的 | 可选的参数值 | 起始支持版本 |
|---|---|---|---|---|
| uuid | 资源uuid | 2.3 | ||
| port | 端口 | 是 | 2.3 | |
| userTags | 用户标签，请参见 创建用户标签(CreateUserTag)；资源类型是 VipVO | 是 | 2.3 | |
| systemTags | 系统标签，请参见 创建系统标签(CreateSystemTag)； 资源类型是 VipVO | 是 | 2.3 | |
| timeout | 是 |
Note:
- 对于 vipqos 规则设置了 port
的，格式为：
DeleteVipQos uuid=xx port=xx