GetRuleGroupList
    • PDF

    GetRuleGroupList

    • PDF

    Article Summary

    개요

    Event Rule을 조회합니다.

    요청

    API URL

    URL: https://cw.apigw.ntruss.com/cw_fea/real/cw/api/rule/group/ruleGrp/query
    Method: POST
    

    요청 헤더

    공통설정에 명시된 요청헤더가 필요합니다.

    x-ncp-apigw-signature-v2: {generated signature}
    x-ncp-apigw-timestamp: {current timestamp}
    x-ncp-iam-access-key: {your iam access key}
    

    요청 바디

    항목필수 여부타입제약 사항설명
    pageNumYintpage number
    pageSizeYintpage size
    prodKeyYString상품의 cw_key
    searchNStringkeyword

    예시

    요청 예시

    아래는 모든 상품에 대한 Event Rule를 조회하는 예시입니다. 이때 pageSize를 3으로 하고 pageNum을 1로 하여 조회결과 총 3개의 Event Rule이 리턴됩니다.

    POST /cw_fea/real/cw/api/rule/group/ruleGrp/query
    Host: cw.apigw.ntruss.com
    x-ncp-apigw-signature-v2: {generated signature}
    x-ncp-apigw-timestamp: {current timestamp}
    x-ncp-iam-access-key: {your iam access key}
    
    Payload:
    {
        "prodKey": "*",
        "pageSize": 3,
        "pageNum": 1,
        "search": ""
    }
    
    
    

    응답 예시

    {
      "pageNum": 0,
      "pageSize": 0,
      "ruleGroups": [
        {
          "cfTriggers": [],
          "createTime": 1589775745332,
          "domainCode": "PUB",
          "groupName": "eventRule001",
          "id": "eventRuleId001",
          "metricsGroups": [
            {
              "createTime": 1589769312574,
              "domainCode": "PUB",
              "groupDesc": "서버 사용량에 대한 Metric Group(template) 입니다.",
              "groupName": "서버 사용량",
              "id": "metricGroupId001",
              "metrics": [
                {
                  "calculation": "AVG",
                  "condition": "GT",
                  "dimensions": [
                    {
                      "dim": "type",
                      "val": "svr"
                    }
                  ],
                  "duration": 1,
                  "eventLevel": "INFO",
                  "metric": "avg_write_cnt",
                  "metricGroupItemId": "metricGroupItemId001",
                  "threshold": 0.7
                },
                {
                  "calculation": "AVG",
                  "condition": "GT",
                  "dimensions": [
                    {
                      "dim": "type",
                      "val": "svr"
                    }
                  ],
                  "duration": 1,
                  "eventLevel": "INFO",
                  "metric": "avg_cpu_used_rto",
                  "metricGroupItemId": "metricGroupItemId002",
                  "threshold": 2
                }
              ],
              "prodKey": "xxxxxxxxxxxxxxxxxx",
              "regionCode": "KR",
              "temporaryGroup": false,
              "updateTime": 1589770306595
            }
          ],
          "monitorGroups": [
            {
              "groupDesc": "모니터 그룹을 생성합니다.",
              "groupName": "monitorGroup001",
              "id": "monitorGroupId001",
              "monitorGroupItemList": [
                {
                  "nrn": "targetNRN001",
                  "resourceId": "targetId001"
                }
              ],
              "prodKey": "xxxxxxxxxxxxxxxxxx",
              "temporaryGroup": false
            }
          ],
          "prodKey": "xxxxxxxxxxxxxxxxxx",
          "productName": "System/Server",
          "recipientNotifications": [
            {
              "groupName": "통보대상자그룹",
              "groupNum": xx,
              "notifyTypes": [
                "SMS",
                "EMAIL"
              ]
            }
          ],
          "regionCode": "KR",
          "ruleVersion": "V2",
          "updateTime": 1589775745332
        }
      ]
      "totalPages": 2,
      "totalRecords": 2
    }
    
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.