요청하는 프로그래밍 방식 API 키에 사용할 수 있는 모든 프로젝트의 모든 클러스터에 대한 세부 정보를 가져옵니다.
필수 역할
할당된 모든 역할로 이 엔드포인트를 성공적으로 호출할 수 있습니다.
요청
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /api/public/v1.0/clusters요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다. |
|
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
응답 매개변수
응답 문서
응답 JSON 문서에는 result 객체 배열, link 객체 배열, 조회된 result 객체의 총 개수가 포함되어 있습니다.
이름 | 유형 | 설명 |
|---|---|---|
| 배열 | 배열에는 내장된 |
| 배열 | 배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다. |
| 숫자 | 결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다. |
results embeddedDocument
각 결과 는 하나의 프로젝트입니다.
이름 | 유형 | 설명 |
|---|---|---|
| 객체 배열 | API 키에 볼 수 있는 권한이 있는 각 프로젝트의 클러스터를 설명하는 객체입니다. |
| integer | 열려 있는 경고의 수입니다. |
| 부울 | 클러스터의 노드에 액세스하는 데 인증이 필요한지 여부를 지정합니다. |
| 문자열 | 클러스터의 가용성. 값에는 다음이 포함됩니다.
|
| 부울 | 클러스터에 대해 백업을 활성화할지 여부를 지정합니다. |
| 문자열 | MongoDB Ops Manager 클러스터의 고유 식별자입니다. |
| 숫자 | 클러스터의 각 노드에 저장된 데이터의 총 크기(바이트)입니다. |
| 문자열 | MongoDB Ops Manager 에 표시되는 클러스터 의 이름입니다. |
| integer | 클러스터의 노드 수입니다. |
| 부울 | 클러스터 의 노드에 액세스 하기 위해 SSL 인증 이 필요한지 여부를 지정합니다. |
| 문자열 | MongoDB cluster 의 유형입니다. 값에는 다음이 포함됩니다.
|
| 문자열 배열 | 클러스터의 각 노드가 실행 중인 MongoDB 버전입니다. |
| 문자열 | 프로젝트의 고유 식별자입니다. |
| 문자열 | 반환된 클러스터가 속한 프로젝트의 이름입니다. |
| 문자열 | 반환된 클러스터가 속한 프로젝트를 소유한 조직의 고유 식별자입니다. |
| 문자열 | 반환된 클러스터가 속한 프로젝트를 소유한 조직의 이름입니다. |
| 문자열 | 계획 유형입니다. MongoDB Ops Manager 에서 이 값은 항상 MongoDB Ops Manager 입니다. |
| 문자열 배열 | 프로젝트에 적용된 태그입니다. |
요청 예시
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 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}응답 본문
{ "links": [ { "href": "https://example.com:8080/api/public/v1.0/clusters", "rel": "self" } ], "results": [ { "clusters": [ { "alertCount": 0, "authEnabled": true, "availability": "available", "backupEnabled": false, "clusterId": "5e6bc0352e41683c191c8956", "dataSizeBytes": 0, "name": "Cluster1", "nodeCount": 3, "sslEnabled": true, "type": "replica set", "versions": [ "4.2.3" ] }, { "alertCount": 0, "authEnabled": true, "availability": "available", "backupEnabled": false, "clusterId": "5e6bc60ba4c3f47a54d8fe95", "dataSizeBytes": 0, "name": "Cluster2", "nodeCount": 3, "sslEnabled": true, "type": "replica set", "versions": [ "4.2.3" ] } ], "groupId": "5df90932f10fab675508b0e5", "groupName": "az", "orgId": "5df7a168f10fab3a149357fb", "orgName": "jww-12-16", "planType": "Ops Manager", "tags": [
] }, { "clusters": [ { "alertCount": 0, "authEnabled": true, "availability": "available", "backupEnabled": false, "clusterId": "5e6bbf6a9de0d35b1527dd93", "dataSizeBytes": 0, "name": "Cluster0", "nodeCount": 3, "sslEnabled": true, "type": "replica set", "versions": [ "4.2.3" ] } ], "groupId": "5df90590f10fab5e33de2305", "groupName": "jww-12-17", "orgId": "5df7a168f10fab3a149357fb", "orgName": "jww-12-16", "planType": "Ops Manager", "tags": [
] }, { "clusters": [ { "alertCount": 0, "authEnabled": true, "availability": "dead", "backupEnabled": false, "clusterId": "5e6be93fd434591c4ca765f6", "dataSizeBytes": 0, "name": "Cluster0", "nodeCount": 0, "sslEnabled": true, "type": "replica set", "versions": [ "4.2.3" ] } ], "groupId": "5df90923f10fab675508b065", "groupName": "gcp", "orgId": "5df7a168f10fab3a149357fb", "orgName": "jww-12-16", "planType": "Ops Manager", "tags": [
] } ], "totalCount": 3}