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> 是要更新之路徑的 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 要求，以刪除 ID 為 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> 是要提取之路徑的 ID

例如，您可以執行下列 cURL 要求，以取得 ID 為 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. 選擇「活動追蹤」。
4. 選取 路徑。
5. 按一下 建立 以開啟建立頁面。
6. 輸入路徑的有意義名稱。
7. 在 遞送規則中，修改 規則 1:
   • 傳送審核事件來源: 選取將符合此規則的審核事件位置。
   • 目標: 選取將附加至此規則的目標。 按一下 新增目標，以將更多目標新增至規則。
8. 按一下 新增規則，以將其他規則新增至路徑。
   • 遞送規則的順序會影響遞送行為。 規則會依序處理，一旦符合規則，就不會處理後續的規則。
9. 每一個規則都有一個向上及向下箭頭，可讓您變更規則順序。
10. 每一個規則都有一個 移除 按鈕，可讓您從路徑中刪除規則。
11. 請檢閱路徑定義，確定規則的順序符合預期。
12. 按一下建立。

使用使用者介面更新路徑

1. 登入 IBM Cloud 帳戶。
2. 點擊「選單」圖示 > 可觀測性。
3. 選擇「活動追蹤」。
4. 選取 路徑。
5. 決定要更新的路徑，然後按一下 。
6. 按一下 重新命名 以重新命名路由。
7. 按一下 編輯 以更新路由規則。
8. 如果需要，請編輯現有規則:
   • 傳送審核事件來源: 選取將符合此規則的審核事件位置。
   • 目標: 選取將附加至此規則的目標。 按一下 新增目標，以將更多目標新增至規則。
9. 按一下 新增規則，以將其他規則新增至路徑。
   • 遞送規則的順序會影響遞送行為。 規則會依序處理，一旦符合規則，就不會處理後續的規則。
10. 每一個規則都有一個向上及向下箭頭，可讓您變更規則順序。
11. 每一個規則都有一個 移除 按鈕，可讓您從路徑中刪除規則。
12. 按一下 更新，以變更您的路徑。

使用使用者介面檢視路由

1. 登入 IBM Cloud 帳戶。
2. 點擊「選單」圖示 > 可觀測性。
3. 選擇「活動追蹤」。
4. 選取 路徑。
5. 路由表依建立日期排序。 路徑的順序不會影響遞送行為。
6. 每一個路由區塊都會顯示路由名稱及規則。
7. 遞送頁面也會顯示 遞送指引，以及配置遞送的其他相關資訊。

使用使用者介面刪除路徑

1. 登入 IBM Cloud 帳戶。
2. 點擊「選單」圖示 > 可觀測性。
3. 選擇「活動追蹤」。
4. 選取 路徑。
5. 決定要更新的路徑，然後按一下 。
6. 按一下 刪除，以刪除整個路由。 在刪除路徑之前，您必須先輸入路徑名稱。