管理报告

您可以生成管理报告来收集系统使用情况数据，例如活动和非活动项目的数量以及存储库和数据库的大小。

管理报告数据

管理报告会收集以下数据。

数据 详细信息
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}

Note: 生成管理报告需要一些时间。在获取了操作 ID 后，不要立即去获取管理报告。请等待一段时间，具体取决于您的项目大小。

请求标头

您可以获取 JSON 或 CSV 格式的管理报告。在 Content-Type 标头中指定格式: application/json 或 text/csv。

返回页首

另请参阅：