ovahubファイアウォールを管理
/api/v1/firewalls
組織のファイアウォールの名前、ルール、既定の選択、サーバーへの適用を管理します。
呼び出す前に
ルールや適用先の変更により SSH 接続が切れる場合があります。システムのリソースは編集できません。再試行では同じ requestKey を使用してください。プロバイダーの結果が不明な場合、409 が返ることがあります。
API のフィールド名、型、コードはすべての言語で共通です。
リクエスト例
curl "https://tovahub.com/api/v1/firewalls" -X POST \
-H "Authorization: Bearer $TOVAHUB_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"action": "create",
"requestKey": "docs_example_001",
"name": "my-firewall"
}'表示のみ。このページから API リクエストは送信されません。
パラメーター
actionJSON ボディ · 必須"create" | "rules" | "rename" | "default" | "servers" | "attach" | "delete"
各操作が受け付けるのは次のフィールドのみです：create (name, rules); rules (id, rules); rename (id, name); default/delete (id); servers (id, serverIds); attach (id, serverId)。各操作には requestKey も必要です。
idJSON ボディ · 任意string
system または 24 文字のファイアウォール ID。create 以外では必須です。システムリソースは編集できません。
nameJSON ボディ · 任意string
前後の空白を除いた名前。1–80 文字。create と rename では必須で、他の操作では拒否されます。
rulesJSON ボディ · 任意object[]
最大 64 ルール。rules 操作では必須、create では既定値 []。各ルールには displayName（1–255 文字）、protocol（tcp、udp、icmp または空文字列）、destPorts（最大 15 個のポートまたは範囲、0–65535）、ipv4（最大 100 個の IP/CIDR または AnyIPv4）、ipv6（最大 100 個の IP/CIDR または AnyIPv6）、action: accept、status: active が必要です。少なくとも一方の IP リストは空にできません。TCP/UDP はポートが必要で、ICMP では不要です。
requestKeyJSON ボディ · 必須string
8–100 文字。使用できるのは A–Z、a–z、0–9、アンダースコア、ハイフンです。同じ操作を再試行するときは、同じキーと完全に同じ入力を使用してください。
serverIdsJSON ボディ · 任意string[]
servers で必須。プラットフォームのサーバー ID を最大 100 個指定します。各 ID は24 桁の16進数文字列です。
serverIdJSON ボディ · 任意string
attach で必須。24 桁の16進数文字列のプラットフォームサーバー ID。
レスポンス
HTTP ステータス 200
確認済みのファイアウォール変更結果を返します。プロバイダーの結果が不確かな場合は、架空のタスク受付結果を返さずエラーにします。
okboolean (true)要求したファイアウォール操作が完了したか、元の結果が正常に再返却されました。
pendingboolean (false)現在の実装では、成功した分岐は常に false を返します。
idstring変更対象のプラットフォーム側ファイアウォール識別子。操作で許可される場合は system。