API標準及多語言預置SDK
本產品(Actiontrail/2020-07-06)的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK,開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜,需花費 5個工作日左右。因此建議加入我們的服務DingTalk群(147535001692),在專家指導下進行簽名對接。
在使用API前,您需要準備好身份帳號及存取金鑰(AccessKey),才能有效通過用戶端工具(SDK、CLI等)訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求,需通過自簽名方式對接 API,建議優先諮詢我們的支援人員團隊(服務DingTalk群:147535001692),擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露,所有相關資源都將面臨未經授權訪問的風險。為確保安全,建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey,同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下,才使用阿里雲帳號。
地域
|
API |
標題 |
API概述 |
| DescribeRegions | 查詢可以使用的阿里雲地區 | 查詢Action Trail支援的阿里雲地區。 |
追蹤
|
API |
標題 |
API概述 |
| CreateTrail | 建立跟蹤 | Action Trail預設為每個阿里雲帳號記錄最近90天的事件。為了能夠追溯90天以前的事件,您可以建立跟蹤,將操作事件投遞到Object Storage Service、Log ServiceSLS或MaxCompute,以便對事件進行分析。 |
| DeleteTrail | 刪除跟蹤 | 刪除Action Trail跟蹤。 |
| StartLogging | 啟用跟蹤 | 啟用跟蹤,開始將Action Trail事件投遞到 OSS 或 SLS 或 MaxCompute。 |
| UpdateTrail | 更新跟蹤 | 調整Action Trail跟蹤的配置資訊。 |
| StopLogging | 禁用跟蹤 | 停止跟蹤,停止將Action Trail事件投遞到 OSS 或 SLS 或 MaxCompute。 |
| GetTrailStatus | 查詢跟蹤狀態 | 查詢跟蹤的狀態。 |
| DescribeTrails | 查詢某地區的跟蹤列表 | 查看已建立的跟蹤列表。 |
| DescribeUserTrailCount | 查詢使用者跟蹤數量 | 查詢開啟的跟蹤個數,包含組織跟蹤。 |
| DescribeTrailDeliveryMetricData | 擷取投遞監控指標 | 擷取投遞監控指標。 |
事件
|
API |
標題 |
API概述 |
| LookupEvents | 檢索詳細事件 | 檢索詳細歷史事件。 |
資料回補
|
API |
標題 |
API概述 |
| CreateDeliveryHistoryJob | 建立資料回補投遞任務 | 建立資料回補投遞任務。 |
| DeleteDeliveryHistoryJob | 刪除資料回補投遞任務 | 刪除資料回補投遞任務。 |
| ListDeliveryHistoryJobs | 擷取資料回補投遞任務 | 查詢資料回補投遞工作清單。 |
| GetDeliveryHistoryJob | 查詢資料回補投遞任務詳情 | 查詢資料回補投遞任務詳情。 |
AccessKey 稽核
|
API |
標題 |
API概述 |
| GetAccessKeyLastUsedEvents | 查詢指定AccessKey的最後使用的事件記錄 | 查詢指定AccessKey的最後使用的事件記錄。 |
| GetAccessKeyLastUsedInfo | 查詢指定AccessKey的最後使用記錄 | 查詢指定AccessKey的最後使用記錄。 |
| GetAccessKeyLastUsedIps | 查詢指定AccessKey的最後使用的IP記錄 | 查詢指定AccessKey的最後使用的IP記錄。 |
| GetAccessKeyLastUsedProducts | 查詢指定AccessKey的最後使用的雲端服務記錄 | 查詢指定AccessKey的最後使用的雲端服務記錄。 |
| GetAccessKeyLastUsedResources | 查詢指定AccessKey的最後使用的資源記錄 | 查詢指定AccessKey的最後使用的資源記錄。 |
資料事件選擇器
|
API |
標題 |
API概述 |
| ListDataEventSelectors | 列舉所有資料事件選取器 | 本介面用於列舉所有資料事件選取器。 |
| GetDataEventSelector | 擷取資料事件選取器 | 本介面用於擷取指定跟蹤名稱的資料事件選取器詳細資料。 |
| PutDataEventSelector | 設定資料事件選取器 | 本介面用於建立或設定資料事件選取器。請注意:如要使用本介面建立資料事件選取器,必須保證跟蹤名稱存在。如不存在,請先調用CreateTrail介面建立跟蹤。 |
| DeleteDataEventSelector | 刪除資料事件選取器 | 本介面用於刪除指定跟蹤名稱的資料事件選取器。 |
事件洞察
|
API |
標題 |
API概述 |
| EnableInsight | 開啟審計事件洞察 | 開啟審計事件洞察。 |
| DisableInsight | 關閉審計事件洞察 | 關閉特定的InsightType。 |
| GetInsightTypes | 擷取審計事件洞察類型 | 擷取使用者開啟的所有InsightTypes。 |
| GetInsightSelectors | 擷取洞察選取器 | 擷取跟蹤需投遞的InsightTypes。 |
| GetInsightsEventsCount | 擷取洞察事件數目量 | 擷取當前帳號的Insights事件數目量。 |
| PutInsightSelectors | 設定洞察選取器 | 設定跟蹤需投遞的InsightTypes。 |
| LookupInsightEvents | 查詢洞察事件 | 查詢Insight事件。 |
其他
|
API |
標題 |
API概述 |
| UpdateAdvancedQueryTemplate | 更新進階查詢範本 | 更新進階查詢範本。 |
| GetGlobalEventsStorageRegion | 查詢全域事件儲存地區 | 查詢全域事件儲存地區。 |
| UpdateGlobalEventsStorageRegion | 設定全域事件儲存地域 | 設定全域事件儲存地域。 |
| CreateAdvancedQueryTemplate | 建立進階查詢範本 | 建立進階查詢範本。 |
| DeleteAdvancedQueryTemplate | 刪除進階查詢範本 | 刪除進階查詢範本 |
| DescribeAdvancedQueryTemplate | 查詢進階查詢範本 | 查詢進階查詢範本。 |
| DescribeUserAlertCount | 查詢使用者時間段內每日警示量 | 查詢使用者時間段內每日警示量。 |
| DescribeUserLogCount | 查詢使用者時間段內每日日誌量 | 查詢使用者時間段內每日日誌量。 |
| GetAdvancedQueryTemplate | 取得單個進階範本資訊 | 取得單個進階範本資訊。 |
| DeleteAdvancedQueryHistory | 刪除進階查詢歷史 | 本介面用於刪除指定進階查詢記錄。 |
| CreateAdvancedQueryHistory | 建立進階查詢歷史 | 本介面用於建立進階查詢記錄,支援儲存自訂查詢條件陳述式以供複用和管理。 |
| DescribeAdvancedQueryHistory | 查詢進階查詢歷史 | 本介面用於擷取所有進階查詢記錄。 |
| DescribeResourceLifeCycleEvents | 查詢資源生命週期事件 | 本介面用於查詢指定資源的生命週期事件。 |
| DescribeScenes | 查詢進階查詢情境 | 本介面用於查詢所有進階查詢情境。 |
| DescribeSearchTemplates | 查詢進階查詢系統模板 | 本介面用於查詢指定情境下的進階查詢系統模版。 |
| ListDataEventServices | 查詢資料事件支援服務與事件名稱 | 本介面用於查詢資料事件支援的服務與事件名稱。 |
| GetGovernanceMetrics | 查詢Action Trail成熟度等級 | 本介面用於查詢Action Trail成熟度等級。 |