1개의 프로젝트에 대해 모든 로그 수집 작업 가져오기
- Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.
- 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할 서비스 계정 을 만듭니다.
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}
는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
collection 작업을 생성하면 Cloud Manager는 백그라운드 job을 시작하여 지정된 Cloud Manager deployment에서 로그를 다운로드합니다. 이 엔드포인트를 사용하여 지정된 Cloud Manager 프로젝트에 대한 모든 collection 작업을 검색합니다.
기본 URL: https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{GROUP-ID}/logCollectionJobs
요청 경로 매개변수
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
그룹 ID | 문자열 | 필수 사항 | 로그 collection 요청 작업을 식별하는 고유한 24자리 16진수 문자열입니다. |
요청 쿼리 매개변수
이름 | 유형 | 필요성 | 설명 | 기본값 |
---|---|---|---|---|
pageNum | 숫자 | 옵션 | 결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다. | 1 |
itemsPerPage | 숫자 | 옵션 | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. | 100 |
pretty | 부울 | 옵션 | false | |
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 결과 목록을 반환하는 엔드포인트의 경우 | false |
backupJobsEnabledOnly | 부울 | 옵션 | 데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다. | true |
verbose | 부울 | 옵션 | 응답에 모든 하위 작업을 포함할지 여부를 나타내는 플래그입니다. 각 collection 작업에는 요청에 포함된 각 로그 유형 및 MongoDB 프로세스에 대한 작업이 포함되어 있습니다. | false |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
---|---|---|
results | 배열 | 배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다. |
links | 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
totalCount | 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results
embeddedDocument
각 결과 는 하나의 로그 collection 작업입니다.
이름 | 유형 | 설명 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
자식 작업 | 배열 | 이 요청과 연결된 하위 작업 목록입니다. 상세 쿼리 매개변수를 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진수 문자열입니다. | ||||||||||||
URL | 문자열 | 이 요청에서 로그를 다운로드하는 인터넷 주소입니다. | ||||||||||||
logCollectionFromDate | 문자열 | ISO 8601 의 로그 컬렉션 시작 날짜 및 시간입니다. 형식(UTC). | ||||||||||||
logCollectionToDate | 문자열 | ISO 8601 에서 로그 컬렉션 의 종료 날짜 및 시간입니다. 형식(UTC). |
요청 예시
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --include \ 4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?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 "links": [ 3 { 4 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?verbose=true&pageNum=1&itemsPerPage=100", 5 "rel": "self" 6 } 7 ], 8 "results": [ 9 { 10 "childJobs": [ 11 { 12 "automationAgentId": "5c810cc4ff7a256345ff97bf", 13 "errorMessage": null, 14 "finishDate": "2019-03-07T12:21:30Z", 15 "hostName": "server1.example.com", 16 "logCollectionType": "AUTOMATION_AGENT", 17 "path": "server1.example.com/automation_agent", 18 "startDate": "2019-03-07T12:21:24Z", 19 "status": "SUCCESS", 20 "uncompressedDiskSpaceBytes": 14686 21 } 22 ], 23 "creationDate": "2019-03-07T12:21:24Z", 24 "downloadUrl": "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c810cc4ff7a256345ff97b7/download", 25 "expirationDate": "2019-04-06T12:21:24Z", 26 "groupId": "5c8100bcf2a30b12ff88258f", 27 "id": "5c810cc4ff7a256345ff97b7", 28 "logTypes": [ 29 "AUTOMATION_AGENT", 30 "MONGODB" 31 ], 32 "redacted": true, 33 "resourceName": "myReplicaSet", 34 "resourceType": "replicaset", 35 "rootResourceName": "myReplicaSet", 36 "rootResourceType": "replicaset", 37 "sizeRequestedPerFileBytes": 1000, 38 "status": "SUCCESS", 39 "uncompressedSizeTotalBytes": 63326, 40 "userId": "5c80f75fcf09a246878f67a4" 41 }, 42 { 43 "childJobs": [ 44 { 45 "automationAgentId": "5c81086e014b76a3d85e1117", 46 "errorMessage": null, 47 "finishDate": "2019-03-07T12:02:57Z", 48 "hostName": "server1.example.com:27027", 49 "logCollectionType": "MONGODB", 50 "path": "server1.example.com/27027/mongodb", 51 "startDate": "2019-03-07T12:02:54Z", 52 "status": "SUCCESS", 53 "uncompressedDiskSpaceBytes": 9292 54 } 55 ], 56 "creationDate": "2019-03-07T12:02:54Z", 57 "downloadUrl": "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs/5c81086e014b76a3d85e1113/download", 58 "expirationDate": "2019-05-06T12:02:54Z", 59 "groupId": "5c8100bcf2a30b12ff88258f", 60 "id": "5c81086e014b76a3d85e1113", 61 "logTypes": [ 62 "MONGODB", 63 "FTDC", 64 "AUTOMATION_AGENT" 65 ], 66 "redacted": false, 67 "resourceName": "myReplicaSet", 68 "resourceType": "replicaset", 69 "rootResourceName": "myReplicaSet", 70 "rootResourceType": "replicaset", 71 "sizeRequestedPerFileBytes": 1000, 72 "status": "IN_PROGRESS", 73 "uncompressedSizeTotalBytes": 44518, 74 "userId": "5c80f75fcf09a246878f67a4" 75 } 76 ], 77 "totalCount": 2 78 }