API 参数字典

最近更新时间:2024-12-10 14:53:22

我的收藏

修改应用配置信息

ModifyGeneralApmApplicationConfig API 用于修改应用配置信息 ,应用配置通过 Tags 参数进行传递,Tags是一个由 ApmTag 组成的数组,ApmTag 支持如下键值对:
Key
Value 类型
示例值
描述
UrlConvergenceSwitch
int64
1
URL 收敛开关。0:关,1:开
UrlConvergenceThreshold
int64
50
URL 收敛阈值
UrlConvergence
string
market.StockService.getStock(.*?),market.StockService.getPreDayS
URL 收敛规则正则
UrlExclude
string
market.StockService.getStock(.*?),market.StockService.getPreDayS
URL 排除规则正则
OperationNameFilter
string
RPCServer/market.MarketService2/(.*?)
接口过滤
ExceptionFilter
string
io.grpc.StatusRuntimeException,java.sql.(.*?)
错误类型过滤
ErrorCodeFilter
string
400,500
HTTP 状态码过滤
LogSource
string
CLS
日志源
LogRegion
string
ap-guangzhou
日志地域
IsRelatedLog
int64
1
是否开启日志。0:关,1:开
LogTopicID
string
032f3078-10b6-46a0-978f-1696e8e79696
日志主题
LogSet
string
postgres
日志集
AgentEnable
bool
true
探针总开关:true 开启,false 关闭
SnapshotEnable
bool
false
方法栈快照开关:true 开启,false 关闭
SnapshotTimeout
int64
2000
慢调用监听触发阈值(单位:ms)
AgentIgnoreOperation
string
/hello/world,/health/check
忽略接口列表,多个接口用逗号分隔
EnableSecurityConfig
bool
true
是否启用应用级别的应用安全配置,false 的情况下默认使用业务系统级别的配置
IsSqlInjectionAnalysis
int64
1
是否开启SQL注入。1:开,0:关;
在修改时仅在 EnableSecurityConfig=true 时有效
IsInstrumentationVulnerabilityScan
int64
1
是否开启组件漏洞检测。1:开,0:关;
在修改时仅在 EnableSecurityConfig=true 时有效
EnableDashboardConfig
bool
true
是否启用应用级别的 Dashboard 控制台配置,false 的情况下默认使用业务系统级别的配置
IsRelatedDashboard
int64
1
是否关联了 Dashboard 控制台。1:是, 0:否
DashboardTopicID
string
testTopicID
Dashboard TopicID
说明:
关于应用配置的更多详细信息,可以参考 应用配置帮助文档
使用 ModifyGeneralApmApplicationConfig API 接口修改应用配置信息的时候,仅需要在Tags 中填入需要修改的配置项,不需要填入完整的应用配置。
输入示例如下:
{
"InstanceId": "apm-059oXBfTL",
"Tags": [
{
"Key": "UrlConvergence",
"Value": "RPCServer/market.MarketServiceleetcode9(.*?)"
},
{
"Key": "UrlConvergenceThreshold",
"Value": "600"
},
{
"Key": "UrlConvergenceSwitch",
"Value": "1"
},
{
"Key": "AgentEnable",
"Value": "true"
}
],
"ServiceNames": [
"stock-service",
"profile-service"
]
}