/ /

/ /

모든 Ops Manager 서버 로그 수집 작업 가져오기

이 엔드포인트를 사용하여 모든 Ops Manager 서버 로그 컬렉션 작업 조회 .

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /admin/omLogCollectionJobs

필수 역할

이 엔드포인트를 호출하는 API 키에 Global Read Only 역할 이 있어야 합니다.

요청 매개변수

요청 경로 매개변수

이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.

요청 쿼리 매개변수

이름	유형	필요성	설명	기본값
`pageNum`	숫자	옵션	결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.	`1`
`itemsPerPage`	숫자	옵션	페이지당 반환할 항목 수. 최대 500개까지 가능합니다.	`100`
`verbose`	부울	옵션	응답에 모든 하위 작업을 포함할지 여부를 나타내는 플래그입니다. 각 Ops Manager 서버 로그 컬렉션 작업 요청 에 포함된 각 서버 및 로그 유형 조합에 대한 하위 작업 있습니다.	`false`
`pretty`	부울	옵션	응답 본문이 pretty-print 형식이어야 하는지 여부를 나타내는 플래그입니다.	`false`
`envelope`	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드 액세스 할 수 없습니다. 이 문제를 해결하려면 `envelope=true` 쿼리 에서 를 설정하다 .	`false`

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

응답에는 결과 객체 배열 , 링크 객체 배열 , 조회된 총 결과 객체 수가 포함됩니다.

이름	유형	설명
`results`	배열	Ops Manager 서버 로그 컬렉션 작업의 배열입니다.내장된 문서 결과를 확인합니다.
`links`	배열	하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크 배열입니다. URL 간의 관계는 웹 연결 5988 사양(RFC)을 따릅니다.
`totalCount`	숫자	결과 설정하다 의 총 항목 수입니다. 페이지를 매길 때 `results` 의 크기를 초과할 수 있습니다.

결과 내장된 문서

각 results 요소는 하나의 Ops Manager 서버 로그 컬렉션 작업 나타냅니다.

이름	유형	설명
`id`	문자열	이 작업 식별하는 고유한 24-16진수 문자열입니다.
`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`	부울	데이터가 `sizeRequestedPerFileBytes`에 도달하여 Ops Manager 하위 작업의 수집된 데이터를 잘랐는지 여부를 나타내는 플래그입니다.
`downloadUrl`	문자열	아카이브를 다운로드 할 수 있는 URL 입니다.Ops Manager 서버 로그 다운로드를 참조하세요.
`childJobs`	배열	이 요청 과 연결된 하위 작업의 목록입니다. Ops Manager `verbose=true`을(를) 설정하다 경우에만 이 필드 포함합니다.

ChildJobs 내장된 문서

각 하위 작업 하나의 서버 와 하나의 로그 유형에 대한 로그 컬렉션 작업 나타냅니다.

이름	유형	설명
`childJobs[n].serverId`	문자열	`serverId` 이 하위 작업 로그를 수집하는 Ops Manager 서버 의 입니다.
`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`	부울	데이터가 `sizeRequestedPerFileBytes`에 도달하여 Ops Manager 이 하위 작업의 수집된 데이터를 잘랐는지 여부를 나타내는 플래그입니다.
`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
}

돌아가기

만들기

1개의 작업 가져오기