API標準及多語言預置SDK
本產品（xtrace/2019-08-08）的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 |
標題 |
API概述 |
| GetTagKey | 擷取標籤Key | 調用GetTagKey介面擷取標籤鍵 |
| GetTagVal | 擷取標籤Value | 擷取上報的鏈路資料中指定Tag Key對應的Tag Value。 |
| GetTrace | 擷取調用鏈路詳情 | 調用GetTrace介面擷取調用鏈路詳情。 |
| ListIpOrHosts | 擷取IP地址或機器名 | 擷取鏈路資料中的IP地址或者機器名稱，可擷取整個地區或某個應用下的所有IP地址。 |
| ListServices | 擷取應用列表 | 調用ListServices擷取應用列表。 |
| ListSpanNames | 擷取所有Span名稱 | 擷取指定地區下所有的Span名稱，也可擷取某個微服務的所有Span名稱。 |
| QueryMetric | 查詢監控指標 | 調用QueryMetric查詢相關監控指標。 |
| SearchTraces | 查詢調用鏈列表 | 調用SearchTraces查詢調用鏈列表，可根據時間、應用程式名稱、IP地址、Span名稱、Tag等資訊對調用鏈進行過濾查詢。 |
存取控制
|
API |
標題 |
API概述 |
| OpenXtraceService | 开通可观测链路 OpenTelemetry 版 | 开通可观测链路 OpenTelemetry 版。 |
| CheckCommercialStatus | 检查商业化状态 | 检查商业化状态。 |