CLI 先决条件

在使用 CLI 管理路由之前，请在本地系统中安装最新的 Activity Tracker Event Routing CLI V2 插件。 请参阅安装 Activity Tracker Event Routing CLI。

接下来，登录到 IBM Cloud。 运行以下命令: ibmcloud login

使用 CLI 创建路径

使用此命令为 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]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 0
Rules:                   [locations: [us-south], target_ids: [33333333-3333-3333-3333-333333333333]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:10:09.996Z

使用 CLI 更新路由

使用此命令可更新 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]

OK
Route
Name:                    dev-eu-de-route
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 1
Rules:                   [locations: [*], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:13:37.218Z

使用 CLI 删除路由

使用此命令删除 Activity Tracker Event Routing 路由。

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

Are you sure you want to remove the route with the Route ID 44444444-4444-4444-4444-444444444444? [y/N]> y
OK
Route with route ID 44444444-4444-4444-4444-444444444444 was successfully removed.

FAILED
No route found with route name - 33333333-3333-3333-3333-333333333333

使用 CLI 查看路由

使用此命令可获取有关 Activity Tracker Event Routing 路径的信息。

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

OK
Route
Name:                    dev-eu-de-route-0
ID:                      44444444-4444-4444-4444-444444444444
CRN:                     crn:v1:staging:public:atracker:eu-de:a/11111111111111111111111111111111::route:44444444-4444-4444-4444-444444444444
Version:                 2
Rules:                   [locations: [us-south], target_ids: [55555555-5555-5555-5555-555555555555]]
Created:                 2022-02-24T21:10:09.996Z
Updated:                 2022-02-24T21:15:07.281Z

使用 CLI 列出所有路由

使用此命令可列出 Activity Tracker Event Routing 的所有已配置路径。

ibmcloud atracker route ls [--output FORMAT]

Name                      ID                                     Rules                                              Route Version   API version   CreatedAt                  UpdatedAt
my-global-route           aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   [[11111111-1111-1111-1111-111111111111],[global]]  5               2             2022-05-04T20:18:00.595Z   2022-05-05T19:04:58.374Z
send-all-to-us-east       bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb   [[22222222-2222-2222-2222-222222222222],[*]]       0               2             2022-05-06T12:02:47.832Z   2022-05-06T12:02:47.832Z

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 创建路由

在创建路径之前，必须 创建目标。

您可以使用以下 cURL 命令创建路由：

curl -X POST  <ENDPOINT>/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

位置

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

• ROUTE_NAME 是路由的名称。 名称的最大长度为 180 个字符，不能包含下列任何特殊字符:-，.，_ 和 :。

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

• LOCATIONS 是与路由关联的位置的列表。 指定 global 以包含全局事件。 要包含所有位置，请指定 *。 如果您有多个规则以及具有 * 位置的规则，那么其他规则会将事件路由到指定的目标，其中任何事件都与任何其他规则不匹配，从而将其余事件路由到具有 * 位置的规则指定的目标。

• TARGET_ID 是定义在其中路由和收集审计事件的目标的 GUID。 这可以包括其他区域中目标的 GUID。 如果 TARGET_ID 为空，那么将废弃与规则匹配的任何事件。

例如，您可以使用以下 cURL 请求来创建用于定义如何在帐户中收集和路由基于全局和美南位置的事件的路径:

curl -X POST   https://private.us-south.atracker.cloud.ibm.com/api/v2/routes   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global"],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

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

使用 API 更新路由

更新路由时，必须在请求的数据部分中包含路由信息。

• 必须传递所有字段。
• 更新需要更改的字段。

您可以使用以下 cURL 命令来更新路由:

curl -X PUT  <ENDPOINT>/api/v2/routes/<ROUTE_ID>   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "ROUTE_NAME",
    "rules": [
      {
        "locations": ["LOCATIONS"],
        "target_ids": ["TARGET_ID"]
      }
    ]
  }'

位置

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

• <ROUTE_ID> 是要更新的路由的标识

• ROUTE_NAME 是路由的名称。 名称的最大长度为 180 个字符，不能包含下列任何特殊字符:-，.，_ 和 :。

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

• LOCATIONS 是与路由关联的位置的列表。 指定 global 以包含全局事件。 要包含所有位置，请指定 *。 如果您有多个规则以及具有 * 位置的规则，那么其他规则会将事件路由到指定的目标，其中任何事件都与任何其他规则不匹配，从而将其余事件路由到具有 * 位置的规则指定的目标。

• TARGET_ID 是定义在其中路由和收集审计事件的目标的 GUID。 这可以包括其他区域中目标的 GUID。 如果 TARGET_ID 为空，那么将废弃与规则匹配的任何事件。

例如，您可以使用以下 cURL 请求来更新用于定义如何在帐户中收集和路由基于全局和美国南部以及美国东部位置的事件的路由:

curl -X PUT https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa   -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"  -d '{
    "name": "my-route",
    "rules": [
      {
        "locations": ["us-south", "global", "us-east],
        "target_ids": ["22222222-2222-2222-2222-222222222222"]
      }
    ]
  }'

使用 API 删除路由

可以使用以下 cURL 命令来删除路由:

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

位置

• <ENDPOINT> 是您计划在其中配置或管理路由的区域中的 API 端点。 有关更多信息，请参阅 端点。
• <ROUTE_ID> 是要删除的路由的 ID

例如，可以运行以下 cURL 请求以删除标识为 aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa 的路由:

curl -X DELETE  https://private.us-south.atracker.cloud.ibm.com/api/v2/routes/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

使用 API 查看路由

您可以使用以下 cURL 命令来查看 1 路由:

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

位置

• <ENDPOINT> 是您计划在其中配置或管理路由的区域中的 API 端点。 有关更多信息，请参阅 端点。
• <ROUTE_ID> 是要访存的路由的标识

例如，您可以运行以下 cURL 请求以获取有关标识为 aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa 的路由的信息:

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

使用 API 列出区域中的所有路径

您可以使用以下 cURL 命令来查看所有路由:

curl -X GET   <ENDPOINT>/api/v2/routes   -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/routes    -H "Authorization:  $ACCESS_TOKEN"   -H "content-type: application/json"

HTTP 响应代码

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

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

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

使用用户界面创建路由

1. 登录到 IBM Cloud 帐户。
2. 单击 菜单 图标 > 可观察性。
3. 选择 Activity Tracker。
4. 选择 路由。
5. 选择 路由。
6. 单击 创建 以打开创建页面。
7. 输入有意义的路由名称。
8. 在 路由规则中，修改 规则 1:
   • 发送审计事件: 选择将与此规则匹配的审计事件位置。
   • 目标: 选择将附加到此规则的目标。 单击 添加目标 以向规则添加更多目标。
9. 单击 添加规则 以向路径添加其他规则。
   • 路由规则的顺序会影响路由行为。 按顺序处理规则，一旦匹配了规则，就不会处理后续规则。
10. 每个规则都有一个向上和向下箭头，允许您更改规则顺序。
11. 每个规则都有一个 除去 按钮，允许您从路径中删除规则。
12. 查看路径定义，确保规则的顺序符合预期。
13. 单击创建。

使用 UI 更新路由

1. 登录到 IBM Cloud 帐户。
2. 单击 菜单 图标 > 可观察性。
3. 选择 Activity Tracker。
4. 选择 路由。
5. 选择 路由。
6. 确定要更新的路径，然后单击 。
7. 单击 重命名 以重命名路由。
8. 单击 编辑 以更新路由规则。
9. 如果需要，请编辑现有规则:
   • 发送审计事件: 选择将与此规则匹配的审计事件位置。
   • 目标: 选择将附加到此规则的目标。 单击 添加目标 以向规则添加更多目标。
10. 单击 添加规则 以向路径添加其他规则。

• 路由规则的顺序会影响路由行为。 按顺序处理规则，一旦匹配了规则，就不会处理后续规则。

11. 每个规则都有一个向上和向下箭头，允许您更改规则顺序。
12. 每个规则都有一个 除去 按钮，允许您从路径中删除规则。
13. 单击 更新 以更改路径。

使用 UI 查看路由

1. 登录到 IBM Cloud 帐户。
2. 单击 菜单 图标 > 可观察性。
3. 选择 Activity Tracker。
4. 选择 路由。
5. 选择 路由。
6. 路由表按创建日期排序。 路由的顺序不会影响路由行为。
7. 每个路由块都显示路由名称和规则。
8. “路由”页面还显示 路由指导 以及有关配置路由的其他信息。

使用 UI 删除路由

1. 登录到 IBM Cloud 帐户。
2. 单击 菜单 图标 > 可观察性。
3. 选择 Activity Tracker。
4. 选择 路由。
5. 选择 路由。
6. 确定要更新的路径，然后单击 。
7. 单击 删除 以删除整个路由。 在删除路由之前，必须输入路由名称。