/ /

/ /

获取所有Ops Manager服务器日志集合作业

使用此端点检索每个Ops Manager服务器日志集合作业。

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /admin/omLogCollectionJobs

所需角色

要求调用此端点的 API密钥具有 Global Read Only角色。

请求参数

请求路径参数

此端点不使用 HTTP 请求路径参数。

请求查询参数

名称	类型	必要性	说明	默认
`pageNum`	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
`itemsPerPage`	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
`verbose`	布尔	Optional	指示是否在响应中包含所有子作业的标志。对于请求中包含的服务器和日志类型的每个组合，每个Ops Manager服务器日志集合作业都有一个子作业。	`false`
`pretty`	布尔	Optional	指示响应正文是否应采用美观打印格式的标志。	`false`
`envelope`	布尔	Optional	指示是否将响应包装在信封中的标志。某些API客户端无法访问权限HTTP响应标头或状态代码。要修复此问题，请在查询中设立 `envelope=true`。	`false`

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

响应包括结果对象大量、链接对象大量以及检索到的结果对象总数。

名称	类型	说明
`results`	阵列	Ops Manager服务器日志集合作业数组。请参阅嵌入式文档结果。
`links`	阵列	指向子资源或相关资源的一个或多个链接的数组。 URL 之间的关系遵循 Web 链接规范5988 (RFC)。
`totalCount`	数字	结果设立的项目总数。分页时可能会超过 `results` 的大小。

结果嵌入式文档

每个 results 元素代表一个Ops Manager服务器日志集合作业。

名称	类型	说明
`id`	字符串	标识此作业的唯一 24-十六进制数字字符串。
`status`	字符串	作业状态。返回以下值之一： `SUCCESS` `FAILURE` `IN_PROGRESS` `MARKED_FOR_EXPIRY` `EXPIRED`
`creationDate`	字符串	Ops Manager创建作业的时间戳，采用 ISO 8601 UTC 格式。
`expirationDate`	字符串	作业过期且Ops Manager自动删除其数据的时间戳，采用 ISO 8601 UTC 格式。
`finishDate`	字符串	作业完成时的时间戳，采用 ISO 8601 UTC 格式。 `null`，而作业正在进行中。
`servers`	字符串数组	`serverId`此请求中包含的值的列表。由列出活动Ops Manager服务器返回。
`logTypes`	字符串数组	此请求中包含的日志类型。返回以下一个或多个值： `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`sizeRequestedPerFileBytes`	数字	每个服务器每个日志类型的最大请求大小（以字节为单位）。
`logCollectionFromDate`	字符串	时间范围过滤的开始，采用 ISO 8601 UTC 格式。如果请求未指定时间范围，则为 `null`。
`logCollectionToDate`	字符串	时间范围过滤的末尾，采用 ISO 8601 UTC 格式。如果请求未指定时间范围，则为 `null`。
`uncompressedSizeTotalBytes`	数字	所收集日志数据的总未压缩大小（以字节为单位）。
`sizeLimitHit`	布尔	指示Ops Manager是否因为数据达到 `sizeRequestedPerFileBytes` 而截断任何子作业收集的数据的标志。
`downloadUrl`	字符串	可从中下载存档的URL 。请参阅下载Ops Manager服务器日志。
`childJobs`	阵列	与此请求关联的子作业列表。仅当您设立`verbose=true` 时， Ops Manager才包含此字段。

childJobs 嵌入式文档

每个子作业代表一台服务器和一种日志类型的日志集合任务。

名称	类型	说明
`childJobs[n].serverId`	字符串	`serverId` 此子作业从中收集日志的Ops Manager服务器的 ID。
`childJobs[n].logCollectionType`	字符串	此子作业收集的日志类型。返回以下值之一： `APPLICATION` `HTTP_ACCESS` `MIGRATION`
`childJobs[n].status`	字符串	此子作业的状态。返回以下值之一： `SUCCESS` `FAILURE` `IN_PROGRESS` `MARKED_FOR_EXPIRY` `EXPIRED`
`childJobs[n].startDate`	字符串	此子作业启动的时间戳，采用 ISO 8601 UTC 格式。
`childJobs[n].finishDate`	字符串	此子作业完成时的时间戳，采用 ISO 8601 UTC 格式。 `null`，而子作业正在进行中。
`childJobs[n].errorMessage`	字符串	解释此子作业失败原因的错误消息。 `null`（如果子作业未失败）。
`childJobs[n].sizeLimitHit`	布尔	指示Ops Manager是否因数据达到 `sizeRequestedPerFileBytes` 而截断此子作业收集的数据的标志。
`childJobs[n].uncompressedDiskspaceBytes`	数字	该子作业使用的未压缩磁盘空间总量（以字节为单位）。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs?verbose=true&pretty=true"

响应示例

响应标头

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

响应体

{
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs?verbose=true&pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "id": "675a1234567890abcdef1234",
      "status": "SUCCESS",
      "creationDate": "2026-04-13T10:00:00Z",
      "expirationDate": "2026-04-20T10:00:00Z",
      "finishDate": "2026-04-13T10:02:30Z",
      "servers": [
        "om-server-1.example.com",
        "om-server-2.example.com"
      ],
      "logTypes": ["APPLICATION", "HTTP_ACCESS"],
      "sizeRequestedPerFileBytes": 5242880,
      "logCollectionFromDate": null,
      "logCollectionToDate": null,
      "uncompressedSizeTotalBytes": 8388608,
      "sizeLimitHit": true,
      "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs/675a1234567890abcdef1234:download",
      "childJobs": [
        {
          "serverId": "om-server-1.example.com",
          "logCollectionType": "APPLICATION",
          "status": "SUCCESS",
          "startDate": "2026-04-13T10:00:05Z",
          "finishDate": "2026-04-13T10:01:30Z",
          "errorMessage": null,
          "sizeLimitHit": true,
          "uncompressedDiskspaceBytes": 5242880
        },
        {
          "serverId": "om-server-1.example.com",
          "logCollectionType": "HTTP_ACCESS",
          "status": "SUCCESS",
          "startDate": "2026-04-13T10:00:05Z",
          "finishDate": "2026-04-13T10:01:45Z",
          "errorMessage": null,
          "sizeLimitHit": false,
          "uncompressedDiskspaceBytes": 2097152
        },
        {
          "serverId": "om-server-2.example.com",
          "logCollectionType": "APPLICATION",
          "status": "FAILURE",
          "startDate": "2026-04-13T10:00:10Z",
          "finishDate": "2026-04-13T10:00:45Z",
          "errorMessage": "Failed to read log file: permission denied",
          "sizeLimitHit": false,
          "uncompressedDiskspaceBytes": 0
        },
        {
          "serverId": "om-server-2.example.com",
          "logCollectionType": "HTTP_ACCESS",
          "status": "SUCCESS",
          "startDate": "2026-04-13T10:00:10Z",
          "finishDate": "2026-04-13T10:02:00Z",
          "errorMessage": null,
          "sizeLimitHit": false,
          "uncompressedDiskspaceBytes": 1048576
        }
      ]
    }
  ],
  "totalCount": 1
}

后退

创建

来年

获取一份工作