VIP作成

Description

VIPの設定を作成します。
1つのPoolに対して1つのVIPの設定のみ割り当てることが可能です。
サブネットとVIPの指定は必須です。

Request URL

Network API v2.0

POST /v2.0/lb/vips

Request Json

{
    "vip": {
        "admin_state_up": 管理状態の有無,
        "name": "VIP設定の名前", 
        "pool_id": "プールID", 
        "protocol": "プロトコル", 
        "protocol_port": "ポート番号", 
        "subnet_id": "サブネットID"
    }
}

Request Parameters

Parameter Value Style Description
X-Auth-Token トークンID header トークン発行 にて払い出されたID
protocol TCP
UDP
plain VIPのプロトコルを指定します。
protocol_port 0 ~ 65535 plain ポート番号を指定します。
subnet_id サブネットID plain ロードバランサー用グローバルIPアドレスのサブネットIDを指定します。
admin_state_up true
false
plain 管理状態の有無
pool_id プールID plain VIPをつけるPOOLを指定します。
既にVIPがついているPOOLは指定できません。
POOL一覧取得 にて任意のプールIDをご確認ください。
name(Optional) VIP設定の名前 plain VIPの設定に任意の名前を指定します。
address(Optional) VIP plain ロードバランサー用グローバルIPアドレスを指定します。
また、初めてVIPを作成される場合の入力は任意となりますが、指定したサブネットで既に1つ以上のVIPを作成している場合、入力が必須となります。
description(Optional) VIP設定の説明・概要 plain VIPの設定について任意の説明・概要を指定します。
session_persistence
(Optional)
SOURCE_IP plain セッション維持を有効にする場合、指定します。
connection_limit
(Optional)
最大同時接続数 plain 最大同時接続数を指定します。
※デフォルトは「-1 (無制限)」

Response

  • Normal response codes
201

Example

  • Request
curl -i -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Auth-Token: トークンID" \
-d '{"vip":{"address":"VIP","admin_state_up":管理状態の有無,"protocol":"プロトコル","protocol_port":"ポート番号","subnet_id":"サブネットID","pool_id":"プールID","name":"VIP設定の名前"}}' \
ネットワークエンドポイント/lb/vips
  • Response
{
    "vip": {
        "status": "PENDING_CREATE"
        "protocol": "プロトコル",
        "description": "",
        "address": "VIP",
        "protocol_port": ポート番号,
        "port_id": "ポートID",
        "id": "VIP ID",
        "status_description": null,
        "name": "VIP設定の名前",
        "admin_state_up": true,
        "subnet_id": "サブネットID",
        "tenant_id": "テナントID",
        "connection_limit": -1,
        "pool_id": "プールID",
        "session_persistence": null
    }
}

Internet for everyone

Copyright (c) 2024 GMO Internet Group, Inc. All Rights Reserved.