공개 미리 보기: 피드백 제공하세요: 지정된 프로젝트 의 지정된 호스팅하다 에 대한 로그 메시지 범위 가 포함된 압축(.gz) 로그 파일 반환합니다.
공개 미리 보기: MongoDB Atlas 관리자 API 에서 자동으로 생성된 Atlas API 하위 명령은 관리자 API 에 대한 전체 기능을 제공하며 현재 공개 미리 보기로 제공됩니다( 피드백 https://feedback.mongodb.com/forums/930808-Atlas-cli). 관리자 API 기능에는 자체 출시하다 수명 주기가 있으며, 이는 제공된 API 엔드포인트 문서 링크를 통해 확인할 수 있습니다.
MongoDB 5분마다 클러스터 백엔드 인프라의 프로세스 및 감사 로그를 업데이트합니다. 로그는 약 5분 길이의 청크로 저장되지만 이 기간은 다를 수 있습니다. 로그 파일에 대해 API 폴링하는 경우 연속 폴링에 일부 겹치는 로그가 포함될 수 있더라도 5분마다 폴링하는 것이 좋습니다. 이 기능 M0 무료 클러스터, M2, M5, flex 또는 서버리스 리스 클러스터에서는 사용할 수 없습니다. 이 리소스 사용하려면 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 읽기 전용 이상의 역할 있어야 합니다. API JSON 응답 스키마 사용한 직접 호출을 지원 하지 않습니다. 'Accept: 애플리케이션 /vnd.atlas.YYYY-MM-DD+gzip' 형식의 수락 헤더를 사용하여 gzip 응답 스키마 요청 해야 합니다.
이 명령은 자동으로 생성되며 Atlas API 엔드포인트 https://www.mongodb.com/ko-kr/docs/api/doc/atlas-admin-api-v2/operation/operation-gethostlogs와 1:1 에 해당합니다. .
자세한 내용과 예시는 위에 링크된 참조 API 문서를 참조하세요.
구문
atlas api monitoringAndLogs getHostLogs [options]
옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
--endDate | int | 거짓 | 검색할 로그 메시지 범위의 종료 지점에 대한 날짜 및 시간을 UNIX 시대 이후 경과한 시간(초)으로 지정합니다. 이 값은 시작 날짜로부터 24시간 후로 기본 설정됩니다. 시작 날짜도 지정하지 않으면 기본값은 요청 시점으로 설정됩니다. |
--envelope | envelope | 거짓 | 애플리케이션이 응답을 엔벨로프 JSON 객체 로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스 할 수 없습니다. 이 문제를 해결하려면 쿼리 에서 envelope=true 를 설정하다 . 결과 목록을 반환하는 엔드포인트는 결과 객체 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다. |
--groupId | 문자열 | true | 프로젝트 식별하는 고유한 24-16진수 문자열입니다. [/groups](# 태그를 지정하다 /Projects/operation/listProjects) 엔드포인트를 사용하여 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 . 참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다. |
-h, --help | 거짓 | getHostLogs 도움말 | |
--hostName | 문자열 | true | 다운로드하려는 로그 파일을 저장하는 호스트를 식별하는 사람이 읽을 수 있는 레이블입니다. |
--logName | 문자열 | true | 반환하려는 로그 파일을 식별하는 사람이 읽을 수 있는 레이블입니다. 감사 로그를 반환하려면 지정된 프로젝트에 대해 데이터베이스 감사를 활성화하십시오. |
-o, --output | 문자열 | 거짓 | 기본 설정 API 형식, ["gzip"] 가능 이 값의 기본값은 "gzip"입니다. |
--outputFile | 문자열 | 거짓 | API 출력을 쓰기 (write) 파일 입니다. 이 플래그는 엔드포인트의 출력이 바이너리(예: gzip)이고 명령이 파이프되지 않은 경우(예: Atlas 명령 > out.zip)에 필요합니다. |
--startDate | int | 거짓 | 검색할 로그 메시지 범위의 시작점에 대한 날짜 및 시간을 UNIX 시대 이후 경과한 시간(초)으로 지정합니다. 이 값은 종료일 24시간 전으로 기본 설정됩니다. 종료 날짜도 지정되지 않은 경우 값은 기본적으로 요청 시간 24시간 전으로 설정됩니다. |
--version | 문자열 | 거짓 | API 호출 시 사용할 API 버전 [옵션: "2023-01-01", "2023-02-01"], 기본값은 최신 버전 또는 프로필 api_version 구성 값( 설정하다 경우) 이 값의 기본값은 '2023-02-01'입니다. |
상속된 옵션
이름 | 유형 | 필수 사항 | 설명 |
|---|---|---|---|
-P, --profile | 문자열 | 거짓 | 구성 파일 에서 사용할 프로필의 이름입니다. Atlas CLI 의 프로필에 대해 학습 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings를 참조하세요. |
예시
atlas api monitoringAndLogs getHostLogs --version 2023-02-01 --endDate 1609545600 --groupId [your-project-id] --hostName [your-host-name] --logName mongodb --startDate 1609459200