문서 메뉴
문서 홈
/
MongoDB Ops Manager
/
API
/
Ops Manager 관리 API 리소스
/
배포
/
클러스터

모든 프로젝트의 모든 cluster 가져오기

이 페이지의 내용

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

요청하는 프로그래밍 방식 API 키에 사용할 수 있는 모든 프로젝트의 모든 클러스터에 대한 세부 정보를 가져옵니다.

필수 역할

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

요청

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

GET /api/public/v1.0/clusters

요청 경로 매개변수

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

요청 쿼리 매개변수

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

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

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

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

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

요청 본문 매개변수

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

응답

응답 매개변수

응답 문서

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

이름
유형
설명
results
배열
배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다.
links
배열
배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
totalCount
숫자
결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

results embeddedDocument

각 결과 는 하나의 프로젝트입니다.

이름
유형
설명
clusters
객체 배열
API 키에 볼 수 있는 권한이 있는 각 프로젝트의 클러스터를 설명하는 객체입니다.
clusters.[n].alertCount
integer
열려 있는 경고의 수입니다.
clusters.[n].authEnabled
부울
클러스터의 노드에 액세스하는 데 인증이 필요한지 여부를 지정합니다.
clusters.[n].availability
문자열

클러스터의 가용성. 값에는 다음이 포함됩니다.

  • available: 클러스터의 모든 노드를 사용할 수 있습니다.

  • warning: 클러스터의 일부 노드를 사용할 수 있습니다. 하나 이상의 노드를 사용할 수 없습니다.

  • unavailable: 클러스터를 사용할 수 없습니다. 클러스터에 프라이머리 노드가 없습니다.

  • dead: 클러스터가 비활성 상태입니다.

clusters.[n].backupEnabled
부울
클러스터에 대해 백업을 활성화할지 여부를 지정합니다.
clusters.[n].clusterId
문자열
MongoDB Ops Manager 클러스터의 고유 식별자입니다.
clusters.[n].dataSizeBytes
숫자
클러스터의 각 노드에 저장된 데이터의 총 크기(바이트)입니다.
clusters.[n].name
문자열
Ops Manager에 표시되는 cluster의 이름입니다.
clusters.[n].nodeCount
integer
클러스터의 노드 수입니다.
clusters.[n].sslEnabled
부울
클러스터의 노드에 액세스하기 위해 SSL 인증이 필요한지 여부를 지정합니다.
clusters.[n].type
문자열

MongoDB cluster 의 유형입니다. 값에는 다음이 포함됩니다.

clusters.[n].versions
문자열 배열
클러스터의 각 노드가 실행 중인 MongoDB 버전입니다.
groupId
문자열
프로젝트의 고유 식별자입니다.
groupName
문자열
반환된 클러스터가 속한 프로젝트의 이름입니다.
orgId
문자열
반환된 클러스터가 속한 프로젝트를 소유한 조직의 고유 식별자입니다.
orgName
문자열
반환된 클러스터가 속한 프로젝트를 소유한 조직의 이름입니다.
planType
문자열

계획 유형입니다.

Ops Manager에서 이 값은 항상 Ops Manager입니다.

tags
문자열 배열
프로젝트에 적용된 태그입니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/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/clusters",
5      "rel": "self"
6    }
7  ],
8  "results": [
9    {
10      "clusters": [
11        {
12          "alertCount": 0,
13          "authEnabled": true,
14          "availability": "available",
15          "backupEnabled": false,
16          "clusterId": "5e6bc0352e41683c191c8956",
17          "dataSizeBytes": 0,
18          "name": "Cluster1",
19          "nodeCount": 3,
20          "sslEnabled": true,
21          "type": "replica set",
22          "versions": [
23            "4.2.3"
24          ]
25        },
26        {
27          "alertCount": 0,
28          "authEnabled": true,
29          "availability": "available",
30          "backupEnabled": false,
31          "clusterId": "5e6bc60ba4c3f47a54d8fe95",
32          "dataSizeBytes": 0,
33          "name": "Cluster2",
34          "nodeCount": 3,
35          "sslEnabled": true,
36          "type": "replica set",
37          "versions": [
38            "4.2.3"
39          ]
40        }
41      ],
42      "groupId": "5df90932f10fab675508b0e5",
43      "groupName": "az",
44      "orgId": "5df7a168f10fab3a149357fb",
45      "orgName": "jww-12-16",
46      "planType": "Ops Manager",
47      "tags": [
48
49      ]
50    },
51    {
52      "clusters": [
53        {
54          "alertCount": 0,
55          "authEnabled": true,
56          "availability": "available",
57          "backupEnabled": false,
58          "clusterId": "5e6bbf6a9de0d35b1527dd93",
59          "dataSizeBytes": 0,
60          "name": "Cluster0",
61          "nodeCount": 3,
62          "sslEnabled": true,
63          "type": "replica set",
64          "versions": [
65            "4.2.3"
66          ]
67        }
68      ],
69      "groupId": "5df90590f10fab5e33de2305",
70      "groupName": "jww-12-17",
71      "orgId": "5df7a168f10fab3a149357fb",
72      "orgName": "jww-12-16",
73      "planType": "Ops Manager",
74      "tags": [
75
76      ]
77    },
78    {
79      "clusters": [
80        {
81          "alertCount": 0,
82          "authEnabled": true,
83          "availability": "dead",
84          "backupEnabled": false,
85          "clusterId": "5e6be93fd434591c4ca765f6",
86          "dataSizeBytes": 0,
87          "name": "Cluster0",
88          "nodeCount": 0,
89          "sslEnabled": true,
90          "type": "replica set",
91          "versions": [
92            "4.2.3"
93          ]
94        }
95      ],
96      "groupId": "5df90923f10fab675508b065",
97      "groupName": "gcp",
98      "orgId": "5df7a168f10fab3a149357fb",
99      "orgName": "jww-12-16",
100      "planType": "Ops Manager",
101      "tags": [
102
103      ]
104    }
105  ],
106  "totalCount": 3
107}

돌아가기

클러스터