应用性能监控获取 APM 接入点-业务系统相关接口-API 中心-腾讯云

1. 接口描述

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

获取 APM 接入点

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

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

4. 示例

示例1 获取 APM 接入点

获取 APM 接入点示例

输入示例

POST / HTTP/1.1
Host: apm.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. 开发者资源

腾讯云 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

命令行工具

Tencent Cloud CLI 3.0

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	参数错误。