CLI の前提条件

CLI を使用して Activity Tracker Event Routing アカウント設定値を管理する前に、 IBM Cloud Activity Tracker Event Routing CLI をインストールします。

Activity Tracker Event Routing アカウントの設定を読み取ったり更新したりするためのIAM権限が割り当てられていることを確認してください。

CLI を使用したアカウント設定の取得

このコマンドを使用して、 IBM Cloud Activity Tracker Event Routing アカウントの設定情報を取得します。

ibmcloud atracker setting get [--output FORMAT]

Atracker settings
Metadata region primary:     us-south
Metadata region backup:      us-east
Default targets:             []
Permitted target regions:    []
Private api endpoint only:   false
API version:                 2

CLI を使用した設定の更新

このコマンドを使用して、デフォルト・ターゲット、許可されたターゲット領域、および 1 次メタデータ領域などの現行アカウント設定を変更します。

ibmcloud atracker setting update [--metadata-region-primary REGION] [--metadata-region-backup REGION] [--default-targets TARGET] [--permitted-target-regions REGIONS] [--private-api-endpoint-only ( TRUE | FALSE )] [--output FORMAT] [--force]

API の設定とアクション

以下の表に、設定を管理するために実行できるアクションをリストします。

プライベート・エンドポイントとパブリック・エンドポイントを使用して、設定を管理できます。 使用可能な ENDPOINTS のリストについて詳しくは、エンドポイントを参照してください。

• デフォルトでは、プライベート・ネットワークから設定を管理できます。 次の形式の API エンドポイントを使用する必要があります。https://private.<region>.atracker.cloud.ibm.com

• また、地域内のパブリック・エンドポイントを有効にして、設定を管理することもできます。 詳しくは、エンドポイントの管理を参照してください。

REST API の詳細については、 設定 API を参照してください。

API 前提条件

設定を管理するために API 呼び出しを行うには、以下のステップを実行します。

1. IAM アクセス・トークンを取得します。 詳しくは、IAM アクセス・トークンの取得を参照してください。
2. 設定を構成または管理する予定の地域の API エンドポイントを識別します。 詳しくは、エンドポイントを参照してください。

API を使用した設定の取得

以下の cURL コマンドを使用して、既存の設定情報を取得できます。

curl -X GET  ENDPOINT/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

ここで、

ENDPOINT

ターゲットを構成または管理する予定のリージョン内の API エンドポイントです。 詳しくは、エンドポイントを参照してください。

例えば、以下の cURL 要求設定情報を米国南部地域で使用できます。

curl -X GET   https://private.us-south.atracker.cloud.ibm.com/api/v2/settings   -H "Authorization:  $ACCESS_TOKEN"

以下のような応答が返されます。

{
 "default_targets": ["50375218-0000-4234-bbb4-171bebab8408", "c7519d8a-5f97-498b-0000-8542f60955cd"],
 "permitted_target_regions": ["us-south", "us-east"],
 "metadata_region_primary": "us-south",
 "metadata_region_backup": "eu-de",
 "private_api_endpoint_only": false
}

ここで、

default_targets

ターゲット ID のリストです。 ルーティング・ルールによってイベントが他のターゲットに送信されない場合、これらのターゲットはイベントを受信します。

permitted_target_regions

ターゲットを定義するために使用できる領域のリストです。 許可されるターゲット領域は最大 2 つまでです。

metadata_region_primary

経路定義およびターゲット定義に関連付けられたメタデータが保管される領域です。

metadata_region_backup

ルートおよびターゲットの定義に関連するメタデータがバックアップ先として保存される領域です。

private_api_endpoint_only

プライベート・エンドポイントを使用できるかどうかを指定します。 trueの場合は、プライベート・エンドポイントのみを使用できます。

API を使用した設定の更新

設定を更新する場合は、要求のデータ・セクションに設定情報を含める必要があります。

• すべてのフィールドを渡す必要があります。
• 変更が必要なフィールドを更新します。

以下の cURL コマンドを使用して、設定を更新できます。

curl -X PUT  <ENDPOINT>/api/v2/settings
-H "Authorization:  $ACCESS_TOKEN"
-H "content-type: application/json"
-d '{
   "default_targets": ["IDs"],
   "permitted_target_regions": ["REGIONS"],
   "metadata_region_primary": "REGION",
   "metadata_region_backup": "REGION",
   "private_api_endpoint_only": false
}'

ここで、

ENDPOINT

ターゲットを構成または管理する予定のリージョン内の API エンドポイントです。 詳しくは、エンドポイントを参照してください。

default_targets

ターゲット ID のリストです。 ルーティング・ルールによってイベントが他のターゲットに送信されない場合、これらのターゲットはイベントを受信します。

permitted_target_regions

ターゲットを定義するために使用できる領域のリストです。 最大 2 つの許可されたターゲット領域を指定できます。

metadata_region_primary

経路定義およびターゲット定義に関連付けられたメタデータが保管される領域です。

metadata_region_backup

ルートおよびターゲットの定義に関連するメタデータがバックアップ先として保存される領域です。

private_api_endpoint_only

プライベート・エンドポイントを使用できるかどうかを指定します。 trueの場合は、プライベート・エンドポイントのみを使用できます。

HTTP 応答コード

IBM Cloud Activity Tracker Event Routing REST API を使用すると、メソッドが正常に完了したかどうかを示す標準 HTTP 応答コードを取得できます。

• 200 応答は、どのような場合でも成功を示しています。
• 4xx 応答は、失敗を示しています。
• 5xx 応答は通常、内部システム・エラーを示しています。

いくつかの HTTP 応答コードについては、以下の表を参照してください。

UI を使用してアカウントを取得する

1. IBM Cloud アカウントにログインします。
2. メニュー アイコンをクリックしてください > オブザーバビリティ。
3. **「Activity Tracker」**を選択します。
4. 「ルーティング」 を選択します。
5. 「 設定 」を選択します。

このページでは、以下の設定を表示できます。

• メタデータ・ロケーション: 1 次メタデータ・リージョンとバックアップ・メタデータ・リージョンを表示します。
• 許可されている対象地域。 イベントを送信できるターゲット領域を表示します。
• デフォルト・ターゲット: 構成済みのデフォルト・ターゲットを表示します。
• パブリック・エンドポイント: パブリック・エンドポイントが有効かどうかを表示します。 無効にすると、 Activity Tracker Event Routing UI にアクセスできません。
• レポート: 構成を JSON 形式で表示します。

UI を使用した設定の更新

1. IBM Cloud アカウントにログインします。
2. メニュー アイコンをクリックしてください > オブザーバビリティ。
3. **「Activity Tracker」**を選択します。
4. 「ルーティング」 を選択します。
5. 「 設定 」を選択します。

変更する設定の横にある 「編集」 をクリックします。 以下の設定を変更できます：

• メタデータ・ロケーション: 目的の 1 次メタデータ・リージョンとバックアップ・メタデータ・リージョンを選択します。
• 許可されたターゲット領域: ターゲットを作成できる領域を選択します。 地域が選択されていない場合、すべての地域がイベントを受信できます。
• デフォルト・ターゲット: ルーティング・ルールが存在しないか一致しない場合にデフォルトで使用されるターゲットを選択します。