跳转到主要内容
API Explorer|API Explorer
资源中心/网络服务/网络服务相关接口/虚拟IP相关接口
POSTVIP Operations起始版本 0.6同步需要认证

创建虚拟IP

创建虚拟IP

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • nameString必填

      资源名称

    • descriptionString

      资源的详细描述

    • l3NetworkUuidString必填

      使用虚拟IP网络服务的三层网络UUID

    • ipRangeUuidString

      IP段UUID

    • allocatorStrategyString

      分配策略

    • requiredIpString

      请求的IP

    • resourceUuidString

      资源UUID

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryVipInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • l3NetworkUuidString必填

      使用虚拟IP网络服务的三层网络UUID

    • ipString必填

      IPv4类型的IP地址

    • stateString必填

      状态（启用，禁用）

    • gatewayString必填

      网关

    • netmaskString必填

      子网掩码

    • prefixLenString必填

      掩码长度

    • serviceProviderString必填

      提供VIP服务的服务提供者

    • peerL3NetworkUuidString必填

      暂无描述。

    • useForString必填

      用途，例如：端口转发

    • systemboolean必填

      是否系统创建

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • servicesRefsList必填

      详情参考servicesRefs

      • uuidString必填

        资源的UUID，唯一标示该资源

      • serviceTypeString必填

        服务类型

      • vipUuidString必填

        暂无描述。

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

请求地址

POST/zstack/v1/vips

/zstack/v1/vips

操作 ID

CreateVip

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/vips' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"name":"<name>","description":"<description>","l3NetworkUuid":"<l3NetworkUuid>","ipRangeUuid":"<ipRangeUuid>","allocatorStrategy":"<allocatorStrategy>","requiredIp":"<requiredIp>","resourceUuid":"<resourceUuid>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "45a2700283f039a39f40100505a68609", "name": "vip1", "ipRangeUuid": "da8d443f5c923c969118721845891d53", "l3NetworkUuid": "e43b5613fd8039ee888cca53dae87341", "ip": "192.168.0.1", "state": "Enabled", "gateway": "127.0.0.1", "netmask": "255.255.0.0", "peerL3NetworkUuids": [ "1f970d11e2be3b0da5ad65cd4d20a549" ], "system": false } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史