Description

リスナーを作成します。

リスナーにて接続を受け付けるポート番号やプロトコルを設定します。

リスナーを作成するには、ロードバランサーが追加されている必要があります。

Request URL

Load Balancer API

POST /v2.0/lbaas/listeners

Request Json

{
  "listener": {
    "protocol": "プロトコル",
    "protocol_port": ポート番号,
    "loadbalancer_id": "ロードバランサーID",
    "name": "リスナー名"
  }
}

Request Parameters

Parameter Value Style Description
X-Auth-Token トークン header トークンの情報を指定します。
トークンの発行方法は、トークン発行 にてご確認ください。
protocol TCP
UDP
body プロトコルを指定します。
protocol_port ポート番号 body 接続を受け付けるポート番号を指定します。
loadbalancerid ロードバランサーID body リスナーを紐付けるロードバランサーIDを指定します。
ロードバランサーIDの確認方法は、ロードバランサー一覧取得 を実行の上、レスポンス結果から対象ロードバランサーのロードバランサーIDをご確認ください。
name リスナー名 body 任意のリスナー名を指定します。

Response Code

Success

201

Example

Request

curl -X POST \
-H "Accept: application/json" \
-H "X-Auth-Token: トークン" \
-d '{"listener": {"protocol": "プロトコル","protocol_port": ポート番号,"loadbalancer_id": "ロードバランサーID","name": "リスナー名"}}' \
https://lbaas.c3j1.conoha.io/v2.0/lbaas/listeners

Response

{
	"listener": {
		"id": "リスナーID",
		"name": "リスナー名",
		"description": "",
		"provisioning_status": "PENDING_CREATE",
		"operating_status": "OFFLINE",
		"admin_state_up": true,
		"protocol": "TCP",
		"protocol_port": 10022,
		"connection_limit": -1,
		"project_id": "テナントID",
		"default_pool_id": null,
		"loadbalancers": [
			{
				"id": "ロードバランサーID"
			}
		],
		"tenant_id": "テナントID"
	}
}

ConoHaにて提供しておりますAPIにつきましては、クラウド基盤として採用しておりますOpenStackの機能にて実装しておりますので、詳細な情報や使い方はOpenStackのドキュメントにてご確認ください。