本產品（
應用實時監控服務ARMS/2019-08-08）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
監控指標
| API | 標題 | API概述 |
|---|---|---|
| QueryMetricByPage | 查詢監控指標 | 分頁查詢應用監控或前端監控的相關監控指標。 |
應用監控
| API | 標題 | API概述 |
|---|---|---|
| GetTraceApp | 獲取應用監控任務詳情 | 獲取應用監控任務詳情。 |
| GetAppJVMConfig | 獲取應用各個實例的JVM配置信息 | 獲取應用各個實例的JVM配置信息。 |
| QueryAppTopology | 查詢拓撲圖 | |
| GetAppApiByPage | 查詢接口的黃金三指標數據 | 通過分頁的形式查詢應用下每個接口的請求量、錯誤數、平均響應時間三種性能數據?？赏ㄟ^返回信息中的Completed字段判斷分頁是否結束。如未結束，CurrentPage參數加一后繼續發起查詢即可。 |
| GetTrace | 獲取調用鏈詳情 | 加快獲取調用鏈詳情。 |
| GetStack | 獲取調用鏈方法棧 | 獲取調用鏈方法棧信息。 |
| GetMultipleTrace | 獲取多個調用鏈詳情 | 獲取多個調用鏈的詳情。 |
| ConfigApp | 打開或關閉應用監控總開關 | 打開或關閉應用監控的Agent總開關，或者查詢Agent總開關的狀態。 |
| SaveTraceAppConfig | 應用監控自定義設置 | 進行應用監控的自定義設置（如調用鏈采樣設置、Agent開關等）。 |
| GetTraceAppConfig | 查詢應用監控自定義設置 | 查詢應用監控中，某個應用的全部自定義設置（如調用鏈采樣設置、Agent開關等）。此接口僅適用于接入應用監控的應用，不適用于接入可觀測鏈路 OpenTelemetry 版的應用。 |
| DeleteTraceApp | 刪除指定ID和類型的應用 | 刪除指定ID或類型的應用。 |
| QueryReleaseMetric | 查看不同版本的指標 | 查詢EDAS和K8s應用發布過程中不同版本的指標。 |
| ListTraceApps | 獲取指定地域下全部應用監控任務的列表 | 獲取指定地域下全部應用監控任務的列表。 |
| SearchTraceAppByName | 按應用名稱查詢應用監控任務 | 按應用名稱查詢應用監控任務。 |
| SearchTraceAppByPage | 分頁查詢應用監控任務 | 分頁查詢應用監控任務。 |
| SearchTraces | 查詢調用鏈列表信息 | 查詢調用鏈列表信息，可根據時間、應用名稱、IP地址、Span名稱和Tag等信息篩選調用鏈。 |
| SearchTracesByPage | 分頁查詢調用鏈列表信息 | 分頁查詢調用鏈列表信息，可根據時間、應用名稱、IP地址、Span名稱和Tag等信息篩選調用鏈。 |
| GetAgentDownloadUrlV2 | 獲取探針下載鏈接V2 | 獲取探針下載地址。 |
| GetAgentDownloadUrl | 獲取探針下載鏈接 | 獲取探針下載鏈接。 |
| DescribeTraceLicenseKey | 列出LicenseKey | 列出LicenseKey。 |
| ListInsightsEvents | 查詢異常事件列表 | 查詢指定時間段內Insights的異常事件列表。 |
| QueryAppMetadata | 查詢編碼映射內容 | 根據ID和類型查詢編碼映射內容。 |
| DeleteAppList | 批量刪除應用 | 根據應用監控PID列表，批量刪除應用。 |
| DoInsightsAction | 訪問Insights相關的各種子功能 | 根據參數指定的模塊類型，執行相應的動作 |
訪問控制
| API | 標題 | API概述 |
|---|---|---|
| OpenArmsServiceSecondVersion | 開通ARMS | 開通ARMS下指定子產品的后付費功能。 |
| OpenXtraceDefaultSLR | 開通可觀測鏈路 OpenTelemetry 版服務關聯角色 | 開通可觀測鏈路 OpenTelemetry 版服務關聯角色AliyunServiceRoleForXtrace。 |
| OpenArmsDefaultSLR | 開通ARMS服務關聯角色 | 開通ARMS服務關聯角色AliyunServiceRoleForARMS。 |
| ChangeResourceGroup | ARMS資源轉組 | 修改資源所屬資源組。 |
| TagResources | 創建標簽資源關系 | 用于給ARMS資源實例打標簽。 |
| UntagResources | 刪除標簽資源關系 | 用于刪除ARMS資源實例標簽。 |
產品計費
| API | 標題 | API概述 |
|---|---|---|
| GetCommercialStatus | 獲取商業化狀態 | 查看當前賬號是否開通對應產品的商業化版本。 |
| CheckCommercialStatus | 檢查產品商業化狀態 | 檢查產品的商業化開通狀態。 |
| QueryCommercialUsage | 查詢可觀測用量數據 | 查詢寫入量數據，支持應用監控、可觀測鏈路OpenTelemetry版、Prometheus、用戶體驗監控四大產品用量數據。 |