문서 메뉴
문서 홈
/
MongoDB Ops Manager
/
API
/
Ops Manager 관리 API 리소스
/
MongoDB Server 사용량

모든 물리적 호스트 조회

이 페이지의 내용

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

필수 역할

이 리소스를 사용하려면 역할을 가진 API 키가 Global Owner 필요 합니다.

리소스

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

GET /usage/groups

요청 경로 매개변수

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

요청 쿼리 매개변수

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

이름
유형
설명
기본값
pageNum
integer
페이지 번호(1-인덱스 기준)입니다.
1
itemsPerPage
integer
페이지당 반환할 항목 수. 최대 500개까지 가능합니다.
100
pretty
부울
응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타냅니다. 형식.
false
envelope
부울

응답을 엔벨로프에 래핑할지 여부를 나타냅니다.

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

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

상태
HTTP 응답 코드
envelope
예상되는 응답 본문

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

none

요청 본문 매개변수

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

응답

응답 문서

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

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

results embeddedDocument

결과 배열의 각 요소는 하나의 물리적 호스트입니다.

응답 요소
유형
설명
호스트
객체 배열
제공된 물리적 호스트에 바인딩된 가상 호스트의 목록입니다.
hosts
.[n].groupId
문자열
Ops Manager가 이 가상 호스트를 배치하는 프로젝트의 고유 식별자입니다.
hosts
.[n].hostname
문자열
물리적 호스트에 바인딩된 가상 호스트의 FQDN 입니다.
id
문자열
Ops Manager가 가상 호스트를 바인딩한 물리적 호스트의 고유 식별자입니다.
이름
문자열
물리적 호스트에 부여한 레이블입니다.
serverType
문자열

물리적 호스트의 서버 유형입니다.

Ops Manager는 다음 값 중 하나를 반환합니다.

  • DEV_SERVER

  • test_SERVER

  • Production_SERVER

  • RAM_POOL

팁

다음도 참조하세요.

MongoDB 사용

요청 예시

1curl --user "{publicApiKey}:{privateApiKey}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?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": "http://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pageNum=1&itemsPerPage=100",
5      "rel": "self"
6    }
7  ],
8  "results": [
9    {
10      "hosts": [
11        {
12          "groupId": "{projectId1}",
13          "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-7"
14        },
15        {
16          "groupId": "{projectId1}",
17          "hostname": "virtual.host.niivowqqlyjpkakk.internal.mongodb-8"
18        }
19      ],
20      "id": "{physicalHostId1}",
21      "name": "physicalHostA",
22      "serverType": "DEV_SERVER"
23    },
24    {
25      "hosts": [
26        {
27          "groupId": "{projectId2}",
28          "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-0"
29        },
30        {
31          "groupId": "{projectId2}",
32          "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
33        }
34      ],
35      "id": "{physicalHostId2}",
36      "name": "physicalHostB",
37      "serverType": "DEV_SERVER"
38    },
39  ],
40  "totalCount": 2
41}

돌아가기

일일 사용량 스냅샷 생성