IBM Cloud Docs
cURL の使用

cURL の使用

端末のコマンド・ライン・ツール cURL で、URL 構文を使用して IBM Cloud Monitoring サービスを管理することができます。

cURL 構文

cURL コマンドを実行するには、端末から以下の構文を使用します。

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

説明

  • <METHOD> は、実行したいREST API呼び出しのタイプを示す。
  • <MONITORING-ENDPOINT> は、モニタリング・インスタンスが利用可能なエンドポイントを示します。 詳しくは、Monitoring エンドポイントを参照してください。 例えば、us-south で使用可能なインスタンスのエンドポイントは https://us-south.monitoring.cloud.ibm.com です。
  • <API_URL> API URLの詳細については、 REST APIエンドポイントを 参照してください。
  • HEADERS は、追加情報 (IBM Cloud Monitoring サービスを認証するための情報など) を追加します。
  • DATA では、必要になる可能性のある追加情報を渡すことができます。

IAM トークンのヘッダー

IBM Cloud Monitoring REST API を使用してルーチン・タスクを自動化し、通知をモニターする場合に、IAM トークンを使用して Monitoring サービスを認証します。

cURL コマンドに以下のオプションを追加し、IAM トークンを使用して IBM Cloud Monitoring サービスを認証します。

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

説明

  • IBMInstanceID は、cURL コマンドでターゲットにする IBM Cloud Monitoring インスタンスの GUID を示します。

    モニタリング・インスタンスのGUIDを取得するには、以下のコマンドを実行する： ibmcloud resource service-instance <NAME> --output json | jq -r '.[].guid'

  • Authorization は、IBM Cloud Monitoring サービス・インスタンスの認証に使用される IAM トークンを示します。

    IAM AUTH_TOKEN トークンを取得するには、コマンド ibmcloud iam oauth-tokens | awk '{print $4}' を実行します。

    詳しくは、IAM API トークンの取得を参照してください。

  • SysdigTeamID は、チームの GUID を示します。

    GUID を取得するには、Monitoring チームの ID の取得を参照してください。

Monitoring トークンのヘッダー

Monitoring REST API を使用してルーチン・タスクを自動化し、通知をモニターする場合は、IBM Cloud Monitoring API トークンを使用して Monitoring サービスを認証することもできます。

cURL コマンドに以下のコマンド・オプションを追加し、IBM Cloud Monitoring トークンを使用して Monitoring サービスを認証します。

-H "Authorization: Bearer $SYSDIG_TOKEN"

Monitoring トークンを取得するには、Monitoring API トークンの取得を参照してください。

cURL API 照会の実行

IAM トークンを使用して cURL API 照会を実行して認証を行うには、以下のステップを実行します。

  1. IAM トークンを設定します。

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

  2. IBM Cloud Monitoring インスタンス GUID を設定します。

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

  3. cURL API 照会を実行します。

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

例えば、JSON ファイルを使用してアラート定義と通知チャネルが定義されるアラートを作成するには、以下のコマンドを実行します。

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