IBM Cloud Docs
Usando cURL

Usando cURL

É possível usar cURL, uma ferramenta de linha de comandos, por meio de um terminal para gerenciar o serviço IBM Cloud Monitoring usando a sintaxe URL.

Sintaxe cURL

Use a sintaxe a seguir por meio de um terminal para executar um comando cURL:

curl -X <METHOD> <MONITORING_ENDPOINT>/<API_URL> <-H HEADERS,> [-d DATA]

em que

  • <METHOD> indica o tipo de chamada à API REST que você deseja fazer.
  • <MONITORING-ENDPOINT> indica o ponto de extremidade em que a instância de monitoramento está disponível. Para obter mais informações, consulte Terminais do Monitoring. Por exemplo, o terminal para uma instância que está disponível em us-south é o seguinte: https://us-south.monitoring.cloud.ibm.com
  • <API_URL> Para obter mais informações sobre URLs de API, consulte Endpoints de API REST.
  • HEADERS incluem informações adicionais, como informações para autenticar com o serviço do IBM Cloud Monitoring.
  • DATA permite que você transmita informações adicionais que possam ser necessárias.

Cabeçalhos para tokens do IAM

Use tokens do IAM para autenticar-se com o serviço IBM Cloud Monitoring quando usar a API de REST do Monitoring para automatizar tarefas de rotina e monitorar notificações.

Em um comando cURL, inclua as opções a seguir para autenticar com o serviço do IBM Cloud Monitoring usando um token do IAM:

-H "Authorization: $AUTH_TOKEN"
-H "IBMInstanceID: $GUID"
-H "SysdigTeamID: $TEAM_ID"

em que

  • IBMInstanceID indica o GUID da instância IBM Cloud Monitoring que você deseja destinar com o comando cURL.

    Para obter o GUID da instância de monitoramento, execute o seguinte comando: ibmcloud resource service-instance <NAME> --output json | jq -r '.[].guid'

  • Authorization indica o token do IAM que é usado para autenticar com a instância de serviço do IBM Cloud Monitoring.

    Para obter o token do IAM AUTH_TOKEN, execute o comando a seguir: ibmcloud iam oauth-tokens | awk '{print $4}'

    Para obter mais informações, consulte Obtendo o token da API do IAM.

  • SysdigTeamID indica o GUID de uma equipe.

    Para obter o GUID, consulte Obtendo o ID de uma equipe do Monitoring.

Cabeçalhos para o token do Monitoring

Também é possível usar tokens da API do Monitoring para autenticar-se com o serviço IBM Cloud Monitoring quando usar a API de REST do Monitoring para automatizar tarefas de rotina e monitorar notificações.

Em um comando cURL, inclua a seguinte opção de comando para autenticar-se com o serviço IBM Cloud Monitoring usando um token do Monitoring:

-H "Authorization: Bearer $SYSDIG_TOKEN"

Para obter o token do Monitoring, consulte Obtendo o token da API do Monitoring.

Executando uma consulta de API cURL

Para executar uma consulta de API cURL e autenticar usando o token do IAM, conclua as etapas a seguir:

  1. Configure o token do IAM.

    AUTH_TOKEN=$(ibmcloud iam oauth-tokens | awk '{print $4}')

  2. Configure o GUID da instância do IBM Cloud Monitoring.

    GUID=$(ibmcloud resource service-instance <NAME> --output json | jq -r '.[].guid')

  3. Execute a consulta de API cURL.

    curl -X <METHOD> <MONITORING_ENDPOINT>/<API_URL> -H "Authorization: $AUTH_TOKEN" -H "IBMInstanceID: $GUID" -H "content-type: application/json"

Por exemplo, para criar um alerta no qual o canal de definição de alerta e de notificação é definido por meio de um arquivo JSON, é possível executar o comando a seguir:

curl -X POST \
  https://us-south.monitoring.cloud.ibm.com/api/alerts \
  -H 'Authorization: Bearer eyJraW...' \
  -H 'IBMInstanceID: fc8ceb8a-...' \
  -H 'Content-Type: application/json' \
  -d @alert.json