Ottieni dettagli su un avviso utente

Per ottenere informazioni su un avviso, puoi utilizzare il seguente comando 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"

Dove

• <REST_API_ENDPOINT> indica l'endpoint di destinazione della chiamata API REST. Per ulteriori informazioni, vedi Monitoring endpoint API REST. Ad esempio, l'endpoint pubblico per un'istanza disponibile in us - south è il seguente: https://us-south.monitoring.cloud.ibm.com/api

• Puoi passare più intestazioni utilizzando -H.

  Authorization e IBMInstanceID sono intestazioni richieste per l'autenticazione.

  TeamID è facoltativo. Quando si specifica questa intestazione, si limita la richiesta ai dati e alle risorse disponibili per il team specificato.

  Per ottenere un AUTH_TOKEN e la GUID consultare, Intestazioni per i token IAM.

• <ALERT_ID> definisce l'ID dell'avviso che si desidera modificare.

Ad esempio, il corpo della risposta per un avviso è simile al seguente:

{
  "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
  }
}

Crea un avviso

Puoi utilizzare il seguente comando cURL per creare un avviso:

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

Dove

• <REST_API_ENDPOINT> indica l'endpoint di destinazione della chiamata API REST. Per ulteriori informazioni, vedi Monitoring endpoint API REST. Ad esempio, l'endpoint pubblico per un'istanza disponibile in us - south è il seguente: https://us-south.monitoring.cloud.ibm.com/api

• Puoi passare più intestazioni utilizzando -H.

  Authorization e IBMInstanceID sono intestazioni richieste per l'autenticazione.

  TeamID è facoltativo. Quando si specifica questa intestazione, si limita la richiesta ai dati e alle risorse disponibili per il team specificato.

  Per ottenere un AUTH_TOKEN e la GUID consultare, Intestazioni per i token IAM.

• È possibile passare i dati per creare l'avviso nel file alert.json utilizzando -d.

  Quando si crea un avviso, includere i seguenti parametri: tipo, nome, gravità, durata, condizione, segmentby, segmentConditionn, filtro, notificationChannelIds, abilitato

  Per ulteriori informazioni, consultare Schema di avviso.

Il seguente esempio mostra i parametri del corpo della richiesta che è possibile impostare per creare un avviso:

{
  "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"
  }
}

Aggiorna un avviso

Per aggiornare un avviso esistente, è necessario l'ID di tale avviso.

Puoi utilizzare il seguente comando cURL per aggiornare un avviso:

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

Dove

• <REST_API_ENDPOINT> indica l'endpoint di destinazione della chiamata API REST. Per ulteriori informazioni, vedi Monitoring endpoint API REST. Ad esempio, l'endpoint pubblico per un'istanza disponibile in us - south è il seguente: https://us-south.monitoring.cloud.ibm.com/api

• Puoi passare più intestazioni utilizzando -H.

  Authorization e IBMInstanceID sono intestazioni richieste per l'autenticazione.

  TeamID è facoltativo. Quando si specifica questa intestazione, si limita la richiesta ai dati e alle risorse disponibili per il team specificato.

  Per ottenere un AUTH_TOKEN e la GUID consultare, Intestazioni per i token IAM.

• <ALERT_ID> definisce l'ID dell'avviso che si desidera modificare.

• È possibile passare i dati per creare l'avviso nel file alert.json utilizzando -d.

  Per ulteriori informazioni, consultare Schema di avviso.

Il seguente esempio mostra i parametri del corpo della richiesta che è possibile impostare per aggiornare un avviso:

{
  "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
      ]
    }
}

Elimina un avviso

Per eliminare un avviso esistente, è necessario l'ID di tale avviso.

È possibile utilizzare il comando cURL per eliminare un messaggio di alert:

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"

Dove

• <REST_API_ENDPOINT> indica l'endpoint di destinazione della chiamata API REST. Per ulteriori informazioni, vedi Monitoring endpoint API REST. Ad esempio, l'endpoint pubblico per un'istanza disponibile in us - south è il seguente: https://us-south.monitoring.cloud.ibm.com/api

• Puoi passare più intestazioni utilizzando -H.

  Authorization e IBMInstanceID sono intestazioni richieste per l'autenticazione.

  TeamID è facoltativo. Quando si specifica questa intestazione, si limita la richiesta ai dati e alle risorse disponibili per il team specificato.

  Per ottenere un AUTH_TOKEN e la GUID consultare, Intestazioni per i token IAM.

• <ALERT_ID> definisce l'ID dell'avviso che si vuole eliminare.

Ottieni tutti gli avvisi utente

È possibile utilizzare il seguente comando cURL per ottenere informazioni su tutti gli avvisi:

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

Dove

• <REST_API_ENDPOINT> indica l'endpoint di destinazione della chiamata API REST. Per ulteriori informazioni, vedi Monitoring endpoint API REST. Ad esempio, l'endpoint pubblico per un'istanza disponibile in us - south è il seguente: https://us-south.monitoring.cloud.ibm.com/api

• Puoi passare più intestazioni utilizzando -H.

  Authorization e IBMInstanceID sono intestazioni richieste per l'autenticazione. Per ottenere un AUTH_TOKEN e la GUID consultare, Intestazioni per i token IAM.

• to e from sono parametri di query che è necessario definire per configurare il periodo di tempo per cui si desiderano informazioni sugli avvisi.

Per ulteriori informazioni sul formato della risposta, vedi Schema di avviso.

Schema degli avvisi: corpo della richiesta

{
  "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": ""
      }
    }
  ]
}

Schema degli avvisi: corpo della risposta

{
  "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
      }
    }
  ]
}

Codici di risposta di errore

La tabella riportata di seguito mostra i codici di risposta di errore comuni:

Parametri del corpo

kubernetes.namespace.name='production'

container.image='nginx'*.

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

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

Parametri di query