接口请求域名： apm.intl.tencentcloudapi.com 。
通用查询调用链列表
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeGeneralSpanList。 |
| Version | 是 | String | 公共参数，本接口取值：2021-06-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 业务系统 ID |
| StartTime | 是 | Integer | Span 查询开始时间戳（单位：秒） |
| EndTime | 是 | Integer | Span 查询结束时间戳（单位：秒） |
| Filters.N | 否 | Array of Filter | 通用过滤参数 支持的过滤key如service.name |
| OrderBy | 否 | OrderBy | 排序
现支持的 Value 有：
|
| BusinessName | 否 | String | 业务自身服务名，控制台用户请填写taw |
| Limit | 否 | Integer | 单页项目个数，默认为1000，合法取值范围为1～1000 |
| Offset | 否 | Integer | 分页 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数量 |
| Spans | Array of Span | Span 分页列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
根据 Trace ID 列表批量查询 Span，Filters 查询参数中将 Type 设置为 in ，将 Trace ID 列表通过,隔开
POST / HTTP/1.1
Host: apm.intl.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
}
]
}
}
指定 Tag 过滤条件拿到 Span 列表
POST / HTTP/1.1
Host: apm.intl.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
}
]
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | AuthFailure.UnauthorizedOperation |
| FailedOperation | 操作失败。 |
| FailedOperation.AppIdNotMatchInstanceInfo | AppID 和业务系统信息不匹配。 |
| FailedOperation.InstanceIdIsEmpty | 业务系统 ID 为空。 |
| FailedOperation.InstanceNotFound | APM 业务系统不存在。 |
| InternalError | 内部错误。 |
文档反馈