Docs Menu
Docs Home
/
MongoDB Cloud Manager
/ / / /

1개의 프로젝트에서 1개의 cluster 가져오기

이 페이지의 내용

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

프로젝트 한 개에서 cluster 한 개의 세부 정보를 조회합니다.

할당된 모든 역할로 이 엔드포인트를 성공적으로 호출할 수 있습니다.

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

GET /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}
이름
유형
설명
PROJECT-ID
문자열
프로젝트의 고유 식별자입니다.
CLUSTER-ID
문자열
조회하려는 cluster의 고유 식별자입니다.

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

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

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

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

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

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

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

이름
유형
설명
clusterName
문자열
클러스터의 이름을 표시합니다. mongod 자체에서는 클러스터 이름을 지정할 수 없습니다. Cloud Manager가 이 이름을 제공하며 사용자가 업데이트할 수 있습니다. 샤드 클러스터 내의 복제본 세트의 경우, 클러스터 이름은 상위 클러스터의 이름입니다.
groupId
문자열
cluster가 속한 프로젝트의 고유 식별자입니다.
id
문자열
cluster의 고유 식별자입니다.
lastHeartbeat
날짜
ISO 8601 의 타임스탬프 Cloud Manager 가 가장 최근에 이 클러스터 에서 핑 을 처리한 UTC 의 날짜 및 시간 형식입니다.
replicaSetName
문자열
복제본 세트 이름입니다. Cloud Manager는 cluster의 typeNameREPLICA_SET 또는 CONFIG_SERVER_REPLICA_SET 인 경우 이 값을 반환합니다.
shardName
문자열
샤드 이름입니다. Cloud Manager는 cluster에 SHARDEDtypeName 가 있거나 샤딩된 cluster의 해당 부분에 REPLICA_SET 가 있는 경우 이 값을 반환합니다.
typeName
문자열

클러스터 유형입니다. Cloud Manager는 다음을 반환할 수 있습니다.

typeName
설명
REPLICA_SET
SHARDED
각 샤드 가 독립형 인스턴스 인 샤드 샤딩된 클러스터 입니다. 어떤 샤드도 복제본 세트가 아닙니다.
SHARDED_REPLICA_SET
복제본 세트인 샤드를 하나 이상 포함하는 shard cluster입니다.
CONFIG_SERVER_REPLICA_SET
복제본 세트로 배포된 config 서버입니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--include \
--request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}?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 "clusterName": "myRS",
3 "groupId": "5e84b94c003f2d6370004f4e",
4 "id": "5e8ba20e87d9396ca9b96bd0",
5 "lastHeartbeat": "2020-06-10T14:51:28Z",
6 "links": [
7 {
8 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",
9 "rel": "self"
10 }
11 ],
12 "replicaSetName": "myRS",
13 "typeName": "REPLICA_SET"
14}

돌아가기

1개의 프로젝트에서 모든 cluster 가져오기