사용자 경보에 대한 세부사항 가져오기

다음 cURL 명령을 사용하여 경보에 대한 정보를 가져올 수 있습니다.

curl -X GET <REST_API_ENDPOINT>/api/alerts/<ALERT_ID> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "TeamID: $TEAM_ID" -H "content-type: application/json"

여기서,

• <REST_API_ENDPOINT> REST API 호출이 타겟팅하는 엔드포인트를 나타냅니다. 자세한 정보는 MonitoringREST API 엔드포인트를 참조하십시오. 예를 들어, 미국에서 사용 가능한 인스턴스에 대한 공용 엔드포인트는 다음과 같습니다. https://us-south.monitoring.cloud.ibm.com/api

• -H를 사용하여 여러 헤더를 전달할 수 있습니다.

  Authorization 및 IBMInstanceID는 인증에 필요한 헤더입니다.

  TeamID는 선택사항입니다. 이 헤더를 지정하면 지정된 팀에 사용 가능한 데이터 및 리소스로 요청이 제한됩니다.

  AUTH_TOKEN 및 GUID를 가져오려면 IAM 토큰에 대한 헤더를 참조하십시오.

• <ALERT_ID> '은 수정하려는 알림의 ID를 정의합니다.

예를 들어, 경보의 응답 본문은 다음과 같습니다.

{
  "alert": {
    "autoCreated": false,
    "condition": "min(min(dallas_prod)) = 0",
    "createdOn": 1551358413000,
    "enabled": false,
    "id": 23211,
    "modifiedOn": 1551634372000,
    "name": "Monitoring Uptime Alert",
    "filter": "env in (\"prod\")",
    "notificationChannelIds": [
      4
    ],
    "segmentBy": [
      "host.hostname"
    ],
    "segmentCondition": {
      "type": "ANY"
    },
    "notificationCount": 60,
    "rateOfChange": false,
    "reNotify": false,
    "severity": 0,
    "severityLabel": "HIGH",
    "teamId": 493,
    "timespan": 60000000,
    "type": "MANUAL",
    "version": 9
  }
}

경보 작성

다음 cURL 명령을 사용하여 경보를 작성할 수 있습니다.

curl -X POST <REST_API_ENDPOINT>/api/alerts -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "TeamID: $TEAM_ID" -H "content-type: application/json" -d @alert.json

여기서,

• <REST_API_ENDPOINT> REST API 호출이 타겟팅하는 엔드포인트를 나타냅니다. 자세한 정보는 MonitoringREST API 엔드포인트를 참조하십시오. 예를 들어, 미국에서 사용 가능한 인스턴스에 대한 공용 엔드포인트는 다음과 같습니다. https://us-south.monitoring.cloud.ibm.com/api

• -H를 사용하여 여러 헤더를 전달할 수 있습니다.

  Authorization 및 IBMInstanceID는 인증에 필요한 헤더입니다.

  TeamID는 선택사항입니다. 이 헤더를 지정하면 지정된 팀에 사용 가능한 데이터 및 리소스로 요청이 제한됩니다.

  AUTH_TOKEN 및 GUID를 가져오려면 IAM 토큰에 대한 헤더를 참조하십시오.

• alert.json를 사용하여 -d 파일에서 경보를 작성하는 데 필요한 데이터를 전달할 수 있습니다.

  경보를 작성할 때 다음 매개변수를 포함하십시오. type, name, severity, timespan, condition, segmentby, segmentConditionn, filter, notificationChannelIds, enabled

  자세한 정보는 경보 스키마를 참조하십시오.

다음 샘플은 경보를 작성하기 위해 설정할 수 있는 요청 본문 매개변수를 표시합니다.

{
  "alert": {
    "version": null,
    "name": "My Alert!",
    "description": null,
    "teamId": null,
    "enabled": false,
    "filter": null,
    "type": "MANUAL",
    "condition": "avg(timeAvg(uptime)) <= 0",
    "timespan": 600000000,
    "notificationChannelIds": [],
    "reNotify": false,
    "reNotifyMinutes": 30,
    "segmentBy": [
      "host.hostName"
    ],
    "segmentCondition": {
      "type": "ANY"
    },
    "severityLabel": "LOW"
  }
}

경보 업데이트

기존 경보를 업데이트하려면 이 경보의 ID가 필요합니다.

다음 cURL 명령을 사용하여 경보를 업데이트할 수 있습니다.

curl -X PUT <REST_API_ENDPOINT>/api/alerts/<ALERT_ID> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "TeamID: $TEAM_ID" -H "content-type: application/json" -d @alert.json

여기서,

• <REST_API_ENDPOINT> REST API 호출이 타겟팅하는 엔드포인트를 나타냅니다. 자세한 정보는 MonitoringREST API 엔드포인트를 참조하십시오. 예를 들어, 미국에서 사용 가능한 인스턴스에 대한 공용 엔드포인트는 다음과 같습니다. https://us-south.monitoring.cloud.ibm.com/api

• -H를 사용하여 여러 헤더를 전달할 수 있습니다.

  Authorization 및 IBMInstanceID는 인증에 필요한 헤더입니다.

  TeamID는 선택사항입니다. 이 헤더를 지정하면 지정된 팀에 사용 가능한 데이터 및 리소스로 요청이 제한됩니다.

  AUTH_TOKEN 및 GUID를 가져오려면 IAM 토큰에 대한 헤더를 참조하십시오.

• <ALERT_ID> '은 수정하려는 알림의 ID를 정의합니다.

• alert.json를 사용하여 -d 파일에서 경보를 작성하는 데 필요한 데이터를 전달할 수 있습니다.

  자세한 정보는 경보 스키마를 참조하십시오.

다음 샘플은 경보를 업데이트하기 위해 설정할 수 있는 요청 본문 매개변수를 표시합니다.

{
  "alert": {
      "type": "MANUAL",
      "id": 23212,
      "version": 10,
      "name": "CheckNginxConnections",
      "description": "Active connections of nginx server",
      "enabled": false,
      "severity": 2,
      "timespan": 1000000,
      "condition": "avg(avg(nginx.net.connections)) > 1000",
      "segmentBy": [
          "host.hostName"
      ],
      "segmentCondition": {
          "type": "ANY"
      },
      "notificationChannelIds": [
          2
      ]
    }
}

경보 삭제

기존 경보를 삭제하려면 이 경보의 ID가 필요합니다.

다음 cURL 명령을 사용하여 경보를 삭제할 수 있습니다.

curl -X DELETE <REST_API_ENDPOINT>/api/alerts/<ALERT_ID> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "TeamID: $TEAM_ID" -H "content-type: application/json"

여기서,

• <REST_API_ENDPOINT> REST API 호출이 타겟팅하는 엔드포인트를 나타냅니다. 자세한 정보는 MonitoringREST API 엔드포인트를 참조하십시오. 예를 들어, 미국에서 사용 가능한 인스턴스에 대한 공용 엔드포인트는 다음과 같습니다. https://us-south.monitoring.cloud.ibm.com/api

• -H를 사용하여 여러 헤더를 전달할 수 있습니다.

  Authorization 및 IBMInstanceID는 인증에 필요한 헤더입니다.

  TeamID는 선택사항입니다. 이 헤더를 지정하면 지정된 팀에 사용 가능한 데이터 및 리소스로 요청이 제한됩니다.

  AUTH_TOKEN 및 GUID를 가져오려면 IAM 토큰에 대한 헤더를 참조하십시오.

• <ALERT_ID> '은 삭제하려는 알림의 ID를 정의합니다.

모든 사용자 경보 받기

다음 cURL 명령을 사용하여 모든 경보에 대한 정보를 가져올 수 있습니다.

curl -X GET <REST_API_ENDPOINT>/api/alerts?from=<START_TIMESTAMP>&to=<END_TIMESTAMP> -H "Authorization: Bearer $AUTH_TOKEN" -H "IBMInstanceID: $GUID"

여기서,

• <REST_API_ENDPOINT> REST API 호출이 타겟팅하는 엔드포인트를 나타냅니다. 자세한 정보는 MonitoringREST API 엔드포인트를 참조하십시오. 예를 들어, 미국에서 사용 가능한 인스턴스에 대한 공용 엔드포인트는 다음과 같습니다. https://us-south.monitoring.cloud.ibm.com/api

• -H를 사용하여 여러 헤더를 전달할 수 있습니다.

  Authorization 및 IBMInstanceID는 인증에 필요한 헤더입니다. AUTH_TOKEN 및 GUID를 가져오려면 IAM 토큰에 대한 헤더를 참조하십시오.

• to 및 from은 경보에 대한 정보를 원하는 기간을 구성하기 위해 정의해야 하는 조회 매개변수입니다.

응답 형식에 대한 자세한 정보는 경보 스키마를 참조하십시오.

경보 스키마: 요청 본문

{
  "alerts": [
    {
      "alert": {
        "version": null,
        "name": "",
        "description": null,
        "teamId": null,
        "enabled": false,
        "filter": null,
        "type": "",
        "condition": "",
        "timespan": 600000000,
        "notificationChannelIds": [],
        "reNotify": false,
        "reNotifyMinutes": 30,
        "segmentBy": [],
        "segmentCondition": {
          "type": ""
        },
        "severityLabel": ""
      }
    }
  ]
}

경보 스키마: 응답 본문

{
  "alerts": [
    {
    "alert": {
      "autoCreated": false,
      "condition": "",
      "createdOn": 1551358413000,
      "enabled": false,
      "id": 23211,
      "modifiedOn": 1551634372000,
      "name": "",
      "filter": "",
      "notificationChannelIds": [],
      "segmentBy": [],
      "segmentCondition": {
        "type": "ANY"
      },
      "notificationCount": 60,
      "rateOfChange": false,
      "reNotify": false,
      "severity": 0,
      "severityLabel": "",
      "teamId": 493,
      "timespan": 60000000,
      "type": "",
      "version": 9
      }
    }
  ]
}

오류 응답 코드

다음 표에는 공통 오류 응답 코드가 표시됩니다.

본문 매개변수

kubernetes.namespace.name='production'

container.image='nginx'*.

kubernetes.namespace.name='production' and container.image='nginx'*.

"notificationChannelIds": [
      "EMAIL",
      "WEBHOOK"
    ]

조회 매개변수