{ "name": "apm", "display_name": "应用性能监控", "description": "应用性能监控 API 文档 主要包括 1. 应用相关接口； 2. 业务系统相关接口； 3. 通用查询相关接口。", "domain": "other", "api_version": "2021-06-22", "endpoint": "apm.tencentcloudapi.com", "actions": [ { "name": "CreateApmInstance", "description": "业务购买 APM 业务系统，调用该接口创建", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "业务系统名", "example": "可观测-测试" }, { "name": "Description", "type": "string", "required": false, "description": "业务系统描述信息", "example": "可观测-测试用的业务系统" }, { "name": "TraceDuration", "type": "integer", "required": false, "description": "Trace 数据保存时长（单位：天，默认存储时长为3天）", "example": "3" }, { "name": "Tags", "type": "array", "required": false, "description": "业务系统 Tag 列表", "example": "[{ \t\t\"Key\": \"AppID\", \t\t\"Value\": \"123123422\" \t}]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "维度Key(列名，标签Key)", "example": "region" }, { "name": "Value", "type": "string", "required": true, "description": "维度值（标签值）", "example": "ap-guangzhou" } ] }, { "name": "SpanDailyCounters", "type": "integer", "required": false, "description": "业务系统上报额度值，默认赋值为0表示不限制上报额度，已废弃", "example": "100000000" }, { "name": "PayMode", "type": "integer", "required": false, "description": "业务系统的计费模式（0=按量付费，1=预付费）", "example": "1" }, { "name": "Free", "type": "integer", "required": false, "description": "是否为免费版业务系统（0=付费版；1=TSF 受限免费版；2=免费版）", "example": "0" } ], "required": [ "Name" ] }, { "name": "CreateApmPrometheusRule", "description": "用于创建apm业务系统与Prometheus实例的指标匹配规则", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "指标匹配规则名", "example": "MyRule" }, { "name": "ServiceName", "type": "string", "required": true, "description": "规则生效的应用。作用全部应用就传空字符串", "example": "java-market-service" }, { "name": "MetricMatchType", "type": "integer", "required": true, "description": "指标匹配类型：0精准匹配，1前缀匹配，2后缀匹配", "example": "1" }, { "name": "MetricNameRule", "type": "string", "required": true, "description": "客户定义的命中指标名规则。", "example": "task.duration" }, { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-059oXBfTL" } ], "required": [ "Name", "ServiceName", "MetricMatchType", "MetricNameRule", "InstanceId" ] }, { "name": "CreateApmSampleConfig", "description": "创建采样配置接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-1o8yMC47u" }, { "name": "SampleRate", "type": "integer", "required": true, "description": "采样率", "example": "95" }, { "name": "ServiceName", "type": "string", "required": true, "description": "应用名", "example": "java-order-service" }, { "name": "SampleName", "type": "string", "required": true, "description": "采样规则名", "example": "testSample" }, { "name": "Tags", "type": "array", "required": false, "description": "采样Tags", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "Key 值定义", "example": "Name" }, { "name": "Value", "type": "string", "required": true, "description": "Value 值定义", "example": "CloudMonitor" } ] }, { "name": "OperationName", "type": "string", "required": false, "description": "接口名", "example": "/stock/get/1" }, { "name": "OperationType", "type": "integer", "required": false, "description": "0=精确匹配（默认）；1=前缀匹配；2=后缀匹配", "example": "0" } ], "required": [ "InstanceId", "SampleRate", "ServiceName", "SampleName" ] }, { "name": "CreateProfileTask", "description": "创建事件任务", "status": "online", "parameters": [ { "name": "ServiceName", "type": "string", "required": true, "description": "应用名称", "example": "springboot-service" }, { "name": "InstanceId", "type": "string", "required": true, "description": "APM业务系统ID", "example": "apm-eQls4MGPr" }, { "name": "ServiceInstance", "type": "string", "required": true, "description": "应用实例（在线）", "example": "127.0.0.1" }, { "name": "Event", "type": "string", "required": true, "description": "事件类型（cpu、alloc）", "example": "cpu" }, { "name": "Duration", "type": "integer", "required": true, "description": "任务持续时长(单位：毫秒)，范围限制在5~180秒", "example": "5000" }, { "name": "AllTimes", "type": "integer", "required": true, "description": "执行次数，范围限制在1~100次", "example": "1" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间戳，0代表从当前开始(单位：秒)", "example": "0" }, { "name": "TaskInterval", "type": "integer", "required": false, "description": "任务执行间隔(单位：毫秒)，范围限制在10~600秒，不可小于1.5倍的Duration", "example": "5000" } ], "required": [ "ServiceName", "InstanceId", "ServiceInstance", "Event", "Duration", "AllTimes" ] }, { "name": "DeleteApmSampleConfig", "description": "删除采样配置接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-1o8yMC47u" }, { "name": "SampleName", "type": "string", "required": true, "description": "采样规则名", "example": "testSample" } ], "required": [ "InstanceId", "SampleName" ] }, { "name": "DescribeApmAgent", "description": "获取 APM 接入点", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-CVfliqa8U" }, { "name": "AgentType", "type": "string", "required": false, "description": "接入方式，现支持 skywalking, ot, ebpf 方式接入上报，不填默认为 ot", "example": "ot" }, { "name": "NetworkMode", "type": "string", "required": false, "description": "上报环境，现支持 pl (内网上报), public (外网), inner (自研 VPC )环境上报，不传默认为 public", "example": "public" }, { "name": "LanguageEnvironment", "type": "string", "required": false, "description": "语言，现支持 java, golang, php, python, dotNet, nodejs 语言上报，不传默认为 golang", "example": "java" }, { "name": "ReportMethod", "type": "string", "required": false, "description": "上报方式，已弃用", "example": "http" } ], "required": [ "InstanceId" ] }, { "name": "DescribeApmAllVulCount", "description": "查询用户所有漏洞信息", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "秒级时间戳", "example": "1728910000" }, { "name": "EndTime", "type": "integer", "required": true, "description": "秒级时间戳", "example": "1728910000" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeApmApplicationConfig", "description": "查询应用配置接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "apm-aadsad" }, { "name": "ServiceName", "type": "string", "required": true, "description": "服务名称", "example": "java-order-service" } ], "required": [ "InstanceId", "ServiceName" ] }, { "name": "DescribeApmAssociation", "description": "用于查询apm业务系统与其他产品的关联关系", "status": "online", "parameters": [ { "name": "ProductName", "type": "string", "required": true, "description": "关联的产品名，当前只支持Prometheus", "example": "Prometheus" }, { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统名", "example": "apm-059oXBfTL" } ], "required": [ "ProductName", "InstanceId" ] }, { "name": "DescribeApmInstances", "description": "获取 APM 业务系统列表", "status": "online", "parameters": [ { "name": "Tags", "type": "array", "required": false, "description": "Tag 列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "维度Key(列名，标签Key)", "example": "region" }, { "name": "Value", "type": "string", "required": true, "description": "维度值（标签值）", "example": "ap-guangzhou" } ] }, { "name": "InstanceName", "type": "string", "required": false, "description": "按业务系统名过滤，支持模糊检索", "example": "可观测-测试" }, { "name": "InstanceId", "type": "string", "required": false, "description": "按业务系统 ID 过滤，支持模糊检索", "example": "apm-CVfliqa8U" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "按业务系统 ID 过滤", "example": "[ \"apm-CVfliqa8U\", \"apm-059oXBfTL\" ]", "item_type": "string" }, { "name": "DemoInstanceFlag", "type": "integer", "required": false, "description": "是否查询官方 Demo 业务系统（0=非 Demo 业务系统，1=Demo 业务系统，默认为0）", "example": "0" }, { "name": "AllRegionsFlag", "type": "integer", "required": false, "description": "是否查询全地域业务系统（0=不查询全地域，1=查询全地域，默认为0）", "example": "1" } ], "required": [] }, { "name": "DescribeApmPrometheusRule", "description": "用于查询apm业务系统与Prometheus实例的指标匹配规则", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-059oXBfTL" } ], "required": [ "InstanceId" ] }, { "name": "DescribeApmSQLInjectionDetail", "description": "查询SQL注入详情信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-CVfliqa8U" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制", "example": "9" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" }, { "name": "StartTime", "type": "integer", "required": false, "description": "秒级时间戳", "example": "1728910000" }, { "name": "EndTime", "type": "integer", "required": false, "description": "秒级时间戳", "example": "1728910000" }, { "name": "OrderBy", "type": "object", "required": false, "description": "排序", "example": "{ \"Key\":\"time\", \"Value\":\"desc\" }", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要排序的字段，现支持 startTIme, endTime, duration", "example": "startTime" }, { "name": "Value", "type": "string", "required": true, "description": "asc 顺序排序 / desc 倒序排序", "example": "asc" } ] }, { "name": "Filters", "type": "array", "required": false, "description": "查询过滤条件", "example": "[ { \"Key\": \"process.serviceName\", \"Type\": \"=\", \"Value\": \"profile-service\" } ]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] }, { "name": "GroupBy", "type": "array", "required": false, "description": "聚合维度", "example": "[\"error.object\"]", "item_type": "string" }, { "name": "Metrics", "type": "array", "required": false, "description": "指标列表", "example": "无", "item_type": "object", "children": [ { "name": "MetricName", "type": "string", "required": true, "description": "指标名", "example": "request_count" }, { "name": "Compares", "type": "array", "required": false, "description": "同比，现支持 CompareByYesterday (与昨天相比)和CompareByLastWeek (与上周相比)", "example": "CompareByYesterday", "item_type": "string" }, { "name": "Compare", "type": "string", "required": false, "description": "同比，已弃用，不建议使用", "example": "CompareByYesterday" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeApmSampleConfig", "description": "查询采样配置接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-1o8yMC47u" }, { "name": "SampleName", "type": "string", "required": false, "description": "采样规则名", "example": "testSample" } ], "required": [ "InstanceId" ] }, { "name": "DescribeApmServiceMetric", "description": "获取 APM 应用指标列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-CVfliqa8U" }, { "name": "ServiceName", "type": "string", "required": false, "description": "应用名", "example": "apm_test" }, { "name": "ServiceID", "type": "string", "required": false, "description": "应用ID", "example": "svc-JRNE5rvV8" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间", "example": "1719317419" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间", "example": "1720580629" }, { "name": "OrderBy", "type": "object", "required": false, "description": "排序", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要排序的字段，现支持 startTIme, endTime, duration", "example": "startTime" }, { "name": "Value", "type": "string", "required": true, "description": "asc 顺序排序 / desc 倒序排序", "example": "asc" } ] }, { "name": "Demo", "type": "boolean", "required": false, "description": "是否demo模式", "example": "false" }, { "name": "ServiceStatus", "type": "string", "required": false, "description": "应用状态筛选，可枚举的值为：health、warning、error。如果选中多个状态用逗号隔开，例如：\"warning,error\"", "example": "health" }, { "name": "Tags", "type": "array", "required": false, "description": "标签列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "维度Key(列名，标签Key)", "example": "region" }, { "name": "Value", "type": "string", "required": true, "description": "维度值（标签值）", "example": "ap-guangzhou" } ] }, { "name": "Page", "type": "integer", "required": false, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "页大小", "example": "2" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeApmVulnerabilityCount", "description": "查询漏洞指标", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "APM业务系统ID", "example": "apm-CVfliqa8U" }, { "name": "ServiceName", "type": "string", "required": true, "description": "APM应用名称", "example": "java-order-service" }, { "name": "StartTime", "type": "integer", "required": true, "description": "秒级时间戳", "example": "1728910000" }, { "name": "EndTime", "type": "integer", "required": false, "description": "秒级时间戳", "example": "1728910000" }, { "name": "Type", "type": "string", "required": false, "description": "查询的数据类型，攻击检测为“attack_detect”", "example": "attack_detect" } ], "required": [ "InstanceId", "ServiceName", "StartTime" ] }, { "name": "DescribeApmVulnerabilityDetail", "description": "查询漏洞详情", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "秒级时间戳", "example": "1728910000" }, { "name": "EndTime", "type": "integer", "required": true, "description": "秒级时间戳", "example": "1728910000" }, { "name": "InstanceId", "type": "string", "required": true, "description": "APM业务系统ID", "example": "apm-CVfliqa8U" }, { "name": "Filters", "type": "array", "required": false, "description": "条件过滤，必填service.name, instrumentation.name, version, vul.id", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] } ], "required": [ "StartTime", "EndTime", "InstanceId" ] }, { "name": "DescribeGeneralApmApplicationConfig", "description": "查询应用配置信息", "status": "online", "parameters": [ { "name": "ServiceName", "type": "string", "required": true, "description": "应用名", "example": "profile-service" }, { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-059oXBfTL" } ], "required": [ "ServiceName", "InstanceId" ] }, { "name": "DescribeGeneralMetricData", "description": "获取指标数据通用接口。用户根据需要上送请求参数，返回对应的指标数据。 接口调用频率限制为：20次/秒，1200次/分钟。单请求的数据点数限制为1440个。 获取指标数据通用接口用法：DescribeGeneralMetricData 是通用的指标数据查询接口，支持灵活的获取指标数据。该接口的查询方式类似于使用如下 SQL 语句：SELECT {Metrics} FROM {ViewName} WHERE {Filters} GROUP BY {GroupBy}。在发起请求前，请\ufffd...", "status": "online", "parameters": [ { "name": "Metrics", "type": "array", "required": true, "description": "需要查询的指标名称，不可自定义输入，[详情请见。](https://cloud.tencent.com/document/product/248/101681)", "example": "[\"request_count\", \"duration_avg\"]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-ylTJfTSbn" }, { "name": "ViewName", "type": "string", "required": true, "description": "视图名称，不可自定义输入。[详情请见。](https://cloud.tencent.com/document/product/248/101681)", "example": "service_metric" }, { "name": "Filters", "type": "array", "required": true, "description": "要过滤的维度信息，不同视图有对应的指标维度，[详情请见。](https://cloud.tencent.com/document/product/248/101681)", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值", "example": "sso-api" } ] }, { "name": "GroupBy", "type": "array", "required": false, "description": "聚合维度，不同视图有对应的指标维度，[详情请见。](https://cloud.tencent.com/document/product/248/101681)", "example": "[\"service.name\", \"span.kind\"]", "item_type": "string" }, { "name": "StartTime", "type": "integer", "required": false, "description": "起始时间的时间戳，支持查询30天内的指标数据。（单位：秒）", "example": "1617123538" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间的时间戳，支持查询30天内的指标数据。（单位：秒）", "example": "1617123538" }, { "name": "Period", "type": "integer", "required": false, "description": "是否按固定时间跨度聚合，填入1及大于1的值按1处理，不填按0处理。 - 填入0，则计算开始时间到截止时间的指标数据。 - 填入1，则会按照开始时间到截止时间的时间跨度选择聚合粒度： - 时间跨度 (0,12) 小时，则按一分钟粒度聚合。 - 时间跨度 [12,48] 小时，则按五分钟粒度聚合。 - 时间跨度 (48, +∞) 小时，则按一小时粒度聚合。", "example": "1" }, { "name": "OrderBy", "type": "object", "required": false, "description": "对查询指标进行排序： Key 填写云 API 指标名称，[详情请见。](https://cloud.tencent.com/document/product/248/101681) Value 填写排序方式： - asc：对查询指标进行升序排序 - desc：对查询指标进行降序排序", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要排序的字段，现支持 startTIme, endTime, duration", "example": "startTime" }, { "name": "Value", "type": "string", "required": true, "description": "asc 顺序排序 / desc 倒序排序", "example": "asc" } ] }, { "name": "PageSize", "type": "integer", "required": false, "description": "查询指标的限制条数，目前最多展示50条数据，PageSize取值为1-50，上送PageSize则根据PageSize的值展示限制条数。", "example": "5" } ], "required": [ "Metrics", "InstanceId", "ViewName", "Filters" ] }, { "name": "DescribeGeneralOTSpanList", "description": "通用查询 OpenTelemetry 调用链列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-CVfliqa8U" }, { "name": "StartTime", "type": "integer", "required": true, "description": "Span 查询开始时间戳（单位：秒）", "example": "1617123538" }, { "name": "EndTime", "type": "integer", "required": true, "description": "Span 查询结束时间戳（单位：秒）", "example": "1617123538" }, { "name": "Filters", "type": "array", "required": false, "description": "通用过滤参数", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] }, { "name": "OrderBy", "type": "object", "required": false, "description": "排序 现支持的 Key 有： - startTime(开始时间) - endTime(结束时间) - duration(响应时间) 现支持的 Value 有： - desc(降序排序) - asc(升序排序)", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要排序的字段，现支持 startTIme, endTime, duration", "example": "startTime" }, { "name": "Value", "type": "string", "required": true, "description": "asc 顺序排序 / desc 倒序排序", "example": "asc" } ] }, { "name": "BusinessName", "type": "string", "required": false, "description": "业务自身服务名，控制台用户请填写taw", "example": "taw" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页项目个数，默认为10000，合法取值范围为0～10000", "example": "15" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页", "example": "1" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeGeneralSpanList", "description": "通用查询调用链列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-CVfliqa8U" }, { "name": "StartTime", "type": "integer", "required": true, "description": "Span 查询开始时间戳（单位：秒）", "example": "1617123538" }, { "name": "EndTime", "type": "integer", "required": true, "description": "Span 查询结束时间戳（单位：秒）", "example": "1617123538" }, { "name": "Filters", "type": "array", "required": false, "description": "通用过滤参数", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] }, { "name": "OrderBy", "type": "object", "required": false, "description": "排序 现支持的 Key 有： - startTime(开始时间) - endTime(结束时间) - duration(响应时间) 现支持的 Value 有： - desc(降序排序) - asc(升序排序)", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要排序的字段，现支持 startTIme, endTime, duration", "example": "startTime" }, { "name": "Value", "type": "string", "required": true, "description": "asc 顺序排序 / desc 倒序排序", "example": "asc" } ] }, { "name": "BusinessName", "type": "string", "required": false, "description": "业务自身服务名，控制台用户请填写taw", "example": "taw" }, { "name": "Limit", "type": "integer", "required": false, "description": "单页项目个数，默认为1000，合法取值范围为1～1000", "example": "15" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页", "example": "1" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeMetricRecords", "description": "查询指标列表接口，查询指标更推荐使用DescribeGeneralMetricData接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-CVfliqa8U" }, { "name": "Metrics", "type": "array", "required": true, "description": "指标列表", "example": "无", "item_type": "object", "children": [ { "name": "MetricName", "type": "string", "required": true, "description": "指标名", "example": "request_count" }, { "name": "Compares", "type": "array", "required": false, "description": "同比，现支持 CompareByYesterday (与昨天相比)和CompareByLastWeek (与上周相比)", "example": "CompareByYesterday", "item_type": "string" }, { "name": "Compare", "type": "string", "required": false, "description": "同比，已弃用，不建议使用", "example": "CompareByYesterday" } ] }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间（单位为秒）", "example": "1618361193" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间（单位为秒）", "example": "1618361193" }, { "name": "GroupBy", "type": "array", "required": true, "description": "聚合维度", "example": "[\"service.instance\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] }, { "name": "OrFilters", "type": "array", "required": false, "description": "Or 过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] }, { "name": "OrderBy", "type": "object", "required": false, "description": "排序 现支持的 Key 有： - startTime(开始时间) - endTime(结束时间) - duration(响应时间) 现支持的 Value 有： - desc(降序排序) - asc(升序排序)", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要排序的字段，现支持 startTIme, endTime, duration", "example": "startTime" }, { "name": "Value", "type": "string", "required": true, "description": "asc 顺序排序 / desc 倒序排序", "example": "asc" } ] }, { "name": "BusinessName", "type": "string", "required": false, "description": "业务名称，控制台用户请填写taw。", "example": "taw" }, { "name": "Type", "type": "string", "required": false, "description": "特殊处理查询结果", "example": "service_runtime_thread_pool" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页大小，默认为1000，合法取值范围为0~1000", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页起始点", "example": "1" }, { "name": "PageIndex", "type": "integer", "required": false, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "页长", "example": "10" } ], "required": [ "InstanceId", "Metrics", "StartTime", "EndTime", "GroupBy" ] }, { "name": "DescribeOPRAllVulCount", "description": "查询用户所有漏洞信息", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "秒级时间戳", "example": "1728910000" }, { "name": "EndTime", "type": "integer", "required": true, "description": "秒级时间戳", "example": "1728910000" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeServiceOverview", "description": "应用概览数据拉取", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-52Dpv13GR" }, { "name": "Metrics", "type": "array", "required": true, "description": "指标列表", "example": "无", "item_type": "object", "children": [ { "name": "MetricName", "type": "string", "required": true, "description": "指标名", "example": "request_count" }, { "name": "Compares", "type": "array", "required": false, "description": "同比，现支持 CompareByYesterday (与昨天相比)和CompareByLastWeek (与上周相比)", "example": "CompareByYesterday", "item_type": "string" }, { "name": "Compare", "type": "string", "required": false, "description": "同比，已弃用，不建议使用", "example": "CompareByYesterday" } ] }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间（单位：秒）", "example": "1618361193" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间（单位：秒）", "example": "1618361193" }, { "name": "GroupBy", "type": "array", "required": true, "description": "聚合维度", "example": "[\"service.name\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] }, { "name": "OrderBy", "type": "object", "required": false, "description": "排序方式 Value 填写： - asc：对查询指标进行升序排序 - desc：对查询指标进行降序排序", "example": "无", "children": [ { "name": "Key", "type": "string", "required": true, "description": "需要排序的字段，现支持 startTIme, endTime, duration", "example": "startTime" }, { "name": "Value", "type": "string", "required": true, "description": "asc 顺序排序 / desc 倒序排序", "example": "asc" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "每页大小", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页起始点", "example": "1" } ], "required": [ "InstanceId", "Metrics", "StartTime", "EndTime", "GroupBy" ] }, { "name": "DescribeTagValues", "description": "根据维度名和过滤条件，查询维度数据.", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-52Dpv13GR" }, { "name": "TagKey", "type": "string", "required": true, "description": "维度名", "example": "service.name" }, { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间（单位为秒）", "example": "1734400800" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间（单位为秒）", "example": "1734415200" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] }, { "name": "OrFilters", "type": "array", "required": false, "description": "Or 过滤条件", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] }, { "name": "Type", "type": "string", "required": false, "description": "使用类型", "example": "agentConfig" } ], "required": [ "InstanceId", "TagKey", "StartTime", "EndTime" ] }, { "name": "DescribeTopologyNew", "description": "根据应用名查询服务拓扑图", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-52Dpv13GR" }, { "name": "StartTime", "type": "integer", "required": true, "description": "查询开始时间", "example": "1617163200" }, { "name": "EndTime", "type": "integer", "required": true, "description": "查询结束时间", "example": "1617192000" }, { "name": "ServiceName", "type": "string", "required": false, "description": "应用名", "example": "java-order-service" }, { "name": "UpLevel", "type": "integer", "required": false, "description": "上游层级", "example": "2" }, { "name": "ServiceInstance", "type": "string", "required": false, "description": "应用实例信息", "example": "127.0.0.1" }, { "name": "DownLevel", "type": "integer", "required": false, "description": "下游层级", "example": "2" }, { "name": "View", "type": "string", "required": false, "description": "视角", "example": "db" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器", "example": "[ { \"key\":\"TraceID\", \"operator\":\"eq\", \"value\":\"9c35b592750d5e0c15bd202bbae57a29\" } ]", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "过滤方式（=, !=, in）", "example": "=" }, { "name": "Key", "type": "string", "required": true, "description": "过滤维度名", "example": "service.name" }, { "name": "Value", "type": "string", "required": true, "description": "过滤值，in过滤方式用逗号分割多个值", "example": "sso-api" } ] }, { "name": "Topic", "type": "string", "required": false, "description": "表示Topic（MQ拓扑图用）", "example": "prod.ecommerce.order.created.v1" }, { "name": "Selectors", "type": "object", "required": false, "description": "视图筛选列表", "example": "{ \"Component\":[ \"Service\", \"MQ\", \"Database\" ] }", "children": [ { "name": "Component", "type": "array", "required": false, "description": "组件勾选情况 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "Id", "type": "string", "required": false, "description": "视图ID", "example": "topo_apm-xxxxyzj_6d15af9600d6e8aefd739a2" }, { "name": "TraceID", "type": "string", "required": false, "description": "TraceID", "example": "9c35b592750d5e0c15bd202bbae57a29" }, { "name": "IsSlowTopFive", "type": "boolean", "required": false, "description": "查询top5慢响应节点", "example": "true" }, { "name": "GetResource", "type": "boolean", "required": false, "description": "是否获取资源层信息", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "根据应用标签过滤", "example": "[ { \"Key\": \"运营产品\", \"Value\": \"云监控产品\" } ]", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "维度Key(列名，标签Key)", "example": "region" }, { "name": "Value", "type": "string", "required": true, "description": "维度值（标签值）", "example": "ap-guangzhou" } ] }, { "name": "Hidden", "type": "object", "required": false, "description": "不显示的节点类型", "example": "{ \"Component\":[ \"MQ\", \"Database\" ] }", "children": [ { "name": "Component", "type": "array", "required": false, "description": "组件勾选情况 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "ModifyApmApplicationConfig", "description": "修改应用配置接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-1o8yMC47u" }, { "name": "ServiceName", "type": "string", "required": true, "description": "应用名", "example": "java-market-service" }, { "name": "UrlConvergenceSwitch", "type": "integer", "required": true, "description": "URL收敛开关,0 关 | 1 开", "example": "1" }, { "name": "UrlConvergenceThreshold", "type": "integer", "required": false, "description": "URL收敛阈值", "example": "500" }, { "name": "ExceptionFilter", "type": "string", "required": false, "description": "异常过滤正则规则，逗号分隔", "example": "stock(.*?),ppp(.*?)" }, { "name": "UrlConvergence", "type": "string", "required": false, "description": "URL收敛正则规则，逗号分隔", "example": "stock(.*?),ppp(.*?)" }, { "name": "ErrorCodeFilter", "type": "string", "required": false, "description": "错误码过滤，逗号分隔", "example": "500,400" }, { "name": "UrlExclude", "type": "string", "required": false, "description": "URL排除正则规则，逗号分隔", "example": "stock(.*?),ppp(.*?)" }, { "name": "IsRelatedLog", "type": "integer", "required": false, "description": "日志开关 0 关 1 开", "example": "0" }, { "name": "LogRegion", "type": "string", "required": false, "description": "日志地域", "example": "ap-guangzhou" }, { "name": "LogTopicID", "type": "string", "required": false, "description": "日志主题ID", "example": "84bac169-79d8-4409-8e56-aebcf63b5783" }, { "name": "LogSet", "type": "string", "required": false, "description": "CLS 日志集 | ES 集群ID", "example": "postgres" }, { "name": "LogSource", "type": "string", "required": false, "description": "日志来源 CLS | ES", "example": "CLS" }, { "name": "IgnoreOperationName", "type": "string", "required": false, "description": "需过滤的接口", "example": "getOrderInfo" }, { "name": "EnableSnapshot", "type": "boolean", "required": false, "description": "是否开启线程剖析", "example": "false" }, { "name": "SnapshotTimeout", "type": "integer", "required": false, "description": "线程剖析超时阈值", "example": "2000" }, { "name": "AgentEnable", "type": "boolean", "required": false, "description": "是否开启agent", "example": "true" }, { "name": "TraceSquash", "type": "boolean", "required": false, "description": "是否开启链路压缩", "example": "false" }, { "name": "EventEnable", "type": "boolean", "required": false, "description": "是否开启应用诊断的开关", "example": "true" }, { "name": "InstrumentList", "type": "array", "required": false, "description": "组件列表", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "组件名称", "example": "Redis" }, { "name": "Enable", "type": "boolean", "required": false, "description": "组件开关", "example": "true" } ] }, { "name": "AgentOperationConfigView", "type": "object", "required": false, "description": "探针接口相关配置", "example": "无", "children": [ { "name": "RetentionValid", "type": "boolean", "required": false, "description": "当前接口配置是否开启了接口白名单配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "false" }, { "name": "IgnoreOperation", "type": "string", "required": false, "description": "RetentionValid为false时生效，接口配置中的黑名单配置，配置中的接口不采集 注意：此字段可能返回 null，表示取不到有效值。", "example": "/get/*" }, { "name": "RetentionOperation", "type": "string", "required": false, "description": "RetentionValid为true时生效，接口配置中的白名单配置，仅采集配置中的接口 注意：此字段可能返回 null，表示取不到有效值。", "example": "/get/*" } ] }, { "name": "EnableLogConfig", "type": "boolean", "required": false, "description": "是否开启应用日志配置", "example": "false" }, { "name": "EnableDashboardConfig", "type": "boolean", "required": false, "description": "应用是否开启dashboard配置： false 关（与业务系统保持一致）/true 开（应用级配置）", "example": "false" }, { "name": "IsRelatedDashboard", "type": "integer", "required": false, "description": "是否关联dashboard： 0 关 1 开", "example": "0" }, { "name": "DashboardTopicID", "type": "string", "required": false, "description": "dashboard ID", "example": "2bl22vlyd6gq0wx3" }, { "name": "LogIndexType", "type": "integer", "required": false, "description": "CLS索引类型(0=全文索引，1=键值索引)", "example": "0" }, { "name": "LogTraceIdKey", "type": "string", "required": false, "description": "traceId的索引key: 当CLS索引类型为键值索引时生效", "example": "trace_id" }, { "name": "EnableSecurityConfig", "type": "boolean", "required": false, "description": "是否开启应用安全配置", "example": "false" }, { "name": "IsSqlInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启SQL注入分析", "example": "0" }, { "name": "IsInstrumentationVulnerabilityScan", "type": "integer", "required": false, "description": "是否开启组件漏洞检测", "example": "0" }, { "name": "IsRemoteCommandExecutionAnalysis", "type": "integer", "required": false, "description": "是否开启远程命令检测", "example": "0" }, { "name": "IsMemoryHijackingAnalysis", "type": "integer", "required": false, "description": "是否开启内存马检测", "example": "0" }, { "name": "IsDeleteAnyFileAnalysis", "type": "integer", "required": false, "description": "是否开启删除任意文件检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsReadAnyFileAnalysis", "type": "integer", "required": false, "description": "是否开启读取任意文件检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsUploadAnyFileAnalysis", "type": "integer", "required": false, "description": "是否开启上传任意文件检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsIncludeAnyFileAnalysis", "type": "integer", "required": false, "description": "是否开启包含任意文件检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsDirectoryTraversalAnalysis", "type": "integer", "required": false, "description": "是否开启目录遍历检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsTemplateEngineInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启模板引擎注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsScriptEngineInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启脚本引擎注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsExpressionInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启表达式注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsJNDIInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启JNDI注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsJNIInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启JNI注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsWebshellBackdoorAnalysis", "type": "integer", "required": false, "description": "是否开启Webshell后门检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsDeserializationAnalysis", "type": "integer", "required": false, "description": "是否开启反序列化检测（0-关闭，1-开启）", "example": "0" }, { "name": "UrlAutoConvergenceEnable", "type": "boolean", "required": false, "description": "接口自动收敛开关,0 关 | 1 开", "example": "false" }, { "name": "UrlLongSegmentThreshold", "type": "integer", "required": false, "description": "URL长分段收敛阈值", "example": "40" }, { "name": "UrlNumberSegmentThreshold", "type": "integer", "required": false, "description": "URL数字分段收敛阈值", "example": "5" }, { "name": "DisableMemoryUsed", "type": "integer", "required": false, "description": "探针熔断内存阈值", "example": "90" }, { "name": "DisableCpuUsed", "type": "integer", "required": false, "description": "探针熔断CPU阈值", "example": "90" }, { "name": "DbStatementParametersEnabled", "type": "boolean", "required": false, "description": "是否开启SQL参数获取", "example": "false" }, { "name": "SlowSQLThresholds", "type": "array", "required": false, "description": "慢SQL阈值", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "维度Key(列名，标签Key)", "example": "region" }, { "name": "Value", "type": "string", "required": true, "description": "维度值（标签值）", "example": "ap-guangzhou" } ] }, { "name": "EnableDesensitizationRule", "type": "integer", "required": false, "description": "是否开启脱敏规则", "example": "1" }, { "name": "DesensitizationRule", "type": "string", "required": false, "description": "脱敏规则", "example": "email,password" }, { "name": "LogSpanIdKey", "type": "string", "required": false, "description": "spanId的索引key: 当CLS索引类型为键值索引时生效", "example": "span_id" }, { "name": "AutoProfilingConfig", "type": "object", "required": false, "description": "自动性能剖析任务配置", "example": "无", "children": [ { "name": "CpuProfilingEnable", "type": "boolean", "required": false, "description": "自动CPU剖析任务开关", "example": "true" }, { "name": "MemoryProfilingEnable", "type": "boolean", "required": false, "description": "自动内存剖析任务开关", "example": "true" }, { "name": "CpuProfilingThreshold", "type": "integer", "required": false, "description": "自动CPU剖析任务阈值", "example": "80" }, { "name": "MemoryProfilingThreshold", "type": "integer", "required": false, "description": "自动内存剖析任务阈值", "example": "80" }, { "name": "CpuProfilingDuration", "type": "integer", "required": false, "description": "CPU自动剖析任务时长", "example": "60000" }, { "name": "MemoryProfilingDuration", "type": "integer", "required": false, "description": "内存自动剖析任务时长", "example": "60000" } ] }, { "name": "EnableThresholdConfig", "type": "boolean", "required": false, "description": "阈值配置开关。true 表示使用应用级阈值；false 表示使用业务系统级阈值", "example": "true" }, { "name": "ErrRateThreshold", "type": "integer", "required": false, "description": "错误率阈值（%），用于判断应用健康状态为\u0026quot;红色\u0026quot;", "example": "5" }, { "name": "ResponseDurationWarningThreshold", "type": "integer", "required": false, "description": "响应时间预警阈值（ms），用于判断应用健康状态为\u0026quot;黄色\u0026quot;", "example": "500" } ], "required": [ "InstanceId", "ServiceName", "UrlConvergenceSwitch" ] }, { "name": "ModifyApmAssociation", "description": "用于修改apm业务系统与其他产品的关联关系（包括创建和删除）", "status": "online", "parameters": [ { "name": "ProductName", "type": "string", "required": true, "description": "关联的产品名，当前只支持Prometheus、CKafka", "example": "Prometheus" }, { "name": "Status", "type": "integer", "required": true, "description": "关联关系的状态：// 关联关系状态：1（启用）、2（不启用）", "example": "1" }, { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-059oXBfTL" }, { "name": "PeerId", "type": "string", "required": false, "description": "关联的产品实例ID", "example": "prom-xxxxxx" }, { "name": "Topic", "type": "string", "required": false, "description": "CKafka消息主题", "example": "apm-trace" } ], "required": [ "ProductName", "Status", "InstanceId" ] }, { "name": "ModifyApmInstance", "description": "修改APM业务系统接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统 ID", "example": "apm-6Dxp7Nd0B" }, { "name": "Name", "type": "string", "required": true, "description": "业务系统名", "example": "可观测-测试" }, { "name": "Tags", "type": "array", "required": false, "description": "Tag 列表", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "维度Key(列名，标签Key)", "example": "region" }, { "name": "Value", "type": "string", "required": true, "description": "维度值（标签值）", "example": "ap-guangzhou" } ] }, { "name": "Description", "type": "string", "required": false, "description": "业务系统描述", "example": "可观测-测试用的业务系统" }, { "name": "TraceDuration", "type": "integer", "required": false, "description": "Trace 数据保存时长（单位：天）", "example": "7" }, { "name": "OpenBilling", "type": "boolean", "required": false, "description": "是否开启计费", "example": "true" }, { "name": "SpanDailyCounters", "type": "integer", "required": false, "description": "业务系统上报额度", "example": "10000000" }, { "name": "ErrRateThreshold", "type": "integer", "required": false, "description": "错误率警示线，当应用的平均错误率超出该阈值时，系统会给出异常提示。", "example": "11" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "采样率（单位：%）", "example": "11" }, { "name": "ErrorSample", "type": "integer", "required": false, "description": "是否开启错误采样（0=关, 1=开）", "example": "1" }, { "name": "SlowRequestSavedThreshold", "type": "integer", "required": false, "description": "采样慢调用保存阈值（单位：ms）", "example": "500" }, { "name": "IsRelatedLog", "type": "integer", "required": false, "description": "是否开启日志功能（0=关, 1=开）", "example": "0" }, { "name": "LogRegion", "type": "string", "required": false, "description": "日志地域，开启日志功能后才会生效", "example": "ap-guangzhou" }, { "name": "LogTopicID", "type": "string", "required": false, "description": "CLS 日志主题 ID，开启日志功能后才会生效", "example": "cls-1c1cac" }, { "name": "LogSet", "type": "string", "required": false, "description": "日志集，开启日志功能后才会生效", "example": "cls-av2q1f1" }, { "name": "LogSource", "type": "string", "required": false, "description": "日志源，开启日志功能后才会生效", "example": "CLS" }, { "name": "CustomShowTags", "type": "array", "required": false, "description": "用户自定义展示标签列表", "example": "[\"oneTag\"]", "item_type": "string" }, { "name": "PayMode", "type": "integer", "required": false, "description": "修改计费模式（1为预付费，0为按量付费）", "example": "1" }, { "name": "ResponseDurationWarningThreshold", "type": "integer", "required": false, "description": "响应时间警示线", "example": "500" }, { "name": "Free", "type": "integer", "required": false, "description": "是否免费（0=付费版；1=TSF 受限免费版；2=免费版），默认0", "example": "0" }, { "name": "IsRelatedDashboard", "type": "integer", "required": false, "description": "是否关联 Dashboard（0=关,1=开）", "example": "0" }, { "name": "DashboardTopicID", "type": "string", "required": false, "description": "关联的 Dashboard ID，开启关联 Dashboard 后才会生效", "example": "dashboard-agv1br13b" }, { "name": "IsSqlInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启 SQL 注入检测（0=关,1=开）", "example": "0" }, { "name": "IsInstrumentationVulnerabilityScan", "type": "integer", "required": false, "description": "是否开启组件漏洞检测（0=关,1=开）", "example": "0" }, { "name": "IsRemoteCommandExecutionAnalysis", "type": "integer", "required": false, "description": "是否开启远程命令攻击检测", "example": "0" }, { "name": "IsMemoryHijackingAnalysis", "type": "integer", "required": false, "description": "是否开启内存马检测", "example": "0" }, { "name": "LogIndexType", "type": "integer", "required": false, "description": "CLS索引类型(0=全文索引，1=键值索引)", "example": "0" }, { "name": "LogTraceIdKey", "type": "string", "required": false, "description": "traceId的索引key: 当CLS索引类型为键值索引时生效", "example": "trace_id" }, { "name": "IsDeleteAnyFileAnalysis", "type": "integer", "required": false, "description": "是否开启删除任意文件检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsReadAnyFileAnalysis", "type": "integer", "required": false, "description": "是否开启读取任意文件检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsUploadAnyFileAnalysis", "type": "integer", "required": false, "description": "是否开启上传任意文件检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsIncludeAnyFileAnalysis", "type": "integer", "required": false, "description": "是否开启包含任意文件检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsDirectoryTraversalAnalysis", "type": "integer", "required": false, "description": "是否开启目录遍历检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsTemplateEngineInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启模板引擎注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsScriptEngineInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启脚本引擎注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsExpressionInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启表达式注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsJNDIInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启JNDI注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsJNIInjectionAnalysis", "type": "integer", "required": false, "description": "是否开启JNI注入检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsWebshellBackdoorAnalysis", "type": "integer", "required": false, "description": "是否开启Webshell后门检测（0-关闭，1-开启）", "example": "0" }, { "name": "IsDeserializationAnalysis", "type": "integer", "required": false, "description": "是否开启反序列化检测（0-关闭，1-开启）", "example": "0" }, { "name": "UrlLongSegmentThreshold", "type": "integer", "required": false, "description": "URL长分段收敛阈值", "example": "40" }, { "name": "UrlNumberSegmentThreshold", "type": "integer", "required": false, "description": "URL数字分段收敛阈值", "example": "5" }, { "name": "LogSpanIdKey", "type": "string", "required": false, "description": "spanId的索引key: 当CLS索引类型为键值索引时生效", "example": "span_id" } ], "required": [ "InstanceId", "Name" ] }, { "name": "ModifyApmPrometheusRule", "description": "用于修改apm业务系统与Prometheus实例的指标匹配规则", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": true, "description": "规则ID", "example": "1" }, { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-059oXBfTL" }, { "name": "Name", "type": "string", "required": false, "description": "所要修改的规则名", "example": "MyRule" }, { "name": "Status", "type": "integer", "required": false, "description": "规则状态：1(启用)、2（不启用）、3（删除）", "example": "1" }, { "name": "ServiceName", "type": "string", "required": false, "description": "规则生效的应用。生效于全部应用就传空（这个如果不修改也要传旧的规则）", "example": "profile-service" }, { "name": "MetricMatchType", "type": "integer", "required": false, "description": "匹配类型：0精准匹配，1前缀匹配，2后缀匹配（这个如果不修改也要传旧的规则）", "example": "0" }, { "name": "MetricNameRule", "type": "string", "required": false, "description": "客户定义的命中指标名规则。", "example": "task.duration" } ], "required": [ "Id", "InstanceId" ] }, { "name": "ModifyApmSampleConfig", "description": "修改采样配置接口", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-1o8yMC47u" }, { "name": "SampleName", "type": "string", "required": true, "description": "采样规则名", "example": "testSample" }, { "name": "SampleRate", "type": "integer", "required": true, "description": "采样率", "example": "95" }, { "name": "ServiceName", "type": "string", "required": false, "description": "应用名，生效于所有应用则填空", "example": "java-market-service" }, { "name": "OperationName", "type": "string", "required": false, "description": "接口名", "example": "/test" }, { "name": "Tags", "type": "array", "required": false, "description": "采样tag", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "Key 值定义", "example": "Name" }, { "name": "Value", "type": "string", "required": true, "description": "Value 值定义", "example": "CloudMonitor" } ] }, { "name": "Status", "type": "integer", "required": false, "description": "采样开关 0关 1开 2删除", "example": "1" }, { "name": "Id", "type": "integer", "required": false, "description": "配置Id", "example": "1" }, { "name": "OperationType", "type": "integer", "required": false, "description": "0=精确匹配（默认）；1=前缀匹配；2=后缀匹配", "example": "0" } ], "required": [ "InstanceId", "SampleName", "SampleRate" ] }, { "name": "ModifyGeneralApmApplicationConfig", "description": "对外开放的openApi，客户可以灵活的指定需要修改的字段，再加入需要修改的服务列表.", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统Id", "example": "apm-059oXBfTL" }, { "name": "Tags", "type": "array", "required": true, "description": "需要修改的字段key value分别指定字段名、字段值 [具体字段请见](https://cloud.tencent.com/document/product/248/111241)", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "维度Key(列名，标签Key)", "example": "region" }, { "name": "Value", "type": "string", "required": true, "description": "维度值（标签值）", "example": "ap-guangzhou" } ] }, { "name": "ServiceNames", "type": "array", "required": true, "description": "需要修改配置的应用列表名称", "example": "[\"stock-service\",\"profile-service28\",\"profile-service08\"]", "item_type": "string" } ], "required": [ "InstanceId", "Tags", "ServiceNames" ] }, { "name": "TerminateApmInstance", "description": "销毁 APM 业务系统", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "业务系统ID", "example": "apm-CVfliqa8U" } ], "required": [ "InstanceId" ] } ] }