接口请求域名： apm.intl.tencentcloudapi.com 。
修改应用配置接口
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyApmApplicationConfig。 |
| Version | 是 | String | 公共参数，本接口取值：2021-06-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 业务系统 ID |
| ServiceName | 是 | String | 应用名 |
| UrlConvergenceSwitch | 是 | Integer | URL收敛开关,0 关 |
| UrlConvergenceThreshold | 否 | Integer | URL收敛阈值 |
| ExceptionFilter | 否 | String | 异常过滤正则规则，逗号分隔 |
| UrlConvergence | 否 | String | URL收敛正则规则，逗号分隔 |
| ErrorCodeFilter | 否 | String | 错误码过滤，逗号分隔 |
| UrlExclude | 否 | String | URL排除正则规则，逗号分隔 |
| IsRelatedLog | 否 | Integer | 日志开关 0 关 1 开 |
| LogRegion | 否 | String | 日志地域 |
| LogTopicID | 否 | String | 日志主题ID |
| LogSet | 否 | String | CLS 日志集 |
| LogSource | 否 | String | 日志来源 CLS |
| IgnoreOperationName | 否 | String | 需过滤的接口 |
| EnableSnapshot | 否 | Boolean | 是否开启线程剖析 |
| SnapshotTimeout | 否 | Integer | 线程剖析超时阈值 |
| AgentEnable | 否 | Boolean | 是否开启agent |
| TraceSquash | 否 | Boolean | 是否开启链路压缩 |
| EventEnable | 否 | Boolean | 是否开启应用诊断的开关 |
| InstrumentList.N | 否 | Array of Instrument | 组件列表 |
| AgentOperationConfigView | 否 | AgentOperationConfigView | 探针接口相关配置 |
| EnableLogConfig | 否 | Boolean | 是否开启应用日志配置 |
| EnableDashboardConfig | 否 | Boolean | 应用是否开启dashboard配置： false 关（与业务系统保持一致）/true 开（应用级配置） |
| IsRelatedDashboard | 否 | Integer | 是否关联dashboard： 0 关 1 开 |
| DashboardTopicID | 否 | String | dashboard ID |
| LogIndexType | 否 | Integer | CLS索引类型(0=全文索引，1=键值索引) |
| LogTraceIdKey | 否 | String | traceId的索引key: 当CLS索引类型为键值索引时生效 |
| EnableSecurityConfig | 否 | Boolean | 是否开启应用安全配置 |
| IsSqlInjectionAnalysis | 否 | Integer | 是否开启SQL注入分析 |
| IsInstrumentationVulnerabilityScan | 否 | Integer | 是否开启组件漏洞检测 |
| IsRemoteCommandExecutionAnalysis | 否 | Integer | 是否开启远程命令检测 |
| IsMemoryHijackingAnalysis | 否 | Integer | 是否开启内存马检测 |
| IsDeleteAnyFileAnalysis | 否 | Integer | 是否开启删除任意文件检测（0-关闭，1-开启） |
| IsReadAnyFileAnalysis | 否 | Integer | 是否开启读取任意文件检测（0-关闭，1-开启） |
| IsUploadAnyFileAnalysis | 否 | Integer | 是否开启上传任意文件检测（0-关闭，1-开启） |
| IsIncludeAnyFileAnalysis | 否 | Integer | 是否开启包含任意文件检测（0-关闭，1-开启） |
| IsDirectoryTraversalAnalysis | 否 | Integer | 是否开启目录遍历检测（0-关闭，1-开启） |
| IsTemplateEngineInjectionAnalysis | 否 | Integer | 是否开启模板引擎注入检测（0-关闭，1-开启） |
| IsScriptEngineInjectionAnalysis | 否 | Integer | 是否开启脚本引擎注入检测（0-关闭，1-开启） |
| IsExpressionInjectionAnalysis | 否 | Integer | 是否开启表达式注入检测（0-关闭，1-开启） |
| IsJNDIInjectionAnalysis | 否 | Integer | 是否开启JNDI注入检测（0-关闭，1-开启） |
| IsJNIInjectionAnalysis | 否 | Integer | 是否开启JNI注入检测（0-关闭，1-开启） |
| IsWebshellBackdoorAnalysis | 否 | Integer | 是否开启Webshell后门检测（0-关闭，1-开启） |
| IsDeserializationAnalysis | 否 | Integer | 是否开启反序列化检测（0-关闭，1-开启） |
| UrlAutoConvergenceEnable | 否 | Boolean | 接口自动收敛开关,0 关 |
| UrlLongSegmentThreshold | 否 | Integer | URL长分段收敛阈值 |
| UrlNumberSegmentThreshold | 否 | Integer | URL数字分段收敛阈值 |
| DisableMemoryUsed | 否 | Integer | 探针熔断内存阈值 |
| DisableCpuUsed | 否 | Integer | 探针熔断CPU阈值 |
| DbStatementParametersEnabled | 否 | Boolean | 是否开启SQL参数获取 |
| SlowSQLThresholds.N | 否 | Array of ApmTag | 慢SQL阈值 |
| EnableDesensitizationRule | 否 | Integer | 是否开启脱敏规则 |
| DesensitizationRule | 否 | String | 脱敏规则 |
| LogSpanIdKey | 否 | String | spanId的索引key: 当CLS索引类型为键值索引时生效 |
| AutoProfilingConfig | 否 | AutoProfilingConfig | 自动性能剖析任务配置 |
| EnableThresholdConfig | 否 | Boolean | 阈值配置开关。true 表示使用应用级阈值；false 表示使用业务系统级阈值 |
| ErrRateThreshold | 否 | Integer | 错误率阈值（%），用于判断应用健康状态为"红色" |
| ResponseDurationWarningThreshold | 否 | Integer | 响应时间预警阈值（ms），用于判断应用健康状态为"黄色" |
| UseDefaultFuseConfig | 否 | Boolean | 是否使用探针默认熔断阈值 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: apm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApmApplicationConfig
<公共请求参数>
{
"InstanceId": "apm-oJ7C40jYv",
"ServiceName": "springboot-service",
"UrlConvergenceSwitch": 0,
"UrlConvergenceThreshold": 1000,
"ExceptionFilter": "",
"UrlConvergence": "",
"ErrorCodeFilter": "",
"UrlExclude": "",
"IsRelatedLog": 0,
"LogRegion": "",
"LogTopicID": "",
"LogSet": "",
"LogSource": "CLS",
"IgnoreOperationName": "abc\nccc",
"EnableSnapshot": true,
"SnapshotTimeout": 2000,
"AgentEnable": true,
"TraceSquash": true,
"EventEnable": false,
"InstrumentList": [
{
"Name": "apm-spring-annotations",
"Enable": true
}
],
"AgentOperationConfigView": {
"RetentionValid": false,
"IgnoreOperation": "/test",
"RetentionOperation": ""
},
"EnableLogConfig": false,
"EnableDashboardConfig": false,
"IsRelatedDashboard": 0,
"DashboardTopicID": "",
"LogIndexType": 0,
"LogTraceIdKey": "",
"EnableSecurityConfig": false,
"IsSqlInjectionAnalysis": 1,
"IsInstrumentationVulnerabilityScan": 1,
"IsRemoteCommandExecutionAnalysis": 0,
"IsMemoryHijackingAnalysis": 0,
"IsDeleteAnyFileAnalysis": 0,
"IsReadAnyFileAnalysis": 0,
"IsUploadAnyFileAnalysis": 0,
"IsIncludeAnyFileAnalysis": 0,
"IsDirectoryTraversalAnalysis": 0,
"IsTemplateEngineInjectionAnalysis": 0,
"IsScriptEngineInjectionAnalysis": 0,
"IsExpressionInjectionAnalysis": 0,
"IsJNDIInjectionAnalysis": 0,
"IsJNIInjectionAnalysis": 0,
"IsWebshellBackdoorAnalysis": 0,
"IsDeserializationAnalysis": 0,
"UrlAutoConvergenceEnable": false,
"UrlLongSegmentThreshold": 40,
"UrlNumberSegmentThreshold": 5,
"DisableMemoryUsed": 60,
"DisableCpuUsed": 60,
"DbStatementParametersEnabled": true
}
{
"Response": {
"RequestId": "1514d407-9a83-4569-a9c6-0be6b2d6b9ca"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| FailedOperation.AgentOperationConfigInvalid | 探针接口相关配置错误 |
| FailedOperation.AppIdNotMatchInstanceInfo | AppID 和业务系统信息不匹配。 |
| FailedOperation.InstanceIdIsEmpty | 业务系统 ID 为空。 |
| FailedOperation.InvalidRegex | 非法的正则表达式。 |
文档反馈