Activity Tracker 事件路由命令行界面

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

该路线的现有名称或ID。

--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-south 或 eu-gb。 如果未指定，将使用登录的区域或目标区域。

--name TARGET_NAME

目标的名称。

请勿在任何资源名称中包含任何个人身份信息 (PII)。

--type TARGET_TYPE

将 TARGET_TYPE 设置为 COS 目标的 cloud_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-south 或 eu-gb。 如果未指定，将使用登录的区域或目标区域。

--name TARGET_NAME

目标的名称。

请勿在任何资源名称中包含任何个人身份信息 (PII)。

--type TARGET_TYPE

将 TARGET_TYPE 设置为 event_streams，目标地址为 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 是否启用了服务对服务身份验证。 如果启用了服务到服务且不提供 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-south 或 eu-gb。 如果未指定，将使用登录的区域或目标区域。

--name TARGET_NAME

目标的名称。

请勿在任何资源名称中包含任何个人身份信息 (PII)。

--type TARGET_TYPE

将 TARGET_TYPE 设置为 cloud_logs，目标地址为 IBM 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

列出命令的可用选项。

使用此命令可创建 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-south 或 eu-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

列出命令的可用选项。

使用此命令创建一个 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

将 TARGET_TYPE 设置为 COS 目标的 cloud_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 是否启用了服务对服务身份验证。 如果启用了服务到服务且不提供 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-south 或 eu-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 Enabled 是 true，Service Endpoint Enabled 是 true，那么您就可以访问专用端点。 如果无法访问私有端点，就无法重新启用公共端点，因为重新启用公共端点需要私有端点访问权限。

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
指定存储路由和目标定义相关元数据的区域。
metadata_region_backup
是存储与路由和目标定义相关的元数据的区域，作为备份位置。
private-api-endpoint-only
指定是否可以使用专用端点。 如果 true，则只能使用专用端点。
--output FORMAT
如果指定 JSON，输出将以 JSON 格式返回。 如果未指定 JSON，输出将以表格格式返回。
help | --help | -h
列出命令的可用选项。