1개의 모니터링되는 호스트의 구성 업데이트

이 페이지의 내용

Resource

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

Cloud Manager는 2024년 8월 30일부터 더 이상 MongoDB 3.6 및 4.0에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다. MongoDB 배포를 업그레이드하거나 Atlas로 마이그레이션하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.

참고

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

모니터링되는 MongoDB 프로세스의 구성을 업데이트합니다.

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

Resource

PATCH /groups/{PROJECT-ID}/hosts/{HOST-ID}

요청 경로 매개변수

Parameter	유형	필요성	설명
프로젝트 ID	문자열	필수 사항	이 MongoDB 프로세스를 소유하는 프로젝트의 고유 식별자입니다.
HOST-ID	문자열	필수 사항	MongoDB 프로세스용 호스트의 고유 식별자입니다.

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

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

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

false

요청 본문 매개변수

Parameter	유형	필요성	설명
alertsEnabled	부울	옵션	이 MongoDB 프로세스에 대해 경고를 활성화해야 하는 경우 `true` 로 설정합니다.
authMechanismName	문자열	옵션	이 MongoDB 프로세스에 연결하는 데 사용할 인증 메커니즘을 지정합니다. 가능한 값은 다음과 같습니다. `MONGODB_CR` (여기에는 SCRAM-SHA-1, SCRAM-SHA-256 및 MONGODB-CR이 포함됩니다.) `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
logsEnabled	부울	옵션	Cloud Manager가 이 MongoDB 프로세스에 대한 로그를 수집해야 하는 경우 `true` 으)로 설정합니다.
비밀번호	문자열	조건부	이 MongoDB 프로세스에 연결하기 위한 비밀번호입니다. `"authMechanismName" : "MONGODB_CR"` 인지 `"authMechanismName" : "SCRAM_SHA_1"` 인지 지정합니다. 그러나 호스트 엔터티가 반환될 때는 절대 노출되지 않습니다.
ProfilerEnabled	부울	옵션	Cloud Manager가 이 MongoDB 프로세스에서 프로필 정보를 수집하는 경우 `true` 으)로 설정합니다.
sslEnabled	부울	조건부	이 MongoDB 프로세스에 대해 TLS/SSL 을 활성화해야 하는 경우 `true` 로 설정합니다. `"authMechanismName" : "MONGODB_X509"` `true` 로 설정합니다.
사용자 이름	문자열	조건부	이 MongoDB 프로세스에 연결하는 데 필요한 사용자 이름입니다. `"authMechanismName" : "MONGODB_CR"` 인지 `"authMechanismName" : "SCRAM_SHA_1"` 인지 지정합니다.

authMechanismName 이 NONE 인 경우 사용자 이름 및 비밀번호 에 대한 기존 값이 모두 지워집니다. authMechanismName 이 SCRAM-SHA-1 인 경우 사용자 이름 과 비밀번호 를 모두 제공해야 합니다.

응답

이름	유형	설명
별칭	문자열 배열	Cloud Manager가 MongoDB 프로세스에 대해 검색한 대체 호스트 이름 및 포트 조합의 배열입니다. 이러한 조합에는 호스트 이름, FQDN , IPv4 주소 및 IPv6 주소가 포함될 수 있습니다.
alertsEnabled	부울	`true` 이 MongoDB 프로세스에 경고가 활성화되어 있는지 여부.
authMechanismName	문자열	이 MongoDB 프로세스에 연결하는 데 사용되는 인증 메커니즘입니다. 그러면 다음 값 중 하나만 표시됩니다. `MONGODB_CR` (여기에는 SCRAM-SHA-1, SCRAM-SHA-256 및 MONGODB-CR이 포함됩니다.) `GSSAPI` `PLAIN` `MONGODB_X509` `NONE`
clusterId	문자열	MongoDB 프로세스가 속한 cluster의 고유 식별자입니다.
생성됨	날짜	Cloud Manager가 이 MongoDB 프로세스를 생성하거나 처음 발견한 날짜입니다.
groupId	문자열	이 호스트를 소유한 그룹 의 고유 식별자입니다.
hasStartupWarnings	부울	`true` 이 MongoDB 프로세스에 시작 경고가 발생한 경우.
숨김	부울	`true` 호스팅하다 가 Cloud Manager UI 에 표시되는 경우 `true` 으)로 설정하다 호스트는 API 응답에서 생략됩니다.
숨겨진 세컨더리	부울	`true` 이 호스팅하다 가 숨겨진 세컨더리 인 경우.
hostEnabled	부울	`true` MongoDB 프로세스가 현재 활성화된 경우.
호스트 이름	문자열	Cloud Manager가 가장 잘 결정할 수 있는 프라이머리 호스트 이름입니다. 이는 호스트 이름, FQDN, IPv4 주소 또는 IPv6 주소일 수 있습니다.
id	문자열	고유 식별자입니다.
ipAddress	문자열	이 MongoDB 프로세스의 `hostname` 와(과) 연결된 IPv4 또는 IPv6 주소입니다. 액세스 가능한 추가 IPv4 또는 IPv6 주소가 `aliases` 배열에 표시될 수 있습니다.
journalingEnabled	부울	`true` 이 MongoDB 프로세스에 대해 저널링이 활성화된 경우.
lastDataSizeBytes	숫자	인덱스를 제외한 디스크에 있는 호스트 데이터베이스의 압축되지 않은 크기(바이트)입니다. 은(는) 로컬 데이터베이스의`lastDataSizeBytes` 데이터를 포함 하지 않습니다 .
lastIndexSizeBytes	숫자	디스크에 있는 호스트 데이터베이스 인덱스의 압축되지 않은 크기(바이트)입니다. 이 숫자에는 로컬 데이터베이스의 인덱스 크기가 포함 되지 않습니다 .
lastPing	날짜	ISO 8601 의 타임스탬프 이 MongoDB 프로세스에 대한 마지막 핑이 수신된 날짜 및 시간 형식(UTC )입니다.
lastRestart	날짜	ISO 8601 의 타임스탬프 이 프로세스가 마지막으로 다시 시작된 날짜 및 시간 형식(UTC )입니다. MongoDB 프로세스를 다시 시작한 적이 없는 경우 `lastRestart` 필드가 생략됩니다.
링크	배열	하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크가 포함된 배열입니다. URL 간의 관계는 웹 링크 사양 에 설명되어 있습니다. . 최소한 `links` 배열에는 `self` 라는 링크가 하나 포함됩니다.
logsEnabled	부울	`true` Cloud Manager가 이 MongoDB 프로세스에 대한 로그를 수집하는 경우.
LowUlimit	부울	`true` 이 MongoDB 프로세스의 호스팅하다 에 `ulimit` 설정이 낮은 경우.
포트	숫자	MongoDB 프로세스가 수신 대기하는 포트입니다.
ProfilerEnabled	부울	`true` Cloud Manager가 이 MongoDB 프로세스에서 프로필 정보를 수집하는 경우
복제본 세트 이름	문자열	이 프로세스가 속한 복제본 세트의 이름입니다. 이 프로세스가 복제본 세트의 일부인 경우에만 표시됩니다.
replicaStateName	문자열	복제본 세트 내 이 MongoDB 프로세스의 현재 상태입니다. 이 프로세스가 복제본 세트의 일부인 경우에만 표시됩니다. 가능한 값은 복제본 세트 멤버 상태 를 참조하세요.
shardName	문자열	이 프로세스가 속한 샤드의 이름입니다. 프로세스가 샤드 cluster의 일부인 경우에만 표시됩니다.
secondaryDelaySecs	숫자	이 복제본 세트 멤버의 데이터가 프라이머리 를 추적하는 시간(초)입니다. 이 값을 `0` 로 설정하면 멤버가 지연 멤버로 구성되지 않습니다. 세컨더리 지연에 대한 자세한 내용은 지연된 복제본 세트 멤버를 참조하세요.
sslEnabled	부울	`true` 이 MongoDB 프로세스 에 대해 TLS/SSL 이 활성화된 경우.
systemInfo	객체	운영 체제 또는 container에서 보고한 이 MongoDB 프로세스 서버에 대한 RAM 및 CPU 정보가 포함된 객체입니다.
systemInfo.memSizeMB	숫자	RAM 용량(MB)입니다.
systemInfo.numCores	숫자	CPU 코어 수입니다.
typeName	문자열	이 MongoDB 프로세스를 입력합니다. 가능한 값은 다음과 같습니다. `STANDALONE` `REPLICA_PRIMARY` `REPLICA_SECONDARY` `REPLICA_ARBITER` `RECOVERING` `SHARD_MONGOS` `SHARD_CONFIG` `SHARD_STANDALONE` `SHARD_PRIMARY` `SHARD_SECONDARY` `NO_DATA` Cloud Manager에 추가된 새 호스트의 유형은 모니터링이 첫 번째 핑을 수신할 때까지 `NO_DATA` 가 됩니다.
uptimeMsec	숫자	이 프로세스를 마지막으로 다시 시작한 이후의 밀리초 수입니다.
버전	문자열	이 프로세스에 대해 실행 중인 MongoDB의 버전입니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}?pretty=true" \
     --data '
       {
         "sslEnabled": true,
         "username": "mongodb",
         "password": "M0ng0DB!:)"
       }'

응답 예시

응답 헤더

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   "alertsEnabled" : true,
3   "authMechanismName" : "SCRAM-SHA-1",
4   "clusterId" : "{CLUSTER-ID}",
5   "created" : "2014-04-22T19:56:50Z",
6   "groupId" : "{PROJECT-ID}",
7   "hasStartupWarnings" : false,
8   "hidden" : false,
9   "hostEnabled" : true,
10   "hostname" : "server1.example.com",
11   "id" : "{HOST-ID}",
12   "ipAddress": "10.1.0.10",
13   "journalingEnabled" : false,
14   "lastDataSizeBytes" : 470208719,
15   "lastIndexSizeBytes" : 110420592,
16   "lastPing" : "2016-08-15T17:57:12Z",
17   "links" : [  ],
18   "logsEnabled" : false,
19   "lowUlimit" : false,
20   "muninEnabled" : false,
21   "port" : 26000,
22   "profilerEnabled" : false,
23   "replicaSetName": "rs1",
24   "replicaStateName" : "SECONDARY",
25   "sslEnabled" : true,
26   "systemInfo" : {
27     "memSizeMB" : 65536,
28     "numCores" : 16
29   },
30   "typeName": "REPLICA_SECONDARY",
31   "uptimeMsec": 489182394,
32   "username" : "mongodb",
33   "version" : "4.0.0"
34 }

참고

Cloud Manager가 응답에서 muninEnabled 를 반환하지만, Munin 은 은(는) 지원되지 않습니다.

돌아가기

모니터

모니터링 중지

1	{
2	"alertsEnabled" : true,
3	"authMechanismName" : "SCRAM-SHA-1",
4	"clusterId" : "{CLUSTER-ID}",
5	"created" : "2014-04-22T19:56:50Z",
6	"groupId" : "{PROJECT-ID}",
7	"hasStartupWarnings" : false,
8	"hidden" : false,
9	"hostEnabled" : true,
10	"hostname" : "server1.example.com",
11	"id" : "{HOST-ID}",
12	"ipAddress": "10.1.0.10",
13	"journalingEnabled" : false,
14	"lastDataSizeBytes" : 470208719,
15	"lastIndexSizeBytes" : 110420592,
16	"lastPing" : "2016-08-15T17:57:12Z",
17	"links" : [ ],
18	"logsEnabled" : false,
19	"lowUlimit" : false,
20	"muninEnabled" : false,
21	"port" : 26000,
22	"profilerEnabled" : false,
23	"replicaSetName": "rs1",
24	"replicaStateName" : "SECONDARY",
25	"sslEnabled" : true,
26	"systemInfo" : {
27	"memSizeMB" : 65536,
28	"numCores" : 16
29	},
30	"typeName": "REPLICA_SECONDARY",
31	"uptimeMsec": 489182394,
32	"username" : "mongodb",
33	"version" : "4.0.0"
34	}