【参考】各用語の説明
contract_sv_id、contract_svc_idは、GET contractsのレスポンスで取得できるIDとなります。詳細については、「GET contracts」、及び「用語」をご覧ください。
概要
特定の契約に紐づくログを、1日単位でダウンロードできるAPIです。契約に関する様々な種類のログを取得できます。
API情報
| 項目 |
内容 |
| メソッド |
GET |
| URL |
https://api.isa.iij.jp/v1/log/[contract_sv_id]/[contract_svc_id]/download |
| 対応スコープ |
isa_read |
| 対応バージョン |
v1 |
| 権限管理ロール |
管理者 |
| リクエストパラメータ |
以下参照 |
| リクエストボディ |
なし |
リクエストパラメータ
| パラメータ |
説明 |
例 |
| date |
ログ取得対象日。リクエスト日から起算して2日前から95日前までの期間を指定可能です |
YYYYMMDD（例：20241101） |
| type |
ログの種類。「contract_svc_id」に応じて異なるログタイプを指定可能です |
対象によって指定できるログタイプが異なります
- isw（Webゲートウェイ）:access（アクセスログ）
- isf（ファイアウォール：タイプ1）access,app（アプリケーションログ）
- isi（ファイアウォール：タイプ2）:access
|
レスポンス情報
| パラメータ |
説明 |
| request_id |
リクエストID。問い合わせ時に使用します |
| error_type |
エラーが発生した際のエラー種別 |
| error_message |
エラーメッセージ |
エラーレスポンス
| エラー種別 |
説明 |
| Parameter Error |
無効な契約IDや日付、またはtypeのパラメータが無効な場合 |
| Too Large File Size |
リクエストされたファイルのサイズが4GiBを超える場合 |
| Not Found |
リクエストされたファイルが存在しない場合 |
| System Error |
サーバ側でエラーが発生した場合 |
サンプルリクエスト
GET /v1/log/[contract_sv_id]/[contract_svc_id]/download?date=20241101&type=access HTTP/1.1 |
Host: api.isa.iij.jp |
Authorization: Bearer [token] |
サンプルレスポンス
HTTP/1.1 200 OK |
Content-Type: application/octet-stream |
Content-Length: 12345 # 実際のサイズに応じて可変します。 |
… # レスポンスボディはバイナリ形式のzipファイルです。 |
その他
ダウンロードできるファイルサイズは、4GiBまでです。