1. 接口描述
接口请求域名: apm.tencentcloudapi.com 。
查询trace详情接口信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSpanTreeByID。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 业务系统 ID 示例值:apm-52Dpv13GR |
| Filters.N | 是 | Array of Filter | TraceID |
| StartTime | 是 | Integer | Span查询开始时间戳(单位:秒) 示例值:1617123538 |
| EndTime | 是 | Integer | Span查询结束时间戳(单位:秒) 示例值:1617123538 |
| IsFold | 否 | Boolean | 代表请求的是否为完整瀑布图 示例值:false |
| EntrySpanSelected | 否 | Boolean | 开启关键调用视图 示例值:true |
| FocusSpanId | 否 | String | 关注的SpanId 示例值:da21f86a7f76f925 |
| FilterViewTagKeyList.N | 否 | Array of String | 过滤视图的Tag列表 示例值:["peer.service"] |
| EnableResourceLink | 否 | Boolean | 是否开启云资源关联 示例值:false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SpanTreeView | SpanTreeView | 树形图 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询trace详情接口信息
查询trace详情接口信息示例
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSpanTreeByID
<公共请求参数>
{
"InstanceId": "apm-059oXBfTL",
"Filters": [
{
"Type": "=",
"Key": "traceID",
"Value": "97984ab4e9053954277fe0b34064fbe4"
}
],
"StartTime": 1734847016,
"EndTime": 1734933416
}
输出示例
{
"Response": {
"RequestId": "363b22b9-cf43-4a31-bf51-436a1266f4d6",
"SpanTreeView": {
"ChartData": {
"Series": [
{
"Data": [
0,
170
],
"Name": "startTime",
"Stack": "series"
},
{
"Data": [
3000643,
3000303
],
"Name": "timeConsuming",
"Stack": "series"
}
],
"YAxis": [
{
"Data": [
""
],
"Keys": [
""
]
}
]
},
"CntExceeded": false,
"CompressedTreeData": "H4sIAAAAAAAA/8RWzW7cNhB+FYOnFpBo6nclXe0gXSRtiuyil8AwKGlWZlYiCYpa2zB8KPoKPbWnAj301h5678u0aR+jEHedpXYV23Gc5LZcfpz55uPwG726QtNjlCGfemEOeRr5RQlRtEAOOhJcA9coQ0K7r+mKukKVoNwW1IoVcHAohezk4RUrr5GDZut/v6ENvOsEctALCYpqJvgGN4wxp/l3DM5blL266hfP4BJliPGVWMJ6+xlcbk7+98cP//74m/m3Wh9YGvSZ1hI3oM9EiRy0onXXo58+maNrZ4BpNdVde1qIEiygTwi6Pumhb/N/LRQczCTlB1O+EKox/HfpvPn5z39+/alH/f3XL2++/32fWCEaKXgv6DabFk1BtcVsoxRmvNWUFzYzj+CE4ABPUguvFS1gemzB0kmahDQPISVRkEahP5ksgORBSOJwkUNoJ5OU4yXjtlA9AVAWSAIovGB1DTbsQVG2bTAWZlP5/WQSnRoE4l1d2/u0kTUorC+ljVJUQ80aphmvLDQHjQ1BJvf0DnGUjEGlUDbDIPZi38KNRNq5OdODSnTaJmg/hy1U3DwaC/nVfP7twbCrb4qWVNFmkJ5gYuEaaFta2WldO5liFeN4LOc4O1PImWj1XsV+FODEy9KAePdr8bVlSOAaamhAq0tX03O3EcXSlUq8hkK7JEqFG+flokzysojdZeuHqy+2En+5S01TVYHeL2PAaesFpxcXOzKfGk8YuTisYK8RxzWiFXCNV6DaoaLDWj3sxa5P/IAkAfEmuzm7FtSpiWRFKDpVH06wnw6uuL8OzHtn+njirjU7GtgnGWwrPWc2BW8ShGkQhF4QeZMtEnj5Dlw8wNWUVx2t4MmFVnSnsN6zTxx0dMbqUgE3tmvmWhymJPEg9SGJ40UI95hrL/rVU+D9A4AerERt3lV/sw+edHdFHZ99jzR7HtKztxjB7bU8Ytt/gjb+kPrGRh/jGhSn9edxvLsG4+3ef9sMbqVivHLPIW9Wxftr8D4hP+yj5g5b+oR38XkdsL95B82MHCgjDnrOOKDM9Rw0bfumpozPNC2WZtP82j183G2eRhYQQgISbHCzt5WZuKKardsuQ8gsX0JlTvXLafsSaqqhfC6qG/hcSFYYe17jZ6DNx+DJo/KNw4/O938AAAD//wEAAP//E/t39j4NAAA=",
"QueryTimeout": false,
"TraceOverview": {
"Duration": 3000643,
"ErrorMsg": "nil",
"Operation": "/popup/{id}",
"ServiceName": "ot-java-order-service",
"Status": 0,
"TraceID": "97984ab4e9053954277fe0b34064fbe4"
},
"TreeData": ""
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | AuthFailure.UnauthorizedOperation |
| FailedOperation | 操作失败。 |
| FailedOperation.AppIdNotMatchInstanceInfo | AppID 和业务系统信息不匹配。 |
| FailedOperation.InstanceIdIsEmpty | 业务系统 ID 为空。 |
| FailedOperation.InstanceNotFound | APM 业务系统不存在。 |
| FailedOperation.InvalidQueryTimeInterval | 查询起始时间应小于当前时间。 |
| FailedOperation.ItemNotFound | 查询结果为空。 |
| FailedOperation.QueryTimeIntervalConflict | 查询起始时间应小于终止时间。 |
| FailedOperation.QueryTraceIsEmpty | 当前查询trace不存在。 |
| FailedOperation.ShortQueryTime | 当前trace生成时间较短,可能会存在链路不全的情况。 |
| FailedOperation.Timeout | 超时。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| UnknownParameter | 未知参数错误。 |