管理报告
您可以生成管理报告来收集系统使用情况数据,例如活动和非活动项目的数量以及存储库和数据库的大小。
管理报告所含内容
管理报告包含以下部分:
部分 | 包含 |
---|---|
projects-ping-result |
列出已被 ping 的项目以及每个项目的 ping 状态。 此部分中的信息每 2 小时重新生成一次。 |
projects-last-login-activity |
列出每个项目的最后登录时间。 此部分中的信息每 5 分钟重新生成一次。 |
active-sessions |
列出每个项目中的活动会话数量。 此部分中的信息每 5 分钟重新生成一次。 |
projects-repository-size |
列出每个项目的存储库大小和可回收大小。 可回收大小是存储库中的物理文件,其逻辑文件已被删除,因此可以通过手动优化 GC 进程来清理它们。 此部分中的信息每 2 小时重新生成一次。 |
projects-db-space-used |
每个项目 (SQL Server 或 Oracle 服务器) 的已用数据库空间大小。 此部分中的信息每 2 小时重新生成一次。 |
如何生成管理报告
需要站点管理员权限才能生成管理报告。
要生成管理报告,请执行以下操作:
-
进行以下 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: 如果您将 fetch-or-not 设置为 true 用于 project-ping,则管理报告会包含项目 ping 数据。如果您将 fetch-or-not 设置为 false,则管理报告不包含项目 ping 数据。
-
is-file-latest。仅当 fetch-or-not 设置为 true 时有效。控制是否获取管理报告相应 API 的最新 JSON 文件数据。
Example: 如果您将 project-ping 的 is-file-latest 设置为 true,则管理报告包含项目 ping API 的最新 JSON 文件数据。它可能是最近调用 API 的其他站点管理员用户。
如果您将 project-ping 的 is-file-latest 设置为 false,则管理报告包含将 fetch-or-not 设置为 true 时触发的项目 ping API 的 JSON 文件数据。
响应示例 Copy code{
"report-parameters": {
"report-parameter": "string"
}
}报告参数 (操作 ID) 是一个编码字符串,包含触发管理报告的时间以及设置标志的方式。
-
-
使用您在步骤 1 中获得的操作 ID (报告参数) 进行以下 GET 调用以获取管理报告。
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
}
]
}
}
}
另请参见: