사용량 제한 조회

Prev Next

도메인에 설정된 사용량 제한을 조회합니다.

  • document_upload : 업로드한 Document 크기를 보여줍니다 / uploaded documnet byte
  • reindex : 재색인(섹션, 색인 추가시 발생)된 문서 사이즈를 보여줍니다. / reindexed document byte
  • autocomplete_reindex : 자동완성이 적용된 문서의 수를 보여줍니다. / reindexed document count for autocomplete
  • search_response : Search Query 네트워크 사용량을 보여줍니다. / response size of searching, unit is byte
GET https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/{name}/quota

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
name Yes string 생성되어져 있는 Domain 이름

응답

필드명 타입 설명 비고
[].type string 사용량 제한을 설정한 항목 search_response, document_upload, reindex, autocomplete_reindex
[].status string 리소스 상태 usable, unusable(사용량 초과)
[].updateTime string 마지막으로 상태 혹은 사용량 제한 설정이 변경된 시간
[].quota number 사용량 제한
[].interval string 초기화 주기 1Month, 1Day
[].usageQuantity number 설정한 주기 동안의 사용량

응답 Status

HTTP Status Desc
200 OK(조회 완료)
400 Bad Request
401 Unauthorized
403 Forbidden
500 Internal Server Error

예시

요청 예시

GET /CloudSearch/beta/v1/domain/my_service/quota HTTP/1.1
Host: cloudsearch.apigw.ntruss.com
x-ncp-iam-access-key: cPMl0CYGgRYvEa8sylCj
x-ncp-apigw-signature-v2: +Ln++MqcKHckKli2y/bB76xLUu8qR9rLvo6j2yIYuYg=
x-ncp-apigw-timestamp: 1551453306138

응답 예시

[
  {
    "type": "search_response",
    "status": "usable",
    "updateTime": "30-04-2019 15:00:01",
    "quota": 10000000000,
    "interval": "1Month",
    "usageQuantity": 6221
  },
  {
    "type": "document_upload",
    "status": "usable",
    "updateTime": "30-04-2019 15:00:05",
    "quota": 1000000,
    "interval": "1Month",
    "usageQuantity": 17736
  }
]