Ops Manager 서버 로그 컬렉션 작업 생성하면 Ops Manager 배경 작업을 시작하여 대상 서버에서 요청된 로그를 수집합니다. 각 서버 로컬에서 로그를 수집하고, 압축 및 암호화하고, 결과를 애플리케이션 데이터베이스에 저장합니다. 이 엔드포인트를 사용하여 새 작업 만듭니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
POST /admin/omLogCollectionJobs
필수 역할
이 엔드포인트를 호출하는 API 키에 Global Owner 역할 이 있어야 합니다.
요청 매개변수
요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식이어야 하는지 여부를 나타내는 플래그입니다. |
| ||||||
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이름 | 유형 | 필요성 | 설명 |
|---|---|---|---|
| 문자열 배열 | 옵션 | 활성 Ops Manager 서버 나열에서 반환된 |
| 문자열 배열 | 옵션 | 수집할 로그 유형입니다. 각 요소는 다음 값 중 하나여야 합니다.
이 필드 생략하거나 빈 배열 전달하면 Ops Manager 모든 로그 유형을 수집합니다. |
| 숫자 | 옵션 | 서버 당 로그 유형별 압축되지 않은 최대 크기(바이트)입니다. 0보다 커야 합니다. 이 필드 생략하면 Ops Manager 요청된 서버 및 로그 유형에 구성된 나머지 저장 자동으로 할당합니다. |
| 문자열 | 옵션 | 수집할 시간 범위 의 시작(ISO 8601 UTC 형식)입니다. 이 필드 설정하다 경우 |
| 문자열 | 옵션 | 수집할 시간 범위 의 끝(ISO 8601 UTC 형식)입니다. 이 필드 설정하다 경우 |
참고
크기 제한과 시간 범위 결합하면 Ops Manager 크기 제한을 안전 한도로 적용합니다. 이 시간 범위 의 로그가 크기 제한을 초과하는 경우 Ops Manager 크기 제한까지 가장 최근 로그를 반환하고 영향을 받는 하위 작업에 대해 sizeLimitHit 를 true 로 설정합니다. 시간 범위 와 함께 sizeRequestedPerFileBytes 를 생략하면 Ops Manager 요청된 서버 및 로그 유형에 구성된 나머지 저장 자동으로 할당합니다.
Ops Manager 다음 규칙 중 하나를 위반하는 생성 요청 거부합니다.
Rule | 오류 코드 | HTTP status |
|---|---|---|
|
| 400 |
|
| 400 |
|
| 400 |
|
| 400 |
시간 범위 7 일을 초과할 수 없습니다. |
| 400 |
시간 범위 Ops Manager 관리자가 구성한 최대 로그 기록보다 일찍 시작되어서는 안 됩니다. |
| 400 |
|
| 400 |
동시 작업 수는 4개를 초과할 수 없습니다. |
| 429 |
예상 저장 Ops Manager 관리자가 로그 컬렉션 위해 구성한 저장 제한을 초과하지 않아야 합니다. |
| 413 |
응답
이름 | 유형 | 설명 |
|---|---|---|
| 문자열 | 새 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" }'
응답 예시
응답 헤더
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
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" }