tencent cloud

应用性能监控

获取 APM 接入点

Download
聚焦模式
字号
最后更新时间: 2026-05-14 20:28:53

1. 接口描述

接口请求域名: apm.intl.tencentcloudapi.com 。

获取 APM 接入点

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeApmAgent。
Version String 公共参数,本接口取值:2021-06-22。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 业务系统 ID
AgentType String 接入方式,现支持 skywalking, ot, ebpf 方式接入上报,不填默认为 ot
NetworkMode String 上报环境,现支持 pl (内网上报), public (外网), inner (自研 VPC )环境上报,不传默认为 public
LanguageEnvironment String 语言,现支持 java, golang, php, python, dotNet, nodejs 语言上报,不传默认为 golang
ReportMethod String 上报方式,已弃用

3. 输出参数

参数名称 类型 描述
ApmAgent ApmAgentInfo Agent 信息
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取 APM 接入点

获取 APM 接入点示例

输入示例

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

{
    "InstanceId": "jYm6_leMg"
}

输出示例

{
    "Response": {
        "ApmAgent": {
            "CollectorURL": "http://127.0.0.1:8080",
            "AgentDownloadURL": "https://agent.tapm.tencentyun.com/DownloadAgent",
            "Token": "14dac76ca10f4610f727ca68528758b43980251387493706d18988fa7d0621b7",
            "PublicCollectorURL": "http://127.0.0.1:8080",
            "InnerCollectorURL": "http://127.0.0.1:8080",
            "PrivateLinkCollectorURL": "http://127.0.0.1:8080"
        },
        "RequestId": "mzltx5whme-zl7je3p16tk5fwtb7ht61"
    }
}

5. 开发者资源

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation AuthFailure.UnauthorizedOperation
FailedOperation 操作失败。
FailedOperation.AppIdNotMatchInstanceInfo AppID 和业务系统信息不匹配。
FailedOperation.DemoInstanceNotAllowModified 未命中白名单且业务系统 ID 为官方 Demo 业务系统 ID 时,不允许修改接口。
FailedOperation.InstanceIdIsEmpty 业务系统 ID 为空。
FailedOperation.InstanceNotFound APM 业务系统不存在。
FailedOperation.NotInnerVPC 非内网 VPC。
InternalError 内部错误。
InvalidParameter 参数错误。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈