帮你快速理解、总结文档立即下载
文档中心>API 中心>应用性能监控>通用查询相关接口>根据链路查询目标服务的上下游服务

根据链路查询目标服务的上下游服务

最近更新时间：2026-09-02 01:10:41
我的收藏

本页目录：

1. 接口描述

接口请求域名： apm.tencentcloudapi.com 。

根据链路查询目标服务的上下游相关服务

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeRelatedServicesOnTrace。
Version 是 String 公共参数，本接口取值：2021-06-22。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 业务系统 ID
示例值：apm-6xYKFXYxo
StartTime 是 Integer 查询开始时间
示例值：1764101580
EndTime 是 Integer 查询结束时间
示例值：1764144780
ServiceName 否 String 应用名
示例值：service-A
IsServiceTopology 否 Boolean 是否为应用拓扑查询
示例值：false

3. 输出参数

参数名称 类型 描述
TotalTraces Integer 查询的总链路数
示例值：0
TotalServices Integer 查询到的应用的数量
示例值：1
SelectedTraces Integer 挑选的链路数量
示例值：0
ServiceRelations Array of ServiceRelation 相关的服务/应用名列表
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询与目标应用存在调用关联的上下游服务

查询与目标应用存在调用关联的上下游服务

输入示例

POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRelatedServicesOnTrace
<公共请求参数>

{
    "InstanceId": "apm-6xYKFXYxo",
    "StartTime": 1764101580,
    "EndTime": 1764144780,
    "ServiceName": "service-A",
    "IsServiceTopology": false
}

输出示例

{
    "Response": {
        "SelectedTraces": 0,
        "ServiceRelations": [
            {
                "DownstreamServices": [],
                "ServiceName": "service-A",
                "UpstreamServices": []
            }
        ],
        "TotalServices": 1,
        "TotalTraces": 0,
        "RequestId": "434b0ac9-870c-43a9-b83f-40d930d24e77"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure.UnauthorizedOperation AuthFailure.UnauthorizedOperation
FailedOperation.AppIdNotMatchInstanceInfo AppID 和业务系统信息不匹配。
FailedOperation.InstanceNotFound APM 业务系统不存在。
中国站