1개의 글로벌 사용 보고서 아카이브 가져오기

이 페이지의 내용

필수 역할

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

주어진 기간 동안 서버 사용량에 대한 zip 또는 .tar.gz 형식의 압축 보고서를 조회합니다.

필수 역할

이 리소스 를 성공적으로 호출하려면 API 키에 Global Owner 역할 이 있어야 합니다.

요청

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

GET /usage/report

요청 경로 매개변수

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

요청 쿼리 매개변수

이름

유형

필요성

설명

기본값

pretty

부울

옵션

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

false

envelope

부울

옵션

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

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

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

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

false

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 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}

응답 본문

이 엔드포인트는 fileFormat 매개 변수를 기반으로 .zip 또는 .tar.gz 압축 파일을 반환합니다.

돌아가기

1개의 프로젝트 진단 아카이브 가져오기

모든 호스트 할당 나열