1개의 cluster 업데이트
1개의 프로젝트에서 1개의 클러스터를 업데이트합니다.
clusterName 필드 만 업데이트 할 수 있습니다. MongoDB Ops Manager 는 검색한 클러스터 속성을 기반으로 다른 모든 클러스터 필드를 채웁니다.
참고
이 작업은 typeName 가 SHARDED 또는 SHARDED_REPLICA_SET 인 클러스터에서만 사용할 수 있습니다.
필수 역할
다음과 같은 할당된 역할을 사용하여 이 엔드포인트를 성공적으로 호출할 수 있습니다.
요청
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}
요청 경로 매개변수
이름 | 유형 | 설명 |
|---|---|---|
PROJECT-ID | 문자열 | 프로젝트의 고유 식별자입니다. |
CLUSTER-ID | 문자열 | 조회하려는 cluster의 고유 식별자입니다. |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
본문 매개변수 | 유형 | 필요성 | 설명 |
|---|---|---|---|
clusterName | 문자열 | 필수 사항 | 클러스터에 할당할 이름입니다. |
응답
응답 매개변수
이름 | 유형 | 설명 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
clusterName | 문자열 | 클러스터의 이름을 표시합니다. mongod 자체에서는 클러스터 이름을 지정할 수 없습니다. MongoDB Ops Manager가 이 이름을 제공하며 사용자가 업데이트할 수 있습니다. 샤드 클러스터 내의 복제본 세트의 경우, 클러스터 이름은 상위 클러스터의 이름입니다. | ||||||||||
groupId | 문자열 | cluster가 속한 프로젝트의 고유 식별자입니다. | ||||||||||
id | 문자열 | cluster의 고유 식별자입니다. | ||||||||||
lastHeartbeat | 날짜 | ISO 8601 의 타임스탬프 MongoDB Ops Manager가 가장 최근에 이 클러스터에서 핑을 처리한 UTC 의 날짜 및 시간 형식입니다. | ||||||||||
replicaSetName | 문자열 | 복제본 세트 이름입니다. Ops Manager는 cluster typeName 가 REPLICA_SET 또는 CONFIG_SERVER_REPLICA_SET 인 경우 이 값을 반환합니다. | ||||||||||
shardName | 문자열 | 샤드 이름입니다. Ops Manager는 cluster에 typeName 가 SHARDED 이거나 REPLICA_SET 샤드 cluster의 해당 부분이 있는 경우 이 값을 반환합니다. | ||||||||||
typeName | 문자열 | cluster 유형입니다. 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/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}?pretty=true" --data '{ "clusterName":"New Cluster Name" }'
응답 예시
응답 헤더
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}
응답 본문
1 { 2 "clusterName": "New Cluster Name", 3 "groupId": "5e84b94c003f2d6370004f4e", 4 "id": "5e8ba20e87d9396ca9b96bd0", 5 "lastHeartbeat": "2020-06-10T14:51:28Z", 6 "links": [ 7 { 8 "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0", 9 "rel": "self" 10 } 11 ], 12 "replicaSetName": "myRS", 13 "typeName": "REPLICA_SET" 14 }