ModifyApmApplicationConfig
Last updated: 2025-11-14 16:37:45
1. API Description
Domain name for API request: apm.intl.tencentcloudapi.com.
Modify application configurations
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyApmApplicationConfig. |
| Version | Yes | String | Common Params. The value used for this API: 2021-06-22. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Business system ID. |
| ServiceName | Yes | String | Application name |
| UrlConvergenceSwitch | Yes | Integer | URL convergence switch. 0: Off; 1: On |
| UrlConvergenceThreshold | No | Integer | URL convergence threshold |
| ExceptionFilter | No | String | Regex rules for exception filtering, separated by commas |
| UrlConvergence | No | String | Regex rules for URL convergence, separated by commas |
| ErrorCodeFilter | No | String | Error code filtering, separated by commas |
| UrlExclude | No | String | Regex rules for URL exclusion, separated by commas |
| IsRelatedLog | No | Integer | Log switch. 0: Off; 1: On |
| LogRegion | No | String | Log region. |
| LogTopicID | No | String | Log topic ID |
| LogSet | No | String | CLS log set/ES cluster ID |
| LogSource | No | String | Log source: CLS or ES |
| IgnoreOperationName | No | String | APIs to be filtered |
| EnableSnapshot | No | Boolean | Whether thread profiling is enabled. |
| SnapshotTimeout | No | Integer | Timeout threshold for thread profiling. |
| AgentEnable | No | Boolean | Whether agent is enabled. |
| TraceSquash | No | Boolean | Whether link compression is enabled. |
| EventEnable | No | Boolean | Switch for enabling application diagnosis. |
| InstrumentList.N | No | Array of Instrument | Component List |
| AgentOperationConfigView | No | AgentOperationConfigView | Related configurations of the probe APIs. |
| EnableLogConfig | No | Boolean | Whether to enable application log configuration. |
| EnableDashboardConfig | No | Boolean | Whether to enable the dashboard configuration for applications. false: disabled (consistent with the business system configuration); true: enabled (application-level configuration). |
| IsRelatedDashboard | No | Integer | Whether to associate with Dashboard. 0: disabled; 1: enabled. |
| DashboardTopicID | No | String | dashboard ID |
| LogIndexType | No | Integer | CLS index type. (0 = full-text index; 1 = key-value index). |
| LogTraceIdKey | No | String | Index key of traceId. It is valid when the CLS index type is key-value index. |
| EnableSecurityConfig | No | Boolean | Whether to enable the application security configuration. |
| IsSqlInjectionAnalysis | No | Integer | Whether to enable SQL injection analysis. |
| IsInstrumentationVulnerabilityScan | No | Integer | Whether to enable detection of component vulnerability. |
| IsRemoteCommandExecutionAnalysis | No | Integer | Whether remote command detection is enabled. |
| IsMemoryHijackingAnalysis | No | Integer | Whether to enable detection of Java webshell. |
| IsDeleteAnyFileAnalysis | No | Integer | Whether to enable the detection of deleting arbitrary files. (0 - disabled; 1: enabled.) |
| IsReadAnyFileAnalysis | No | Integer | Whether to enable the detection of reading arbitrary files. (0 - disabled; 1 - enabled.) |
| IsUploadAnyFileAnalysis | No | Integer | Whether to enable the detection of uploading arbitrary files. (0 - disabled; 1 - enabled.) |
| IsIncludeAnyFileAnalysis | No | Integer | Whether to enable the detection of the inclusion of arbitrary files. (0: disabled, 1: enabled.) |
| IsDirectoryTraversalAnalysis | No | Integer | Whether to enable traversal detection of the directory. (0 - disabled; 1 - enabled). |
| IsTemplateEngineInjectionAnalysis | No | Integer | Whether to enable template engine injection detection. (0: disabled; 1: enabled.) |
| IsScriptEngineInjectionAnalysis | No | Integer | Whether to enable script engine injection detection. (0 - disabled; 1 - enabled.) |
| IsExpressionInjectionAnalysis | No | Integer | Whether to enable expression injection detection. (0 - disabled; 1 - enabled.) |
| IsJNDIInjectionAnalysis | No | Integer | Whether to enable JNDI injection detection. (0 - disabled; 1 - enabled.) |
| IsJNIInjectionAnalysis | No | Integer | Whether to enable JNI injection detection. (0 - disabled, 1 - enabled). |
| IsWebshellBackdoorAnalysis | No | Integer | Whether to enable Webshell backdoor detection. (0 - disabled; 1 - enabled). |
| IsDeserializationAnalysis | No | Integer | Whether to enable deserialization detection. (0 - disabled; 1 - enabled). |
| UrlAutoConvergenceEnable | No | Boolean | Automatic convergence switch for APIs. 0: disabled | 1: enabled. |
| UrlLongSegmentThreshold | No | Integer | Convergence threshold for URL long segments. |
| UrlNumberSegmentThreshold | No | Integer | Convergence threshold for URL numerical segments. |
| DisableMemoryUsed | No | Integer | Specifies the memory threshold for probe fusing. |
| DisableCpuUsed | No | Integer | Specifies the CPU threshold for probe fusing. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Modifying Application Configuration
This example shows you how to modify the application configuration.
Input Example
POST / HTTP/1.1
Host: apm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApmApplicationConfig
<Common request parameters>
{
"InstanceId": "apm-1o8yMC47u",
"ServiceName": "java-market-service11",
"ExceptionFilter": "stock(.*?),ppp(.*?)",
"UrlConvergence": "stock(.*?),ppp(.*?)",
"ErrorCodeFilter": "500,400",
"UrlConvergenceSwitch": 1,
"UrlConvergenceThreshold": 500,
"UrlExclude": "33132",
"EnableSnapshot": false,
"SnapshotTimeout": 2000
}Output Example
{
"Response": {
"RequestId": "wcl-9esoxoii8t2exer215won26rkzc8"
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.AgentOperationConfigInvalid | Error in related configurations of the probe APIs. |
| FailedOperation.AppIdNotMatchInstanceInfo | The appid does not match the business system information. |
| FailedOperation.InstanceIdIsEmpty | Business system id is empty. |
| FailedOperation.InvalidRegex | Invalid regular expression. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback