1. 接口描述
接口请求域名： apm.tencentcloudapi.com 。
通用查询调用链列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeGeneralSpanList。 |
| Version | 是 | String | 公共参数，本接口取值：2021-06-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 业务系统 ID 示例值：apm-CVfliqa8U |
| StartTime | 是 | Integer | Span 查询开始时间戳（单位：秒） 示例值：1617123538 |
| EndTime | 是 | Integer | Span 查询结束时间戳（单位：秒） 示例值：1617123538 |
| Filters.N | 否 | Array of Filter | 通用过滤参数 示例值：{ "Key": "service.name", "Type": "=", "Value": "java-order-service" } |
| OrderBy | 否 | OrderBy | 排序 现支持的 Key 有： - startTime(开始时间) - endTime(结束时间) - duration(响应时间) 现支持的 Value 有： - desc(降序排序) - asc(升序排序) 示例值：{ "Key": "startTime", "Value": "desc" } |
| BusinessName | 否 | String | 业务自身服务名，控制台用户请填写taw 示例值：taw |
| Limit | 否 | Integer | 单页项目个数，默认为10000，合法取值范围为0～10000 示例值：15 |
| Offset | 否 | Integer | 分页 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数量 示例值：200 |
| Spans | Array of Span | Span 分页列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通用查询调用链列表
根据 Trace ID 列表批量查询 Span，Filters 查询参数中将 Type 设置为 in ，将 Trace ID 列表通过,隔开
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralSpanList
<公共请求参数>
{
"OrderBy": {
"Value": "startTime",
"Key": "desc"
},
"Filters": [
{
"Key": "traceID",
"Type": "in",
"Value": "663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac"
}
],
"Limit": 0,
"Offset": 10,
"InstanceId": "apm-52Dpv13GR",
"StartTime": 1742374000,
"EndTime": 1742374331,
"BusinessName": "tdmq"
}输出示例
{
"Response": {
"TotalCount": 0,
"RequestId": "test-test-test",
"Spans": [
{
"TraceID": "663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac",
"Logs": [
{
"Timestamp": 0,
"Fields": [
{
"Type": "service.name",
"Value": "=",
"Key": "java-order-service"
}
]
}
],
"Tags": [
{
"Type": "service.name",
"Value": "=",
"Key": "java-order-service"
}
],
"Process": {
"ServiceName": "java-order-service",
"Tags": [
{
"Type": "service.name",
"Value": "=",
"Key": "java-order-service"
}
]
},
"Timestamp": 0,
"OperationName": "/test",
"References": [
{
"RefType": "1",
"SpanID": "4q6549c49aaa",
"TraceID": "663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac"
}
],
"StartTime": 0,
"Duration": 0,
"SpanID": "1q23w1q32165",
"StartTimeMillis": 0
}
]
}
}示例2 通用查询调用链列表2
指定 Tag 过滤条件拿到 Span 列表
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralSpanList
<公共请求参数>
{
"OrderBy": {
"Value": "startTime",
"Key": "desce"
},
"Filters": [
{
"Key": "pulsar:sub_name",
"Type": "=",
"Value": "participants"
}
],
"Limit": 0,
"Offset": 10,
"InstanceId": "52Dpv13GR",
"BusinessName": "tdmq",
"StartTime": 1621923035,
"EndTime": 1621923038
}输出示例
{
"Response": {
"TotalCount": 0,
"RequestId": "test-test-test",
"Spans": [
{
"TraceID": "663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac",
"Logs": [
{
"Timestamp": 0,
"Fields": [
{
"Type": "job",
"Value": "=",
"Key": "test1"
}
]
}
],
"Tags": [
{
"Type": "=",
"Value": "java-order-service",
"Key": "service.name"
}
],
"Process": {
"ServiceName": "java-order-service",
"Tags": [
{
"Type": "job",
"Value": "=",
"Key": "test2"
}
]
},
"Timestamp": 0,
"OperationName": "/testOperation",
"References": [
{
"RefType": "1",
"SpanID": "qertuytw",
"TraceID": "663727c6d5d4436dd1fcaa509d0f4dc0,6c2c8ebff420a8e5b2276ec799446f98,68d3062a4c559ba212a36f61c97ba8ac"
}
],
"StartTime": 0,
"Duration": 0,
"SpanID": "xasfvava",
"StartTimeMillis": 0
}
]
}
}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: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | AuthFailure.UnauthorizedOperation |
| FailedOperation | 操作失败。 |
| FailedOperation.AppIdNotMatchInstanceInfo | AppID 和业务系统信息不匹配。 |
| FailedOperation.InstanceIdIsEmpty | 业务系统 ID 为空。 |
| FailedOperation.InstanceNotFound | APM 业务系统不存在。 |
| InternalError | 内部错误。 |
