Create Listener#

リスナーを作成します。

APIエンドポイント#

リージョン APIエンドポイント
西日本リージョン3の場合 https://nfv.jp-west-3.cloud.global.fujitsu.com
東日本リージョン3の場合 https://nfv.jp-east-3.cloud.global.fujitsu.com

HTTPメソッドとURI#

POST

/lb/nfv/listeners

HTTPステータスコード#

正常時:202

エラー時:400,403,404,500

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定
Description
listeners body object 必須 リスナーのオブジェクト
name body string 必須 リスナーの名前
ロードバランサー内で一意にする必要があります。
type body string internal
任意
リスナーのタイプ
publicはインターネットに公開する場合に指定します。
internalはプライベートネットワークで利用する場合に指定します。
loadbalancer_name body string 必須 リスナーを設定するロードバランサー名
protocol body string tcp
任意
リスナーのプロトコル
リスナーで待ち受けるプロトコルを指定します。以下が指定できます。
- tcp
- udp
- http
- https
- ssl
port body string デフォルト値は Descriptionを参照
任意
リスナーの待ち受けポート
- https および sslのデフォルト値: 443
- その他のデフォルト値: 80
distribution_mode body string min-connection
任意
振り分けアルゴリズム
リスナーが利用する振り分けアルゴリズムを指定します。以下が指定できます。
- round-robin
- min-connection
persistence_mode body string connection
任意
一意性保証設定
リスナーで利用する一意性保証方法を指定します。以下が指定できます。
- connection
- cookie

レスポンスボディ(正常系)の説明#

名前 Type Description
listeners object リスナーのオブジェクト
name string リスナーの名前
loadbalancer_name string リスナーが設定されているロードバランサー名
id string リスナーのID
type string リスナーのタイプ
protocol string リスナーの待ち受けプロトコル
port string リスナーの待ち受けポート
distribution_mode string リスナーが利用する振り分けアルゴリズム
persistence_mode string リスナーで利用する一意性保証方法

リクエスト例#

{
    "listeners": {
        "name": "listener01",
        "type": "internal",
        "loadbalancer_name": "LB01",
        "protocol": "tcp",
        "port ": 80,
        "distribution_mode": "round-robin",
        "persistence_mode": "connection"
    }
}

レスポンス例#

{
    "listeners": {
        "name": "listener01",
        "loadbalancer_name": "LB01",
        "id": "33584",
        "type": "internal",
        "protocol": "tcp",
        "port": "80",
        "distribution_mode": "round-robin",
        "persistence_mode": "connection"
    }
}