1개의 로그 collection 작업 가져오기
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}
는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
로그 컬렉션 작업 을 만들면 MongoDB Ops Manager 가 배경 작업 을 시작하여 지정된 MongoDB Ops Manager 배포서버 서버에서 로그를 다운로드 합니다. 이 엔드포인트를 사용하여 고유 식별자로 단일 로그 컬렉션 작업 을 조회 할 수 있습니다.
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}
요청 경로 매개변수
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
그룹 ID | 문자열 | 필수 사항 | 로그 collection 요청 작업을 식별하는 고유한 24자리 16진수 문자열입니다. |
작업-ID | 문자열 | 필수 사항 | 재시도할 로그 컬렉션 작업 을 식별하는 고유한 24-16진수 string 입니다. 개의 프로젝트에 대한 모든 로그 컬렉션 작업 가져오기 엔드포인트를 사용하여 프로젝트 와 연결된 ID를 가져옵니다. |
요청 쿼리 매개변수
이름 | 유형 | 설명 | 기본값 | ||||
---|---|---|---|---|---|---|---|
pageNum | integer | 페이지 번호(1-인덱스 기준)입니다. | 1 | ||||
itemsPerPage | integer | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. | 100 | ||||
pretty | 부울 | false | |||||
envelope | 부울 | 응답을 엔벨로프에 래핑할지 여부를 나타냅니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
결과 목록을 반환하는 엔드포인트의 경우 | none |
verbose | 부울 | true인 경우 응답의 모든 하위 작업을 반환합니다. collection 작업에는 요청에 포함된 각 로그 유형과 MongoDB 프로세스에 대한 작업이 포함됩니다. | false |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
이름 | 유형 | 설명 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
자식 작업 | 배열 | 이 요청과 연결된 하위 작업 목록입니다. 상세 쿼리 매개변수를 true 로 설정한 경우 응답에 포함됩니다. | ||||||||||||
childJobs[n].errorMessage | 문자열 | 이 하위 작업이 실패한 이유를 보여주는 오류 메시지(해당되는 경우). | ||||||||||||
childJobs[n].finishDate | 문자열 | ISO 8601 의 타임스탬프 이 하위 작업이 완료된 UTC 의 날짜 및 시간 형식입니다. | ||||||||||||
childJobs[n].hostName | 문자열 | 하위 작업이 로그를 수집하는 호스트의 이름입니다. | ||||||||||||
childJobs[n].logCollectionType | 문자열 | 이 하위 작업이 수집하는 로그 유형입니다. 다음 값 중 하나를 반환합니다.
| ||||||||||||
차일드잡[n].path | 문자열 | 이 하위 작업이 로그를 수집하는 배포 내 프로세스의 경로입니다. MongoDB Atlas는 이러한 경로를 사용하여 압축된 아카이브 파일에서 디렉토리 계층 구조를 구축합니다.
| ||||||||||||
childJobs[n].startDate | 문자열 | ISO 8601 의 타임스탬프 이 하위 작업이 시작된 날짜 및 시간 형식(UTC )입니다. | ||||||||||||
차일드잡[n].status | 문자열 | 이 하위 작업의 상태입니다. 이 리소스는 다음 값 중 하나를 반환합니다.
| ||||||||||||
childJobs[n].uncompressedDiskSpaceBytes | 숫자 | 이 하위 작업이 사용하는 압축되지 않은 총 디스크 공간(바이트)입니다. | ||||||||||||
creationDate | 문자열 | 유닉스 시간 이후 경과된 시간(초)으로 표시한 타임스탬프 로그 수집 요청 작업을 생성한 시점. | ||||||||||||
만료 날짜 | 문자열 | 유닉스 시간 이후 경과된 시간(초)으로 표시한 타임스탬프 로그 수집 요청 작업이 만료되는 경우. | ||||||||||||
groupId | 문자열 | 로그 수집 요청과 연결된 프로젝트 24를 식별하는 고유한 -16진수 입니다.string | ||||||||||||
id | 문자열 | 로그 collection 요청 작업을 식별하는 고유한 24자리 16진수 문자열입니다. | ||||||||||||
logTypes | 배열 | 이 요청에 포함된 로그 유형 목록입니다. 이 리소스는 다음 값 중 하나 이상을 반환합니다.
| ||||||||||||
편집됨 | 부울 | 요청이 응답의 이메일, 호스트 이름, IP 주소 및 네임스페이스를 임의의 문자열 값으로 대체하는지 여부를 나타내는 플래그입니다. | ||||||||||||
ResourceName | 문자열 | 로그를 요청한 리소스의 이름입니다. | ||||||||||||
리소스 유형 | 문자열 | 로그를 요청한 리소스 유형입니다. 이 리소스는 다음 값 중 하나를 반환합니다.
| ||||||||||||
rootResourceName | 문자열 | 배포의 일부에 대해 로그를 요청한 경우 전체 배포의 이름입니다. 배포의 일부는 클러스터 또는 샤드 클러스터의 샤드 하나의 복제본 세트일 수 있습니다. | ||||||||||||
rootResourceType | 문자열 | 배포의 일부에 대한 로그를 요청한 경우 전체 배포의 일부를 입력합니다. Part of the deployment could be a replica set in a cluster or one shard of a sharded cluster. 이 리소스는 다음 값 중 하나를 반환합니다.
| ||||||||||||
상태 | 문자열 | collection 요청 작업의 상태입니다. 이 리소스는 다음 값 중 하나를 반환합니다.
| ||||||||||||
sizeRequestedPerFileBytes | 숫자 | 각 로그 파일의 크기(바이트)입니다. | ||||||||||||
uncompressedSizeTotalBytes | 숫자 | 이 요청이 반환하는 로그 데이터의 압축되지 않은 총 크기(바이트)입니다. | ||||||||||||
userId | 문자열 | 요청을 실행하는 사용자를 식별하는 고유한 24자리 16진수 문자열입니다. | ||||||||||||
downloadUrl | 문자열 | 이 요청에서 로그를 다운로드하는 인터넷 주소입니다. |
요청 예시
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/{JOB-ID}?verbose=true&pretty=true"
응답 예시
응답 헤더
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
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}
응답 본문
1 { 2 "childJobs": [ 3 { 4 "automationAgentId": "5c81086e014b76a3d85e1123", 5 "errorMessage": null, 6 "finishDate": "2019-03-07T12:02:57Z", 7 "hostName": "server1.example.com", 8 "logCollectionType": "AUTOMATION_AGENT", 9 "path": "server1.example.com/automation_agent", 10 "startDate": "2019-03-07T12:02:54Z", 11 "status": "SUCCESS", 12 "uncompressedDiskSpaceBytes": 12827 13 }, 14 { 15 "automationAgentId": "5c81086e014b76a3d85e1117", 16 "errorMessage": null, 17 "finishDate": "2019-03-07T12:02:57Z", 18 "hostName": "server1.example.com:27027", 19 "logCollectionType": "MONGODB", 20 "path": "server1.example.com/27027/mongodb", 21 "startDate": "2019-03-07T12:02:54Z", 22 "status": "SUCCESS", 23 "uncompressedDiskSpaceBytes": 9292 24 }, 25 ... 26 ], 27 "creationDate": "2019-03-07T12:02:54Z", 28 "downloadUrl": "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download", 29 "expirationDate": "2019-05-06T12:02:54Z", 30 "groupId": "5c8100bcf2a30b12ff88258f", 31 "id": "5c81086e014b76a3d85e1113", 32 "logTypes": [ 33 "AUTOMATION_AGENT", 34 "MONGODB", 35 "FTDC" 36 ], 37 "redacted": false, 38 "resourceName": "myReplicaSet", 39 "resourceType": "replicaset", 40 "rootResourceName": "myReplicaSet", 41 "rootResourceType": "replicaset", 42 "sizeRequestedPerFileBytes": 1000, 43 "status": "IN_PROGRESS", 44 "uncompressedSizeTotalBytes": 44518, 45 "userId": "5c80f75fcf09a246878f67a4" 46 }