listQueryStatistics

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

Classic/VPC 환경에서 이용 가능합니다.

Ncloud API 표준 규격을 적용한 API입니다.

도메인 1건의 질의수를 조회합니다. 결과는 baseTimeUnit 간격으로 끊어진 연속 시계열이며 기준 시각 오름차순으로 반환되고, 질의가 없던 구간도 queryCount 0 으로 채워집니다. 조회 구간은 filter 표현식으로 지정하며, 생략하면 baseTimeUnit 별 기본 조회 기간이 적용됩니다. 조회 가능한 과거 구간은 baseTimeUnit 별 보관 기간(MINUTE_1·MINUTE_5·MINUTE_30 60일, HOUR_3 90일, DAY_1 730일)까지이며, 그보다 앞선 구간을 지정해도 오류 없이 데이터가 없는 구간으로 반환됩니다. 한 번에 조회할 수 있는 구간에는 상한이 있습니다. baseTimeUnit 별 최대 조회 구간은 MINUTE_1 7일, MINUTE_5 30일, MINUTE_30 60일, HOUR_3 90일, DAY_1 730일이며, 이를 넘는 구간을 filter 로 지정하면 400 InvalidParameter 로 응답합니다. 이 API 는 삭제된 도메인의 과거 질의수도 조회할 수 있습니다. 도메인 조회·수정 등 다른 API 는 삭제된 도메인 번호에 403 Forbidden 으로 응답하지만, 질의수는 도메인이 삭제된 뒤에도 보관 기간 동안 남아 있어 이 API 에서만 예외적으로 허용합니다. 이 예외는 삭제 여부만 검사에서 제외할 뿐 소유 검증은 그대로 적용되므로, 호출자가 보유했던 도메인에만 해당합니다. 소유 이력이 없는 도메인 번호는 삭제 여부와 실재 여부에 관계없이 다른 API 와 동일하게 403 Forbidden 으로 응답합니다. 회원이 보유한 전체 도메인의 합계는 GET /query-statistics 를 사용합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

요청 헤더

Global DNS API에서 공통으로 사용하는 헤더에 대한 정보는 Global DNS 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://globaldns.apigw.gov-ntruss.com/dns/v2/domains/120/query-statistics?baseTimeUnit=HOUR_3' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

QueryStatistic

질의수 데이터 포인트

응답 상태 코드

Global DNS API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Global DNS 응답 상태 코드를 참조해 주십시오.

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

응답 예시

응답 예시는 다음과 같습니다.

{
  "queryStatistics": [
    {
      "queryCount": 1234,
      "baseTimestamp": 1568111263000
    }
  ]
}