CLI 必要條件

在使用 CLI 來管理 Activity Tracker Event Routing 帳戶設定之前，請 安裝 IBM Cloud Activity Tracker Event Routing CLI。

確認您具有 IAM 許可權來讀取或更新 Activity Tracker Event Routing 帳戶設定。

使用 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 更新設定

使用這個指令來修改現行帳戶設定，例如預設目標、允許的目標區域及主要 meta 資料區域。

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

是可用來定義目標的區域清單。 最多容許兩個允許的目標區域。

metadata_region_primary

是儲存與路徑及目標定義相關聯之 meta 資料的區域。

metadata_region_backup

是與路徑及目標定義相關聯的 meta 資料儲存為備份位置的區域。

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

是可用來定義目標的區域清單。 最多可以指定兩個允許的目標區域。

metadata_region_primary

是儲存與路徑及目標定義相關聯之 meta 資料的區域。

metadata_region_backup

是與路徑及目標定義相關聯的 meta 資料儲存為備份位置的區域。

private_api_endpoint_only

指定是否也無法使用專用端點。 如果 true，則只能使用專用端點。

HTTP 回應碼

當您使用IBM Cloud Activity Tracker Event Routing REST API 時，您可以獲得標準HTTP回應碼來指示方法是否成功完成。

• 200 回應一律表示成功。
• 4xx 回應指出失敗。
• 5xx 回應通常指出內部系統錯誤。

請參閱下表以了解一些HTTP回應碼：

使用使用者介面取得帳號設定

1. 登入 IBM Cloud 帳戶。
2. 點擊「選單」圖示 > 可觀察性。
3. 選取 Activity Tracker。
4. 選取 遞送。
5. 選擇「設定」。

在此頁面上，您可以檢視下列設定:

• meta 資料位置: 顯示主要 meta 資料區域及備份 meta 資料區域。
• 允許的目標區域。 顯示可以傳送事件的目標區域。
• 預設目標: 顯示已配置的預設目標。
• 公用端點: 顯示是否已啟用公用端點。 停用時，無法存取 Activity Tracker Event Routing 使用者介面。
• 報告: 以 JSON 格式顯示配置。

使用使用者介面更新設定

1. 登入 IBM Cloud 帳戶。
2. 點擊「選單」圖示 > 可觀察性。
3. 選取 Activity Tracker。
4. 選取 遞送。
5. 選擇「設定」。

按一下要變更之設定旁的 編輯。 您可以修改以下設定：

• meta 資料位置: 選取您想要的主要 meta 資料區域及備份 meta 資料區域。
• 允許的目標區域: 選取可在其中建立目標的區域。 如果未選取任何地區，則所有地區都可以接收事件。
• 預設目標: 選取遞送規則不存在或不符合時依預設將使用的目標。