獲取有關用戶警報的詳細信息

您可以使用以下內容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 呼叫的目標端點。 有關更多信息，請參閱 Monitoring REST 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 呼叫的目標端點。 有關更多信息，請參閱 Monitoring REST API 端點。 例如，us-south 中可用的實例的公共端點如下：https://us-south.monitoring.cloud.ibm.com/api

• 您可以使用以下方法傳遞多個標頭 -H。

  Authorization 和 IBMInstanceID 是身份驗證所需的標頭。

  TeamID 是可選的。 當您指定此標頭時，您將請求限制為指定團隊可用的資料和資源。

  為了得到一個 AUTH_TOKEN 和 GUID 看，IAM 令牌的標頭。

• 您可以傳遞資料來建立警報 alert.json 文件透過使用 -d。

  建立警報時，請包含以下參數：type、name、嚴重性、timespan、condition、slotby、slotConditionn、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 呼叫的目標端點。 有關更多信息，請參閱 Monitoring REST 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 呼叫的目標端點。 有關更多信息，請參閱 Monitoring REST 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 呼叫的目標端點。 有關更多信息，請參閱 Monitoring REST 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"
    ]

查詢參數