Create an L7 Rule#

L7ルールを作成します。

APIエンドポイント#

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

HTTPメソッドとURI#

POST

/v2.0/lbaas/l7policies/{l7policy_id}/rules

HTTPステータスコード#

正常時:201

エラー時:400,401,403,404,409,500,503

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

名前 In Type デフォルト値
/必須指定
Description
admin_state_up body boolean 任意 リソースの管理状態
「true」または「false」を指定します。
compare_type body string 必須 L7ルールの比較タイプ
「CONTAINS」、「ENDS_WITH」、「EQUAL_TO」、「REGEX」または「STARTS_WITH」を指定します。
invert body boolean 任意 trueの場合、ルールの論理が反転されます。例えば、equal toは、not equal toになります。
true」または「false」を指定します。
key body string 任意 比較のために用いられるキー
例えば、クッキー名などを指定します。
l7policy_id path uuid 必須 L7ポリシーID
project_id body string 任意 プロジェクトID
rule body object 必須 L7ルールオブジェクト
type body string 必須 L7ルールのタイプ
「FILE_TYPE」、「PATH」、「COOKIE」、「HOST_NAME」または「HEADER」を指定します。
value body string 必須 比較に用いられる値
例えば、比較すべきファイルタイプなどを指定します。

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

名前 Type Description
admin_state_up boolean リソースの管理状態
「true」または「false」が表示されます。
compare_type string L7ルールの比較タイプ
「CONTAINS」、「ENDS_WITH」、「EQUAL_TO」、「REGEX」または「STARTS_WITH」が表示されます。
created_at string リソースが作成された日時(UTC)のタイムスタンプ
id uuid L7ルールID
invert boolean trueの場合、ルールの論理が反転されます。例えば、equal toは、not equal toになります。
「true」または「false」が表示されます。
key string 比較のために用いられるキー
例えば、クッキー名などが表示されます。
operating_status string リソースの運用状況
「ONLINE」または「OFFLINE」が表示されます。
operating_statusの詳細は「Operating Status Codes」を参照してください。
project_id string プロジェクトID
provisioning_status string リソースの提供状況
「ACTIVE」、「PENDING_CREATE」、「PENDING_UPDATE」または「ERROR」が表示されます。
provisioning_statusの詳細は「Provisioning Status Codes」を参照してください。
rule object L7ルールオブジェクト
type string L7ルールのタイプ
「FILE_TYPE」、「PATH」、「COOKIE」、「HOST_NAME」または「HEADER」が表示されます。
updated_at string リソースの更新日時(UTC)のタイムスタンプ
value string 比較に用いられる値
例えば、比較すべきファイルタイプなどが表示されます。

リクエスト例#

{
	"rule":{
		"compare_type":"STARTS_WITH",
		"type":"PATH",
		"value":"/access.html"
	}
}

レスポンス例#

{
    "rule": {
        "admin_state_up": true,
        "compare_type": "STARTS_WITH",
        "created_at": "2019-03-25T05:12:43",
        "id": "b363ef39-798e-4697-94fa-5addd23d1829",
        "invert": false,
        "key": null,
        "operating_status": "OFFLINE",
        "project_id": "51ed616c4bf0440ab6cfe5ff96edce91",
        "provisioning_status": "PENDING_CREATE",
        "type": "PATH",
        "updated_at": null,
        "value": "/access.html"
    }
}