ユーザー・アラートについての詳細の取得

以下の 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 エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは 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 エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは 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 エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは 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 エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは 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 エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのパブリック・エンドポイントは 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"
    ]

照会パラメーター