Kaspersky Security for Virtualization 5.2 Light Agent

レポートで使用するメソッド

Integration Server REST API を使用して、テナントおよびテナントの保護レポートの使用時に次の操作を実行できます:

  • レポートの生成
  • レポートのアップロード

このセクションの内容:

レポートの生成

レポートのアップロード

ページのトップに戻る
[Topic 199638]

レポートの生成

Integration Server データベースに保存されたデータに基づいたレポートを、指定したレポート設定に従って生成できます。レポートの生成対象とする保護対象のテナント、およびデータを受け取る間隔を指定できます。

Accept リクエストのヘッダーに、データの出力フォーマットを指定します:Accept:application/csv

メソッド:

POST /api/2.0/virtualization/reports/tenants?tenantId={テナント ID}&from={日時}&to={日時}

各パラメータの説明:

  • tenantId={テナント ID} - Integration Server 定義データベース内のテナントの識別子。テナントが指定されている場合、このテナントの仮想マシンを保護している期間の情報のみがレポートに含まれます。テナントが指定されていない場合、指定期間内に保護されていた全仮想マシンのデータがレポートに含まれます。
  • from={日時} - レポート対象期間の開始日時。形式:YYYY-MM-DDThh:mm:ss。値が指定されていない場合、Integration Server データベース内の最も初期の日付が使用されます。
  • to={日時} - レポート対象期間の終了日時。形式:YYYY-MM-DDThh:mm:ss。この値を指定しない場合、現在の日付が使用されます。

このリクエストは非同期で実行され、REST API は CreateTenantReport タスクの識別子を返します。このタスクを使用して、レポートの生成処理の進捗を監視できます。タスクの実行が完了すると、[result]フィールドにレポートの識別子またはエラーメッセージが表示されます。

リターンコード:

  • 202 (Accepted) – リクエストの実行が受諾されました。レスポンスは、CreateTenantReport タスクの識別子を返します。
  • 403 (Forbidden) – リソースへのアクセスが拒否されました。
  • 404 (Not Found) – Integration Server データベース内に、指定した識別子のテナントが見つかりません。
ページのトップに戻る
[Topic 199657]

レポートのアップロード

以前に生成したレポートをアップロードします。

Accept リクエストのヘッダーに、データの出力形式を指定します:Accept: application/csv

複数に分割してレポートをアップロードできます。データ範囲を Range リクエストヘッダーで指定できます。例:

Range: bytes=0-1023

このヘッダーを持つリクエストへのレスポンスで、REST API は 206 (Partial content) の結果と、データ先頭のキロバイトを返します。このレスポンスには、 Content-Range ヘッダーと Content-Length ヘッダーが含まれています。

例:

Content-Range: bytes=0-1023/123456

Content-Length: 1024

メソッド:

GET /api/2.0/virtualization/reports/tenants/{レポート ID}

各パラメータの説明:

{レポート ID} - レポートの識別子。CreateTenantReport タスクが成功した結果として取得されます(必須パラメータ)。

リターンコード:

  • 200 (OK) – リクエストが正常に完了しました。レスポンスは、Accept ヘッダーで指定した形式でレポートデータを返します。
  • 206 (Partial content) – リクエストが正常に完了しました。レスポンスは、Range ヘッダーで指定されたレポート部分を返します。
  • 403 (Forbidden) – リソースへのアクセスが拒否されました。
  • 404 (Not Found) – 指定した識別子のレポートが見つかりません。
  • 415 (Unsupported Media Type) – リクエストしたしたデータ形式がサポートされていません(Accept リクエストヘッダーに、誤った形式が渡されました)。
ページのトップに戻る
[Topic 199658]