1개의 물리적 호스트 만들기

이 페이지의 내용

필수 역할

Resource
요청 경로 매개변수
요청 쿼리 매개변수
요청 본문 매개변수
응답
요청 예시
응답 예시
응답 헤더
응답 본문

필수 역할

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

Resource

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

POST /usage/groups

요청 경로 매개변수

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

요청 쿼리 매개변수

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

이름

유형

설명

기본값

pageNum

integer

페이지 번호(1-인덱스 기준)입니다.

1

itemsPerPage

integer

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

100

pretty

부울

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

false

envelope

부울

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

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

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

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

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

none

요청 본문 매개변수

본문 매개변수	유형	필요성	설명
가상 호스트	문자열 배열	필수 사항	제공된 물리적 호스트에 바인딩된 가상 호스트의 목록입니다.
virtualHosts .groupId	문자열	옵션	Ops Manager가 이 가상 호스트를 배치하는 프로젝트의 고유 식별자입니다.
virtualHosts .hostname	문자열	옵션	물리적 호스트에 바인딩된 가상 호스트의 FQDN 입니다.
이름	문자열	필수 사항	물리적 호스트에 부여한 레이블입니다. 이 값은 고유해야 합니다.
serverType	문자열	필수 사항	물리적 호스트의 서버 유형입니다. 다음 값 중 하나로 설정할 수 있습니다. `DEV_SERVER` `TEST_SERVER` `PRODUCTION_SERVER` `RAM_POOL` 학습 내용은 MongoDB 사용법을 참조하세요.

응답

응답 요소	유형	설명
호스트	객체 배열	제공된 물리적 호스트에 바인딩된 가상 호스트의 목록입니다.
hosts .[n].groupId	문자열	Ops Manager가 이 가상 호스트를 배치하는 프로젝트의 고유 식별자입니다.
hosts .[n].hostname	문자열	물리적 호스트에 바인딩된 가상 호스트의 FQDN 입니다.
id	문자열	Ops Manager가 가상 호스트를 바인딩한 물리적 호스트의 고유 식별자입니다.
이름	문자열	물리적 호스트에 부여한 레이블입니다.
serverType	문자열	물리적 호스트의 서버 유형입니다. Ops Manager는 다음 값 중 하나를 반환합니다. DEV_SERVER test_SERVER Production_SERVER RAM_POOL 학습 내용은 MongoDB 사용법을 참조하세요.

요청 예시

1 curl --user "{publicApiKey}:{privateApiKey}" --digest \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --include \
5      --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \
6      --data '{
7                "name": "physicalHostA",
8                "serverType":
9                  {
10                    "name": "PRODUCTION_SERVER",
11                    "label": "Production Server",
12                  },
13                "virtualHosts": [
14                  {
15                    "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
16                    "groupId": "{groupId}"
17                  }
18                ]
19              }'

응답 예시

응답 헤더

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   "hosts": [
3     {
4       "groupId": "{groupId}",
5       "hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
6     }
7   ],
8   "id": "{physicalHostID}",
9   "name": "physicalHostA",
10   "serverType":
11     {
12       "name": "PRODUCTION_SERVER",
13       "label": "Production Server",
14     },
15 }

돌아가기

1개의 물리적 호스트 검색

1개의 물리적 호스트 업데이트

1	curl --user "{publicApiKey}:{privateApiKey}" --digest \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--include \
5	--request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/usage/groups?pretty=true" \
6	--data '{
7	"name": "physicalHostA",
8	"serverType":
9	{
10	"name": "PRODUCTION_SERVER",
11	"label": "Production Server",
12	},
13	"virtualHosts": [
14	{
15	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1",
16	"groupId": "{groupId}"
17	}
18	]
19	}'

1	{
2	"hosts": [
3	{
4	"groupId": "{groupId}",
5	"hostname": "virtual.host.lqhfcxlgzqtimcxf.internal.mongodb-1"
6	}
7	],
8	"id": "{physicalHostID}",
9	"name": "physicalHostA",
10	"serverType":
11	{
12	"name": "PRODUCTION_SERVER",
13	"label": "Production Server",
14	},
15	}