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.
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 |
| UrlConvergenceThreshold | No | Integer | URL convergence threshold |
| ExceptionFilter | No | String | Exception filtering regex rules, comma-separated |
| UrlConvergence | No | String | URL convergence regex rules, comma-separated |
| ErrorCodeFilter | No | String | Error code filtering, comma-separated |
| UrlExclude | No | String | URL exclusion regex rule, comma-separated |
| IsRelatedLog | No | Integer | Log switch 0 Disabled 1 Enabled |
| LogRegion | No | String | Log region |
| LogTopicID | No | String | Log topic ID |
| LogSet | No | String | CLS logset |
| LogSource | No | String | Log source CLS |
| IgnoreOperationName | No | String | Interfaces to Filter |
| EnableSnapshot | No | Boolean | Whether thread profiling is enabled |
| SnapshotTimeout | No | Integer | Timeout threshold for thread profiling |
| AgentEnable | No | Boolean | Whether to enable agent |
| TraceSquash | No | Boolean | Whether to enable link compression |
| EventEnable | No | Boolean | Whether the switch for enabling application diagnosis is enabled |
| InstrumentList.N | No | Array of Instrument | Component list |
| AgentOperationConfigView | No | AgentOperationConfigView | probe API related configuration |
| EnableLogConfig | No | Boolean | Whether the application log configuration is enabled |
| EnableDashboardConfig | No | Boolean | Whether the dashboard configuration is enabled: false (disabled, consistent with the business system)/true (enabled, application-level configuration) |
| IsRelatedDashboard | No | Integer | Whether to associate with dashboard: 0 off 1 on |
| 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: This parameter is valid only when the CLS index type is key-value index. |
| EnableSecurityConfig | No | Boolean | Whether application security configuration is enabled |
| IsSqlInjectionAnalysis | No | Integer | Whether SQL injection analysis is enabled |
| IsInstrumentationVulnerabilityScan | No | Integer | Whether component vulnerability detection is enabled |
| IsRemoteCommandExecutionAnalysis | No | Integer | Whether remote command detection is enabled |
| IsMemoryHijackingAnalysis | No | Integer | Whether Java Webshell detection is enabled |
| IsDeleteAnyFileAnalysis | No | Integer | Whether to enable detection of any file deletion (0 - turn off, 1 - turn on) |
| IsReadAnyFileAnalysis | No | Integer | Whether to enable arbitrary file read detection (0 - disabled, 1 - enabled) |
| IsUploadAnyFileAnalysis | No | Integer | Whether to enable arbitrary file upload detection (0-disable, 1-enable) |
| IsIncludeAnyFileAnalysis | No | Integer | Whether to enable detection of arbitrary files (0 - disabled, 1 - enabled) |
| IsDirectoryTraversalAnalysis | No | Integer | Whether path traversal detection is enabled (0-disabled, 1-enabled) |
| IsTemplateEngineInjectionAnalysis | No | Integer | Whether to enable template engine injection detection (0-disable, 1-enable) |
| IsScriptEngineInjectionAnalysis | No | Integer | Whether to enable script engine injection detection (0-disable, 1-enable) |
| IsExpressionInjectionAnalysis | No | Integer | Whether expression injection detection is enabled (0-disabled, 1-enabled) |
| IsJNDIInjectionAnalysis | No | Integer | Whether JNDI injection detection is enabled (0 - disabled, 1 - enabled) |
| IsJNIInjectionAnalysis | No | Integer | Whether JNI injection detection is enabled (0-disabled, 1-enabled) |
| IsWebshellBackdoorAnalysis | No | Integer | Whether to enable Webshell backdoor detection (0 - disabled, 1 - enabled) |
| IsDeserializationAnalysis | No | Integer | Whether deserialization detection is enabled (0-disabled, 1-enabled) |
| UrlAutoConvergenceEnable | No | Boolean | API auto convergence switch, 0-off |
| UrlLongSegmentThreshold | No | Integer | URL long segment convergence threshold |
| UrlNumberSegmentThreshold | No | Integer | URL digit segment convergence threshold |
| DisableMemoryUsed | No | Integer | Fuse memory threshold of the probe |
| DisableCpuUsed | No | Integer | Probe fuse CPU threshold |
| DbStatementParametersEnabled | No | Boolean | Whether SQL parameter access is enabled |
| SlowSQLThresholds.N | No | Array of ApmTag | Slow SQL threshold |
| EnableDesensitizationRule | No | Integer | Whether the masking rule is enabled |
| DesensitizationRule | No | String | Masking rule |
| LogSpanIdKey | No | String | Index key of spanId: This parameter is valid only when the CLS index type is key-value index. |
| AutoProfilingConfig | No | AutoProfilingConfig | Automated performance analysis task configuration |
| EnableThresholdConfig | No | Boolean | Threshold configuration switch. true means use application level threshold; false means use business system level threshold. |
| ErrRateThreshold | No | Integer | Error rate threshold (%) used to judge the application health status as "red". |
| ResponseDurationWarningThreshold | No | Integer | Alert threshold for response time (ms), used to judge the application health status as "yellow". |
| UseDefaultFuseConfig | No | Boolean | Whether to use the default fuse threshold of the probe |
| 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. |
POST / HTTP/1.1
Host: apm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApmApplicationConfig
<Common request parameters>
{
"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"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários