ネットワークセキュリティポリシー API リファレンス
サーバーのローカルファイアウォール設定およびアクセス許可IPリストをプログラムから制御するための API を案内します。
📋 概要
この API モジュールは GIIP [ローカルガード] 機能を制御し、サーバーの入出力トラフィックをフィルタリングするセキュリティポリシーをリアルタイムでアップデートします。
🔐 認証およびヘッダー
すべてのリクエストは、共通の認証ヘッダーを含める必要があります。
- Header:
x-giip-ak: [Your Access Key] - Header:
x-giip-sk: [Your Secret Key]
🚀 主要な API エンドポイント
1. サーバー別セキュリティルールの照会 (Get Security Rules)
- URL:
POST /api/security/rules/list - 説明: 特定のサーバーに適用されているインバウンド/アウトバウンド許可ルール情報を照会します。
- Request Body:
{
"serverIsn": 456
}
2. 許可IPの追加 (Add Allowed IP)
- URL:
POST /api/security/rules/add - 説明: 特定のポートにアクセス可能な新規IPまたは帯域をファイアウォールポリシーに追加します。
- Request Body:
{
"serverIsn": 456,
"port": 8080,
"allowedIp": "1.2.3.4",
"description": "Dev Team Access"
}
3. セキュリティポリシーの一括適用 (Deploy Policy)
- URL:
POST /api/security/policy/deploy - 説明: 特定プロジェクトに所属するすべてのサーバーに対して、標準セキュリティポリシーを一斉に適用します。
- Request Body:
{
"projectIsn": 123,
"policyId": "P-SEC-001"
}
🔍 レスポンスデータの例
{
"RstVal": 0,
"RstMsg": "Success",
"Data": {
"affectedServers": 15,
"status": "In Progress"
}
}
💡 活用事例
- 動的IPホワイトリスティング: 在宅勤務の社員がVPN接続した際、自動的にその社員の現在のIPをサーバーのファイアウォールに登録します。
- 侵入対応の自動化: セキュリティ監視システムで攻撃IPを検知した際、即座にAPIを呼び出して該当IPを全社サーバーで遮断します。
🛡️ Sk3(高性能ロギング)の活用
セキュリティポリシーの修正やIPホワイトリスティングのような機密性の高いインフラ制御作業において、変更履歴の整合性確保と詳細な監査ログ(Audit Log)のために giipApiSk3 エンドポイントを推奨します。
- エンドポイント:
https://giipfaw.azurewebsites.net/api/giipApiSk3 - セキュリティ上の利点: ポリシー更新失敗時に呼び出し元の詳細な環境情報(IP, UA)と StackTrace を即座に記録し、不正アクセスの試行や設定エラーの原因を迅速に分析できます。
- 活用チップ:
textコマンドとjsondataを組み合わせて複雑なセキュリティルールセットを送信する際、データを損失することなく安全にインフラ全体のセキュリティレベルを管理できます。
🔧 トラブルシューティング
| 症状 | 原因 | 解決方法 |
|---|---|---|
| すべてのリクエストが401/認証エラーで失敗する | x-giip-ak または x-giip-sk ヘッダーが欠落しているか、無効なキーが使用されている | 両方の認証ヘッダーが含まれているか、発行された Access Key/Secret Key が正しいかを確認します |
POST /api/security/rules/add のレスポンスの RstVal が0以外になる | serverIsn の欠落、または allowedIp の形式(IP・帯域)エラー | Request Body の serverIsn、port、allowedIp の値を規格どおりに再確認します |
ポリシー一括適用後に affectedServers が0で返る | projectIsn が誤っているか、該当プロジェクトに所属するサーバーが存在しない | 正しい projectIsn を指定し、プロジェクトにサーバーが登録されているか確認します |
| 複雑なセキュリティルールセットの送信時にデータが失われる | text コマンド内の特殊文字がエスケープされていない | giipApiSk3 エンドポイントで text と jsondata を組み合わせてパラメータを安全に送信します |
バージョン: 1.1
最終更新日: 2026-04-11
ソースファイル: giipv3/public/help/api-network-security.ja.md
関連ドキュメント: