CLI 先决条件

在使用 CLI 管理目标之前，请完成以下步骤:

1. 安装 IBM Cloud CLI。

2. 安装 IBM Cloud Activity Tracker Event Routing CLI。

3. 登录到 IBM Cloud。 运行以下命令: ibmcloud login

使用同一帐户的 UI witihin 配置 S2S 授权

执行以下操作以使用 IBM Cloud UI 配置服务到服务授权。

1. 以将配置 IBM Cloud Activity Tracker Event Routing 目标的帐户所有者身份登录到 IBM Cloud 帐户。

   使用用户标识和密码登录后，IBM Cloud“仪表板”即会打开。

2. 单击管理 > 访问权 (IAM)。 这样会显示 管理访问权和用户。

3. 点击授权。

4. 单击创建。

5. 对于 源服务，选择 Activity Tracker，对于 要如何限定访问范围?，选择 所有资源。

6. 对于 目标服务，请选择 Cloud Object Storage 以 要如何限定访问范围? 选择 基于所选属性的资源。

7. 选择 服务实例，字符串等于 COS 实例的名称。

8. 对于 服务访问权，请选择 对象写程序。

9. 单击授权。 新的服务到服务授权将列示在“管理授权”视图中。

您将只能使用 UI 向 IBM Cloud Object Storage 实例授权。 如果要将授权限制为特定 IBM Cloud Object Storage 存储区，那么需要使用 API 配置授权。

使用 CLI 配置 S2S 授权

执行以下操作以使用 IBM Cloud CLI 配置服务到服务授权。

1. 以将配置 IBM Cloud Activity Tracker Event Routing 授权的帐户所有者身份登录到 IBM Cloud 帐户。

2. 创建用于定义服务到服务授权的授权策略。

   ibmcloud iam authorization-policy-create atracker cloud-object-storage "Object Writer" [--target-service-instance-id <COS_SERVICE_INSTANCE>
   

   其中：

   COS_SERVICE_INSTANCE 是要授权的 COS 实例的 存储区实例 CRN。

使用 API 配置 S2S 授权

执行以下操作以使用 IBM Cloud API 配置服务到服务授权。

1. 以将配置 IBM Cloud Activity Tracker Event Routing IAM 授权的帐户所有者身份登录到 IBM Cloud 帐户。

2. 创建定义服务到服务授权的 authorization_policy_resource.json 文件。

   {
       "type": "authorization",
       "subjects": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "atracker"
                   }
               ]
           }
       ],
       "roles": [
           {
               "role_id": "crn:v1:bluemix:public:iam::::serviceRole:ObjectWriter"
           }
       ],
       "resources": [
           {
               "attributes": [
                 {
                      "name": "accountId",
                      "value": "CUSTOMER_ACCOUNT_ID"
                  },
                  {
                       "name": "serviceName",
                       "value": "cloud-object-storage"
                   },
                   {
                       "name": "serviceInstance",
                       "value": "COS_SERVICE_INSTANCE"
                   }
               ]
           }
       ]
   }
   

   其中：

   CUSTOMER_ACCOUNT_ID 是将配置目标的帐户的帐户 GUID。 这可以通过使用 ibmcloud account list 命令找到。

   COS_SERVICE_INSTANCE 是要授权的 COS 实例的 存储区实例 CRN。

3. 获取 IAM 访问令牌。 有关更多信息，请参阅 检索 IAM 访问令牌。

4. 运行以下命令以配置服务到服务授权:

   curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header "Authorization: $ACCESS_TOKEN" -d @authorization_policy_resource.json "https://iam.cloud.ibm.com/v1/policies"
   

使用 CLI 创建 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]

Target
Name:               		my-target
ID:                 		000000000-00000000-0000-0000-00000000
CRN:                		crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type:               		cloud_object_storage
COS Endpoint:       		s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN:     		crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket:         		cloud-object-my-target
Service to Service Enabled:	true
Write Status:   		success
Created:            		2021-07-21T16:04:15.174Z
Updated:            		2021-07-21T16:04:15.174Z

使用 CLI 更新 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
Name:               		new-target-name
ID:                 		xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:               		crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type:               		cloud_object_storage
COS Endpoint:       		s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN:    		crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket:         		cloud-object-my-target
Service to Service Enabled:	true
Write Status:   		success
Created:            		2021-07-21T16:04:15.174Z
Updated:           		2021-07-21T17:49:56.452Z

使用 CLI 删除目标

使用此命令删除目标。

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

Are you sure you want to remove the target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx? [y/N]>y
OK
Target with target ID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was successfully removed.

Are you sure you want to remove the Target bearing Target ID 33333333-3333-3333-3333-333333333333? [y/N]> y
FAILED
Something went wrong. Error:
 Status Code:  404
 Incident ID:  67a33257-d5a4-46ec-94d9-14eb70e94f3d
 Code:         not_found
 Message:      The target id specified in `target_id` field is not found.

使用 CLI 验证目标

使用此命令可验证是否为 IBM Cloud Activity Tracker Event Routing 区域正确配置了目标。

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

Target
Name:               		new-target-name
ID:                 		xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:               		crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type:               		cloud_object_storage
COS Endpoint:       		s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN:     		crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket:         		cloud-object-my-target
Service to Service Enabled:	true
Write Status:   		success
Created:            		2021-07-21T16:04:15.174Z
Updated:           		2021-07-21T17:49:56.452Z

使用 CLI 获取有关目标的信息

使用此命令可获取有关 IBM Cloud Activity Tracker Event Routing 区域的目标的信息。

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

Target
Name:               		new-target-name
ID:                 		xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
CRN:               		crn:v1:staging:public:atracker:us-south:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx
Type:               		cloud_object_storage
COS Endpoint:      		s3.us-west.cloud-object-storage.appdomain.cloud
COS Target CRN:     		crn:v1:staging:public:cloud-object-storage:global:a/xxxxxxxxxx:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx:
COS Bucket:         		cloud-object-my-target
Service to Service Enabled:	true
Write Status:   		success
Created:           		2021-07-21T16:04:15.174Z
Updated:            		2021-07-21T17:49:56.452Z

列出区域中的所有目标

使用此命令可列出 IBM Cloud Activity Tracker Event Routing 区域的已配置目标。

ibmcloud atracker target ls [--output FORMAT]

Name                       ID                                     Region     Type                     Service to Service Enabled	Created
target-01                  xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   us-south    cloud_object_storage    true				2020-11-18T03:52:08.603Z
target-02                  yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy   us-south    cloud_object_storage    true				2020-11-18T03:52:01.592Z
target-02-backup           zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz   us-east     cloud_object_storage    false				2021-02-26T06:53:13.466Z

API 目标和操作

下表列出了可以运行的管理目标的操作：

您可以使用专用和公共端点来管理目标。 有关可用的 ENDPOINTS 列表的更多信息，请参阅 端点。

• 您可以使用以下格式的 API 端点来管理专用网络中的目标: https://private.REGION.atracker.cloud.ibm.com

• 您可以使用以下格式的 API 端点来管理公用网络中的目标: https://REGION.atracker.cloud.ibm.com

• 您可以通过更新帐户设置来禁用公共端点。 有关更多信息，请参阅 配置目标和区域设置。

有关 REST API 的更多信息，请参阅 目标。

API 先决条件

要进行 API 调用以管理目标，请完成以下步骤:

1. 获取 IAM 访问令牌。 有关更多信息，请参阅 检索 IAM 访问令牌。
2. 在计划配置或管理目标的区域中标识 API 端点。 有关更多信息，请参阅 端点。

使用 API 创建 COS 目标

您可以使用以下 cURL 命令来创建 IBM Cloud Object Storage (COS) 目标:

curl -X POST  <ENDPOINT>/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "cloud_object_storage",
    "cos_endpoint": {
      "endpoint": "PRIVATE_COS_ENDPOINT",
      "target_crn": "COS_CRN",
      "bucket": "BUCKET_NAME",
      "api_key": "API_KEY",
      "service_to_service_enabled": SERVICE_TO_SERVICE
    }
  }'

位置

• <ENDPOINT> 是计划在其中配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。

• TARGET_NAME 是目标的名称。 名称的最大长度为 256 个字符。

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

• TARGET_TYPE 是目标的类型。 有效类型为 cloud_object_storage。

• cos_endpoint 包含有关目标的信息。 有关如何获取存储区详细信息的更多信息，请参阅 获取存储区配置详细信息。

  PRIVATE_COS_ENDPOINT 指示用于查找此存储区的 IBM Cloud Activity Tracker Event Routing 端点。 使用专用端点。

  COS_CRN 指示供应存储区的 COS 实例的 CRN。

  BUCKET_NAME 指示存储区的名称。

  API_KEY 包含有权将对象上载到存储区的 API 密钥。 如果 service_to_service_enabled 为 true，那么将忽略此值。

  SERVICE_TO_SERVICE 指示是否已对存储区启用 服务到服务授权。 如果已启用服务到服务授权，请指定 true ; 如果未启用服务到服务授权，请指定 false。 缺省情况下，服务到服务授权为 false。

例如，您可以使用以下 cURL 请求在达拉斯创建目标:

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My COS target",
    "target_type": "cloud_object_storage",
    "cos_endpoint": {
      "endpoint": "s3.private.us-south.cloud-object-storage.appdomain.cloud",
      "target_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<instance-id>::",
      "bucket": "my-activity-tracking-bucket",
      "api_key": "xxxxxxxxxxxxxxxxxx",
      "service_to_service_enabled": false
    }
  }'

在响应中，您将获取有关目标的信息，例如指示目标 GUID 的 id 和指示目标 CRN 的 crn。

使用 API 更新 COS 目标

更新 IBM Cloud Object Storage (COS) 目标时，必须在请求的数据部分中包含目标信息。

• 必须传递所有字段。
• 更新需要更改的字段。
• 创建后，无法更改目标的 target_type。

可以使用以下 cURL 命令来更新目标:

curl -X PUT  <ENDPOINT>/api/v2/targets/TARGET_ID  -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "TARGET_NAME",
    "target_type": "TARGET_TYPE",
    "cos_endpoint": {
      "endpoint": "PRIVATE_COS_ENDPOINT",
      "target_crn": "COS_CRN",
      "bucket": "BUCKET_NAME",
      "api_key": "API_KEY",
      "service_to_service_enabled": SERVICE_TO_SERVICE
    }
  }'

位置

• <ENDPOINT> 是计划在其中配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。

• TARGET_ID 是目标的标识。

• TARGET_NAME 是目标的名称。 名称的最大长度为 256 个字符。

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

• TARGET_TYPE 是目标的类型。 将 COS 目标的值设置为 cloud_object_storage。

• cos_endpoint 包含有关目标的信息。 有关如何获取存储区详细信息的更多信息，请参阅 获取存储区配置详细信息。

  PRIVATE_COS_ENDPOINT 指示用于查找此存储区的 IBM Cloud Activity Tracker Event Routing 端点。 使用专用端点。

  COS_CRN 指示供应存储区的 COS 实例的 CRN。

  BUCKET_NAME 指示存储区的名称。

  API_KEY 包含有权将对象上载到存储区的 API 密钥。 如果 service_to_service_enabled 为 true，那么将忽略此值。

  SERVICE_TO_SERVICE 指示是否已对存储区启用 服务到服务授权。 如果已启用服务到服务授权，请指定 true ; 如果未启用服务到服务授权，请指定 false。 缺省情况下，服务到服务授权为 false。

例如，您可以使用以下 cURL 请求在达拉斯创建目标:

curl -X PUT   https://private.us-south.atracker.cloud.ibm.com/api/v2/targets   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"   -d '{
    "name": "My COS target",
    "target_type": "cloud_object_storage",
    "cos_endpoint": {
      "endpoint": "s3.private.us-south.cloud-object-storage.appdomain.cloud",
      "target_crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/<account-id>:<instance-id>::",
      "bucket": "my-activity-tracking-bucket",
      "service_to_service_enabled": true
    }
  }'

使用 API 删除目标

可以使用以下 cURL 命令来删除目标:

curl -X DELETE <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization:  $ACCESS_TOKEN" -H "content-type: application/json"

位置

• <ENDPOINT> 是计划在其中配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。
• <TARGET_ID> 是目标的标识。

例如，可以使用以下 cURL 请求来删除标识为 00000000-0000-0000-0000-000000000000 的美国南部目标:

curl -X DELETE https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

在响应中，如果删除成功，那么将获得空结果:

{}

使用 API 验证目标

您可以使用以下 cURL 命令通过检查要写入目标的凭证来验证目标。

curl -X POST <ENDPOINT>/api/v2/targets/<TARGET_ID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

位置

• <ENDPOINT> 是计划在其中配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。
• <TARGET_ID> 是目标的标识。

例如，可以使用以下 cURL 请求来验证标识为 00000000-0000-0000-0000-000000000000 的美国南部目标:

curl -X POST https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/<TARGETID>/validate -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

在响应中，您将在 cos_write_status 部分中获取信息，例如:

"write_status": {
    "status": "success"
  },

使用 API 查看目标

您可以使用以下 cURL 命令来查看 1 目标的配置详细信息:

curl -X GET <ENDPOINT>/api/v2/targets/<TARGET_ID> -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

位置

• <ENDPOINT> 是计划在其中配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。
• <TARGET_ID> 是目标的标识。

例如，可以运行以下 cURL 请求以获取有关标识为 00000000-0000-0000-0000-000000000000 的目标的信息:

curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets/00000000-0000-0000-0000-000000000000 -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

结果将显示目标是否为 COS ("target_type": "cloud_object_storage")。

使用 API 列出所有目标

可以使用以下 cURL 命令来查看所有目标:

curl -X GET <ENDPOINT>/api/v2/targets -H "Authorization: $ACCESS_TOKEN" -H "content-type: application/json"

位置

• <ENDPOINT> 是计划在其中配置或管理目标的区域中的 API 端点。 有关更多信息，请参阅 端点。

例如，您可以运行以下 cURL 请求以获取有关达拉斯中定义的目标的信息:

curl -X GET https://private.us-south.atracker.cloud.ibm.com/api/v2/targets -H "Authorization:  $ACCESS_TOKEN" -H "content-type: application/json"

结果将显示目标是否为 COS ("target_type": "cloud_object_storage") 目标。

HTTP 响应代码

在使用 IBM Cloud Activity Tracker Event Routing REST API 时，您可以获取标准的 HTTP 响应代码，以指示方法是否成功完成。

• 200 响应始终指示成功。
• 4xx 响应指示失败。
• 5xx 响应通常指示内部系统错误。

有关 HTTP 的一些响应代码，请参见下表：

使用 UI 创建 IBM Cloud Object Storage 目标

只有帐户中的资源才会列出并可选择。 要在其他帐户中指定资源，请在 选择目标下选择 指定 CRN。

1. 登录到 IBM Cloud 帐户。
2. 单击 菜单 图标 > 可观察性。
3. 选择 Activity Tracker。
4. 选择 路由。
5. 选择 目标。
6. 单击 创建 以打开创建面板。
7. 选择类型: 单击 Object Storage。
8. 需要服务授权: 需要服务授权以允许 IBM Cloud Activity Tracker Event Routing 与 IBM Cloud Object Storage进行通信。 单击 立即授权 以自动创建策略，或者单击 在 IAM 中授予访问权。
9. 选择目标: 选取 按实例搜索 或 指定 CRN
   • 按实例搜索: 从表中选择 IBM Cloud Object Storage 实例，或者单击 创建 以创建新的 IBM Cloud Object Storage 实例。 选择实例后，选择 IBM Cloud Object Storage 存储区。
   • 指定 CRN: 输入 IBM Cloud Object Storage 存储区的云资源名称 (CRN)。 这使您能够从其他帐户输入 CRN。

• 存储区端点: 使用缺省存储区端点或对其进行更改。
• 目标名称: 输入有意义的目标名称。
• 目标区域: 选择将处理事件数据的区域。
• 切换 设置为缺省目标 以在 IBM Cloud Activity Tracker Event Routing 设置中将新目标自动设置为缺省目标。 有关更多详细信息，请参阅 缺省目标文档。
• 单击 创建目标。

使用 UI 更新 IBM Cloud Object Storage 目标

只有帐户中的资源才会列出并可选择。 要在其他帐户中指定资源，请在 选择目标下选择 指定 CRN。

1. 登录到 IBM Cloud 帐户。
2. 单击 菜单 图标 > 可观察性。
3. 选择 Activity Tracker。
4. 选择 路由。
5. 选择 目标。
6. 确定要更新的目标，然后单击 。
7. 单击 取消设置为缺省值 以在 IBM Cloud Activity Tracker Event Routing 设置中除去作为缺省目标的目标。 有关更多详细信息，请参阅 缺省目标文档。
8. 单击 编辑 以打开更新面板。
9. 详细信息: 单击 编辑 以更新目标的名称或区域。 您还可以切换 缺省目标，以在 IBM Cloud Activity Tracker Event Routing 设置中添加或除去作为缺省目标的目标。
10. 单击 保存 以更新目标。
11. 目标: 单击 编辑 以更改与目标关联的 IBM Cloud Object Storage 实例或存储区。
12. 单击 保存 以更新目标。

使用 UI 删除目标

如果 IBM Cloud Activity Tracker Event Routing 目标用于路由或用作缺省目标设置，那么无法将其删除。

1. 登录到 IBM Cloud 帐户。
2. 单击 菜单 图标 > 可观察性。
3. 选择 Activity Tracker。
4. 选择 路由。
5. 选择 目标。
6. 确定要删除的目标，然后单击 。
7. 单击 删除，然后在确认面板中单击 删除。

使用用户界面列出区域内的所有目标

1. 登录到 IBM Cloud 帐户。
2. 单击 菜单 图标 > 可观察性。
3. 选择 Activity Tracker。
4. 选择 路由。
5. 选择 目标。

表详细信息:

• 目标类型
• 目标名称
• 目的地区域
• 路由: 如果在任何路由中使用该路由
• 目标状态：
  • 活动: 目标正在按预期工作
  • 错误: 目标不正确，不会将事件路由到目标。 更新目标详细信息或目标以修订目标配置，或者删除不再需要的目标