QueryWidgetDataPreview

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

Metric 데이터와 함께 미리 보기 차트를 조회합니다.

요청

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

메서드	URI
POST	/cw_fea/real/cw/api/data/chart/preview

요청 헤더

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

요청 바디

Metric 정보를 통한 미리 보기 차트 조회 관련 필드에 대한 설명은 ChartDataWidgetDto를 참조해 주십시오.

요청 예시

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

curl --location -request POST 'https://cw.apigw.gov-ntruss.com/cw_fea/real/cw/api/data/chart/preview' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "metricsInfo": [
        {
            "resourceId": "**********",
            "resourceName": "**********",
            "color": "#1f77b4",
            "displayName": "avg_write_cnt",
            "metric": "avg_write_cnt",
            "period": "Min30",
            "statistic": "COUNT",
            "prodKey": "**********",
            "productName": "System/Server(VPC)",
            "dimensions": {
                "type": "svr",
                "instanceNo": "**********"
            }
        }
    ],
    "periodStart": **********,
    "periodEnd": **********
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`color`	String	-	차트 색
`data`	Array	-	조회 결과 데이터 포인트(Unix Timestamp 형식), 데이터 값 형태로 표시
`dimensions`	Object	-	Dimension 정보
`dimensions.instanceNo`	String	-	인스턴스 번호
`dimensions.name`	String	-	Dimension 이름
`dimensions.type`	String	-	Dimension 유형
`displayName`	String	-	위젯에 노출되는 Metric 이름
`idDimension`	String	-	Dimension 이름
`metric`	String	-	Metric 이름
`period`	String	-	집계 주기 `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1`
`prodKey`	String	-	상품 키(cw_key) Cloud Insight 지표 참조
`prodName`	String	-	상품 이름 Cloud Insight 지표 참조
`resourceName`	String	-	리소스 이름
`statistic`	String	-	집계 함수 `COUNT` \| `SUM` \| `MAX` \| `MIN` \| `AVG`

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Insight API 응답 상태 코드를 참조해 주십시오.

응답 예시

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

[
    {
        "color": "#1f77b4",
        "data": [
            [
                1733184000000,
                22
            ],
            [
                1733185800000,
                30
            ],
            [
                1733187600000,
                30
            ],
            [
                1733189400000,
                30
            ],
            [
                1733191200000,
                30
            ],
            [
                1733193000000,
                30
            ],
            [
                1733194800000,
                30
            ],
            [
                1733196600000,
                30
            ],
            [
                1733198400000,
                30
            ],
            [
                1733200200000,
                30
            ],
            [
                1733202000000,
                30
            ],
            [
                1733203800000,
                30
            ]
        ],
        "dimensions": {
            "instanceNo": "**********",
            "name": "**********",
            "type": "svr"
        },
        "displayName": "avg_write_cnt",
        "idDimension": "instanceNo",
        "metric": "avg_write_cnt",
        "period": "Min30",
        "prodKey": "**********",
        "prodName": "Server(VPC)",
        "resourceName": "**********",
        "statistic": "COUNT"
    }
]