모든 유지 관리 Windows 가져오기

이 페이지의 내용

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

종료 날짜가 미래인 모든 유지 관리 기간을 조회합니다.

필수 역할

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

요청

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

GET /groups/{PROJECT-ID}/maintenanceWindows/

요청 경로 매개변수

이름	유형	설명
`PROJECT-ID`	문자열	프로젝트의 고유 식별자입니다.

요청 쿼리 매개변수

이름

유형

필요성

설명

기본값

pretty

부울

옵션

응답 본문이 프리티 프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

false

envelope

부울

옵션

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

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

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

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

false

요청 본문 매개변수

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

응답

응답 문서

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

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

`results` embeddedDocument

각 결과 는 하나의 유지 관리 기간입니다.

이름	유형	설명
`id`	문자열	유지 관리 기간의 고유 식별자입니다.
`groupId`	문자열	이 유지 관리 기간이 적용되는 프로젝트의 고유 식별자입니다.
`created`	문자열	ISO 8601 의 타임스탬프 유지 관리 기간 이 생성된 시점의 UTC 날짜 및 시간 형식입니다.
`updated`	문자열	ISO 8601 의 타임스탬프 유지 관리 기간 이 마지막으로 업데이트된 날짜 및 시간 형식(UTC )입니다.
`startDate`	문자열	ISO 8601 의 타임스탬프 유지 관리 기간 이 시작될 때 날짜 및 시간 형식을 UTC 로 표시합니다.
`endDate`	문자열	ISO 8601 의 타임스탬프 유지 관리 기간 이 종료되면 날짜 및 시간 형식( UTC )으로 변경합니다.
`alertTypeNames`	문자열 배열	유지 관리 기간 동안 무음으로 설정할 경고 유형입니다. 예: `HOST`, `REPLICA_SET`, `CLUSTER`, `AGENT`, `BACKUP`
`description`	문자열	유지 관리 기간에 대한 설명입니다. 이 필드는 유지 관리 기간에 대한 설명을 제공한 경우에만 반환됩니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows"

응답 예시

응답 헤더

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   "results" : [ {
3     "alertTypeNames" : [ "BACKUP" ],
4     "created" : "2015-10-22T15:04:31Z",
5     "description" : "new description",
6     "endDate" : "2015-10-23T23:30:00Z",
7     "groupId" : "{PROJECT-ID}",
8     "id" : "5628faffd4c606594adaa3b2",
9     "startDate" : "2015-10-23T22:00:00Z",
10     "updated" : "2015-10-22T15:04:31Z",
11     "links" : []
12   }, {
13     "alertTypeNames" : [ "AGENT", "BACKUP" ],
14     "created" : "2015-10-22T15:40:09Z",
15     "endDate" : "2015-10-23T23:30:00Z",
16     "groupId" : "{PROJECT-ID}",
17     "id" : "56290359d4c606594adaafe8",
18     "startDate" : "2015-10-23T22:00:00Z",
19     "updated" : "2015-10-22T15:40:09Z",
20     "links" : []
21   } ],
22   "links" : [],
23   "totalCount" : 2
24 }

돌아가기

유지 관리 창

Get One

1	{
2	"results" : [ {
3	"alertTypeNames" : [ "BACKUP" ],
4	"created" : "2015-10-22T15:04:31Z",
5	"description" : "new description",
6	"endDate" : "2015-10-23T23:30:00Z",
7	"groupId" : "{PROJECT-ID}",
8	"id" : "5628faffd4c606594adaa3b2",
9	"startDate" : "2015-10-23T22:00:00Z",
10	"updated" : "2015-10-22T15:04:31Z",
11	"links" : []
12	}, {
13	"alertTypeNames" : [ "AGENT", "BACKUP" ],
14	"created" : "2015-10-22T15:40:09Z",
15	"endDate" : "2015-10-23T23:30:00Z",
16	"groupId" : "{PROJECT-ID}",
17	"id" : "56290359d4c606594adaafe8",
18	"startDate" : "2015-10-23T22:00:00Z",
19	"updated" : "2015-10-22T15:40:09Z",
20	"links" : []
21	} ],
22	"links" : [],
23	"totalCount" : 2
24	}