/ /

创建Ops Manager服务器日志收集作业

创建Ops Manager服务器日志集合作业时， Ops Manager会启动背景任务，从目标服务器收集请求的日志。每台服务器都在本地收集日志，对其进行压缩和加密，然后将结果存储在应用程序数据库中。使用此端点创建新作业。

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

Resource

POST /admin/omLogCollectionJobs

所需角色

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

请求参数

请求路径参数

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

请求查询参数

以下查询参数为可选参数：

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用美观打印格式的标志。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
`status`	HTTP 响应代码
`content`	预期响应正文

false

请求正文参数

名称	类型	必要性	说明
`servers`	字符串数组	Optional	List`serverId` Active Ops Manager Servers 返回的值的列表。如果省略此字段或传递空大量， Ops Manager将从每个活动服务器收集日志。
`logTypes`	字符串数组	Optional	要收集的日志类型。每个元素必须是以下值之一： `APPLICATION` `HTTP_ACCESS` `MIGRATION` 如果省略此字段或传递空大量， Ops Manager将收集每种日志类型。
`sizeRequestedPerFileBytes`	数字	Optional	每个服务器每个日志类型的最大未压缩大小（以字节为单位）。必须大于 0。如果省略此字段， Ops Manager会在请求的服务器和日志类型之间自动分配剩余的已配置存储。
`logCollectionFromDate`	字符串	Optional	要收集的时间范围的开始，采用 ISO 8601 UTC 格式。如果设立此字段，则还必须设立`logCollectionToDate`。
`logCollectionToDate`	字符串	Optional	要收集的时间范围的结束时间，采用 ISO 8601 UTC 格式。如果设立此字段，则还必须设立`logCollectionFromDate`。

注意

当您将大小限制和时间范围结合使用时， Ops Manager会将大小限制用作安全上限。如果时间范围内的日志超过大小限制， Ops Manager将返回不超过大小限制的最新日志，并将受影响的子作业的 sizeLimitHit 设置为 true。如果省略 sizeRequestedPerFileBytes 以及时间范围， Ops Manager会在请求的服务器和日志类型之间自动分配剩余的已配置存储。

Ops Manager会拒绝违反以下规则之一的创建请求：

规则	错误代码	HTTP status
`sizeRequestedPerFileBytes` 必须大于 0。	`INVALID_LOG_REQUEST_SIZE`	400
`logCollectionFromDate` 和 `logCollectionToDate` 必须一起设立。	`OM_LOG_INCOMPLETE_TIME_RANGE`	400
`logCollectionFromDate` must precede `logCollectionToDate`.	`OM_LOG_INVALID_TIME_RANGE`	400
`logCollectionFromDate` 不得在将来。	`OM_LOG_TIME_RANGE_IN_FUTURE`	400
时间范围不得超过 7 天。	`OM_LOG_TIME_RANGE_TOO_LARGE`	400
时间范围的开始时间不得早于Ops Manager管理员配置的最大日志历史记录。	`OM_LOG_TIME_RANGE_TOO_OLD`	400
`servers` 中的每个值都必须标识一个已注册的活动Ops Manager服务器。	`INACTIVE_SERVER` or `INVALID_SERVER`	400
并发作业数不得超过 4。	`TOO_MANY_OM_LOG_JOBS`	429
估计存储不得超过Ops Manager管理员为日志集合配置的存储限制。	`OM_LOG_STORAGE_LIMIT_EXCEEDED`	413

响应

名称	类型	说明
`id`	字符串	新Ops Manager服务器日志集合作业的唯一标识符。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/omLogCollectionJobs?pretty=true" \
     --data '
       {
         "servers": [
           "om-server-1.example.com",
           "om-server-2.example.com"
         ],
         "logTypes": ["APPLICATION", "HTTP_ACCESS"],
         "sizeRequestedPerFileBytes": 5242880,
         "logCollectionFromDate": "2026-04-13T10:00:00Z",
         "logCollectionToDate": "2026-04-14T10:00:00Z"
       }'

响应示例

响应标头

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 201 Created
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}

响应体

{ "id": "675a1234567890abcdef1234" }

后退

列出活动服务器

来年

获取所有作业