Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
리소스
/
로그 컬렉션 작업

로그 수집 작업 만들기

이 페이지의 내용

  • Resource
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 요청 예시
  • 응답 예시
  • 응답 헤더
  • 응답 본문

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

collection 작업을 생성하면 Cloud Manager는 백그라운드 job을 시작하여 지정된 Cloud Manager deployment에서 로그를 다운로드합니다. 이 엔드포인트를 사용하여 새로운 collection 작업을 만듭니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

Resource

POST /groups/{GROUP-ID}/logCollectionJobs

요청 경로 매개변수

이름
유형
필요성
설명

그룹 ID

문자열

필수 사항

로그 collection 요청 작업을 식별하는 고유한 24자리 16진수 문자열입니다.

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름
유형
필요성
설명
기본값

pretty

부울

옵션

응답 본문을 프리티프린트 에 포함해야 하는지 여부를 나타내는 플래그입니다. 형식.

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름
설명

status

HTTP 응답 코드

content

예상되는 응답 본문

false

요청 본문 매개변수

이름
유형
필요성
설명

리소스 유형

문자열

필수 사항

로그를 수집할 리소스 유형입니다. 다음 값 중 하나여야 합니다.

  • CLUSTER, 샤드 cluster의 경우.

  • PROCESS, 복제본 세트의 노드에 해당합니다.

  • REPLICASET, 복제본 세트의 경우`

ResourceName

문자열

필수 사항

로그를 수집할 리소스의 이름입니다. 리소스 유형에 따라 값이 정의됩니다.

  • CLUSTER resourceType 의 경우 값은 배포서버의 이름 또는 CLUSTER-ID 입니다. 예를 들어 my-deployment 입니다.

  • PROCESS resourceType 의 경우 이 값은 복제본 세트의 이름 뒤에 노드 이름을 붙인 것입니다. 예를 들어 Cluster0-shard-1-node-0 입니다.

    복제본 세트의 이름, 노드 목록 및 기타 정보를 얻으려면 클러스터에 액세스하여 rs.conf()._id 및 rs.status() 를 실행합니다.

  • REPLICASET resourceType 의 경우 이 값은 cluster의 복제본 세트 이름 뒤에 샤드 이름이 붙은 것입니다. 예를 들어 test-123abc-shard-0 입니다.

sizeRequestedPerFileBytes

숫자

필수 사항

각 로그 파일의 크기(바이트)입니다.

logTypes

배열

필수 사항

수집할 로그 유형을 지정하는 문자열 배열입니다. 각 배열 요소는 다음 값 중 하나여야 합니다:

  • AUTOMATION_AGENT

  • BACKUP_AGENT

  • MONITORING_AGENT

  • MONGODB

  • FTDC

편집됨

부울

필수 사항

true 로 설정하면 이 작업과 관련된 API 응답의 이메일, 호스트 이름, IP 주소 및 네임스페이스가 임의의 문자열 값으로 대체됩니다.

logCollectionFromDate

문자열

옵션

ISO 8601 의 로그 컬렉션 시작 날짜 및 시간입니다. 형식(UTC). 날짜와 시간은 과거여야 합니다.

logCollectionToDate

문자열

logCollectionFromDate 을(를) 사용하는 경우 필수입니다.

ISO 8601 에서 로그 컬렉션 의 종료 날짜 및 시간입니다. 형식(UTC). 날짜와 시간은 과거여야 합니다. logCollectionToDate 는 logCollectionFromDate 뒤에 와야 합니다.

응답

이름
유형
설명

id

문자열

생성된 로그 collection 작업의 고유 식별자입니다.

요청 예시

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{GROUP-ID}/logCollectionJobs?pretty=true"
6     --data '
7       {
8         "resourceType": "PROCESS",
9         "resourceName": "my_deployment_1",
10         "redacted": true,
11         "sizeRequestedPerFileBytes": 10000000,
12         "logTypes": [
13             "FTDC",
14             "MONGODB",
15             "AUTOMATION_AGENT"
16         ],
17         "logCollectionFromDate": "2024-07-18T13:53:17Z",
18         "logCollectionToDate": "2024-07-18T15:53:17Z"
19       }'

응답 예시

응답 헤더

HTTP/1.1 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
HTTP/1.1 201 Created
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{ "id": "5c81086e014b76a3d85e1113" }

돌아가기

로그 다운로드

다음

확장