修改应用配置(推荐)

最近更新时间:2026-03-25 01:11:10

我的收藏

1. 接口描述

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

修改应用配置接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyApmApplicationConfig。
Version String 公共参数,本接口取值:2021-06-22。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String

业务系统 ID


示例值:apm-1o8yMC47u
ServiceName String

应用名


示例值:java-market-service
UrlConvergenceSwitch Integer

URL收敛开关,0 关 | 1 开


示例值:1
UrlConvergenceThreshold Integer

URL收敛阈值


示例值:500
ExceptionFilter String

异常过滤正则规则,逗号分隔


示例值:stock(.?),ppp(.?)
UrlConvergence String

URL收敛正则规则,逗号分隔


示例值:stock(.?),ppp(.?)
ErrorCodeFilter String

错误码过滤,逗号分隔


示例值:500,400
UrlExclude String

URL排除正则规则,逗号分隔


示例值:stock(.?),ppp(.?)
IsRelatedLog Integer

日志开关 0 关 1 开


示例值:0
LogRegion String

日志地域


示例值:ap-guangzhou
LogTopicID String

日志主题ID


示例值:84bac169-79d8-4409-8e56-aebcf63b5783
LogSet String

CLS 日志集 | ES 集群ID


示例值:postgres
LogSource String

日志来源 CLS | ES


示例值:CLS
IgnoreOperationName String

需过滤的接口


示例值:getOrderInfo
EnableSnapshot Boolean

是否开启线程剖析


示例值:false
SnapshotTimeout Integer

线程剖析超时阈值


示例值:2000
AgentEnable Boolean

是否开启agent


示例值:true
TraceSquash Boolean

是否开启链路压缩


示例值:false
EventEnable Boolean

是否开启应用诊断的开关


示例值:true
InstrumentList.N Array of Instrument

组件列表

AgentOperationConfigView AgentOperationConfigView

探针接口相关配置

EnableLogConfig Boolean

是否开启应用日志配置


示例值:false
EnableDashboardConfig Boolean

应用是否开启dashboard配置: false 关(与业务系统保持一致)/true 开(应用级配置)


示例值:false
IsRelatedDashboard Integer

是否关联dashboard: 0 关 1 开


示例值:0
DashboardTopicID String

dashboard ID


示例值:2bl22vlyd6gq0wx3
LogIndexType Integer

CLS索引类型(0=全文索引,1=键值索引)


示例值:0
LogTraceIdKey String

traceId的索引key: 当CLS索引类型为键值索引时生效


示例值:trace_id
EnableSecurityConfig Boolean

是否开启应用安全配置


示例值:false
IsSqlInjectionAnalysis Integer

是否开启SQL注入分析


示例值:0
IsInstrumentationVulnerabilityScan Integer

是否开启组件漏洞检测


示例值:0
IsRemoteCommandExecutionAnalysis Integer

是否开启远程命令检测


示例值:0
IsMemoryHijackingAnalysis Integer

是否开启内存马检测


示例值:0
IsDeleteAnyFileAnalysis Integer

是否开启删除任意文件检测(0-关闭,1-开启)


示例值:0
IsReadAnyFileAnalysis Integer

是否开启读取任意文件检测(0-关闭,1-开启)


示例值:0
IsUploadAnyFileAnalysis Integer

是否开启上传任意文件检测(0-关闭,1-开启)


示例值:0
IsIncludeAnyFileAnalysis Integer

是否开启包含任意文件检测(0-关闭,1-开启)


示例值:0
IsDirectoryTraversalAnalysis Integer

是否开启目录遍历检测(0-关闭,1-开启)


示例值:0
IsTemplateEngineInjectionAnalysis Integer

是否开启模板引擎注入检测(0-关闭,1-开启)


示例值:0
IsScriptEngineInjectionAnalysis Integer

是否开启脚本引擎注入检测(0-关闭,1-开启)


示例值:0
IsExpressionInjectionAnalysis Integer

是否开启表达式注入检测(0-关闭,1-开启)


示例值:0
IsJNDIInjectionAnalysis Integer

是否开启JNDI注入检测(0-关闭,1-开启)


示例值:0
IsJNIInjectionAnalysis Integer

是否开启JNI注入检测(0-关闭,1-开启)


示例值:0
IsWebshellBackdoorAnalysis Integer

是否开启Webshell后门检测(0-关闭,1-开启)


示例值:0
IsDeserializationAnalysis Integer

是否开启反序列化检测(0-关闭,1-开启)


示例值:0
UrlAutoConvergenceEnable Boolean

接口自动收敛开关,0 关 | 1 开


示例值:false
UrlLongSegmentThreshold Integer

URL长分段收敛阈值


示例值:40
UrlNumberSegmentThreshold Integer

URL数字分段收敛阈值


示例值:5
DisableMemoryUsed Integer

探针熔断内存阈值


示例值:90
DisableCpuUsed Integer

探针熔断CPU阈值


示例值:90
DbStatementParametersEnabled Boolean

是否开启SQL参数获取


示例值:false
SlowSQLThresholds.N Array of ApmTag

慢SQL阈值

EnableDesensitizationRule Integer

是否开启脱敏规则


示例值:1
DesensitizationRule String

脱敏规则


示例值:email,password
LogSpanIdKey String

spanId的索引key: 当CLS索引类型为键值索引时生效


示例值:span_id
AutoProfilingConfig AutoProfilingConfig

自动性能剖析任务配置

EnableThresholdConfig Boolean

阈值配置开关。true 表示使用应用级阈值;false 表示使用业务系统级阈值


示例值:true
ErrRateThreshold Integer

错误率阈值(%),用于判断应用健康状态为"红色"


示例值:5
ResponseDurationWarningThreshold Integer

响应时间预警阈值(ms),用于判断应用健康状态为"黄色"


示例值:500
UseDefaultFuseConfig Boolean

是否使用探针默认熔断阈值


示例值:false

3. 输出参数

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

4. 示例

示例1 成功示例

输入示例

POST / HTTP/1.1
Host: apm.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"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.AgentOperationConfigInvalid 探针接口相关配置错误
FailedOperation.AppIdNotMatchInstanceInfo AppID 和业务系统信息不匹配。
FailedOperation.InstanceIdIsEmpty 业务系统 ID 为空。
FailedOperation.InvalidRegex 非法的正则表达式。