/ /

/ /

전역 앱 설정 가져오기

MongoDB Ops Manager 설치에 대한 전역 애플리케이션 설정 조회.

필수 역할

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

요청

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

GET /admin/settings

요청 경로 매개변수

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

요청 쿼리 매개변수

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

요청 본문 매개변수

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

응답

필드	유형	설명
`dbProperties`	객체	데이터베이스에 저장된 전역 앱 설정의 키-값 쌍. MongoDB Ops Manager는 시크릿 설정을 평문으로 반환하지 않습니다.
`defaultFileProperties`	객체	MongoDB Ops Manager에 포함된 기본값 설정 파일의 키-값 쌍. 이 설정은 인스턴스 수준 설정 재정의 오버라이드 파일과 다릅니다.
`instanceOverrides`	객체	인스턴스별 데이터베이스 재정의 설정입니다. 이 설정은 공개 API를 통해 읽을 수 있지만 업데이트할 수는 없습니다.
`instanceDetails`	객체	인스턴스 수준 데이터베이스 재정의와 관련된 인스턴스 세부 정보
`secretProperties`	문자열 배열	MongoDB Ops Manager가 데이터베이스에 암호화된 값으로 저장하는 설정 이름. 이 목록의 내용은 향후 릴리스에서 변경될 수 있습니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET \
     "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/settings?pretty=true"

응답 예시

응답 헤더

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   "dbProperties": {
3     "mms.centralUrl": "https://ops-manager.example.com",
4     "mms.https.CAFile": "/path/to/ca/file"
5   },
6   "defaultFileProperties": {
7     "mms.https.ClientCertificateMode": "none"
8   },
9   "instanceOverrides": {
10     "instance-1": {
11       "reCaptcha.enabled.registration": "false"
12     }
13   },
14   "instanceDetails": {
15     "instance-1": {
16       "om.instance.runtime.availableProcessors": 2
17     }
18   },
19   "secretProperties": [
20     "mms.smtp.password"
21   ]
22 }

돌아가기

글로벌 앱 설정

설정 업데이트

1	{
2	"dbProperties": {
3	"mms.centralUrl": "https://ops-manager.example.com",
4	"mms.https.CAFile": "/path/to/ca/file"
5	},
6	"defaultFileProperties": {
7	"mms.https.ClientCertificateMode": "none"
8	},
9	"instanceOverrides": {
10	"instance-1": {
11	"reCaptcha.enabled.registration": "false"
12	}
13	},
14	"instanceDetails": {
15	"instance-1": {
16	"om.instance.runtime.availableProcessors": 2
17	}
18	},
19	"secretProperties": [
20	"mms.smtp.password"
21	]
22	}