GetMetricsGroupList

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

서비스(상품)에 대한 전체 Rule Template(감시 항목 그룹) 정보를 조회합니다.

요청

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

메서드	URI
GET	/cw_fea/real/cw/api/rule/group/metrics/query/{prodKey}

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`prodKey`	String	Required	상품 키(cw_key) Cloud Insight 지표 참조

요청 예시

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

curl --location --request GET 'https://cw.apigw.gov-ntruss.com/cw_fea/real/cw/api/rule/group/metrics/query/*************' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`metricsGroups`	Array	-	Rule Template 목록

`metricsGroups`

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

필드	타입	필수 여부	설명
`createTime`	Integer	-	Rule Template 생성 일시(밀리초) Unix Timestamp 형식
`domainCode`	String	-	네이버 클라우드 플랫폼 도메인 코드
`groupDesc`	String	-	Rule Template 설명
`groupName`	String	-	Rule Template 이름
`id`	String	-	Rule Template 아이디
`idDimension`	String	-	Dimension 이름
`metrics`	Array	-	Metric 목록
`prodKey`	String	Required	상품 키(cw_key) Cloud Insight 지표 참조
`prodType`	String	-	상품 유형
`regionCode`	String	-	리전 코드
`temporaryGroup`	Boolean	-	Rule Template 생성 여부 `true` \| `false` `true`: Rule Template 생성 없이 Event Rule 생성 `false`: Rule Template 생성
`updateTime`	Integer	-	Rule Template 수정 일시(밀리초) Unix Timestamp 형식

`metrics`

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

필드	타입	필수 여부	설명
`options`	Object	-	집계 방법 `"집계 주기": [집계 함수]` 형태로 표시 집계 주기: `Min1` \| `Min5` \| `Min30` \| `Hour2` \| `Day1` 집계 함수: `COUNT` \| `SUM` \| `MAX` \| `MIN` \| `AVG`

참고

Metric Group 정보 관련 필드에 대한 설명은 MetricsGroupItem을 참조해 주십시오.

응답 상태 코드

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

응답 예시

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

{
    "metricsGroups": [
        {
            "createTime": 1589769312574,
            "domainCode": "PUB",
            "groupDesc": "test-server에 대한 메트릭 그룹입니다.",
            "groupName": "test-server",
            "id": "***********",
            "idDimension": "instanceNo",
            "metrics": [
                {
                    "calculation": "AVG",
                    "condition": "EQ",
                    "desc": "network send fail packets average",
                    "dimensions": [
                        {
                            "dim": "type",
                            "val": "svr"
                        }
                    ],
                    "duration": 1,
                    "eventLevel": "INFO",
                    "metric": "avg_snd_fail_packt_cnt",
                    "metricGroupItemId": "metricGroupItemId001",
                    "options": {
                        "Min1": [
                            "COUNT",
                            "SUM",
                            "MAX",
                            "MIN",
                            "AVG"
                        ],
                        "Min5": [
                            "COUNT",
                            "SUM",
                            "MAX",
                            "MIN",
                            "AVG"
                        ],
                        "Min30": [
                            "COUNT",
                            "SUM",
                            "MAX",
                            "MIN",
                            "AVG"
                        ],
                        "Hour2": [
                            "COUNT",
                            "SUM",
                            "MAX",
                            "MIN",
                            "AVG"
                        ],
                        "Day1": [
                            "COUNT",
                            "SUM",
                            "MAX",
                            "MIN",
                            "AVG"
                        ]
                    },
                    "threshold": "0"
                }
            ],
            "prodKey": "**********",
            "prodType": "system",
            "regionCode": "KR",
            "temporaryGroup": false,
            "updateTime": 1589770306595
        },
        {
            "createTime": 1589774843799,
            "domainCode": "PUB",
            "groupDesc": "서버 사용량에 대한 Metric Group(template)입니다.",
            "groupName": "서버 사용량",
            "id": "***********",
            "idDimension": "instanceNo",
            "metrics": [
                {
                    "calculation": "AVG",
                    "condition": "GT",
                    "dimensions": [
                        {
                            "dim": "type",
                            "val": "svr"
                        }
                    ],
                    "duration": 1,
                    "eventLevel": "INFO",
                    "metric": "avg_write_cnt",
                    "metricGroupItemId": "metricGroupItemId002",
                    "threshold": 0.7
                },
                {
                    "calculation": "AVG",
                    "condition": "GT",
                    "dimensions": [
                        {
                            "dim": "type",
                            "val": "svr"
                        }
                    ],
                    "duration": 1,
                    "eventLevel": "INFO",
                    "metric": "avg_cpu_used_rto",
                    "metricGroupItemId": "metricGroupItemId003",
                    "threshold": 1
                }
            ],
            "prodKey": "**********",
            "prodType": "system",
            "regionCode": "KR",
            "temporaryGroup": false,
            "updateTime": 1589774843799
        }
    ]
}