1. 接口描述
接口请求域名: apm.tencentcloudapi.com 。
查询应用配置接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeApmApplicationConfig。 |
| Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 实例ID 示例值:apm-aadsad |
| ServiceName | 是 | String | 服务名称 示例值:java-order-service |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ApmAppConfig | ApmAppConfig | Apm应用配置 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取应用配置
获取应用配置
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApmApplicationConfig
<公共请求参数>
{
"InstanceId": "apm-eDyXPD6FF",
"ServiceName": "java-order-service"
}
输出示例
{
"Response": {
"ApmAppConfig": {
"AgentEnable": true,
"AgentOperationConfigView": {
"IgnoreOperation": "",
"RetentionOperation": "",
"RetentionValid": false
},
"Components": "io.opentelemetry.tomcat-10.0",
"DashboardTopicID": "",
"DisableCpuUsed": 0,
"DisableMemoryUsed": 0,
"EnableDashboardConfig": false,
"EnableLogConfig": true,
"EnableSecurityConfig": false,
"EnableSnapshot": false,
"ErrorCodeFilter": "",
"EventEnable": false,
"ExceptionFilter": "",
"IgnoreOperationName": "",
"InstanceKey": "apm-eDyXPD6FF",
"InstrumentList": [
{
"Enable": true,
"Name": "apm-spring-annotations"
}
],
"IsDeleteAnyFileAnalysis": 0,
"IsDeserializationAnalysis": 0,
"IsDirectoryTraversalAnalysis": 0,
"IsExpressionInjectionAnalysis": 0,
"IsIncludeAnyFileAnalysis": 0,
"IsInstrumentationVulnerabilityScan": 0,
"IsJNDIInjectionAnalysis": 0,
"IsJNIInjectionAnalysis": 0,
"IsMemoryHijackingAnalysis": 0,
"IsReadAnyFileAnalysis": 0,
"IsRelatedDashboard": 0,
"IsRelatedLog": 1,
"IsRemoteCommandExecutionAnalysis": 0,
"IsScriptEngineInjectionAnalysis": 0,
"IsSqlInjectionAnalysis": 0,
"IsTemplateEngineInjectionAnalysis": 0,
"IsUploadAnyFileAnalysis": 0,
"IsWebshellBackdoorAnalysis": 0,
"LogIndexType": 0,
"LogRegion": "ap-guangzhou",
"LogSet": "",
"LogSource": "",
"LogTopicID": "cbfe8676-9251-4915-a4ea-92d7f905da63",
"LogTraceIdKey": "",
"ServiceID": "svc-ELHkoErzzc",
"ServiceName": "java-order-service",
"SnapshotTimeout": 500,
"TraceRateLimit": 0,
"TraceSquash": true,
"UrlAutoConvergenceEnable": false,
"UrlConvergence": "",
"UrlConvergenceSwitch": 0,
"UrlConvergenceThreshold": 0,
"UrlExclude": "",
"UrlLongSegmentThreshold": 40,
"UrlNumberSegmentThreshold": 5
},
"RequestId": "9c2b84d6-c0e8-4bd2-8094-b4d427308397"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AppIdNotMatchInstanceInfo | AppID 和业务系统信息不匹配。 |
| FailedOperation.InstanceNotFound | APM 业务系统不存在。 |
| FailedOperation.InvalidServiceName | 业务系统和应用名不匹配。 |