Activity Tracker 事件路由 CLI

IBM Cloud® 指令行介面 (CLI) 為服務產品提供額外的功能。 本資訊說明如何使用 CLI 來定義和管理 IBM Cloud® Activity Tracker Event Routing 範例的設定。

必要條件

  • 安裝 IBM Cloud CLI

  • 請執行以下指令來安裝 CLI:

    ibmcloud plugin install atracker
    

當 IBM Cloud CLI 和外掛程式的更新可用時,您會收到命令列通知。 請務必更新您的 CLI,以便使用最新的指令。 您可以執行 ibmcloud plugin list 查看所有已安裝外掛程式的目前版本。

ibmcloud atracker route create

使用此指令可為 Activity Tracker Event Routing 目標建立新路由。

ibmcloud atracker route create --name ROUTE_NAME  ( --target-ids TARGETS  [--locations REGIONS] | --rules RULES | --file RULES_DEFINITION_JSON_FILE ) [--output FORMAT]

指令選項

--name ROUTE_NAME

要賦予航線的名稱。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--file RULES_DEFINITION_JSON_FILE

包含路由規則定義的 JSON 檔案。 檔案格式需如下所示:

[
  {
    "locations": ["LOCATION1","LOCATION2"],
    "target_ids": ["TARGET_ID1","TARGET_ID2"]
  }
]
--rules RULES

以單引號括起的 JSON 格式規則定義。 例如:

--rules '[{"locations":["global"],"target_ids":["11111111-1111-1111-1111-111111111111"]},{"locations":["us-south","us-east"],"target_ids":["22222222-2222-2222-2222-222222222222","33333333-3333-3333-3333-333333333333"]}]'
--locations LOCATIONS

與航線相關的位置清單。 指定 global 以包含全局事件。 若要包含所有位置,請指定 *。 如果您有多個規則,以及一個具有 * 位置的規則,則其他規則會將事件路由到指定的目標,任何不符合其他規則的事件會將其餘事件路由到具有 * 位置的規則所指定的目標。

--target-ids TARGET_ID

以逗號分隔的目標 ID 清單。

--output FORMAT

如果指定 JSON,輸出將以 JSON 格式回傳。 若未指定 JSON,輸出將以表格格式呈現。

help | --help | -h

列出指令可用的選項。

ibmcloud atracker route update

使用此指令更新 Activity Tracker Event Routing 目標的路由。 任何與最初建立路由時不同的指定值,都會更新為指令中指定的值。

ibmcloud atracker route update --route ROUTE [--name ROUTE_NAME] [--force] ( [--target-ids TARGETS]  [--locations REGIONS] | [--rules RULES] | [--file RULES_DEFINITION_JSON_FILE] ) [--output FORMAT] [--output FORMAT]

指令選項

--route ROUTE

該路線的現有名稱或識別碼。

--name ROUTE_NAME

要賦予路由的更新名稱(可選)。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--file RULES_DEFINITION_JSON_FILE

包含路由規則定義的 JSON 檔案。 檔案格式需如下所示:

[
  {
    "location": ["LOCATIONS"],
    "target_ids": ["TARGET_ID"]
  }
]
--rules RULES

以單引號括起的 JSON 格式規則定義。 例如:

--rules '[{"locations":["global"],"target_ids":["11111111-1111-1111-1111-111111111111"]},{"locations":["us-south","us-east"],"target_ids":["22222222-2222-2222-2222-222222222222","33333333-3333-3333-3333-333333333333"]}]'
--locations LOCATIONS

與航線相關的位置清單。 指定 global 以包含全局事件。 若要包含所有位置,請指定 *。 如果您有多個規則,以及一個具有 * 位置的規則,則其他規則會將事件路由到指定的目標,任何不符合其他規則的事件會將其餘事件路由到具有 * 位置的規則所指定的目標。

--target-ids TARGET_ID

以逗號分隔的目標 ID 清單。

--output FORMAT

如果指定 JSON,輸出將以 JSON 格式回傳。 若未指定 JSON,輸出將以表格格式呈現。

--force

將刪除航線,而不提供使用者任何其他提示。

help | --help | -h

列出指令可用的選項。

ibmcloud atracker route rm

請使用此指令刪除 Activity Tracker Event Routing 路由。

ibmcloud atracker route rm --route ROUTE [--force]

指令選項

--route ROUTE
要刪除的路由名稱或 ID。
--force
將刪除航線,而不提供使用者任何其他提示。
help | --help | -h
列出指令可用的選項。

ibmcloud atracker route get

使用此指令可取得 Activity Tracker Event Routing 路由的相關資訊。

ibmcloud atracker route get --route ROUTE [--output FORMAT]

指令選項

--route <ROUTE_ID>
路由的名稱或 ID。
--output FORMAT
如果指定 JSON,輸出將以 JSON 格式回傳。 若未指定 JSON,輸出將以表格格式呈現。
help | --help | -h
列出指令可用的選項。

ibmcloud atracker route ls

使用此指令可列出 Activity Tracker Event Routing 的所有已設定路由。

ibmcloud atracker route ls [--output FORMAT]

指令選項

--output FORMAT
如果指定 JSON,輸出將以 JSON 格式回傳。 若未指定 JSON,輸出將以表格格式呈現。
help | --help | -h
列出指令可用的選項。

ibmcloud atracker target create (COS)

使用此指令建立 IBM Cloud Object Storage 目標,用來設定活動事件的目的地。

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file COS_ENDPOINT_DEFINITION_JSON_FILE] |  ( [--endpoint COS_ENDPOINT] [--bucket COS_BUCKET] [--target-crn COS_TARGET_CRN] ( [--api-key ( COS_API_KEY | @COS_API_KEY_FILE )] |  [--service-to-service-enabled ( TRUE | FALSE )] ) ) ) [--region REGION] [--output FORMAT]

指令選項

--region REGION | -r REGION

決定 IBM Cloud Activity Tracker Event Routing API 請求端點的區域名稱,例如 us-southeu-gb。 如果未指定,則會使用登入的區域或目標區域。

--name TARGET_NAME

要賦予目標的名稱。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--type TARGET_TYPE

為 COS 目標設定 TARGET_TYPEcloud_object_storage

--file @COS_ENDPOINT_DEFINITION_JSON_FILE

包含端點定義的檔案,格式如下:

{
  "endpoint": "aaaaa",
  "target_crn": "yyyyy",
  "bucket": "zzzzzz",
  "api_key": "xxxxxx"
}
--endpoint COS_ENDPOINT

要與 IBM Cloud Object Storage 桶關聯的 IBM Cloud Object Storage 端點。

--bucket BUCKET

要與目標關聯的 IBM Cloud Object Storage 桶的名稱。

--target-crn COS_TARGET_CRN

IBM Cloud Object Storage 範例的 CRN。

--api-key COS_API_KEY | @COS_API_KEY_FILE

您的 API 密鑰值 或用來取得存取權限的 API 密鑰檔案參考。 例如: ibmcloud login --apikey $KEYFILE

--service-to-service-enabled

表示是否已為水桶啟用 服務對服務授權。 如果啟用服務對服務授權,請指定 TRUE ;如果未啟用服務對服務授權,請指定 FALSE。 預設情況下,service_to_service_enabled 的值為 FALSE

--output FORMAT

目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。

help | --help | -h

列出指令可用的選項。

ibmcloud atracker target create (Event Streams)

使用此指令建立 IBM® Event Streams for IBM Cloud® 目標,用來設定活動事件的目的地。

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--target-crn EVENTSTREAMS_TARGET_CRN] [--brokers BROKER_LIST] [--topic TOPIC] [--api-key ( EVENTSTREAMS_API_KEY | @EVENTSTREAMS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]) ) [--region REGION] [--output FORMAT]

指令選項

--region REGION | -r REGION

決定 IBM Cloud Activity Tracker Event Routing API 請求端點的區域名稱,例如 us-southeu-gb。 如果未指定,則會使用登入的區域或目標區域。

--name TARGET_NAME

要賦予目標的名稱。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--type TARGET_TYPE

針對 Event Streams 目標,將 TARGET_TYPE 設為 event_streams

--file @EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE

包含端點定義的檔案,格式如下:

{
  "target_crn": "yyyyy",
  "brokers": ["broker-1:9093","broker-2:9093"],
  "topic": "my-topic",
  "api_key": "xxxxxxxxxxxxxx"
}
--target-crn eventstreams_target_crn [

IBM® Event Streams for IBM Cloud® 範例的 CRN。 您可以從服務憑證取得來源 crn。

--brokers BROKER_LIST

Event Streams 代理商(端點)清單。 這是 kafka_brokers_sasl 在服務憑證中的值。

--topic TOPIC

Event Streams 事件所傳送至的話題名稱。 這是為 Event Streams 範例建立的主題名稱。

--api-key EVENTSTREAMS_API_KEY | @EVENTSTREAMS_API_KEY_FILE

在 Event Streams 服務憑證中找到的密碼值。 這是 IAM API 金鑰。

--service-to-service-enabled

確定 IBM Cloud Activity Tracker Event Routing 是否已啟用服務對服務驗證。 如果啟用 service to service 且不提供 apikey,請將此旗標設定為 true

--output FORMAT

目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。

help | --help | -h

列出指令可用的選項。## ibmcloud atracker target create (COS)。

使用此指令建立 IBM® Event Streams for IBM Cloud® 目標,用來設定活動事件的目的地。

 ibmcloud atracker target create --name new-target-name --type event-streams --target-crn "crn:v1:bluemix:public:messagehub:eu-de:a/11111111111111111111111111111111:22222222-2222-2222-2222-222222222222::" --brokers "broker-1:9093,broker-2:9093" --topic "topic-name" --api-key xxxxx

ibmcloud atracker target create (IBM Cloud Logs)

使用此指令建立 IBM® Event Streams for IBM Cloud® 目標,用來設定活動事件的目的地。

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file CLOUD_LOGS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--target-crn CLOUD_LOGS_TARGET_CRN] ) ) [--region REGION] [--output FORMAT]

指令選項

--region REGION | -r REGION

決定 IBM Cloud Activity Tracker Event Routing API 請求端點的區域名稱,例如 us-southeu-gb。 如果未指定,則會使用登入的區域或目標區域。

--name TARGET_NAME

要賦予目標的名稱。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--type TARGET_TYPE

針對 IBM Cloud Logs 目標,將 TARGET_TYPE 設為 cloud_logs

--file @CLOUD_LOGS_ENDPOINT_DEFINITION_JSON_FILE

包含端點定義的檔案,格式如下:

{
  "target_crn": "yyyyy"
}
--target-crn CLOUD_LOGS_TARGET_CRN

IBM Cloud Logs 範例的 CRN。

--output FORMAT

目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。

help | --help | -h

列出指令可用的選項。## ibmcloud atracker target create。

使用此指令建立 IBM Cloud Logs 目標,用來設定活動事件的目的地。

 ibmcloud atracker target create --name new-target-name --type cloud-logs --target-crn "crn:v1:bluemix:public:logs:eu-de:a/11111111111111111111111111111111:22222222-2222-2222-2222-222222222222::"

ibmcloud atracker target create (IBM Cloud App Configuration)

請使用此指令建立一個「IBM Cloud® App Configuration」目標,用以設定活動事件的目的地。

 ibmcloud atracker target create --name TARGET_NAME --type TARGET_TYPE ( [--file APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE] | ( [--target-crn APPCONFIG_TARGET_CRN] ) ) [--region REGION] [--output FORMAT]

指令選項

--region REGION | -r REGION

決定 IBM Cloud Activity Tracker Event Routing API 請求端點的區域名稱,例如 us-southeu-gb。 如果未指定,則會使用登入的區域或目標區域。

--name TARGET_NAME

要賦予目標的名稱。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--type TARGET_TYPE

針對 IBM Cloud App Configuration 目標,請將 TARGET_TYPE 設定為 app_config

--file @APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE

包含端點定義的檔案,格式如下:

{
  "target_crn": "yyyyy"
}
--target-crn APPCONFIG_TARGET_CRN

IBM Cloud App Configuration 執行個體的 CRN。

--output FORMAT

目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。

help | --help | -h

列出指令可用的選項。## ibmcloud atracker target create。

請使用此指令建立一個「IBM Cloud App Configuration」目標,用以設定活動事件的目的地。

 ibmcloud atracker target create --name new-target-name --type app-config --target-crn "crn:v1:bluemix:public:logs:eu-de:a/11111111111111111111111111111111:22222222-2222-2222-2222-222222222222::"

ibmcloud atracker target update (COS)

使用此指令更新 IBM Cloud Activity Tracker Event Routing 區域的 COS 目標。 任何與最初建立目標時不同的指定值,都會更新為指令中指定的值。

ibmcloud atracker target update --target TARGET [--name TARGET_NAME] [ [--file COS_ENDPOINT_DEFINITION_JSON_FILE] |  ( [--endpoint COS_ENDPOINT] [--bucket COS_BUCKET] [--target-crn COS_TARGET_CRN] ( [--api-key ( COS_API_KEY | @COS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]))] [--output FORMAT]

指令選項

--target TARGET

ID 或目前的目標名稱。

--name TARGET_NAME

要賦予目標的名稱。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--file @COS_ENDPOINT_DEFINITION_JSON_FILE

包含端點定義的檔案,格式如下:

{
  "endpoint": "aaaaa",
  "target_crn": "yyyyy",
  "bucket": "zzzzzz",
  "api_key": "xxxxxx"
}

或啟用服務對服務驗證的情況:

{
  "endpoint": "aaaaa",
  "target_crn": "yyyyy",
  "bucket": "zzzzzz",
  "service_to_service_enabled": true
}
--endpoint COS_ENDPOINT

要與 IBM Cloud Object Storage 桶關聯的 IBM Cloud Object Storage 端點。

--bucket COS_BUCKET

要與目標關聯的 IBM Cloud Object Storage 桶的名稱。

--target-crn COS_TARGET_CRN

IBM Cloud Object Storage 範例的 CRN。

--api-key COS_API_KEY | @COS_API_KEY_FILE

您的 API 密鑰值 或用來取得存取權限的 API 密鑰檔案參考。 例如: ibmcloud login --apikey $KEYFILE

--service-to-service-enabled (TRUE | FALSE)

表示是否已為水桶啟用 服務對服務授權。 如果啟用服務對服務授權,請指定 TRUE ;如果未啟用服務對服務授權,請指定 FALSE。 預設情況下,服務對服務授權為 FALSE

--output FORMAT

目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。

help | --help | -h

列出指令可用的選項。

ibmcloud atracker target update (Event Streams)

使用此指令更新 IBM Cloud Activity Tracker Event Routing 區域的 Event Streams 目標。 任何與最初建立目標時不同的指定值,都會更新為指令中指定的值。

ibmcloud atracker target update --target TARGET [--name TARGET_NAME] [ [--file EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE] | ( [--brokers BROKER_LIST] [--target-crn EVENTSTREAMS_TARGET_CRN] [--topic TOPIC] ( [--api-key ( EVENTSTREAMS_API_KEY | @EVENTSTREAMS_API_KEY_FILE )] | [--service-to-service-enabled ( TRUE | FALSE )]))] [--output FORMAT]

指令選項

--name TARGET_NAME

要賦予目標的名稱。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--type TARGET_TYPE

為 COS 目標設定 TARGET_TYPEcloud_object_storage

--file @EVENTSTREAMS_ENDPOINT_DEFINITION_JSON_FILE

包含端點定義的檔案,格式如下:

{
  "target_crn": "yyyyy",
  "brokers": ["broker-1:9093","broker-2:9093"],
  "topic": "my-topic",
  "api_key": "xxxxxxxxxxxxxx"
}
--target-crn eventstreams_target_crn [

IBM® Event Streams for IBM Cloud® 範例的 CRN。 您可以從服務憑證取得來源 crn。

--brokers BROKER_LIST

Event Streams 代理商(端點)清單。 這是 kafka_brokers_sasl 在服務憑證中的值。

--topic TOPIC

Event Streams 事件所傳送至的話題名稱。 這是為 Event Streams 範例建立的主題名稱。

--api-key EVENTSTREAMS_API_KEY | @EVENTSTREAMS_API_KEY_FILE

在 Event Streams 服務憑證中找到的密碼值。 這是 IAM API 金鑰。

--service-to-service-enabled

確定 IBM Cloud Activity Tracker Event Routing 是否已啟用服務對服務驗證。 如果啟用 service to service 且不提供 apikey,請將此旗標設定為 true

--output FORMAT

目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。

help | --help | -h

列出指令可用的選項。

ibmcloud atracker target update (IBM Cloud Logs)

使用此指令更新 IBM Cloud Logs 目標,以用於設定活動事件的目的地。

ibmcloud atracker target update --target TARGET [--name TARGET_NAME] ( --file @CLOUD_LOGS_ENDPOINT_DEFINITION_JSON_FILE ) | (--target-crn CLOUD_LOGS_TARGET_CRN) [--output FORMAT]

指令選項

--target TARGET

ID 或目前的目標名稱。

--name TARGET_NAME

要賦予目標的名稱。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--file @CLOUD_LOGS_ENDPOINT_DEFINITION_JSON_FILE

包含端點定義的檔案,格式如下:

{
  "target_crn": "yyyyy",
}
--target-crn CLOUD_LOGS_TARGET_CRN

IBM Cloud Logs 範例的 CRN。

--output FORMAT

目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。

help | --help | -h

列出指令可用的選項。

ibmcloud atracker target update (IBM Cloud App Configuration)

請使用此指令來更新「IBM Cloud App Configuration」目標,以便用於設定活動事件的目的地。

ibmcloud atracker target update --target TARGET [--name TARGET_NAME] ( --file @APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE ) | (--target-crn APPCONFIG_TARGET_CRN) [--output FORMAT]

指令選項

--target TARGET

ID 或目前的目標名稱。

--name TARGET_NAME

要賦予目標的名稱。

請勿在任何資源名稱中包含任何個人識別資訊 (PII)。

--file @APPCONFIG_ENDPOINT_DEFINITION_JSON_FILE

包含端點定義的檔案,格式如下:

{
  "target_crn": "yyyyy",
}
--target-crn APPCONFIG_TARGET_CRN

IBM Cloud App Configuration 執行個體的 CRN。

--output FORMAT

目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。

help | --help | -h

列出指令可用的選項。

ibmcloud atracker target rm

請使用此指令刪除目標。

ibmcloud atracker target rm --target TARGET [--force]

指令選項

--target TARGET
目標的 ID 或名稱。
--force | -f
將刪除目標而不提供使用者任何額外提示。
help | --help | -h
列出指令可用的選項。

ibmcloud atracker target validate

使用此指令驗證目標是否已正確設定為 IBM Cloud Activity Tracker Event Routing 區域。

ibmcloud atracker target validate --target TARGET [--region REGION] [--output FORMAT]

指令選項

--target TARGET
目標的 ID 或名稱。
--region REGION | -r REGION
決定 IBM Cloud Activity Tracker Event Routing API 請求端點的區域名稱,例如 us-southeu-gb。 如果未指定,則會使用登入的區域或目標區域。
--output FORMAT
目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。
help | --help | -h
列出指令可用的選項。

ibmcloud atracker target get

使用此指令可取得 IBM Cloud Activity Tracker Event Routing 區域的目標資訊。

ibmcloud atracker target get --target TARGET [--output FORMAT]

指令選項

--target TARGET
目標的 ID 或名稱。
--output FORMAT
目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。
help | --help | -h
列出指令可用的選項。

ibmcloud atracker target ls

使用此指令可列出 IBM Cloud Activity Tracker Event Routing 區域的已設定目標。

ibmcloud atracker target ls [--output FORMAT]

指令選項

--output FORMAT
目前支援的格式為 JSON。 如果指定,輸出將以 JSON 格式傳回。 若未指定 JSON,輸出將以表格格式呈現。
help | --help | -h
列出指令可用的選項。

ibmcloud atracker setting get

使用此指令可取得 IBM Cloud Activity Tracker Event Routing 帳戶組態的設定。

ibmcloud atracker setting get [--output FORMAT]

指令選項

--output FORMAT
如果指定 JSON,輸出將以 JSON 格式回傳。 若未指定 JSON,輸出將以表格格式呈現。
help | --help | -h
列出指令可用的選項。

ibmcloud atracker setting update

使用此指令可修改目前的設定,例如 IBM Cloud Activity Tracker Event Routing 中的預設目標、允許的目標區域、主要和次要元資料區域。 任何與最初建立目標時不同的值,都會更新為指令中指定的值。

停用公用端點 (--private-api-endpoint-only TRUE) 之前,請確定您的帳戶可以存取私人端點。 您可以執行指令 bx account show. 如果 VRF Enabledtrue,而 Service Endpoint Enabledtrue,那麼您就可以存取私有端點。 如果您無法存取私人端點,就無法重新啟用公用端點,因為重新啟用公用端點需要私人端點存取權。

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]

指令選項

default-targets
是目標 ID 的清單。 如果沒有路由規則會導致事件被傳送至其他目標,這些目標將會收到事件。 TARGETS 是以逗號分隔的目標 ID 清單。
permitted-target-regions
是可用於定義目標的區域清單。 REGIONS 是以逗號分隔的區域清單。 最多可指定兩個允許的目標區域。
metadata-region-primary
指定儲存路由和目標定義相關的元資料的 REGION。
metadata_region_backup
是與路由和目標定義相關的元資料作為備份位置儲存的區域。
private-api-endpoint-only
指定是否可以使用私有端點。 如果 true,則只能使用私人端點。
--output FORMAT
如果指定 JSON,輸出將以 JSON 格式回傳。 若未指定 JSON,輸出將以表格格式呈現。
help | --help | -h
列出指令可用的選項。