API概览

本产品(链路追踪/2019-08-08)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

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检查商业化状态检查商业化状态。