필수 역할
이 리소스를 사용하려면 API 키에 Global Owner 역할이 있어야 합니다.
Resource
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /usage/groups요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 설명 | 기본값 |
|---|---|---|---|
pageNum | integer | 페이지 번호(1-인덱스 기준)입니다. |
|
itemsPerPage | integer | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. |
|
pretty | 부울 | 응답 본문이 프리티 프린트 형식이어야 하는지 여부를 나타냅니다. |
|
envelope | 부울 | 응답을 엔벨로프에 래핑할지 여부를 나타냅니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
결과 목록을 반환하는 엔드포인트의 경우 | none |
요청 본문 매개변수
본문 매개변수 | 유형 | 필요성 | 설명 |
|---|---|---|---|
가상 호스트 | 문자열 배열 | 필수 사항 | 제공된 물리적 호스트에 바인딩된 가상 호스트의 목록입니다. |
virtualHosts | 문자열 | 옵션 | Ops Manager가 이 가상 호스트를 배치하는 프로젝트의 고유 식별자입니다. |
virtualHosts | 문자열 | 옵션 | 물리적 호스트에 바인딩된 가상 호스트의 FQDN 입니다. |
이름 | 문자열 | 필수 사항 | 물리적 호스트에 부여한 레이블입니다. 이 값은 고유해야 합니다. |
serverType | 문자열 | 필수 사항 | 물리적 호스트의 서버 유형입니다. 다음 값 중 하나로 설정할 수 있습니다.
자세한 학습 은 MongoDB 사용 페이지를 참조하세요. |
응답
응답 요소 | 유형 | 설명 |
|---|---|---|
호스트 | 객체 배열 | 제공된 물리적 호스트에 바인딩된 가상 호스트의 목록입니다. |
호스팅 | 문자열 | Ops Manager가 이 가상 호스트를 배치하는 프로젝트의 고유 식별자입니다. |
호스팅 | 문자열 | 물리적 호스트에 바인딩된 가상 호스트의 FQDN 입니다. |
id | 문자열 | Ops Manager가 가상 호스트를 바인딩한 물리적 호스트의 고유 식별자입니다. |
이름 | 문자열 | 물리적 호스트에 부여한 레이블입니다. |
serverType | 문자열 | 물리적 호스트의 서버 유형입니다. Ops Manager는 다음 값 중 하나를 반환합니다.
자세한 학습 은 MongoDB 사용 페이지를 참조하세요. |
요청 예시
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \ --data '{ "name": "physicalHostA", "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server", }, "virtualHosts": [ { "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1", "groupId": "{groupId}" } ] }'응답 예시
응답 헤더
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}응답 본문
{ "hosts": [ { "groupId": "{groupId}", "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1" } ], "id": "{physicalHostID}", "name": "physicalHostA", "serverType": { "name": "PRODUCTION_SERVER", "label": "Production Server", },}