백업 구성 설정 업데이트
- Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.
- 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.
필수 역할
이 리소스에는 Project Automation Admin 역할이 필요합니다.
Resource
기본 URL: https://cloud.mongodb.com/api/public/v1.0
PUT /groups/{PROJECT-ID}/automationConfig/backupAgentConfig
요청
경로 매개변수
이름 | 유형 | 필요성 | 설명 |
|---|---|---|---|
프로젝트 ID | 문자열 | 필수 사항 | 구성을 소유한 프로젝트 를 식별하는 24고유한 -16진수 입니다.string |
쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
본문 매개변수
Parameter | 유형 | 필요성 | 설명 | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configOverrides | 객체 | 옵션 | 백업 설정이 MongoDB Agent 의 설정과 다르기 때문에 변경해야 하는 MongoDB Agent 설정의 목록입니다. 레거시 에이전트에서 MongoDB Agent로 업그레이드할 때 이 옵션을 구성합니다.
| ||||||||||||||||||||||||||||||||
logPath | 문자열 | 옵션 | 이 MongoDB Agent가 로그를 기록하는 절대 파일 경로입니다. 이를 지정하지 않으면 로그는 UNIX 및 Linux 기반 시스템에서는 표준 오류( | ||||||||||||||||||||||||||||||||
로그 회전 | 객체 | 옵션 | 이 MongoDB Agent가 백업 로그를 로테이션하는 임계값입니다. | ||||||||||||||||||||||||||||||||
logRotate .sizeThresholdMB | integer | 옵션 | 이 MongoDB Agent가 로그 파일을 로테이션하기 전의 로그 파일의 최대 크기(MB)입니다. | ||||||||||||||||||||||||||||||||
logRotate .timeDurationHrs | integer | 옵션 | 이 MongoDB Agent가 로그 파일을 로테이션하기 전까지의 시간(시간)입니다. | ||||||||||||||||||||||||||||||||
사용자 이름 | 문자열 | 옵션 | 백업 로그를 managed 애플리케이션 데이터베이스의 MongoDB 사용자입니다. API 를 사용하여 MongoDB 에이전트에 대한 인증을 활성화하는 경우, 이 엔드포인트를 실행할 때 이 매개변수를 mms-automation으로 설정합니다. |
응답
Parameter | 유형 | 필요성 | 설명 | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
configOverrides | 객체 | 옵션 | 백업 설정이 MongoDB Agent 의 설정과 다르기 때문에 변경해야 하는 MongoDB Agent 설정의 목록입니다. 레거시 에이전트에서 MongoDB Agent로 업그레이드할 때 이 옵션을 구성합니다.
| ||||||||||||||||||||||||||||||||
logPath | 문자열 | 옵션 | 이 MongoDB Agent가 로그를 기록하는 절대 파일 경로입니다. 이를 지정하지 않으면 로그는 UNIX 및 Linux 기반 시스템에서는 표준 오류( | ||||||||||||||||||||||||||||||||
로그 회전 | 객체 | 옵션 | 이 MongoDB Agent가 백업 로그를 로테이션하는 임계값입니다. | ||||||||||||||||||||||||||||||||
logRotate .sizeThresholdMB | integer | 옵션 | 이 MongoDB Agent가 로그 파일을 로테이션하기 전의 로그 파일의 최대 크기(MB)입니다. | ||||||||||||||||||||||||||||||||
logRotate .timeDurationHrs | integer | 옵션 | 이 MongoDB Agent가 로그 파일을 로테이션하기 전까지의 시간(시간)입니다. | ||||||||||||||||||||||||||||||||
사용자 이름 | 문자열 | 옵션 | 백업 로그를 managed 애플리케이션 데이터베이스의 MongoDB 사용자입니다. API 를 사용하여 MongoDB 에이전트에 대한 인증을 활성화하는 경우, 이 엔드포인트를 실행할 때 이 매개변수를 mms-automation으로 설정합니다. |
요청 예시
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/backupAgentConfig?pretty=true" \ --data '{ "configOverrides" : { "mmsBaseUrl" : "http://new.example.org" }, "logPath": "/var/log/mongodb-mms-automation/backup-agent.log", "logRotate": { "sizeThresholdMB": 1000, "timeThresholdHrs": 12 }, "username": "mms-automation" }'
응답 예시
응답 헤더
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}
응답 본문
이 엔드포인트는 빈 JSON 객체를 반환합니다.