GetTrace - 获取调用链路详情 - 应用实时监控服务ARMS

调用GetTrace接口获取调用链路详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

xtrace:SearchTrace

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TraceID	string	是	调用链 ID，链路请求的唯一标识。可在控制台的调用链分析页面获取，也可通过 SearchTraces API 获取。	1c6881aab84191a4******
AppType	string	否	应用类型，取值为空或`XTRACE`，推荐设置为空。空：查询 XTRACE 和 ARMS 调用链。 `XTRACE`：只查询 XTRACE 调用链。	XTRACE
RegionId	string	是	地域 ID。	cn-beijing
PageNumber	integer	否	查询分页的页码。	1
PageSize	string	否	查询分页的每页项目数量，最大值为 100。	5

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	1E2B6A4C-6B83-4062-8B6F-AEEC1F******
Spans	object
Span	array<object>	Span 列表。
	array<object>	span 列表。
SpanId	string	Span ID。	fec891bb8f8XXX
HaveStack	boolean	是否有子 Span。取值： `true`：有子 Span。 `false`：无子 Span。	false
ServiceIp	string	服务 IP 地址，即 Span 所在的机器 IP 地址。	192.168.XXX.XXX
OperationName	string	Span 名称。	/api
ParentSpanId	string	父 Span ID。	fec891bb8f8XXX
ResultCode	string	返回码。	200
Duration	integer	耗时，单位为毫秒（ms）。	1000
RpcId	string	表示 Span 之间的父子兄弟关系。例如 1.1 是 1.1.1 的父亲 Span，而 1.1.2 和 1.1.1 是兄弟 Span。	1.1
Timestamp	integer	Span 的产生时间戳。单位为微秒（μm）。	1689845513298000
ServiceName	string	服务名称，又称为应用名称。	server1
TraceID	string	调用链 ID，链路请求的唯一标识。	1c6881aab84191a4
TagEntryList	object
TagEntry	array<object>	标签列表。
	object	标签列表。
Key	string	Span 的标签键。	logLevel
Value	string	Span 的标签值。	Warning
LogEventList	object
LogEvent	array<object>	日志事件列表。
	array<object>	日志事件列表。
Timestamp	integer	日志事件的产生时间戳。单位为微秒（μm）。	1689845513298000
TagEntryList	object
TagEntry	array<object>	标签列表。
	object	标签列表。
Key	string	日志事件的标签键。	logLevel
Value	string	日志事件的标签值。	Warning
StatusCode	integer	状态码。	200

示例

正常返回示例

JSON格式

{
  "RequestId": "1E2B6A4C-6B83-4062-8B6F-AEEC1F******",
  "Spans": {
    "Span": [
      {
        "SpanId": "fec891bb8f8XXX",
        "HaveStack": false,
        "ServiceIp": "192.168.XXX.XXX",
        "OperationName": "/api",
        "ParentSpanId": "fec891bb8f8XXX",
        "ResultCode": "200",
        "Duration": 1000,
        "RpcId": "1.1",
        "Timestamp": 1689845513298000,
        "ServiceName": "server1",
        "TraceID": "1c6881aab84191a4",
        "TagEntryList": {
          "TagEntry": [
            {
              "Key": "logLevel",
              "Value": "Warning"
            }
          ]
        },
        "LogEventList": {
          "LogEvent": [
            {
              "Timestamp": 1689845513298000,
              "TagEntryList": {
                "TagEntry": [
                  {
                    "Key": "logLevel",
                    "Value": "Warning"
                  }
                ]
              }
            }
          ]
        },
        "StatusCode": 200
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。