온라인 아카이브 쿼리 로그 다운로드

얻다 /api/atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz

지정된 온라인 아카이브에 대한 쿼리 로그를 다운로드 . 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 읽기 전용 이상의 역할 있어야 합니다. API JSON 응답 스키마 사용한 직접 호출을 지원 하지 않습니다. '수락: 애플리케이션 /gzip' 형식의 수락 헤더를 사용하여 gzip 응답 스키마 요청 해야 합니다.

온라인 아카이브

경로 매개변수

groupId 문자열 필수 사항

프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.

참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.

형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.
clusterName 문자열 필수 사항

온라인 아카이브 한 개에서 쿼리 로그를 반환하려는 컬렉션이 포함된 cluster를 식별하는 사람이 읽을 수 있는 레이블입니다.

형식은 ^[a-zA-Z0-9][a-zA-Z0-9-]*$ 패턴 과 일치해야 합니다.

쿼리 매개변수

envelope 부울

애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.

기본값은 false 입니다.
startDate integer(int64)

반환할 로그 메시지 범위의 시작 지점을 지정하는 날짜 및 시간입니다. 이 리소스는 유닉스 시간 이후 경과된 시간(초)으로 이 값을 표현합니다.

최소값은 1199145600입니다.
endDate integer(int64)

반환할 로그 메시지 범위의 종료 지점을 지정하는 날짜 및 시간입니다. 이 리소스는 유닉스 시간 이후 경과된 시간(초)으로 이 값을 표현합니다.

최소값은 1199145600입니다.
archiveOnly 부울

온라인 아카이브에 대한 쿼리에 대해서만 로그를 다운로드할지, 아니면 온라인 아카이브와 cluster 모두에 대한 로그를 다운로드할지를 나타내는 플래그입니다.

기본값은 false 입니다.

응답

200 애플리케이션/gzip

확인

이 리소스 압축된 로그 파일 현재 작업 디렉토리 에 다운로드합니다. --output 옵션을 사용하여 이름을 지정하거나 -OJ 옵션을 사용하여 기본값 파일 이름을 사용할 수 있습니다. 기본값 파일 이름은 온라인 아카이브의 쿼리에 대한 로그만 다운로드 하는지, 아니면 온라인 아카이브와 클러스터 모두 다운로드하는지에 따라 달라집니다.
400 application/json

잘못된 요청입니다.
응답 속성 숨기기 응답 속성 표시 객체
- badRequestDetail 객체
  
  요청 세부 정보가 잘못되었습니다.
  
  badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
  
  필드 배열[객체]
  
  클라이언트 요청 의 모든 위반 사항을 설명합니다.
  
  필드 속성 숨기기 필드 속성 표시 객체
  
  description 문자열 필수 사항
  
  요청 요소가 잘못된 이유에 대한 설명입니다.
  
  필드 문자열 필수 사항
  
  요청 본문의 필드 로 연결되는 경로입니다.
- 세부 정보 문자열
  
  각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.
- 오류 integer(int32) 필수 사항
  
  이 오류와 함께 HTTP 상태 코드가 반환되었습니다.
  
  외부 문서
- 오류 코드 문자열 필수 사항
  
  이 오류와 함께 반환된 애플리케이션 오류 코드입니다.
- 매개변수 배열[객체]
  
  오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.
- 이유 문자열
  
  이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
401 application/json

승인되지 않았습니다.
응답 속성 숨기기 응답 속성 표시 객체
- badRequestDetail 객체
  
  요청 세부 정보가 잘못되었습니다.
  
  badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
  
  필드 배열[객체]
  
  클라이언트 요청 의 모든 위반 사항을 설명합니다.
  
  필드 속성 숨기기 필드 속성 표시 객체
  
  description 문자열 필수 사항
  
  요청 요소가 잘못된 이유에 대한 설명입니다.
  
  필드 문자열 필수 사항
  
  요청 본문의 필드 로 연결되는 경로입니다.
- 세부 정보 문자열
  
  각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.
- 오류 integer(int32) 필수 사항
  
  이 오류와 함께 HTTP 상태 코드가 반환되었습니다.
  
  외부 문서
- 오류 코드 문자열 필수 사항
  
  이 오류와 함께 반환된 애플리케이션 오류 코드입니다.
- 매개변수 배열[객체]
  
  오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.
- 이유 문자열
  
  이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
403 application/json

Forbidden.
응답 속성 숨기기 응답 속성 표시 객체
- badRequestDetail 객체
  
  요청 세부 정보가 잘못되었습니다.
  
  badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
  
  필드 배열[객체]
  
  클라이언트 요청 의 모든 위반 사항을 설명합니다.
  
  필드 속성 숨기기 필드 속성 표시 객체
  
  description 문자열 필수 사항
  
  요청 요소가 잘못된 이유에 대한 설명입니다.
  
  필드 문자열 필수 사항
  
  요청 본문의 필드 로 연결되는 경로입니다.
- 세부 정보 문자열
  
  각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.
- 오류 integer(int32) 필수 사항
  
  이 오류와 함께 HTTP 상태 코드가 반환되었습니다.
  
  외부 문서
- 오류 코드 문자열 필수 사항
  
  이 오류와 함께 반환된 애플리케이션 오류 코드입니다.
- 매개변수 배열[객체]
  
  오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.
- 이유 문자열
  
  이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
404 application/json

찾을 수 없습니다.
응답 속성 숨기기 응답 속성 표시 객체
- badRequestDetail 객체
  
  요청 세부 정보가 잘못되었습니다.
  
  badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
  
  필드 배열[객체]
  
  클라이언트 요청 의 모든 위반 사항을 설명합니다.
  
  필드 속성 숨기기 필드 속성 표시 객체
  
  description 문자열 필수 사항
  
  요청 요소가 잘못된 이유에 대한 설명입니다.
  
  필드 문자열 필수 사항
  
  요청 본문의 필드 로 연결되는 경로입니다.
- 세부 정보 문자열
  
  각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.
- 오류 integer(int32) 필수 사항
  
  이 오류와 함께 HTTP 상태 코드가 반환되었습니다.
  
  외부 문서
- 오류 코드 문자열 필수 사항
  
  이 오류와 함께 반환된 애플리케이션 오류 코드입니다.
- 매개변수 배열[객체]
  
  오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.
- 이유 문자열
  
  이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.
500 application/json

내부 서버 오류입니다.
응답 속성 숨기기 응답 속성 표시 객체
- badRequestDetail 객체
  
  요청 세부 정보가 잘못되었습니다.
  
  badRequestDetail 속성 숨기기 badRequestDetail 속성 표시 객체
  
  필드 배열[객체]
  
  클라이언트 요청 의 모든 위반 사항을 설명합니다.
  
  필드 속성 숨기기 필드 속성 표시 객체
  
  description 문자열 필수 사항
  
  요청 요소가 잘못된 이유에 대한 설명입니다.
  
  필드 문자열 필수 사항
  
  요청 본문의 필드 로 연결되는 경로입니다.
- 세부 정보 문자열
  
  각 오류 유형을 유발하는 특정 조건 또는 이유를 설명합니다.
- 오류 integer(int32) 필수 사항
  
  이 오류와 함께 HTTP 상태 코드가 반환되었습니다.
  
  외부 문서
- 오류 코드 문자열 필수 사항
  
  이 오류와 함께 반환된 애플리케이션 오류 코드입니다.
- 매개변수 배열[객체]
  
  오류에 대한 자세한 정보를 제공하는 데 사용된 매개변수입니다.
- 이유 문자열
  
  이 오류와 함께 반환된 애플리케이션 오류 메시지입니다.

GET /API/Atlas/v1.0/groups/{groupId}/clusters/{clusterName}/onlineArchives/queryLogs.gz

curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/onlineArchives/queryLogs.gz' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

응답 예시(400)

{
  "error": 400,
  "detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
  "reason": "Bad Request",
  "errorCode": "VALIDATION_ERROR"
}

응답 예시(401)

{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}

응답 예시(403)

{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}

응답 예시(404)

{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}

응답 예시(500)

{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}