管理レポート

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

管理レポートの内容

管理レポートには、次のセクションが含まれます。

セクション 内容
projects-ping-result

ping を実行されたプロジェクトと各プロジェクトの ping のステータスを表示します。

このセクションの情報は、2 時間ごとに再生成されます。

projects-last-login-activity

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

このセクションの情報は、5 分ごとに再生成されます。

active-sessions

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

このセクションの情報は、5 分ごとに再生成されます。

projects-repository-size

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

リサイクル可能なサイズは、ガベージ・コレクション・プロセスを手動で実行して消去できるように、論理ファイルが削除されたリポジトリ内の物理ファイルです。

このセクションの情報は、2 時間ごとに再生成されます。

projects-db-space-used

各プロジェクトの使用済みデータベース領域のサイズ(SQL サーバまたは Oracle サーバ)。

このセクションの情報は、2 時間ごとに再生成されます。

先頭に戻る

管理レポートの生成方法

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

管理レポートを生成するには、次の手順を実行します。

  1. 次の POST 呼び出しを実行して管理レポートを生成するアクションをトリガし、アクション ID を取得します。

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

     

    要求の例
    Copy code

        "project-request-option": { 
            "project-ping": { 
                "fetch-or-not":"true", 
                "is-file-latest": "false" 
            }, 
            "project-last-login-activity": { 
                "fetch-or-not": "true", 
                "is-file-latest": "false" 
            }, 
            "project-session-connection": { 
                "fetch-or-not": "true", 
                "is-file-latest": "false" 
            }, 
            "project-repository-used-size": { 
                "fetch-or-not": "true", 
                "is-file-latest": "false" 
            }, 
            "project-db-space-used": { 
                "fetch-or-not": "true", 
                "is-file-latest":  "false" 
            } 
        } 

     

    フラグ:

    • fetch-or-not:対応するモジュール・データを管理レポートに含めるかどうかを指定します。

      Example: project-ping の fetch-or-nottrue に設定すると、管理レポートにプロジェクトの ping データを含めます。fetch-or-notfalse に設定すると、管理レポートにプロジェクトの ping データを含めません。

    • is-file-latest:fetch-or-nottrue に設定されている場合にのみ機能します。管理レポートに、対応する API の最新の JSON ファイル・データを取得するかどうかを制御します。

      Example: project-ping の is-file-latesttrue に設定すると、管理レポートにプロジェクト ping API の最新の JSON ファイル・データを含めます。別のサイト管理ユーザが最後に API を呼び出した場合もあります。

      project-ping の is-file-latestfalse に設定すると、管理レポートに、fetch-or-nottrue に設定したときにトリガされるプロジェクト ping API の JSON ファイル・データを含めます。

    応答の例
    Copy code
    {
      "report-parameters": {
        "report-parameter":  "string"
      }
    }

     

    レポート・パラメータ(アクション ID)は、管理レポートがいつトリガされたかと、フラグがどのように設定されたかを含むエンコードされた文字列です。

  2. 次の GET 呼び出しを実行して、ステップ 1 で取得したアクション ID(レポート・パラメータ)を使用して管理レポートをフェッチします。

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

     

    要求ヘッダ:

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

    応答の例:

    Copy code

        "admin-reports": { 
            "projects-ping-result": { 
                "total-count": "16", 
                "created-time": "1656309069018", 
                "project-ping-result": [ 
                    { 
                        "id": 1, 
                        "project-name": "p1", 
                        "domain-name": "DEFAULT", 
                        "status": "Inactive", 
                        "ping-result": "SUCCEEDED" 
                    }, 
                    … 
                    { 
                        "id": 24, 
                        "project-name": "new_p2", 
                        "domain-name": "A", 
                        "status": "Active", 
                        "ping-result": "SUCCEEDED" 
                    } 
                ] 
            }, 
            "projects-last-login-activity": { 
                "total-count": "9", 
                "created-time": "1656309066384", 
                "project-last-login-activity": [ 
                    { 
                        "id": 23, 
                        "project-name": "new_p", 
                        "domain-name": "A", 
                        "last-login-time": 1656298885000 
                    }, 
               … 
                    { 
                        "id": 24, 
                        "project-name": "new_p2", 
                        "domain-name": "A", 
                        "last-login-time": 1656145476000 
                    } 
                ] 
            }, 
            "active-sessions": { 
                "total-count": "1", 
                "created-time": "1656309066371", 
                "active-session": [ 
                    { 
                        "project-id": 23, 
                        "project-name": "new_p", 
                        "domain-name": "A", 
                        "session-info": [ 
                            { 
                                "client-type": "Application Lifecycle Management Client UI", 
                                "session-count": 1 
                            } 
                        ] 
                    } 
                ] 
            }, 
            "projects-repository-size": { 
                "total-results": "8", 
                "created-time": "1656309110153", 
                "project-repository-size": [ 
                    { 
                        "id": 1, 
                        "project-name": "p1", 
                        "domain-name": "DEFAULT", 
                        "repository-size": 1509338, 
                        "recyclable-size": 22248 
                    }, 
                   … 
                    { 
                        "id": 24, 
                        "project-name": "new_p2", 
                        "domain-name": "A", 
                        "repository-size": 1531586, 
                        "recyclable-size": 22248 
                    } 
                ] 
            }, 
            "projects-db-space-used": { 
                "total-count": "16", 
                "created-time": "1656309068342", 
                "project-db-space-used": [ 
                    { 
                        "id": 1, 
                        "project-name": "p1", 
                        "domain-name": "DEFAULT", 
                        "db-server-name": "127.0.0.1", 
                        "db-server-type": "ORACLE", 
                        "actual-space-used": 4388683776 
                    }, 
                   … 
                    { 
                        "id": 24, 
                        "project-name": "new_p2", 
                        "domain-name": "A", 
                        "db-server-name": "127.0.0.1", 
                        "db-server-type": "ORACLE", 
                        "actual-space-used":  4388683776 
                    } 
                ] 
            } 
        } 

先頭に戻る

参照情報: