모니터링 결과 조회

Prev Next

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

Search Engine 클러스터 및 노드 서버의 모니터링 데이터를 조회합니다.

요청

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

메서드 URI
GET /api/v2/monitoring/getSearchEngineMonitoringData/{serviceGroupInstanceNo} (수도권)
GET /api/krs-v2/monitoring/getSearchEngineMonitoringData/{serviceGroupInstanceNo} (남부권)

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
serviceGroupInstanceNo Integer Required 클러스터 인스턴스 번호

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
timeStart Integer Required 조회 시작 일시(밀리초)
  • Unix Timestamp 형식
timeEnd Integer Required 조회 종료 일시(밀리초)
  • Unix Timestamp 형식
metric String Required Metric 유형
  • CLUSTER_ALL_METRICS | SES_ALL_METRICS
    • CLUSTER_ALL_METRICS: 클러스터 모니터링 Metric
    • SES_ALL_METRICS: 노드 모니터링 Metric
computeInstanceNo Integer Conditional 노드 서버 인스턴스 번호
interval String Optional 집계 주기
  • Min1 (기본값) | Min5 | Min30 | Hour2 | Day1
    • Min1: 1분(최대 1일)
    • Min5: 5분(최대 1주일)
    • Min30: 30분(최대 1개월)
    • Hour2: 2시간(최대 3개월)
    • Day1: 1일(최대 1년)

요청 예시

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

curl --location --request GET 'https://vpcsearchengine.apigw.gov-ntruss.com/api/v2/monitoring/getSearchEngineMonitoringData/1037*****?timeStart=1742747874000&timeEnd=1742866674000&metric=SES_ALL_METRICS&computeInstanceNo=1037*****&interval=Min30' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
code Integer - 응답 코드
message String - 응답 메시지
result Object - 응답 결과
result.data Array - 모니터링 데이터
requestId String - 요청에 대한 아이디
  • UUID 형식

result.data

result.data에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
dps Array - 조회 결과
  • 데이터 포인트(Unix Timestamp 형식), 데이터 값 형태로 표시
aggregation String - 집계 함수
dimensions Object - Dimension 정보
dimensions.instanceNo String - 노드 서버 인스턴스 번호
dimensions.Svc_group_instance_no String - 클러스터 인스턴스 번호
interval String - 집계 주기
  • Min1 | Min5 | Min30 | Hour2 | Day1
    • Min1: 1분(최대 1일)
    • Min5: 5분(최대 1주일)
    • Min30: 30분(최대 1개월)
    • Hour2: 2시간(최대 3개월)
    • Day1: 1일(최대 1년)
metric String - Metric 이름
graphName String - 그래프 이름
productName String - 상품 이름

응답 상태 코드

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

응답 예시

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

{
    "code": 0,
    "message": "SUCCESS",
    "result": {
        "data": [
            {
                "dps": [
                    [
                        1742749200000,
                        0.0
                    ],
                    [
                        1742751000000,
                        0.0
                    ],
                    [
                        1742752800000,
                        0.0
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1037*****",
                    "Svc_group_instance_no": "1037*****"
                },
                "interval": "Min30",
                "metric": "Indexing Rate",
                "graphName": "Indexing Rate(/m)",
                "productName": "Search Engine Service(VPC)"
            },
            {
                "dps": [
                    [
                        1742749200000,
                        0.0
                    ],
                    [
                        1742751000000,
                        0.0
                    ],
                    [
                        1742752800000,
                        0.0
                    ],
                    ...
                ],
                "aggregation": "AVG",
                "dimensions": {
                    "instanceNo": "1037*****",
                    "Svc_group_instance_no": "1037*****"
                },
                "interval": "Min30",
                "metric": "Search Rate",
                "graphName": "Search Rate(/m)",
                "productName": "Search Engine Service(VPC)"
            },
            ...
        ]
    },
    "requestId": "1e588fe5-****-****-****-0aa1fb036293"
}