Description

Request URL

Network API v2.0

POST /v2.0/lb/vips

Request Paramters

Parameter Value Style Description
X-Auth-Token User Token header
protocol “TCP” plain Specify protocol for VIP
protocol_port Port Number plain A valid value is from 0 to 65535.
subnet_id subnet id plain Specify the subnet for LB. You should create it in advance.
admin_state_up bool plain
pool_id pool id plain Specify the Pool to be attached to the VIP. You can't choose the Pool which is already attached to the VIP. (A Pool to VIP ratio is 1 to 1 )
name (Optional) VIP Name plain It doesn't have to be unique.
address(Optional) IP address plain Specify the IP address for the VIP (the IP in the specified subnet). You should enter any if you have already created more than one VIP in the specified subnet. It is automatically allocated for the first time you create it.
description (Optional) description plain
session_persistence (Optional) plain  
connection_limit (Optional) limit plain Specify the maximum number that you can connect at the same time. Default : -1 (Unlimited)

Request Json

{
    "vip": {
        "protocol": "TCP",
        "name": "VIP_157-7-94-1-69",
        "admin_state_up": true,
        "subnet_id": "9c27f83a-ba6d-4e0e-b004-e34422e207a6",
        "pool_id": "c6be7cbb-7179-4ae2-8645-1b7e54ae6a27",
        "address": "157.7.94.1",
        "protocol_port": "69"
    }
}

Normal response codes

201

Example

curl -i -X POST \
-H "Accept: application/json" \
-H "X-Auth-Token: 0925897a3d4543218ff0dcd2bb378a8e" \
-d '{"vip": {"protocol": "TCP", "name": "VIP_157-7-94-1-69", "admin_state_up": true, "subnet_id": "9c27f83a-ba6d-4e0e-b004-e34422e207a6", "pool_id": "c6be7cbb-7179-4ae2-8645-1b7e54ae6a27", "address": "157.7.94.1", "protocol_port": "69"}}' \
https://networking.tyo1.cloud.z.com/v2.0/lb/vips
HTTP/1.1 201 Created
Server: openresty/1.7.10.1
Date: Fri, 08 May 2015 12:47:51 GMT
Content-Type: application/json
Content-Length: 472
Connection: keep-alive


HTTP/1.1 201 Created
Date: Fri, 19 Dec 2014 07:44:16 GMT
Server: Apache
Content-Length: 506
Content-Type: application/json

{
    "vip": {
        "status": "PENDING_CREATE",
        "protocol": "TCP",
        "description": "",
        "address": "157.7.94.1 ",
        "protocol_port": 69,
        "port_id": "96dd6521-df79-4285-b77e-6d7eac01f48c",
        "id": "c3dd8156-9760-4366-9a06-16e7576ffdc4",
        "status_description": null,
        "name": "VIP_157-7-94-1-69 ",
        "admin_state_up": true,
        "subnet_id": "9c27f83a-ba6d-4e0e-b004-e34422e207a6",
        "tenant_id": "22394afc818d471ca2f0308c06ae7460",
        "connection_limit": -1,
        "pool_id": "c6be7cbb-7179-4ae2-8645-1b7e54ae6a27",
        "session_persistence": null
    }
}