주어진 기간 동안 서버 사용량에 대한 zip 또는 .tar.gz 형식의 압축 보고서를 조회합니다.
필수 역할
이 리소스를 성공적으로 호출하려면 API 키에 Global Owner 역할이 있어야 합니다.
요청
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /usage/report요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다. |
|
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
startDate | 문자열 | 필수 사항 | 보고서가 시작될 때 ISO 8601 날짜 형식의 날짜입니다. | |
endDate | 문자열 | 필수 사항 | 보고서가 종료될 때 ISO 8601 날짜 형식의 날짜입니다. | |
파일 형식 | 문자열 | 필수 사항 | 결과 보고서의 압축 형식입니다. Ops Manager는 zip 또는 .tar.gz 를 허용합니다. | |
수정 | 부울 | 옵션 | 응답에서 보고서의 모든 IP 주소, 호스트 이름, 조직 이름, 프로젝트 이름을 검열할지 여부를 나타내는 플래그입니다. | true |
요청 본문 매개변수
이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.
응답
이 엔드포인트는 fileFormat 매개 변수를 기반으로 .zip 또는 .tar.gz 압축 파일을 반환합니다.
요청 예시
curl --user "{publicApiKey}:{privateApiKey}" --digest \ --header "Accept: application/gzip" \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/usage/report?startDate=2019-07-27&endDate=2020-07-28&fileFormat=zip"응답 예시
응답 헤더
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}응답 본문
이 엔드포인트는 fileFormat 매개 변수를 기반으로 .zip 또는 .tar.gz 압축 파일을 반환합니다.