管理目標
您可以使用 Activity Tracker Event Routing CLI、Activity Tracker Event Routing REST API 和 Terraform 腳本管理帳戶中的 IBM Cloud® Activity Tracker Event Routing 目標。 目標是一種可收集稽核事件的資源。
瞭解目標在您帳戶中的運作方式
請注意目標的下列相關資訊:
-
每個帳戶最多可設定 16 個目標。 每一個帳戶最多可以有 2 個預設目標。
-
目標用以定義用於收集稽核事件的資源。 路徑 定義如何將帳戶中產生的審核事件遞送至您配置的目標。
-
您可以在任何可使用 Activity Tracker Event Routing 的受支援位置中定義目標。 如需相關資訊,請參閱 位置。
-
目標在區域內建立,但在區域之間可見。 也就是說,所有目標都可以由任何 IBM Cloud® Activity Tracker Event Routing API 端點存取。
-
您可以使用專用和公用端點來管理目標。 如需可用的
ENDPOINTS清單的相關資訊,請參閱 端點。-
您可以使用下列格式的 API 端點,從專用網路管理目標:
https://private.REGION.atracker.cloud.ibm.com -
您可以使用下列格式的 API 端點,從公用網路管理目標:
https://REGION.atracker.cloud.ibm.com -
您可以透過更新帳戶設定來停用公用端點。 如需相關資訊,請參閱 強制專用端點。
-
目標類型
您可以設定以下任何一種目標類型:
| 目標 | 類型 | 進一步瞭解 |
|---|---|---|
| IBM Cloud Object Storage (COS) | cloud_object_storage |
管理 IBM Cloud Object Storage(COS)目標 |
| IBM® Event Streams for IBM Cloud® (Event Streams) | event_streams |
管理 IBM® Event Streams for IBM Cloud®(Event Streams)目標 |
| IBM Cloud Logs | cloud_logs |
管理 IBM Cloud Logs 目標 |
| IBM Cloud App Configuration | app_config |
管理 IBM Cloud App Configuration 目標 |
IAM 存取
您必須授與使用者 IAM 許可權來管理目標。 如需相關資訊,請參閱 指派對資源的存取權。
當您定義原則時,可以指出許可權的範圍。 您可以從授與特定地區或整個帳戶的許可權中選擇。
如果您擁有建立政策和授權的 IAM 權限,則您只能授予您作為目標服務使用者所擁有的存取等級。 例如,如果您對目標服務擁有「檢視者」權限,則在授權時僅需指派「檢視者」角色即可。 如果您嘗試指派較高的權限(例如管理員),可能會顯示已授予權限,但只會指派您對目標服務擁有的最高等級權限(即檢視者)。
具有區域範圍的使用者僅限於其授權區域中的存取目標。
| IAM 動作 | IAM 原則範圍 | IAM 角色 | 說明 |
|---|---|---|---|
atracker.target.read |
地區 | AdministratorEditorViewerOperator |
讀取 (檢視) 目標的相關資訊 |
atracker.target.create |
地區 | AdministratorEditor |
建立目標 |
atracker.target.update |
地區 | AdministratorEditor |
更新目標 |
atracker.target.delete |
地區 | AdministratorEditor |
刪除目標 |
atracker.target.list |
帳戶 | AdministratorEditorViewerOperator |
列出所有目標 |
鑑別選項
若要將事件遞送至目標,請檢查可用來鑑別該目標類型的選項。
| 目標 | 服務對服務 (S2S) 鑑別 | API 金鑰 |
|---|---|---|
cloud_object_storage |
||
event_streams |
||
cloud_logs |
||
app_config |
正在驗證目標
當您驗證目標時,您會檢查為目標配置的認證是否有效。 Activity Tracker Event Routing 會使用這些認證向目的地目標進行鑑別。
您可以使用 IBM Cloud Metrics Routing CLI、IBM Cloud Metrics Routing REST API 及 Terraform Script 來驗證目標。
| 目標類型 | CLI | API |
|---|---|---|
cloud-object-storage |
透過 CLI 驗證 | 透過 API 驗證 |
event_streams |
透過 CLI 驗證 | 透過 API 驗證 |
cloud_logs |
透過 CLI 驗證 | 透過 API 驗證 |
app_config |
透過 CLI 驗證 | 透過 API 驗證 |
CLI 必要條件
在使用 CLI 來管理目標之前,請完成下列步驟:
CLI 指令
下表列出了可用於管理目標的操作:
| 動作 | 指令 |
|---|---|
| 建立目標 | ibmcloud atracker target create |
| 更新目標 | ibmcloud atracker target update |
| 刪除目標 | ibmcloud atracker target delete |
| 讀取目標 | ibmcloud atracker target get |
| 列出所有目標 | ibmcloud atracker target ls |
| 驗證目標 | ibmcloud atracker target validate |
如需相關資訊,請參閱 IBM Cloud Activity Tracker Event Routing V2 CLI。
API 目標和動作
若要進行 API 呼叫以管理目標,請完成下列步驟:
- 取得 IAM 存取憑證。 如需相關資訊,請參閱 擷取 IAM 存取記號。
- 識別您計劃在其中配置或管理目標的地區中的 API 端點。 如需相關資訊,請參閱 端點。
下表列出了可用於管理目標的操作:
| 動作 | REST API 方法 | API_URL |
|---|---|---|
| 建立目標 | POST |
<ENDPOINT>/api/v2/targets |
| 更新目標 | PUT |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| 刪除目標 | DELETE |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| 讀取目標 | GET |
<ENDPOINT>/api/v2/targets/<TARGET_ID> |
| 列出所有目標 | GET |
<ENDPOINT>/api/v2/targets |
| 驗證目標 | POST |
<ENDPOINT>/api/v2/targets/{id}/validate |
如需相關資訊,請參閱 IBM Cloud Activity Tracker Event Routing V2 API。
HTTP 回應碼
當您使用 IBM Cloud Activity Tracker Event Routing REST API 時,您可以取得標準的 HTTP 回應代碼,以表示方法是否成功完成。
- 200 回應一律表示成功。
- 4xx 回應指出失敗。
- 5xx 回應通常指出內部系統錯誤。
請參閱下表中的一些 HTTP 回應代碼:
| 狀態碼 | 狀態 | 說明 |
|---|---|---|
200 |
OK | 已順利完成要求。 |
201 |
OK | 已順利完成要求。 已建立資源。 |
400 |
要求不正確 | 要求未順利完成。 您可能遺漏必要的參數。 |
401 |
未獲授權 | API 要求中使用的 IAM 記號無效或已過期。 |
403 |
禁止 | 由於權限不足,禁止作業。 |
404 |
找不到 | 所要求的資源不存在或已刪除。 |
429 |
太多要求 | 太多要求太快命中 API。 |
500 |
內部伺服器錯誤 | IBM Cloud Activity Tracker Event Routing 處理程序中發生錯誤。 |
下一步
選擇下列其中一個選項,以在您的帳戶中配置目標:
使用使用者介面管理目標
您可以使用 IBM 主控台來管理 IBM Cloud Activity Tracker Event Routing 目標、路徑和設定。
- 登入 IBM Cloud 帳戶。
- 點擊「選單」圖示
> 可觀測性。
- 選擇「活動追蹤」。
- 選擇路線。
如需相關資訊,請參閱 管理 IBM Cloud Logs 目標。