Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

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

이 페이지의 내용

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

1개의 프로젝트에 있는 모든 cluster에 대한 세부 정보를 조회합니다.

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

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

GET /groups/{PROJECT-ID}/clusters
이름
유형
설명

PROJECT-ID

문자열

프로젝트의 고유 식별자입니다.

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

이름
유형
필요성
설명
기본값

pageNum

숫자

옵션

결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.

1

itemsPerPage

숫자

옵션

페이지당 반환할 항목 수. 최대 500개까지 가능합니다.

100

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

결과 목록을 반환하는 엔드포인트의 경우 content 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 status 필드를 추가합니다.

false

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

응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.

이름
유형
설명

results

배열

배열에는 내장된 results 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체 가 포함됩니다.

links

배열

배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.

totalCount

숫자

결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

결과 는 하나의 cluster입니다.

이름
유형
설명

clusterName

문자열

클러스터의 이름을 표시합니다. mongod 자체에서는 클러스터 이름을 지정할 수 없습니다. MongoDB Ops Manager가 이 이름을 제공하며 사용자가 업데이트할 수 있습니다. 샤드 클러스터 내의 복제본 세트의 경우, 클러스터 이름은 상위 클러스터의 이름입니다.

groupId

문자열

cluster가 속한 프로젝트의 고유 식별자입니다.

id

문자열

cluster의 고유 식별자입니다.

lastHeartbeat

날짜

ISO 8601 의 타임스탬프 MongoDB Ops Manager가 가장 최근에 이 클러스터에서 핑을 처리한 UTC 의 날짜 및 시간 형식입니다.

replicaSetName

문자열

복제본 세트 이름입니다. Ops Manager는 cluster typeNameREPLICA_SET 또는 CONFIG_SERVER_REPLICA_SET 인 경우 이 값을 반환합니다.

shardName

문자열

샤드 이름입니다. Ops Manager는 cluster에 typeNameSHARDED 이거나 REPLICA_SET 샤드 cluster의 해당 부분이 있는 경우 이 값을 반환합니다.

typeName

문자열

cluster 유형입니다. Ops 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://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/clusters?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 "links": [
3 {
4 "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters?pageNum=1&itemsPerPage=100",
5 "rel": "self"
6 }
7 ],
8 "results": [
9 {
10 "clusterName": "myRS",
11 "groupId": "5e84b94c003f2d6370004f4e",
12 "id": "5e8ba20e87d9396ca9b96bd0",
13 "lastHeartbeat": "2020-06-10T14:51:28Z",
14 "links": [
15 {
16 "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e8ba20e87d9396ca9b96bd0",
17 "rel": "self"
18 }
19 ],
20 "replicaSetName": "myRS",
21 "typeName": "REPLICA_SET"
22 },
23 {
24 "clusterName": "cm-clstr-repl",
25 "groupId": "5e84b94c003f2d6370004f4e",
26 "id": "5e84e393395ec72bfc888f6c",
27 "lastHeartbeat": "2020-06-10T15:20:08Z",
28 "links": [
29 {
30 "href": "https://example.com:8080/api/public/v1.0/groups/5e84b94c003f2d6370004f4e/clusters/5e84e393395ec72bfc888f6c",
31 "rel": "self"
32 }
33 ],
34 "replicaSetName": "cm-clstr-repl",
35 "typeName": "REPLICA_SET"
36 }
37 ],
38 "totalCount": 2
39}

돌아가기

모든 프로젝트에서 모두 가져오기