接口请求域名： apm.intl.tencentcloudapi.com 。
修改APM业务系统接口
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyApmInstance。 |
| Version | 是 | String | 公共参数，本接口取值：2021-06-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 业务系统 ID |
| Name | 是 | String | 业务系统名 |
| Tags.N | 否 | Array of ApmTag | Tag 列表 |
| Description | 否 | String | 业务系统描述 |
| TraceDuration | 否 | Integer | Trace 数据保存时长（单位：天） |
| OpenBilling | 否 | Boolean | 是否开启计费 |
| SpanDailyCounters | 否 | Integer | 业务系统上报额度 |
| ErrRateThreshold | 否 | Integer | 错误率警示线，当应用的平均错误率超出该阈值时，系统会给出异常提示。 |
| SampleRate | 否 | Integer | 采样率（单位：%） |
| ErrorSample | 否 | Integer | 是否开启错误采样（0=关, 1=开） |
| SlowRequestSavedThreshold | 否 | Integer | 采样慢调用保存阈值（单位：ms） |
| IsRelatedLog | 否 | Integer | 是否开启日志功能（0=关, 1=开） |
| LogRegion | 否 | String | 日志地域，开启日志功能后才会生效 |
| LogTopicID | 否 | String | CLS 日志主题 ID，开启日志功能后才会生效 |
| LogSet | 否 | String | 日志集，开启日志功能后才会生效 |
| LogSource | 否 | String | 日志源，开启日志功能后才会生效 |
| CustomShowTags.N | 否 | Array of String | 用户自定义展示标签列表 |
| PayMode | 否 | Integer | 修改计费模式（1为预付费，0为按量付费） |
| ResponseDurationWarningThreshold | 否 | Integer | 响应时间警示线 |
| Free | 否 | Integer | 是否免费（0=付费版；1=TSF 受限免费版；2=免费版），默认0 |
| IsRelatedDashboard | 否 | Integer | 是否关联 Dashboard（0=关,1=开） |
| DashboardTopicID | 否 | String | 关联的 Dashboard ID，开启关联 Dashboard 后才会生效 |
| IsSqlInjectionAnalysis | 否 | Integer | 是否开启 SQL 注入检测（0=关,1=开） |
| IsInstrumentationVulnerabilityScan | 否 | Integer | 是否开启组件漏洞检测（0=关,1=开） |
| IsRemoteCommandExecutionAnalysis | 否 | Integer | 是否开启远程命令攻击检测 |
| IsMemoryHijackingAnalysis | 否 | Integer | 是否开启内存马检测 |
| LogIndexType | 否 | Integer | CLS索引类型(0=全文索引，1=键值索引) |
| LogTraceIdKey | 否 | String | traceId的索引key: 当CLS索引类型为键值索引时生效 |
| 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-开启） |
| UrlLongSegmentThreshold | 否 | Integer | URL长分段收敛阈值 |
| UrlNumberSegmentThreshold | 否 | Integer | URL数字分段收敛阈值 |
| LogSpanIdKey | 否 | String | spanId的索引key: 当CLS索引类型为键值索引时生效 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
修改 APM 业务系统参数
POST / HTTP/1.1
Host: apm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApmInstance
<公共请求参数>
{
"InstanceId": "apm-CVfliqa8U",
"Tags": [],
"Description": "测试业务系统",
"TraceDuration": 0,
"Name": "测试业务系统",
"OpenBilling": true,
"SpanDailyCounters": 1,
"ErrRateThreshold": 5,
"SampleRate": 50,
"ErrorSample": 1,
"SlowRequestSavedThreshold": 500,
"IsRelatedLog": 0,
"LogRegion": "",
"LogTopicID": "",
"LogSet": "",
"LogSource": ""
}
{
"Response": {
"RequestId": "test-test-test"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | AuthFailure.UnauthorizedOperation |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.AccessTagFail | 访问标签失败。 |
| FailedOperation.AppIdNotMatchInstanceInfo | AppID 和业务系统信息不匹配。 |
| FailedOperation.InstanceCannotModify | 该业务系统不允许修改 |
| FailedOperation.InstanceIdIsEmpty | 业务系统 ID 为空。 |
| FailedOperation.InstanceNotFound | APM 业务系统不存在。 |
| FailedOperation.InvalidParam | 不合法入参 |
| FailedOperation.InvalidRequest | 不合法请求 |
| FailedOperation.SendRequest | 发送查询请求失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
文档反馈