管理レポート

管理レポートを生成して、アクティブなプロジェクトと非アクティブなプロジェクトの数、リポジトリとデータベースのサイズなど、システムの使用状況データを収集できます。

このトピックの内容:

管理レポート・データ

管理レポートでは次のデータが収集されます。

データ 説明
user-login-activities

過去指定された日数にログインしていない非アクティブなユーザを一覧表示します。

  • username：非アクティブなユーザのユーザ名。

  • last-access-timestamp：ユーザの最終ログインのタイムスタンプ。

  • last-access-time：ユーザ名/パスワードによる最終ログイン時刻。

  • last-apikey-access-time：API キーを使用した最終ログイン時刻。

ユーザが一度もログインしたことがない場合は、ユーザ名のみが返されます。
projects-ping-result

ping を実行されたプロジェクトと各プロジェクトの ping の結果を表示します。

  • id：プロジェクト ID。

  • project-name：プロジェクト名。

  • domain-name：プロジェクトが属するドメイン。

  • status：プロジェクトのステータス。

  • ping-result：ping の結果、成功または失敗。

  • total-count：ping されたプロジェクトの数。
projects-last-login-activity

各プロジェクトの最終ログイン時刻を表示します。

  • id：プロジェクト ID。

  • project-name：プロジェクト名。

  • domain-name：プロジェクトが属するドメイン。

  • last-login-time：プロジェクトに最後にログインされた日時。
active-sessions

各プロジェクトのアクティブなセッションの合計を表示します。

  • id：プロジェクト ID。

  • project-name：プロジェクト名。

  • domain-name：プロジェクトが属するドメイン。

  • session-info：

    • session-count：クライアントから開始されたアクティブ・セッションの数。

    • client-type：クライアント名
projects-repository-size

各プロジェクトのリポジトリ・サイズ、リサイクル可能なサイズ、ファイル・サイズを表示します。

  • id：プロジェクト ID。

  • project-name：プロジェクト名。

  • domain-name：プロジェクトが属するドメイン。

  • repository-size：プロジェクト・リポジトリのサイズ。

  • recyclable-size：プロジェクト・リポジトリのリサイクル可能なサイズ。リポジトリのクリーンアップを手動で開始することで空にできるリポジトリスペースを示します。

  • attach：プロジェクト内のすべての添付ファイルのサイズ。

  • tests：テスト関連ファイルのサイズ。

  • runs：テスト実行関連ファイルのサイズ。

  • scripts：プロジェクト・スクリプトのサイズ。

  • script-templates：テンプレート・スクリプトのサイズ。

  • report data：レポート・ファイルのサイズ。

  • report-templates：プロジェクト内のテンプレート・レポートのサイズ。

  • resources：テスト・リソース関連ファイルのサイズ。

  • baseline：ベースライン・ファイルのサイズ。

  • results：自動化テスト実行結果ファイルのサイズ。

  • analysis-item-files：アナリシス項目ファイルのサイズ。
projects-db-space-used

各プロジェクトの使用済みデータベース領域のサイズ。

  • db-server-name：データベース・サーバのホスト名の IP アドレス。

  • db-server-type：データベース・サーバのタイプ（MSSQL または Oracle）。

  • actual-space-used：使用済み領域の物理サイズ（KB 単位）。
project-entities-summary プロジェクトごとに各タイプのエンティティの数を一覧表示します。

先頭に戻る

管理レポートの生成をトリガする

管理レポートの生成をトリガするには、サイト管理者の権限が必要です。

管理レポートの生成をトリガするには：

管理レポートを生成するアクションをトリガするには、次の POST 呼び出しを実行します。

Copy code 
/qcbin/v2/sa/api/collectors/report-collector/execute

要求の例

Copy code 
{
  "project-request-option": {
    "project-session-connection": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-last-login-activity": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-ping": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-db-space-used": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-entities-summary": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-repository-used-size": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "user-last-login-activity": {
      "fetch-or-not": true,
      "is-file-latest": true,
      "inactive-days":  1
    }
  }
}

パラメータ 説明
fetch-or-not

特定のデータを管理レポートに含めるかどうかを指定します。

たとえば、project-ping-result の fetch-or-not を true に設定すると、管理レポートにプロジェクトの ping データを含めます。fetch-or-not を false に設定すると、管理レポートにプロジェクトの ping データを含めません。
is-file-latest

fetch-or-not が true に設定されている場合にのみ機能します。

取得するデータがすでに存在するのか、そして既存のデータが最新なのかを確認するかどうかを制御します。

  • is-file-latest が true に設定されている場合、

    • データが存在しない場合は、生成されます。

    • データがすでに存在し、最新のものである場合は、再生成されません。

    • データがすでに存在しているが期限が切れている場合は、再生成されます。

  • is-file-latestがfalseに設定されている場合、

    • データが存在しない場合は、生成されます。

    • データがすでに存在する場合、有効期限が切れているかどうかに関係なく、再生成されません。

inactive-days

利用可能：user-last-login-activity のみ

管理レポートは、過去指定された日数以上ログインしていない非アクティブなユーザを返します。

標準設定では 90 です。有効な値は 1 から 180 までです。

応答の例

POST 呼び出しは、管理レポートがトリガされた日時とパラメータの設定方法を含むエンコードされた文字列であるアクション ID を返します。

Copy code 
{
  "report-parameters": {
    "report-parameter": "string"
  }
}

先頭に戻る

管理レポートを取得する

管理レポートの生成がトリガされると、アクション ID が返されます。アクション ID で管理レポートを取得するには、次の要求を呼び出します。

Copy code 
GET /qcbin/v2/sa/api/admin-reports/{action-id}

注: 管理レポートの生成には時間がかかります。アクション ID を取得した直後に管理レポートを取得しないでください。プロジェクトのサイズに応じて、しばらくお待ちください。

要求ヘッダ

管理レポートは、JSON または CSV 形式で取得できます。Content-Type ヘッダで、application/json または text/csv の形式を指定します。

先頭に戻る

参照情報：