1개의 프로젝트에서 1개의 클러스터 호스트에 대해 로그 다운로드
지정된 프로젝트의 지정된 호스트에 대한 로그 메시지 범위가 포함된 압축(.gz) 로그 파일을 반환합니다. MongoDB는 클러스터 백엔드 인프라에서 프로세스 및 감사 로그를 5분마다 업데이트합니다. 로그는 약 5분 길이의 청크로 저장되지만 이 기간은 다를 수 있습니다. 로그 파일용 API를 폴링하는 경우 연속 폴링에 일부 중복되는 로그가 포함될 수 있더라도 5분마다 폴링하는 것이 좋습니다. M0 무료 클러스터, M2, M5, 플렉스 또는 서버리스 클러스터에서는 이 기능을 사용할 수 없습니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 데이터 액세스 읽기 전용 이상의 역할이 있어야 합니다. API는 JSON 응답 스키마를 사용한 직접 호출을 지원하지 않습니다. "Accept: application/vnd.atlas.YYYY-MM-DD+gzip" 형식의 accept 헤더를 사용하여 gzip 응답 스키마를 요청해야 합니다. 지원 중단된 버전: v2-{2023-01-01}
경로 매개변수
-
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은
^([a-f0-9]{24})$패턴 과 일치해야 합니다. -
다운로드하려는 로그 파일을 저장하는 호스트를 식별하는 사람이 읽을 수 있는 레이블입니다.
형식은
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$패턴 과 일치해야 합니다. -
반환하려는 로그 파일을 식별하는 사람이 읽을 수 있는 레이블입니다. 감사 로그를 반환하려면 지정된 프로젝트에 대해 데이터베이스 감사를 활성화하십시오.
값은
mongodb,mongos,mongodb-audit-log또는mongos-audit-log입니다.데이터베이스 감사를 설정합니다.
쿼리 매개변수
-
애플리케이션이 응답을
envelopeJSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.기본값은
false입니다. -
검색할 로그 메시지 범위의 종료 지점에 대한 날짜 및 시간을 UNIX 시대 이후 경과한 시간(초)으로 지정합니다. 이 값은 시작 날짜로부터 24시간 후로 기본 설정됩니다. 시작 날짜도 지정하지 않으면 기본값은 요청 시점으로 설정됩니다.
최소값은
1199145600입니다. -
검색할 로그 메시지 범위의 시작점에 대한 날짜 및 시간을 UNIX 시대 이후 경과한 시간(초)으로 지정합니다. 이 값은 종료일 24시간 전으로 기본 설정됩니다. 종료 날짜도 지정되지 않은 경우 값은 기본적으로 요청 시간 24시간 전으로 설정됩니다.
최소값은
1199145600입니다.
atlas api monitoringAndLogs downloadGroupClusterLog --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250219001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.DownloadGroupClusterLogApiParams{}
sdkResp, httpResp, err := client.MonitoringandLogsApi.
DownloadGroupClusterLogWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-02-19+gzip" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" \
--output "file_name.gz"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-02-19+gzip" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" \
--output "file_name.gz"{
"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"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}