Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager 관리 API 리소스
/
자동화
/
자동화 구성 리소스

백업 구성 설정 업데이트

이 페이지의 내용

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

필수 역할

이 리소스 에는 Project Automation Admin 역할 이 필요합니다.

Resource

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

PUT /groups/{PROJECT-ID}/automationConfig/backupAgentConfig

요청

경로 매개변수

이름
유형
필요성
설명
프로젝트 ID
문자열
필수 사항
구성을 소유한 24프로젝트 를 string 식별하는 고유한 -16진수 입니다.

쿼리 매개변수

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

이름
유형
필요성
설명
기본값
pretty
부울
옵션
응답 본문을 프리티프린트 에 포함해야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울
옵션

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

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

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

이름
설명
상태
HTTP 응답 코드
envelope
예상되는 응답 본문
false

본문 매개변수

Parameter
유형
필요성
설명
configOverrides
객체
옵션

백업 설정이 MongoDB Agent 의 설정과 다르기 때문에 변경해야 하는 MongoDB Agent 설정의 목록입니다. 레거시 에이전트에서 MongoDB Agent로 업그레이드할 때 이 옵션을 구성합니다.

설정
데이터 유형
문자열
문자열
문자열
integer
부울
문자열
문자열
문자열
문자열
문자열
문자열
문자열
문자열
부울
문자열
logPath
문자열
옵션
이 MongoDB Agent가 로그를 기록하는 절대 파일 경로입니다. 이를 지정하지 않으면 로그는 UNIX 및 Linux 기반 시스템에서는 표준 오류(stderr)에 기록되고 Windows 시스템에서는 이벤트 로그에 기록됩니다.
로그 회전
객체
옵션
이 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로 업그레이드할 때 이 옵션을 구성합니다.

설정
데이터 유형
문자열
문자열
문자열
integer
부울
문자열
문자열
문자열
문자열
문자열
문자열
문자열
문자열
부울
문자열
logPath
문자열
옵션
이 MongoDB Agent가 로그를 기록하는 절대 파일 경로입니다. 이를 지정하지 않으면 로그는 UNIX 및 Linux 기반 시스템에서는 표준 오류(stderr)에 기록되고 Windows 시스템에서는 이벤트 로그에 기록됩니다.
로그 회전
객체
옵션
이 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://<OpsManagerHost>:<Port>/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"
       }'

응답 예시

응답 헤더

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 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 객체를 반환합니다.

돌아가기

백업 구성 설정 가져오기

다음

모니터링 구성 설정 가져오기