/ /

전역 앱 설정 업데이트

MongoDB Ops Manager 설치의 전역 애플리케이션 설정을 업데이트합니다. 변경하려는 설정만 포함합니다. MongoDB Ops Manager는 다른 모든 설정을 그대로 두업니다.

필수 역할

이 엔드포인트를 성공적으로 호출하려면 API 키에 역할 있어야 Global Owner 합니다.

요청

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

PATCH /admin/settings

요청 경로 매개변수

이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.

요청 쿼리 매개변수

이름	유형	필요성	설명	기본값
pretty	부울	옵션	응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다.	`false`
envelope	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다. `status`HTTP 응답 코드 `content`예상되는 응답 본문	`false`

요청 본문 매개변수

필드	유형	필요성	설명
`dbProperties`	객체	필수 사항	업데이트하거나 추가할 전역 앱 설정의 키-값 쌍. 요청에 포함되지 않은 설정은 변경되지 않습니다. 설정을 제거하려면 값을 `null`(으)로 설정하세요.

중요

MongoDB Ops Manager는 값에 관계없이 mms.app.upgradeMode을 포함하는 모든 요청을 거부합니다. 이러한 요청은 INVALID_SETTINGS_EXCEPTION 오류 코드로 400 오류를 반환합니다.

유효성 검사는 제출된 속성에만 적용되는 것이 아니라 기존 설정과 제출된 설정의 병합된 세트에 대해 실행됩니다. 요청은 제출한 설정의 종속 필드이고 이미 구성되어 있지 않은 경우 포함하지 않은 필드에서 실패할 수 있습니다. 예를 들어 mms.mail.hostname 에 기존 값이 없는 경우 {"mms.emailDaoClass": "SIMPLE_MAILER"} 을 제출하면 detail: "mms.mail.hostname must not be blank" 이 실패합니다.

응답

필드	유형	설명
`restartRequired`	부울	업데이트된 설정이 적용되려면 Ops Manager를 다시 시작해야 하는지 여부를 나타냅니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?pretty=true" \
     --data '{
       "dbProperties": {
         "mms.centralUrl": "https://ops-manager.example.com"
       }
     }'

응답 예시

응답 헤더

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}

응답 본문

1 {
2   "restartRequired": false
3 }

돌아가기

설정 가져오기

백업 관리