tencentcloud-sdk-nodejs-apm 4.1.155 → 4.1.158

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,663 +12,722 @@ export interface DescribeApmAssociationResponse {
12
12
  RequestId?: string;
13
13
  }
14
14
  /**
15
- * ModifyApmInstance请求参数结构体
15
+ * CreateApmInstance请求参数结构体
16
16
  */
17
- export interface ModifyApmInstanceRequest {
18
- /**
19
- * 业务系统 ID
20
- */
21
- InstanceId: string;
17
+ export interface CreateApmInstanceRequest {
22
18
  /**
23
19
  * 业务系统名
24
20
  */
25
21
  Name: string;
26
22
  /**
27
- * Tag 列表
28
- */
29
- Tags?: Array<ApmTag>;
30
- /**
31
- * 业务系统描述
23
+ * 业务系统描述信息
32
24
  */
33
25
  Description?: string;
34
26
  /**
35
- * Trace 数据保存时长(单位:天)
27
+ * Trace 数据保存时长(单位:天,默认存储时长为3天)
36
28
  */
37
29
  TraceDuration?: number;
38
30
  /**
39
- * 是否开启计费
31
+ * 业务系统 Tag 列表
40
32
  */
41
- OpenBilling?: boolean;
33
+ Tags?: Array<ApmTag>;
42
34
  /**
43
- * 业务系统上报额度
35
+ * 业务系统上报额度值,默认赋值为0表示不限制上报额度,已废弃
44
36
  */
45
37
  SpanDailyCounters?: number;
46
38
  /**
47
- * 错误率警示线,当应用的平均错误率超出该阈值时,系统会给出异常提示。
39
+ * 业务系统的计费模式(0=按量付费,1=预付费)
48
40
  */
49
- ErrRateThreshold?: number;
41
+ PayMode?: number;
50
42
  /**
51
- * 采样率(单位:%)
43
+ * 是否为免费版业务系统(0=付费版;1=TSF 受限免费版;2=免费版)
52
44
  */
53
- SampleRate?: number;
45
+ Free?: number;
46
+ }
47
+ /**
48
+ * DescribeServiceOverview返回参数结构体
49
+ */
50
+ export interface DescribeServiceOverviewResponse {
54
51
  /**
55
- * 是否开启错误采样(0=关, 1=开)
52
+ * 指标结果集
56
53
  */
57
- ErrorSample?: number;
54
+ Records?: Array<ApmMetricRecord>;
58
55
  /**
59
- * 采样慢调用保存阈值(单位:ms)
56
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
60
57
  */
61
- SlowRequestSavedThreshold?: number;
58
+ RequestId?: string;
59
+ }
60
+ /**
61
+ * 采样配置信息
62
+ */
63
+ export interface ApmSampleConfig {
62
64
  /**
63
- * 是否开启日志功能(0=关, 1=开)
65
+ * 实例ID
64
66
  */
65
- IsRelatedLog?: number;
67
+ InstanceKey?: string;
66
68
  /**
67
- * 日志地域,开启日志功能后才会生效
69
+ * 服务名
68
70
  */
69
- LogRegion?: string;
71
+ ServiceName?: string;
70
72
  /**
71
- * CLS 日志主题 ID,开启日志功能后才会生效
73
+ * 采样名字
72
74
  */
73
- LogTopicID?: string;
75
+ SampleName?: string;
74
76
  /**
75
- * 日志集,开启日志功能后才会生效
77
+ * 接口名
76
78
  */
77
- LogSet?: string;
79
+ OperationName?: string;
78
80
  /**
79
- * 日志源,开启日志功能后才会生效
81
+ * 采样的span数
80
82
  */
81
- LogSource?: string;
83
+ SpanNum?: number;
82
84
  /**
83
- * 用户自定义展示标签列表
85
+ * 采样配置开关 0 关 1 开
84
86
  */
85
- CustomShowTags?: Array<string>;
87
+ Status?: number;
86
88
  /**
87
- * 修改计费模式(1为预付费,0为按量付费)
89
+ * tags数组
90
+ 注意:此字段可能返回 null,表示取不到有效值。
88
91
  */
89
- PayMode?: number;
92
+ Tags?: Array<APMKVItem>;
90
93
  /**
91
- * 响应时间警示线
94
+ * 采样率
92
95
  */
93
- ResponseDurationWarningThreshold?: number;
96
+ SampleRate?: number;
94
97
  /**
95
- * 是否免费(0=付费版;1=TSF 受限免费版;2=免费版),默认0
98
+ * 0=精确匹配(默认);1=前缀匹配;2=后缀匹配
99
+ 注意:此字段可能返回 null,表示取不到有效值。
96
100
  */
97
- Free?: number;
101
+ OperationType?: number;
98
102
  /**
99
- * 是否关联 Dashboard(0=关,1=开)
103
+ * 配置Id
104
+ 注意:此字段可能返回 null,表示取不到有效值。
100
105
  */
101
- IsRelatedDashboard?: number;
106
+ Id?: number;
107
+ }
108
+ /**
109
+ * 探针有关接口的相关配置
110
+ */
111
+ export interface AgentOperationConfigView {
102
112
  /**
103
- * 关联的 Dashboard ID,开启关联 Dashboard 后才会生效
113
+ * 当前接口配置是否开启了接口白名单配置
114
+ 注意:此字段可能返回 null,表示取不到有效值。
104
115
  */
105
- DashboardTopicID?: string;
116
+ RetentionValid?: boolean;
106
117
  /**
107
- * 是否开启 SQL 注入检测(0=关,1=开)
118
+ * RetentionValid为false时生效,接口配置中的黑名单配置,配置中的接口不采集
119
+ 注意:此字段可能返回 null,表示取不到有效值。
108
120
  */
109
- IsSqlInjectionAnalysis?: number;
121
+ IgnoreOperation?: string;
110
122
  /**
111
- * 是否开启组件漏洞检测(0=关,1=开)
123
+ * RetentionValid为true时生效,接口配置中的白名单配置,仅采集配置中的接口
124
+ 注意:此字段可能返回 null,表示取不到有效值。
112
125
  */
113
- IsInstrumentationVulnerabilityScan?: number;
126
+ RetentionOperation?: string;
127
+ }
128
+ /**
129
+ * 包含了节点的组件数量和健康度数量
130
+ */
131
+ export interface SelectorView {
114
132
  /**
115
- * 是否开启远程命令攻击检测
133
+ * 组件数量
134
+ 注意:此字段可能返回 null,表示取不到有效值。
116
135
  */
117
- IsRemoteCommandExecutionAnalysis?: number;
136
+ Component?: ComponentTopologyView;
137
+ }
138
+ /**
139
+ * DescribeApmSampleConfig请求参数结构体
140
+ */
141
+ export interface DescribeApmSampleConfigRequest {
118
142
  /**
119
- * 是否开启内存马检测
143
+ * 业务系统ID
120
144
  */
121
- IsMemoryHijackingAnalysis?: number;
145
+ InstanceId: string;
122
146
  /**
123
- * CLS索引类型(0=全文索引,1=键值索引)
147
+ * 采样规则名
124
148
  */
125
- LogIndexType?: number;
149
+ SampleName?: string;
150
+ }
151
+ /**
152
+ * DescribeApmSampleConfig返回参数结构体
153
+ */
154
+ export interface DescribeApmSampleConfigResponse {
126
155
  /**
127
- * traceId的索引key: 当CLS索引类型为键值索引时生效
156
+ * 采样配置列表
157
+ 注意:此字段可能返回 null,表示取不到有效值。
128
158
  */
129
- LogTraceIdKey?: string;
159
+ ApmSampleConfigs?: Array<ApmSampleConfig>;
130
160
  /**
131
- * 是否开启删除任意文件检测(0-关闭,1-开启)
161
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
132
162
  */
133
- IsDeleteAnyFileAnalysis?: number;
163
+ RequestId?: string;
164
+ }
165
+ /**
166
+ * DescribeServiceOverview请求参数结构体
167
+ */
168
+ export interface DescribeServiceOverviewRequest {
134
169
  /**
135
- * 是否开启读取任意文件检测(0-关闭,1-开启)
170
+ * 业务系统 ID
136
171
  */
137
- IsReadAnyFileAnalysis?: number;
172
+ InstanceId: string;
138
173
  /**
139
- * 是否开启上传任意文件检测(0-关闭,1-开启)
174
+ * 指标列表
140
175
  */
141
- IsUploadAnyFileAnalysis?: number;
176
+ Metrics: Array<QueryMetricItem>;
142
177
  /**
143
- * 是否开启包含任意文件检测(0-关闭,1-开启)
178
+ * 开始时间(单位:秒)
144
179
  */
145
- IsIncludeAnyFileAnalysis?: number;
180
+ StartTime: number;
146
181
  /**
147
- * 是否开启目录遍历检测(0-关闭,1-开启)
182
+ * 结束时间(单位:秒)
148
183
  */
149
- IsDirectoryTraversalAnalysis?: number;
184
+ EndTime: number;
150
185
  /**
151
- * 是否开启模板引擎注入检测(0-关闭,1-开启)
186
+ * 聚合维度
152
187
  */
153
- IsTemplateEngineInjectionAnalysis?: number;
188
+ GroupBy: Array<string>;
154
189
  /**
155
- * 是否开启脚本引擎注入检测(0-关闭,1-开启)
190
+ * 过滤条件
156
191
  */
157
- IsScriptEngineInjectionAnalysis?: number;
192
+ Filters?: Array<Filter>;
158
193
  /**
159
- * 是否开启表达式注入检测(0-关闭,1-开启)
194
+ * 排序方式
195
+ Value 填写:
196
+ - asc:对查询指标进行升序排序
197
+ - desc:对查询指标进行降序排序
160
198
  */
161
- IsExpressionInjectionAnalysis?: number;
199
+ OrderBy?: OrderBy;
162
200
  /**
163
- * 是否开启JNDI注入检测(0-关闭,1-开启)
201
+ * 每页大小
164
202
  */
165
- IsJNDIInjectionAnalysis?: number;
203
+ Limit?: number;
166
204
  /**
167
- * 是否开启JNI注入检测(0-关闭,1-开启)
205
+ * 分页起始点
168
206
  */
169
- IsJNIInjectionAnalysis?: number;
207
+ Offset?: number;
208
+ }
209
+ /**
210
+ * DescribeTopologyNew返回参数结构体
211
+ */
212
+ export interface DescribeTopologyNewResponse {
170
213
  /**
171
- * 是否开启Webshell后门检测(0-关闭,1-开启)
214
+ * 节点集合
215
+ 注意:此字段可能返回 null,表示取不到有效值。
172
216
  */
173
- IsWebshellBackdoorAnalysis?: number;
217
+ Nodes?: Array<TopologyNode>;
174
218
  /**
175
- * 是否开启反序列化检测(0-关闭,1-开启)
219
+ * 边集合
176
220
  */
177
- IsDeserializationAnalysis?: number;
221
+ Edges?: Array<TopologyEdgeNew>;
178
222
  /**
179
- * URL长分段收敛阈值
223
+ * 拓扑图是否有修改
224
+ 注意:此字段可能返回 null,表示取不到有效值。
180
225
  */
181
- UrlLongSegmentThreshold?: number;
226
+ TopologyModifyFlag?: number;
182
227
  /**
183
- * URL数字分段收敛阈值
228
+ * 节点数量
229
+ 注意:此字段可能返回 null,表示取不到有效值。
184
230
  */
185
- UrlNumberSegmentThreshold?: number;
231
+ Selectors?: SelectorView;
232
+ /**
233
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
234
+ */
235
+ RequestId?: string;
186
236
  }
187
237
  /**
188
- * APM 业务系统信息
238
+ * ModifyApmApplicationConfig返回参数结构体
189
239
  */
190
- export interface ApmInstanceDetail {
240
+ export interface ModifyApmApplicationConfigResponse {
191
241
  /**
192
- * 业务系统 ID
242
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
193
243
  */
194
- InstanceId?: string;
244
+ RequestId?: string;
245
+ }
246
+ /**
247
+ * DescribeApmServiceMetric返回参数结构体
248
+ */
249
+ export interface DescribeApmServiceMetricResponse {
195
250
  /**
196
- * 业务系统名
251
+ * 应用指标列表
197
252
  */
198
- Name?: string;
253
+ ServiceMetricList?: Array<ApmServiceMetric>;
199
254
  /**
200
- * 业务系统描述信息
255
+ * 符合筛选条件的应用数
201
256
  */
202
- Description?: string;
257
+ TotalCount?: number;
203
258
  /**
204
- * 业务系统状态。{
205
- 1: 初始化中; 2: 运行中; 4: 限流}
259
+ * 警示异常应用数
206
260
  */
207
- Status?: number;
261
+ WarningErrorCount?: number;
208
262
  /**
209
- * 业务系统所属地域
263
+ * 应用总数
210
264
  */
211
- Region?: string;
265
+ ApplicationCount?: number;
212
266
  /**
213
- * 业务系统 Tag 列表
267
+ * 页码
214
268
  */
215
- Tags?: Array<ApmTag>;
269
+ Page?: number;
216
270
  /**
217
- * AppID 信息
271
+ * 页大小
218
272
  */
219
- AppId?: number;
273
+ PageSize?: number;
220
274
  /**
221
- * 创建人 Uin
275
+ * 异常应用数
222
276
  */
223
- CreateUin?: string;
277
+ ErrorCount?: number;
224
278
  /**
225
- * 存储使用量(单位:MB)
279
+ * 警示应用数
226
280
  */
227
- AmountOfUsedStorage?: number;
281
+ WarningCount?: number;
228
282
  /**
229
- * 该业务系统服务端应用数量
283
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
230
284
  */
231
- ServiceCount?: number;
232
- /**
233
- * 日均上报 Span 数
285
+ RequestId?: string;
286
+ }
287
+ /**
288
+ * ModifyApmAssociation请求参数结构体
289
+ */
290
+ export interface ModifyApmAssociationRequest {
291
+ /**
292
+ * 关联的产品名,当前只支持Prometheus、CKafka
234
293
  */
235
- CountOfReportSpanPerDay?: number;
294
+ ProductName: string;
236
295
  /**
237
- * Trace 数据保存时长(单位:天)
296
+ * 关联关系的状态:// 关联关系状态:1(启用)、2(不启用)
238
297
  */
239
- TraceDuration?: number;
298
+ Status: number;
240
299
  /**
241
- * 业务系统上报额度
300
+ * 业务系统ID
242
301
  */
243
- SpanDailyCounters?: number;
302
+ InstanceId: string;
244
303
  /**
245
- * 业务系统是否已开通计费(0=未开通,1=已开通)
304
+ * 关联的产品实例ID
246
305
  */
247
- BillingInstance?: number;
306
+ PeerId?: string;
248
307
  /**
249
- * 错误警示线(单位:%)
308
+ * CKafka消息主题
250
309
  */
251
- ErrRateThreshold?: number;
310
+ Topic?: string;
311
+ }
312
+ /**
313
+ * DescribeGeneralOTSpanList返回参数结构体
314
+ */
315
+ export interface DescribeGeneralOTSpanListResponse {
252
316
  /**
253
- * 采样率(单位:%)
317
+ * 总数量
254
318
  */
255
- SampleRate?: number;
319
+ TotalCount?: number;
256
320
  /**
257
- * 是否开启错误采样(0=关, 1=开)
321
+ * Spans字段中包含了链路数据的全部内容,由于数据经过了压缩,需要对结果进行如下三步转换,以还原始的文本。
322
+ 1. 将Spans字段中的文本进行 Base64 解码,得到经过压缩后字节数组。
323
+ 2. 使用 gzip 对压缩后的字节数组进行解压,得到压缩前的字节数组。
324
+ 3. 使用 UTF-8 字符集,将压缩前的字节数组转换为文本。
325
+
258
326
  */
259
- ErrorSample?: number;
327
+ Spans?: string;
260
328
  /**
261
- * 采样慢调用保存阈值(单位:ms)
329
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
262
330
  */
263
- SlowRequestSavedThreshold?: number;
331
+ RequestId?: string;
332
+ }
333
+ /**
334
+ * DescribeApmApplicationConfig返回参数结构体
335
+ */
336
+ export interface DescribeApmApplicationConfigResponse {
264
337
  /**
265
- * CLS 日志所在地域
338
+ * Apm应用配置
339
+ 注意:此字段可能返回 null,表示取不到有效值。
266
340
  */
267
- LogRegion?: string;
341
+ ApmAppConfig: ApmAppConfig;
268
342
  /**
269
- * 日志源
343
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
270
344
  */
271
- LogSource?: string;
345
+ RequestId?: string;
346
+ }
347
+ /**
348
+ * DescribeApmAssociation请求参数结构体
349
+ */
350
+ export interface DescribeApmAssociationRequest {
272
351
  /**
273
- * 日志功能开关(0=关, 1=开)
352
+ * 关联的产品名,当前只支持Prometheus
274
353
  */
275
- IsRelatedLog?: number;
354
+ ProductName: string;
276
355
  /**
277
- * 日志主题 ID
356
+ * 业务系统名
278
357
  */
279
- LogTopicID?: string;
358
+ InstanceId: string;
359
+ }
360
+ /**
361
+ * APM 浮点数类型键值对
362
+ */
363
+ export interface APMKV {
280
364
  /**
281
- * 该业务系统客户端应用数量
365
+ * Key 值定义
282
366
  */
283
- ClientCount?: number;
367
+ Key?: string;
284
368
  /**
285
- * 该业务系统最近2天活跃应用数量
369
+ * Value 值定义
286
370
  */
287
- TotalCount?: number;
371
+ Value?: number;
372
+ }
373
+ /**
374
+ * 节点位置信息
375
+ */
376
+ export interface Position {
288
377
  /**
289
- * CLS 日志集
378
+ * 节点位置横坐标
379
+ 注意:此字段可能返回 null,表示取不到有效值。
290
380
  */
291
- LogSet?: string;
381
+ X?: number;
292
382
  /**
293
- * Metric 数据保存时长(单位:天)
383
+ * 节点位置纵坐标
384
+ 注意:此字段可能返回 null,表示取不到有效值。
294
385
  */
295
- MetricDuration?: number;
386
+ Y?: number;
387
+ }
388
+ /**
389
+ * 包含了视图中节点组件类型的数量
390
+ */
391
+ export interface ComponentTopologyView {
296
392
  /**
297
- * 用户自定义展示标签列表
393
+ * 服务纬度的节点数量
394
+ 注意:此字段可能返回 null,表示取不到有效值。
298
395
  */
299
- CustomShowTags?: Array<string>;
396
+ Service?: number;
300
397
  /**
301
- * 业务系统计费模式(1为预付费,0为按量付费)
398
+ * 数据库节点数量
399
+ 注意:此字段可能返回 null,表示取不到有效值。
302
400
  */
303
- PayMode?: number;
401
+ Database?: number;
304
402
  /**
305
- * 业务系统计费模式是否生效
403
+ * 消息队列节点数量
404
+ 注意:此字段可能返回 null,表示取不到有效值。
306
405
  */
307
- PayModeEffective?: boolean;
406
+ MQ?: number;
407
+ }
408
+ /**
409
+ * CreateProfileTask请求参数结构体
410
+ */
411
+ export interface CreateProfileTaskRequest {
308
412
  /**
309
- * 响应时间警示线(单位:ms)
413
+ * 应用名称
310
414
  */
311
- ResponseDurationWarningThreshold?: number;
415
+ ServiceName: string;
312
416
  /**
313
- * 是否免费(0=否,1=限额免费,2=完全免费),默认0
417
+ * APM业务系统ID
314
418
  */
315
- Free?: number;
419
+ InstanceId: string;
316
420
  /**
317
- * 是否 TSF 默认业务系统(0=否,1=是)
421
+ * 应用实例(在线)
318
422
  */
319
- DefaultTSF?: number;
423
+ ServiceInstance: string;
320
424
  /**
321
- * 是否关联 Dashboard(0=关, 1=开)
425
+ * 事件类型(cpu、alloc)
322
426
  */
323
- IsRelatedDashboard?: number;
427
+ Event: string;
324
428
  /**
325
- * 关联的 Dashboard ID
429
+ * 任务持续时长(单位:毫秒),范围限制在5~180秒
326
430
  */
327
- DashboardTopicID?: string;
431
+ Duration: number;
328
432
  /**
329
- * 是否开启组件漏洞检测(0=关, 1=开)
433
+ * 执行次数,范围限制在1~100次
330
434
  */
331
- IsInstrumentationVulnerabilityScan?: number;
435
+ AllTimes: number;
332
436
  /**
333
- * 是否开启 SQL 注入分析(0=关, 1=开)
437
+ * 开始时间戳,0代表从当前开始(单位:秒)
334
438
  */
335
- IsSqlInjectionAnalysis?: number;
439
+ StartTime?: number;
336
440
  /**
337
- * 限流原因。{
338
- 1: 正式版限额;
339
- 2: 试用版限额;
340
- 4: 试用版到期;
341
- 8: 账号欠费
342
- }
441
+ * 任务执行间隔(单位:毫秒),范围限制在10~600秒,不可小于1.5倍的Duration
343
442
  */
344
- StopReason?: number;
443
+ TaskInterval?: number;
444
+ }
445
+ /**
446
+ * 展示apm业务系统关联prometheus关系返回体
447
+ */
448
+ export interface ApmPrometheusRules {
345
449
  /**
346
- * 是否开远程命令执行检测(0=关, 1=开)
450
+ * 指标匹配规则ID
347
451
  */
348
- IsRemoteCommandExecutionAnalysis?: number;
452
+ Id?: number;
349
453
  /**
350
- * 是否开内存马执行检测(0=关, 1=开)
454
+ * 指标匹配规则名
455
+ 注意:此字段可能返回 null,表示取不到有效值。
351
456
  */
352
- IsMemoryHijackingAnalysis?: number;
457
+ Name?: string;
353
458
  /**
354
- * CLS索引类型(0=全文索引,1=键值索引)
459
+ * 规则生效的应用。生效于全部应用就传空字符串
460
+ 注意:此字段可能返回 null,表示取不到有效值。
355
461
  */
356
- LogIndexType?: number;
462
+ ServiceName?: string;
357
463
  /**
358
- * traceId的索引key: 当CLS索引类型为键值索引时生效
464
+ * 指标匹配规则状态:1(启用)、2(不启用)
465
+ 注意:此字段可能返回 null,表示取不到有效值。
359
466
  */
360
- LogTraceIdKey?: string;
467
+ Status?: number;
361
468
  /**
362
- * 是否开启删除任意文件检测(0-关闭,1-开启)
469
+ * 指标匹配规则
470
+ 注意:此字段可能返回 null,表示取不到有效值。
363
471
  */
364
- IsDeleteAnyFileAnalysis?: number;
472
+ MetricNameRule?: string;
365
473
  /**
366
- * 是否开启读取任意文件检测(0-关闭,1-开启)
474
+ * 匹配类型:0精准匹配,1前缀匹配,2后缀匹配
475
+ 注意:此字段可能返回 null,表示取不到有效值。
367
476
  */
368
- IsReadAnyFileAnalysis?: number;
477
+ MetricMatchType?: number;
478
+ }
479
+ /**
480
+ * 拓扑图边定义
481
+ */
482
+ export interface TopologyEdgeNew {
369
483
  /**
370
- * 是否开启上传任意文件检测(0-关闭,1-开启)
484
+ * 源节点
371
485
  */
372
- IsUploadAnyFileAnalysis?: number;
486
+ Source?: string;
373
487
  /**
374
- * 是否开启包含任意文件检测(0-关闭,1-开启)
488
+ * 边ID
375
489
  */
376
- IsIncludeAnyFileAnalysis?: number;
490
+ Id?: string;
377
491
  /**
378
- * 是否开启目录遍历检测(0-关闭,1-开启)
492
+ * 边权重
493
+ 注意:此字段可能返回 null,表示取不到有效值。
379
494
  */
380
- IsDirectoryTraversalAnalysis?: number;
495
+ Weight?: number;
381
496
  /**
382
- * 是否开启模板引擎注入检测(0-关闭,1-开启)
497
+ * 目标节点
383
498
  */
384
- IsTemplateEngineInjectionAnalysis?: number;
499
+ Target?: string;
385
500
  /**
386
- * 是否开启脚本引擎注入检测(0-关闭,1-开启)
501
+ * 响应时间
502
+ 注意:此字段可能返回 null,表示取不到有效值。
387
503
  */
388
- IsScriptEngineInjectionAnalysis?: number;
504
+ Duration?: number;
389
505
  /**
390
- * 是否开启表达式注入检测(0-关闭,1-开启)
506
+ * 错误率
507
+ 注意:此字段可能返回 null,表示取不到有效值。
391
508
  */
392
- IsExpressionInjectionAnalysis?: number;
509
+ ErrRate?: number;
393
510
  /**
394
- * 是否开启JNDI注入检测(0-关闭,1-开启)
511
+ * 吞吐量
512
+ 注意:此字段可能返回 null,表示取不到有效值。
395
513
  */
396
- IsJNDIInjectionAnalysis?: number;
514
+ Qps?: number;
397
515
  /**
398
- * 是否开启JNI注入检测(0-关闭,1-开启)
516
+ * 边类型
517
+ 注意:此字段可能返回 null,表示取不到有效值。
399
518
  */
400
- IsJNIInjectionAnalysis?: number;
519
+ Type?: string;
401
520
  /**
402
- * 是否开启Webshell后门检测(0-关闭,1-开启)
521
+ * 边颜色
522
+ 注意:此字段可能返回 null,表示取不到有效值。
403
523
  */
404
- IsWebshellBackdoorAnalysis?: number;
524
+ Color?: string;
405
525
  /**
406
- * 是否开启反序列化检测(0-关闭,1-开启)
526
+ * Sql调用数
527
+ 注意:此字段可能返回 null,表示取不到有效值。
407
528
  */
408
- IsDeserializationAnalysis?: number;
529
+ SqlRequestCount?: number;
409
530
  /**
410
- * 业务系统鉴权 token
531
+ * Sql调用错误数
532
+ 注意:此字段可能返回 null,表示取不到有效值。
411
533
  */
412
- Token?: string;
534
+ SqlErrorRequestCount?: number;
413
535
  /**
414
- * URL长分段收敛阈值
536
+ * 边上源节点类型 应用/MQ/DB
415
537
  */
416
- UrlLongSegmentThreshold?: number;
538
+ SourceComp?: string;
417
539
  /**
418
- * URL数字分段收敛阈值
540
+ * 边上目标节点类型 应用/MQ/DB
419
541
  */
420
- UrlNumberSegmentThreshold?: number;
542
+ TargetComp?: string;
421
543
  }
422
544
  /**
423
- * CreateApmInstance请求参数结构体
545
+ * DescribeApmPrometheusRule请求参数结构体
424
546
  */
425
- export interface CreateApmInstanceRequest {
426
- /**
427
- * 业务系统名
428
- */
429
- Name: string;
547
+ export interface DescribeApmPrometheusRuleRequest {
430
548
  /**
431
- * 业务系统描述信息
549
+ * 业务系统ID
432
550
  */
433
- Description?: string;
551
+ InstanceId: string;
552
+ }
553
+ /**
554
+ * CreateApmPrometheusRule返回参数结构体
555
+ */
556
+ export interface CreateApmPrometheusRuleResponse {
434
557
  /**
435
- * Trace 数据保存时长(单位:天,默认存储时长为3天)
558
+ * 指标匹配规则的ID
436
559
  */
437
- TraceDuration?: number;
560
+ RuleId?: number;
438
561
  /**
439
- * 业务系统 Tag 列表
562
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
440
563
  */
441
- Tags?: Array<ApmTag>;
564
+ RequestId?: string;
565
+ }
566
+ /**
567
+ * TerminateApmInstance返回参数结构体
568
+ */
569
+ export interface TerminateApmInstanceResponse {
442
570
  /**
443
- * 业务系统上报额度值,默认赋值为0表示不限制上报额度,已废弃
571
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
444
572
  */
445
- SpanDailyCounters?: number;
446
- /**
447
- * 业务系统的计费模式(0=按量付费,1=预付费)
448
- */
449
- PayMode?: number;
450
- /**
451
- * 是否为免费版业务系统(0=付费版;1=TSF 受限免费版;2=免费版)
452
- */
453
- Free?: number;
573
+ RequestId?: string;
454
574
  }
455
575
  /**
456
- * ModifyGeneralApmApplicationConfig请求参数结构体
576
+ * 指标列表单元
457
577
  */
458
- export interface ModifyGeneralApmApplicationConfigRequest {
459
- /**
460
- * 业务系统Id
461
- */
462
- InstanceId: string;
578
+ export interface ApmMetricRecord {
463
579
  /**
464
- * 需要修改的字段key value分别指定字段名、字段值
465
- [具体字段请见](https://cloud.tencent.com/document/product/248/111241)
580
+ * field数组,用于指标的查询结果
466
581
  */
467
- Tags: Array<ApmTag>;
582
+ Fields?: Array<ApmField>;
468
583
  /**
469
- * 需要修改配置的应用列表名称
584
+ * tag数组,用于区分 Groupby 的对象
470
585
  */
471
- ServiceNames: Array<string>;
586
+ Tags?: Array<ApmTag>;
472
587
  }
473
588
  /**
474
- * DescribeApmServiceMetric请求参数结构体
589
+ * 拓扑图边节点
475
590
  */
476
- export interface DescribeApmServiceMetricRequest {
477
- /**
478
- * 业务系统ID
479
- */
480
- InstanceId: string;
481
- /**
482
- * 应用名
483
- */
484
- ServiceName?: string;
485
- /**
486
- * 应用ID
487
- */
488
- ServiceID?: string;
489
- /**
490
- * 开始时间
491
- */
492
- StartTime?: number;
493
- /**
494
- * 结束时间
495
- */
496
- EndTime?: number;
497
- /**
498
- * 排序
499
- */
500
- OrderBy?: OrderBy;
501
- /**
502
- * 是否demo模式
503
- */
504
- Demo?: boolean;
505
- /**
506
- * 应用状态筛选,可枚举的值为:health、warning、error。如果选中多个状态用逗号隔开,例如:"warning,error"
507
- */
508
- ServiceStatus?: string;
509
- /**
510
- * 标签列表
511
- */
512
- Tags?: Array<ApmTag>;
591
+ export interface TopologyNode {
513
592
  /**
514
- * 页码
593
+ * 错误率
594
+ 注意:此字段可能返回 null,表示取不到有效值。
515
595
  */
516
- Page?: number;
596
+ ErrRate?: number;
517
597
  /**
518
- * 页大小
598
+ * 节点类型
599
+ 注意:此字段可能返回 null,表示取不到有效值。
519
600
  */
520
- PageSize?: number;
601
+ Kind?: string;
521
602
  /**
522
- * 过滤条件
603
+ * 节点名
523
604
  */
524
- Filters?: Array<Filter>;
525
- }
526
- /**
527
- * CreateApmPrometheusRule请求参数结构体
528
- */
529
- export interface CreateApmPrometheusRuleRequest {
605
+ Name?: string;
530
606
  /**
531
- * 指标匹配规则名
607
+ * 节点权重
608
+ 注意:此字段可能返回 null,表示取不到有效值。
532
609
  */
533
- Name: string;
610
+ Weight?: number;
534
611
  /**
535
- * 规则生效的应用。作用全部应用就传空字符串
612
+ * 节点颜色
613
+ 注意:此字段可能返回 null,表示取不到有效值。
536
614
  */
537
- ServiceName: string;
615
+ Color?: string;
538
616
  /**
539
- * 指标匹配类型:0精准匹配,1前缀匹配,2后缀匹配
617
+ * 响应时间
618
+ 注意:此字段可能返回 null,表示取不到有效值。
540
619
  */
541
- MetricMatchType: number;
620
+ Duration?: number;
542
621
  /**
543
- * 客户定义的命中指标名规则。
622
+ * 吞吐量
623
+ 注意:此字段可能返回 null,表示取不到有效值。
544
624
  */
545
- MetricNameRule: string;
625
+ Qps?: number;
546
626
  /**
547
- * 业务系统ID
627
+ * 节点类型
628
+ 注意:此字段可能返回 null,表示取不到有效值。
548
629
  */
549
- InstanceId: string;
550
- }
551
- /**
552
- * 查询
553
- */
554
- export interface QueryMetricItem {
630
+ Type?: string;
555
631
  /**
556
- * 指标名
632
+ * 节点ID
557
633
  */
558
- MetricName: string;
634
+ Id?: string;
559
635
  /**
560
- * 同比,现支持 CompareByYesterday (与昨天相比)和CompareByLastWeek (与上周相比)
636
+ * 节点大小
637
+ 注意:此字段可能返回 null,表示取不到有效值。
561
638
  */
562
- Compares?: Array<string>;
639
+ Size?: string;
563
640
  /**
564
- * 同比,已弃用,不建议使用
641
+ * 节点是否为组件类型
642
+ 注意:此字段可能返回 null,表示取不到有效值。
565
643
  */
566
- Compare?: string;
567
- }
568
- /**
569
- * ModifyApmPrometheusRule请求参数结构体
570
- */
571
- export interface ModifyApmPrometheusRuleRequest {
644
+ IsModule?: boolean;
572
645
  /**
573
- * 规则ID
646
+ * 节点位置信息
647
+ 注意:此字段可能返回 null,表示取不到有效值。
574
648
  */
575
- Id: number;
649
+ Position?: Position;
576
650
  /**
577
- * 业务系统ID
651
+ * 节点标签
652
+ 注意:此字段可能返回 null,表示取不到有效值。
578
653
  */
579
- InstanceId: string;
654
+ Tags?: Array<ApmTag>;
580
655
  /**
581
- * 所要修改的规则名
656
+ * 节点是否可以下钻
657
+ 注意:此字段可能返回 null,表示取不到有效值。
582
658
  */
583
- Name?: string;
659
+ CanDrillDown?: boolean;
584
660
  /**
585
- * 规则状态:1(启用)、2(不启用)、3(删除)
661
+ * 资源层信息
662
+ 注意:此字段可能返回 null,表示取不到有效值。
586
663
  */
587
- Status?: number;
664
+ Resource?: Resource;
588
665
  /**
589
- * 规则生效的应用。生效于全部应用就传空(这个如果不修改也要传旧的规则)
666
+ * 拓扑节点视图名字
590
667
  */
591
- ServiceName?: string;
668
+ NodeView?: string;
592
669
  /**
593
- * 匹配类型:0精准匹配,1前缀匹配,2后缀匹配(这个如果不修改也要传旧的规则)
670
+ * MQ 消费者视角的响应时间 ms
594
671
  */
595
- MetricMatchType?: number;
672
+ ConsumerDuration?: number;
596
673
  /**
597
- * 客户定义的命中指标名规则。
674
+ * MQ 消费者视角的错误率 %
598
675
  */
599
- MetricNameRule?: string;
600
- }
601
- /**
602
- * ModifyGeneralApmApplicationConfig返回参数结构体
603
- */
604
- export interface ModifyGeneralApmApplicationConfigResponse {
676
+ ConsumerErrRate?: number;
605
677
  /**
606
- * 返回值描述
678
+ * MQ 消费者视角的吞吐量
607
679
  */
608
- Message?: string;
680
+ ConsumerQps?: number;
609
681
  /**
610
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
682
+ * 应用 ID
611
683
  */
612
- RequestId?: string;
684
+ ServiceId?: string;
613
685
  }
614
686
  /**
615
- * DescribeApmInstances返回参数结构体
687
+ * DescribeApmAgent返回参数结构体
616
688
  */
617
- export interface DescribeApmInstancesResponse {
689
+ export interface DescribeApmAgentResponse {
618
690
  /**
619
- * APM 业务系统列表
691
+ * Agent 信息
620
692
  */
621
- Instances?: Array<ApmInstanceDetail>;
693
+ ApmAgent?: ApmAgentInfo;
622
694
  /**
623
695
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
624
696
  */
625
697
  RequestId?: string;
626
698
  }
627
699
  /**
628
- * 探针有关接口的相关配置
700
+ * CreateApmSampleConfig请求参数结构体
629
701
  */
630
- export interface AgentOperationConfigView {
702
+ export interface CreateApmSampleConfigRequest {
631
703
  /**
632
- * 当前接口配置是否开启了接口白名单配置
633
- 注意:此字段可能返回 null,表示取不到有效值。
704
+ * 业务系统ID
634
705
  */
635
- RetentionValid?: boolean;
706
+ InstanceId: string;
636
707
  /**
637
- * RetentionValid为false时生效,接口配置中的黑名单配置,配置中的接口不采集
638
- 注意:此字段可能返回 null,表示取不到有效值。
708
+ * 采样率
639
709
  */
640
- IgnoreOperation?: string;
710
+ SampleRate: number;
641
711
  /**
642
- * RetentionValid为true时生效,接口配置中的白名单配置,仅采集配置中的接口
643
- 注意:此字段可能返回 null,表示取不到有效值。
712
+ * 应用名
644
713
  */
645
- RetentionOperation?: string;
646
- }
647
- /**
648
- * 组件
649
- */
650
- export interface Instrument {
714
+ ServiceName: string;
651
715
  /**
652
- * 组件名称
716
+ * 采样规则名
653
717
  */
654
- Name?: string;
718
+ SampleName: string;
655
719
  /**
656
- * 组件开关
720
+ * 采样Tags
657
721
  */
658
- Enable?: boolean;
659
- }
660
- /**
661
- * DescribeTagValues返回参数结构体
662
- */
663
- export interface DescribeTagValuesResponse {
722
+ Tags?: Array<APMKVItem>;
664
723
  /**
665
- * 维度值列表
724
+ * 接口名
666
725
  */
667
- Values?: Array<string>;
726
+ OperationName?: string;
668
727
  /**
669
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
728
+ * 0=精确匹配(默认);1=前缀匹配;2=后缀匹配
670
729
  */
671
- RequestId?: string;
730
+ OperationType?: number;
672
731
  }
673
732
  /**
674
733
  * DescribeTagValues请求参数结构体
@@ -704,238 +763,252 @@ export interface DescribeTagValuesRequest {
704
763
  Type?: string;
705
764
  }
706
765
  /**
707
- * DescribeApmPrometheusRule返回参数结构体
766
+ * apm应用指标信息
708
767
  */
709
- export interface DescribeApmPrometheusRuleResponse {
768
+ export interface ApmServiceMetric {
710
769
  /**
711
- * 指标匹配规则
770
+ * filed数组
771
+ 注意:此字段可能返回 null,表示取不到有效值。
712
772
  */
713
- ApmPrometheusRules?: Array<ApmPrometheusRules>;
773
+ Fields?: Array<ApmField>;
714
774
  /**
715
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
775
+ * tag数组
776
+ 注意:此字段可能返回 null,表示取不到有效值。
716
777
  */
717
- RequestId?: string;
718
- }
719
- /**
720
- * 应用详细信息
721
- */
722
- export interface ServiceDetail {
778
+ Tags?: Array<ApmTag>;
723
779
  /**
724
- * 应用ID
780
+ * 应用信息
725
781
  注意:此字段可能返回 null,表示取不到有效值。
726
782
  */
727
- ServiceID?: string;
783
+ ServiceDetail?: ServiceDetail;
784
+ }
785
+ /**
786
+ * 查询应用配置返回参数
787
+ */
788
+ export interface ApmAppConfig {
728
789
  /**
729
- * 业务系统ID
730
- 注意:此字段可能返回 null,表示取不到有效值。
790
+ * 实例ID
731
791
  */
732
792
  InstanceKey?: string;
733
793
  /**
734
- * 用户appid
735
- 注意:此字段可能返回 null,表示取不到有效值。
794
+ * 服务名
736
795
  */
737
- AppID?: number;
796
+ ServiceName?: string;
738
797
  /**
739
- * 主账号uin
740
- 注意:此字段可能返回 null,表示取不到有效值。
798
+ * URL收敛开关
741
799
  */
742
- CreateUIN?: string;
800
+ UrlConvergenceSwitch?: number;
743
801
  /**
744
- * 应用名
745
- 注意:此字段可能返回 null,表示取不到有效值。
802
+ * URL收敛阈值
746
803
  */
747
- ServiceName?: string;
804
+ UrlConvergenceThreshold?: number;
748
805
  /**
749
- * 应用描述
750
- 注意:此字段可能返回 null,表示取不到有效值。
806
+ * URL收敛正则
751
807
  */
752
- ServiceDescription?: string;
808
+ UrlConvergence?: string;
753
809
  /**
754
- * 地域
755
- 注意:此字段可能返回 null,表示取不到有效值。
810
+ * 异常过滤正则
756
811
  */
757
- Region?: string;
812
+ ExceptionFilter?: string;
758
813
  /**
759
- * 标签
760
- 注意:此字段可能返回 null,表示取不到有效值。
814
+ * 错误码过滤
761
815
  */
762
- Tags?: Array<ApmTag>;
816
+ ErrorCodeFilter?: string;
763
817
  /**
764
- * 业务系统名称
818
+ * 服务组件类型
765
819
  */
766
- InstanceName?: string;
767
- }
768
- /**
769
- * Span 对象
770
- */
771
- export interface Span {
820
+ Components?: string;
772
821
  /**
773
- * Trace ID
822
+ * URL排除正则
774
823
  */
775
- TraceID?: string;
824
+ UrlExclude?: string;
776
825
  /**
777
- * 日志
826
+ * 日志来源
778
827
  */
779
- Logs?: Array<SpanLog>;
828
+ LogSource?: string;
780
829
  /**
781
- * 标签
830
+ * 日志所在地域
782
831
  */
783
- Tags?: Array<SpanTag>;
832
+ LogRegion?: string;
784
833
  /**
785
- * 上报应用服务信息
834
+ * 是否开启日志 0 关 1 开
786
835
  */
787
- Process?: SpanProcess;
836
+ IsRelatedLog?: number;
788
837
  /**
789
- * 产生时间戳(毫秒)
838
+ * 日志主题ID
790
839
  */
791
- Timestamp?: number;
840
+ LogTopicID?: string;
792
841
  /**
793
- * Span 名称
842
+ * 需过滤的接口名
794
843
  */
795
- OperationName?: string;
844
+ IgnoreOperationName?: string;
796
845
  /**
797
- * 关联关系
846
+ * CLS日志集 | ES集群ID
798
847
  */
799
- References?: Array<SpanReference>;
848
+ LogSet?: string;
800
849
  /**
801
- * 产生时间戳(微秒)
850
+ * 探针每秒上报trace数
802
851
  */
803
- StartTime?: number;
852
+ TraceRateLimit?: number;
804
853
  /**
805
- * 持续耗时(微妙)
854
+ * 是否开启线程剖析
806
855
  */
807
- Duration?: number;
856
+ EnableSnapshot?: boolean;
808
857
  /**
809
- * Span ID
858
+ * 线程剖析超时阈值
810
859
  */
811
- SpanID?: string;
860
+ SnapshotTimeout?: number;
812
861
  /**
813
- * 产生时间戳(毫秒)
862
+ * 是否开启agent
814
863
  */
815
- StartTimeMillis?: number;
864
+ AgentEnable?: boolean;
816
865
  /**
817
- * Parent Span ID
866
+ * 组件列表
867
+ 注意:此字段可能返回 null,表示取不到有效值。
818
868
  */
819
- ParentSpanID?: string;
820
- }
821
- /**
822
- * APM Agent 信息
823
- */
824
- export interface ApmAgentInfo {
869
+ InstrumentList?: Array<Instrument>;
825
870
  /**
826
- * Agent 下载地址
871
+ * 是否开启链路压缩
827
872
  */
828
- AgentDownloadURL?: string;
873
+ TraceSquash?: boolean;
829
874
  /**
830
- * Collector 上报地址
875
+ * 是否开启应用诊断开关
831
876
  */
832
- CollectorURL?: string;
877
+ EventEnable?: boolean;
833
878
  /**
834
- * Token 信息
879
+ * 探针接口相关配置
880
+ 注意:此字段可能返回 null,表示取不到有效值。
835
881
  */
836
- Token?: string;
882
+ AgentOperationConfigView?: AgentOperationConfigView;
837
883
  /**
838
- * 外网上报地址
884
+ * 是否开启应用日志配置
839
885
  */
840
- PublicCollectorURL?: string;
886
+ EnableLogConfig?: boolean;
841
887
  /**
842
- * 自研 VPC 上报地址
888
+ * 应用ID
889
+ 注意:此字段可能返回 null,表示取不到有效值。
843
890
  */
844
- InnerCollectorURL?: string;
891
+ ServiceID?: string;
845
892
  /**
846
- * 内网上报地址( Private Link 上报地址)
893
+ * 应用是否开启dashboard配置: false 关(与业务系统保持一致)/true 开(应用级配置)
894
+ 注意:此字段可能返回 null,表示取不到有效值。
847
895
  */
848
- PrivateLinkCollectorURL?: string;
849
- }
850
- /**
851
- * TerminateApmInstance请求参数结构体
852
- */
853
- export interface TerminateApmInstanceRequest {
896
+ EnableDashboardConfig?: boolean;
854
897
  /**
855
- * 业务系统ID
898
+ * 是否关联dashboard: 0 关 1 开
899
+ 注意:此字段可能返回 null,表示取不到有效值。
856
900
  */
857
- InstanceId: string;
858
- }
859
- /**
860
- * 应用相关的配置列表项
861
- */
862
- export interface ApmApplicationConfigView {
901
+ IsRelatedDashboard?: number;
863
902
  /**
864
- * 业务系统 ID
903
+ * dashboard ID
904
+ 注意:此字段可能返回 null,表示取不到有效值。
865
905
  */
866
- InstanceKey?: string;
906
+ DashboardTopicID?: string;
867
907
  /**
868
- * 应用名
908
+ * 是否开启应用级别配置
909
+ 注意:此字段可能返回 null,表示取不到有效值。
869
910
  */
870
- ServiceName?: string;
911
+ EnableSecurityConfig?: boolean;
871
912
  /**
872
- * 接口过滤
913
+ * 是否开启组件漏洞检测
914
+ 注意:此字段可能返回 null,表示取不到有效值。
873
915
  */
874
- OperationNameFilter?: string;
916
+ IsInstrumentationVulnerabilityScan?: number;
875
917
  /**
876
- * 错误类型过滤
918
+ * 是否开启SQL注入分析
919
+ 注意:此字段可能返回 null,表示取不到有效值。
877
920
  */
878
- ExceptionFilter?: string;
921
+ IsSqlInjectionAnalysis?: number;
879
922
  /**
880
- * HTTP 状态码过滤
923
+ * 是否开启远程命令执行分析
924
+ 注意:此字段可能返回 null,表示取不到有效值。
881
925
  */
882
- ErrorCodeFilter?: string;
926
+ IsRemoteCommandExecutionAnalysis?: number;
883
927
  /**
884
- * 应用诊断开关(已废弃)
928
+ * 是否开启内存马检测分析
929
+ 注意:此字段可能返回 null,表示取不到有效值。
885
930
  */
886
- EventEnable?: boolean;
931
+ IsMemoryHijackingAnalysis?: number;
887
932
  /**
888
- * URL 收敛开关 01
933
+ * CLS索引类型(0=全文索引,1=键值索引)
889
934
  */
890
- UrlConvergenceSwitch?: number;
935
+ LogIndexType?: number;
891
936
  /**
892
- * URL 收敛阈值
937
+ * traceId的索引key: 当CLS索引类型为键值索引时生效
893
938
  */
894
- UrlConvergenceThreshold?: number;
939
+ LogTraceIdKey?: string;
895
940
  /**
896
- * URL 收敛规则正则
941
+ * 是否开启删除任意文件检测(0-关闭,1-开启)
942
+ 注意:此字段可能返回 null,表示取不到有效值。
897
943
  */
898
- UrlConvergence?: string;
944
+ IsDeleteAnyFileAnalysis?: number;
899
945
  /**
900
- * URL 排除规则正则
946
+ * 是否开启读取任意文件检测(0-关闭,1-开启)
947
+ 注意:此字段可能返回 null,表示取不到有效值。
901
948
  */
902
- UrlExclude?: string;
949
+ IsReadAnyFileAnalysis?: number;
903
950
  /**
904
- * 是否开启日志 01
951
+ * 是否开启上传任意文件检测(0-关闭,1-开启)
952
+ 注意:此字段可能返回 null,表示取不到有效值。
905
953
  */
906
- IsRelatedLog?: number;
954
+ IsUploadAnyFileAnalysis?: number;
907
955
  /**
908
- * 日志源
956
+ * 是否开启包含任意文件检测(0-关闭,1-开启)
957
+ 注意:此字段可能返回 null,表示取不到有效值。
909
958
  */
910
- LogSource?: string;
959
+ IsIncludeAnyFileAnalysis?: number;
911
960
  /**
912
- * 日志集
961
+ * 是否开启目录遍历检测(0-关闭,1-开启)
962
+ 注意:此字段可能返回 null,表示取不到有效值。
913
963
  */
914
- LogSet?: string;
964
+ IsDirectoryTraversalAnalysis?: number;
915
965
  /**
916
- * 日志主题
966
+ * 是否开启模板引擎注入检测(0-关闭,1-开启)
967
+ 注意:此字段可能返回 null,表示取不到有效值。
917
968
  */
918
- LogTopicID?: string;
969
+ IsTemplateEngineInjectionAnalysis?: number;
919
970
  /**
920
- * 方法栈快照开关 true 开启 false 关闭
971
+ * 是否开启脚本引擎注入检测(0-关闭,1-开启)
972
+ 注意:此字段可能返回 null,表示取不到有效值。
921
973
  */
922
- SnapshotEnable?: boolean;
974
+ IsScriptEngineInjectionAnalysis?: number;
923
975
  /**
924
- * 慢调用监听触发阈值
976
+ * 是否开启表达式注入检测(0-关闭,1-开启)
977
+ 注意:此字段可能返回 null,表示取不到有效值。
925
978
  */
926
- SnapshotTimeout?: number;
979
+ IsExpressionInjectionAnalysis?: number;
927
980
  /**
928
- * 探针总开关
981
+ * 是否开启JNDI注入检测(0-关闭,1-开启)
982
+ 注意:此字段可能返回 null,表示取不到有效值。
929
983
  */
930
- AgentEnable?: boolean;
984
+ IsJNDIInjectionAnalysis?: number;
931
985
  /**
932
- * 组件列表开关(已废弃)
986
+ * 是否开启JNI注入检测(0-关闭,1-开启)
987
+ 注意:此字段可能返回 null,表示取不到有效值。
933
988
  */
934
- InstrumentList?: Array<Instrument>;
989
+ IsJNIInjectionAnalysis?: number;
935
990
  /**
936
- * 链路压缩开关(已废弃)
991
+ * 是否开启Webshell后门检测(0-关闭,1-开启)
992
+ 注意:此字段可能返回 null,表示取不到有效值。
937
993
  */
938
- TraceSquash?: boolean;
994
+ IsWebshellBackdoorAnalysis?: number;
995
+ /**
996
+ * 是否开启反序列化检测(0-关闭,1-开启)
997
+ 注意:此字段可能返回 null,表示取不到有效值。
998
+ */
999
+ IsDeserializationAnalysis?: number;
1000
+ /**
1001
+ * 接口名称自动收敛开关(0-关闭,1-开启)
1002
+ */
1003
+ UrlAutoConvergenceEnable?: boolean;
1004
+ /**
1005
+ * URL长分段收敛阈值
1006
+ */
1007
+ UrlLongSegmentThreshold?: number;
1008
+ /**
1009
+ * URL数字分段收敛阈值
1010
+ */
1011
+ UrlNumberSegmentThreshold?: number;
939
1012
  /**
940
1013
  * 探针熔断内存阈值
941
1014
  */
@@ -954,333 +1027,446 @@ export interface ApmApplicationConfigView {
954
1027
  SlowSQLThresholds?: Array<ApmTag>;
955
1028
  }
956
1029
  /**
957
- * 指标列表单元
1030
+ * CreateApmSampleConfig返回参数结构体
958
1031
  */
959
- export interface ApmMetricRecord {
1032
+ export interface CreateApmSampleConfigResponse {
960
1033
  /**
961
- * field数组,用于指标的查询结果
1034
+ * 采样配置参数
962
1035
  */
963
- Fields?: Array<ApmField>;
1036
+ ApmSampleConfig?: ApmSampleConfig;
964
1037
  /**
965
- * tag数组,用于区分 Groupby 的对象
1038
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
966
1039
  */
967
- Tags?: Array<ApmTag>;
1040
+ RequestId?: string;
968
1041
  }
969
1042
  /**
970
- * DescribeServiceOverview请求参数结构体
1043
+ * 指标曲线数据
971
1044
  */
972
- export interface DescribeServiceOverviewRequest {
1045
+ export interface Line {
973
1046
  /**
974
- * 业务系统 ID
1047
+ * 指标名
975
1048
  */
976
- InstanceId: string;
1049
+ MetricName?: string;
977
1050
  /**
978
- * 指标列表
1051
+ * 指标中文名
979
1052
  */
980
- Metrics: Array<QueryMetricItem>;
1053
+ MetricNameCN?: string;
981
1054
  /**
982
- * 开始时间(单位:秒)
1055
+ * 时间序列
983
1056
  */
984
- StartTime: number;
1057
+ TimeSerial?: Array<number | bigint>;
985
1058
  /**
986
- * 结束时间(单位:秒)
1059
+ * 数据序列
987
1060
  */
988
- EndTime: number;
1061
+ DataSerial?: Array<number>;
989
1062
  /**
990
- * 聚合维度
1063
+ * 维度列表
991
1064
  */
992
- GroupBy: Array<string>;
1065
+ Tags?: Array<ApmTag>;
993
1066
  /**
994
- * 过滤条件
1067
+ * 指标数据单位
995
1068
  */
996
- Filters?: Array<Filter>;
997
- /**
998
- * 排序方式
999
- Value 填写:
1000
- - asc:对查询指标进行升序排序
1001
- - desc:对查询指标进行降序排序
1002
- */
1003
- OrderBy?: OrderBy;
1004
- /**
1005
- * 每页大小
1006
- */
1007
- Limit?: number;
1008
- /**
1009
- * 分页起始点
1010
- */
1011
- Offset?: number;
1069
+ MetricUnit?: string;
1012
1070
  }
1013
1071
  /**
1014
- * DescribeApmSampleConfig返回参数结构体
1072
+ * ModifyApmAssociation返回参数结构体
1015
1073
  */
1016
- export interface DescribeApmSampleConfigResponse {
1017
- /**
1018
- * 采样配置列表
1019
- 注意:此字段可能返回 null,表示取不到有效值。
1020
- */
1021
- ApmSampleConfigs?: Array<ApmSampleConfig>;
1074
+ export interface ModifyApmAssociationResponse {
1022
1075
  /**
1023
1076
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1024
1077
  */
1025
1078
  RequestId?: string;
1026
1079
  }
1027
1080
  /**
1028
- * DescribeApmAgent返回参数结构体
1081
+ * APM 通用 KV 结构
1029
1082
  */
1030
- export interface DescribeApmAgentResponse {
1083
+ export interface APMKVItem {
1031
1084
  /**
1032
- * Agent 信息
1085
+ * Key 值定义
1033
1086
  */
1034
- ApmAgent?: ApmAgentInfo;
1087
+ Key: string;
1035
1088
  /**
1036
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1089
+ * Value 值定义
1037
1090
  */
1038
- RequestId?: string;
1091
+ Value: string;
1039
1092
  }
1040
1093
  /**
1041
- * CreateApmSampleConfig请求参数结构体
1094
+ * DescribeGeneralSpanList请求参数结构体
1042
1095
  */
1043
- export interface CreateApmSampleConfigRequest {
1096
+ export interface DescribeGeneralSpanListRequest {
1044
1097
  /**
1045
- * 业务系统ID
1098
+ * 业务系统 ID
1046
1099
  */
1047
1100
  InstanceId: string;
1048
1101
  /**
1049
- * 采样率
1102
+ * Span 查询开始时间戳(单位:秒)
1050
1103
  */
1051
- SampleRate: number;
1104
+ StartTime: number;
1052
1105
  /**
1053
- * 应用名
1106
+ * Span 查询结束时间戳(单位:秒)
1054
1107
  */
1055
- ServiceName: string;
1108
+ EndTime: number;
1056
1109
  /**
1057
- * 采样规则名
1110
+ * 通用过滤参数
1058
1111
  */
1059
- SampleName: string;
1112
+ Filters?: Array<Filter>;
1060
1113
  /**
1061
- * 采样Tags
1114
+ * 排序
1115
+ 现支持的 Key 有:
1116
+
1117
+ - startTime(开始时间)
1118
+ - endTime(结束时间)
1119
+ - duration(响应时间)
1120
+
1121
+ 现支持的 Value 有:
1122
+
1123
+ - desc(降序排序)
1124
+ - asc(升序排序)
1062
1125
  */
1063
- Tags?: Array<APMKVItem>;
1126
+ OrderBy?: OrderBy;
1064
1127
  /**
1065
- * 接口名
1128
+ * 业务自身服务名,控制台用户请填写taw
1066
1129
  */
1067
- OperationName?: string;
1130
+ BusinessName?: string;
1068
1131
  /**
1069
- * 0=精确匹配(默认);1=前缀匹配;2=后缀匹配
1132
+ * 单页项目个数,默认为1000,合法取值范围为1~1000
1070
1133
  */
1071
- OperationType?: number;
1134
+ Limit?: number;
1135
+ /**
1136
+ * 分页
1137
+ */
1138
+ Offset?: number;
1072
1139
  }
1073
1140
  /**
1074
- * DescribeApmSampleConfig请求参数结构体
1141
+ * DescribeApmAgent请求参数结构体
1075
1142
  */
1076
- export interface DescribeApmSampleConfigRequest {
1143
+ export interface DescribeApmAgentRequest {
1077
1144
  /**
1078
- * 业务系统ID
1145
+ * 业务系统 ID
1079
1146
  */
1080
1147
  InstanceId: string;
1081
1148
  /**
1082
- * 采样规则名
1149
+ * 接入方式,现支持 skywalking, ot, ebpf 方式接入上报,不填默认为 ot
1083
1150
  */
1084
- SampleName?: string;
1085
- }
1086
- /**
1087
- * ModifyApmInstance返回参数结构体
1088
- */
1089
- export interface ModifyApmInstanceResponse {
1151
+ AgentType?: string;
1090
1152
  /**
1091
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1153
+ * 上报环境,现支持 pl (内网上报), public (外网), inner (自研 VPC )环境上报,不传默认为 public
1092
1154
  */
1093
- RequestId?: string;
1094
- }
1095
- /**
1096
- * Span日志部分
1097
-
1098
-
1099
- */
1100
- export interface SpanLog {
1155
+ NetworkMode?: string;
1101
1156
  /**
1102
- * 日志时间戳
1157
+ * 语言,现支持 java, golang, php, python, dotNet, nodejs 语言上报,不传默认为 golang
1103
1158
  */
1104
- Timestamp: number;
1159
+ LanguageEnvironment?: string;
1105
1160
  /**
1106
- * 标签
1161
+ * 上报方式,已弃用
1107
1162
  */
1108
- Fields: Array<SpanTag>;
1163
+ ReportMethod?: string;
1109
1164
  }
1110
1165
  /**
1111
- * apm应用指标信息
1166
+ * DescribeMetricRecords请求参数结构体
1112
1167
  */
1113
- export interface ApmServiceMetric {
1168
+ export interface DescribeMetricRecordsRequest {
1114
1169
  /**
1115
- * filed数组
1116
- 注意:此字段可能返回 null,表示取不到有效值。
1170
+ * 业务系统 ID
1117
1171
  */
1118
- Fields?: Array<ApmField>;
1172
+ InstanceId: string;
1119
1173
  /**
1120
- * tag数组
1121
- 注意:此字段可能返回 null,表示取不到有效值。
1174
+ * 指标列表
1122
1175
  */
1123
- Tags?: Array<ApmTag>;
1176
+ Metrics: Array<QueryMetricItem>;
1124
1177
  /**
1125
- * 应用信息
1126
- 注意:此字段可能返回 null,表示取不到有效值。
1178
+ * 开始时间(单位为秒)
1127
1179
  */
1128
- ServiceDetail?: ServiceDetail;
1129
- }
1130
- /**
1131
- * ModifyApmSampleConfig返回参数结构体
1132
- */
1133
- export interface ModifyApmSampleConfigResponse {
1180
+ StartTime: number;
1134
1181
  /**
1135
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1182
+ * 结束时间(单位为秒)
1136
1183
  */
1137
- RequestId?: string;
1138
- }
1139
- /**
1140
- * 查询应用配置返回参数
1141
- */
1142
- export interface ApmAppConfig {
1184
+ EndTime: number;
1143
1185
  /**
1144
- * 实例ID
1186
+ * 聚合维度
1145
1187
  */
1146
- InstanceKey?: string;
1188
+ GroupBy: Array<string>;
1147
1189
  /**
1148
- * 服务名
1190
+ * 过滤条件
1149
1191
  */
1150
- ServiceName?: string;
1192
+ Filters?: Array<Filter>;
1151
1193
  /**
1152
- * URL收敛开关
1194
+ * Or 过滤条件
1153
1195
  */
1154
- UrlConvergenceSwitch?: number;
1196
+ OrFilters?: Array<Filter>;
1155
1197
  /**
1156
- * URL收敛阈值
1198
+ * 排序
1199
+ 现支持的 Key 有:
1200
+
1201
+ - startTime(开始时间)
1202
+ - endTime(结束时间)
1203
+ - duration(响应时间)
1204
+
1205
+ 现支持的 Value 有:
1206
+
1207
+ - desc(降序排序)
1208
+ - asc(升序排序)
1157
1209
  */
1158
- UrlConvergenceThreshold?: number;
1210
+ OrderBy?: OrderBy;
1159
1211
  /**
1160
- * URL收敛正则
1212
+ * 业务名称,控制台用户请填写taw。
1161
1213
  */
1162
- UrlConvergence?: string;
1214
+ BusinessName?: string;
1163
1215
  /**
1164
- * 异常过滤正则
1216
+ * 特殊处理查询结果
1165
1217
  */
1166
- ExceptionFilter?: string;
1218
+ Type?: string;
1167
1219
  /**
1168
- * 错误码过滤
1220
+ * 每页大小,默认为1000,合法取值范围为0~1000
1169
1221
  */
1170
- ErrorCodeFilter?: string;
1222
+ Limit?: number;
1171
1223
  /**
1172
- * 服务组件类型
1224
+ * 分页起始点
1173
1225
  */
1174
- Components?: string;
1226
+ Offset?: number;
1175
1227
  /**
1176
- * URL排除正则
1228
+ * 页码
1177
1229
  */
1178
- UrlExclude?: string;
1230
+ PageIndex?: number;
1179
1231
  /**
1180
- * 日志来源
1232
+ * 页长
1181
1233
  */
1182
- LogSource?: string;
1234
+ PageSize?: number;
1235
+ }
1236
+ /**
1237
+ * DescribeGeneralMetricData请求参数结构体
1238
+ */
1239
+ export interface DescribeGeneralMetricDataRequest {
1183
1240
  /**
1184
- * 日志所在地域
1241
+ * 需要查询的指标名称,不可自定义输入,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1185
1242
  */
1186
- LogRegion?: string;
1243
+ Metrics: Array<string>;
1187
1244
  /**
1188
- * 是否开启日志 0 关 1 开
1245
+ * 业务系统 ID
1189
1246
  */
1190
- IsRelatedLog?: number;
1247
+ InstanceId: string;
1191
1248
  /**
1192
- * 日志主题ID
1249
+ * 视图名称,不可自定义输入。[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1193
1250
  */
1194
- LogTopicID?: string;
1251
+ ViewName: string;
1195
1252
  /**
1196
- * 需过滤的接口名
1253
+ * 要过滤的维度信息,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1197
1254
  */
1198
- IgnoreOperationName?: string;
1255
+ Filters: Array<GeneralFilter>;
1199
1256
  /**
1200
- * CLS日志集 | ES集群ID
1257
+ * 聚合维度,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1201
1258
  */
1202
- LogSet?: string;
1259
+ GroupBy?: Array<string>;
1203
1260
  /**
1204
- * 探针每秒上报trace数
1261
+ * 起始时间的时间戳,支持查询30天内的指标数据。(单位:秒)
1205
1262
  */
1206
- TraceRateLimit?: number;
1263
+ StartTime?: number;
1207
1264
  /**
1208
- * 是否开启线程剖析
1265
+ * 结束时间的时间戳,支持查询30天内的指标数据。(单位:秒)
1209
1266
  */
1210
- EnableSnapshot?: boolean;
1267
+ EndTime?: number;
1211
1268
  /**
1212
- * 线程剖析超时阈值
1269
+ * 是否按固定时间跨度聚合,填入1及大于1的值按1处理,不填按0处理。
1270
+ - 填入0,则计算开始时间到截止时间的指标数据。
1271
+ - 填入1,则会按照开始时间到截止时间的时间跨度选择聚合粒度:
1272
+ - 时间跨度 (0,12) 小时,则按一分钟粒度聚合。
1273
+ - 时间跨度 [12,48] 小时,则按五分钟粒度聚合。
1274
+ - 时间跨度 (48, +∞) 小时,则按一小时粒度聚合。
1213
1275
  */
1214
- SnapshotTimeout?: number;
1276
+ Period?: number;
1215
1277
  /**
1216
- * 是否开启agent
1278
+ * 对查询指标进行排序:
1279
+ Key 填写云 API 指标名称,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1280
+ Value 填写排序方式:
1281
+ - asc:对查询指标进行升序排序
1282
+ - desc:对查询指标进行降序排序
1217
1283
  */
1218
- AgentEnable?: boolean;
1284
+ OrderBy?: OrderBy;
1219
1285
  /**
1220
- * 组件列表
1221
- 注意:此字段可能返回 null,表示取不到有效值。
1286
+ * 查询指标的限制条数,目前最多展示50条数据,PageSize取值为1-50,上送PageSize则根据PageSize的值展示限制条数。
1222
1287
  */
1223
- InstrumentList?: Array<Instrument>;
1288
+ PageSize?: number;
1289
+ }
1290
+ /**
1291
+ * ModifyApmPrometheusRule请求参数结构体
1292
+ */
1293
+ export interface ModifyApmPrometheusRuleRequest {
1224
1294
  /**
1225
- * 是否开启链路压缩
1295
+ * 规则ID
1226
1296
  */
1227
- TraceSquash?: boolean;
1297
+ Id: number;
1228
1298
  /**
1229
- * 是否开启应用诊断开关
1299
+ * 业务系统ID
1230
1300
  */
1231
- EventEnable?: boolean;
1301
+ InstanceId: string;
1232
1302
  /**
1233
- * 探针接口相关配置
1234
- 注意:此字段可能返回 null,表示取不到有效值。
1303
+ * 所要修改的规则名
1235
1304
  */
1236
- AgentOperationConfigView?: AgentOperationConfigView;
1305
+ Name?: string;
1237
1306
  /**
1238
- * 是否开启应用日志配置
1307
+ * 规则状态:1(启用)、2(不启用)、3(删除)
1239
1308
  */
1240
- EnableLogConfig?: boolean;
1309
+ Status?: number;
1241
1310
  /**
1242
- * 应用ID
1243
- 注意:此字段可能返回 null,表示取不到有效值。
1311
+ * 规则生效的应用。生效于全部应用就传空(这个如果不修改也要传旧的规则)
1244
1312
  */
1245
- ServiceID?: string;
1313
+ ServiceName?: string;
1246
1314
  /**
1247
- * 应用是否开启dashboard配置: false 关(与业务系统保持一致)/true 开(应用级配置)
1248
- 注意:此字段可能返回 null,表示取不到有效值。
1315
+ * 匹配类型:0精准匹配,1前缀匹配,2后缀匹配(这个如果不修改也要传旧的规则)
1249
1316
  */
1250
- EnableDashboardConfig?: boolean;
1317
+ MetricMatchType?: number;
1251
1318
  /**
1252
- * 是否关联dashboard: 0 关 1 开
1253
- 注意:此字段可能返回 null,表示取不到有效值。
1319
+ * 客户定义的命中指标名规则。
1254
1320
  */
1255
- IsRelatedDashboard?: number;
1321
+ MetricNameRule?: string;
1322
+ }
1323
+ /**
1324
+ * ModifyApmInstance返回参数结构体
1325
+ */
1326
+ export interface ModifyApmInstanceResponse {
1256
1327
  /**
1257
- * dashboard ID
1258
- 注意:此字段可能返回 null,表示取不到有效值。
1328
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1259
1329
  */
1260
- DashboardTopicID?: string;
1330
+ RequestId?: string;
1331
+ }
1332
+ /**
1333
+ * 标签
1334
+ */
1335
+ export interface SpanTag {
1261
1336
  /**
1262
- * 是否开启应用级别配置
1263
- 注意:此字段可能返回 null,表示取不到有效值。
1337
+ * 标签类型
1264
1338
  */
1265
- EnableSecurityConfig?: boolean;
1339
+ Type: string;
1266
1340
  /**
1267
- * 是否开启组件漏洞检测
1341
+ * 标签Key
1268
1342
  注意:此字段可能返回 null,表示取不到有效值。
1269
1343
  */
1270
- IsInstrumentationVulnerabilityScan?: number;
1344
+ Key: string;
1271
1345
  /**
1272
- * 是否开启SQL注入分析
1346
+ * 标签值
1273
1347
  注意:此字段可能返回 null,表示取不到有效值。
1274
1348
  */
1349
+ Value: string;
1350
+ }
1351
+ /**
1352
+ * DescribeGeneralMetricData返回参数结构体
1353
+ */
1354
+ export interface DescribeGeneralMetricDataResponse {
1355
+ /**
1356
+ * 指标结果集
1357
+ */
1358
+ Records?: Array<Line>;
1359
+ /**
1360
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1361
+ */
1362
+ RequestId?: string;
1363
+ }
1364
+ /**
1365
+ * ModifyApmInstance请求参数结构体
1366
+ */
1367
+ export interface ModifyApmInstanceRequest {
1368
+ /**
1369
+ * 业务系统 ID
1370
+ */
1371
+ InstanceId: string;
1372
+ /**
1373
+ * 业务系统名
1374
+ */
1375
+ Name: string;
1376
+ /**
1377
+ * Tag 列表
1378
+ */
1379
+ Tags?: Array<ApmTag>;
1380
+ /**
1381
+ * 业务系统描述
1382
+ */
1383
+ Description?: string;
1384
+ /**
1385
+ * Trace 数据保存时长(单位:天)
1386
+ */
1387
+ TraceDuration?: number;
1388
+ /**
1389
+ * 是否开启计费
1390
+ */
1391
+ OpenBilling?: boolean;
1392
+ /**
1393
+ * 业务系统上报额度
1394
+ */
1395
+ SpanDailyCounters?: number;
1396
+ /**
1397
+ * 错误率警示线,当应用的平均错误率超出该阈值时,系统会给出异常提示。
1398
+ */
1399
+ ErrRateThreshold?: number;
1400
+ /**
1401
+ * 采样率(单位:%)
1402
+ */
1403
+ SampleRate?: number;
1404
+ /**
1405
+ * 是否开启错误采样(0=关, 1=开)
1406
+ */
1407
+ ErrorSample?: number;
1408
+ /**
1409
+ * 采样慢调用保存阈值(单位:ms)
1410
+ */
1411
+ SlowRequestSavedThreshold?: number;
1412
+ /**
1413
+ * 是否开启日志功能(0=关, 1=开)
1414
+ */
1415
+ IsRelatedLog?: number;
1416
+ /**
1417
+ * 日志地域,开启日志功能后才会生效
1418
+ */
1419
+ LogRegion?: string;
1420
+ /**
1421
+ * CLS 日志主题 ID,开启日志功能后才会生效
1422
+ */
1423
+ LogTopicID?: string;
1424
+ /**
1425
+ * 日志集,开启日志功能后才会生效
1426
+ */
1427
+ LogSet?: string;
1428
+ /**
1429
+ * 日志源,开启日志功能后才会生效
1430
+ */
1431
+ LogSource?: string;
1432
+ /**
1433
+ * 用户自定义展示标签列表
1434
+ */
1435
+ CustomShowTags?: Array<string>;
1436
+ /**
1437
+ * 修改计费模式(1为预付费,0为按量付费)
1438
+ */
1439
+ PayMode?: number;
1440
+ /**
1441
+ * 响应时间警示线
1442
+ */
1443
+ ResponseDurationWarningThreshold?: number;
1444
+ /**
1445
+ * 是否免费(0=付费版;1=TSF 受限免费版;2=免费版),默认0
1446
+ */
1447
+ Free?: number;
1448
+ /**
1449
+ * 是否关联 Dashboard(0=关,1=开)
1450
+ */
1451
+ IsRelatedDashboard?: number;
1452
+ /**
1453
+ * 关联的 Dashboard ID,开启关联 Dashboard 后才会生效
1454
+ */
1455
+ DashboardTopicID?: string;
1456
+ /**
1457
+ * 是否开启 SQL 注入检测(0=关,1=开)
1458
+ */
1275
1459
  IsSqlInjectionAnalysis?: number;
1276
1460
  /**
1277
- * 是否开启远程命令执行分析
1278
- 注意:此字段可能返回 null,表示取不到有效值。
1461
+ * 是否开启组件漏洞检测(0=关,1=开)
1462
+ */
1463
+ IsInstrumentationVulnerabilityScan?: number;
1464
+ /**
1465
+ * 是否开启远程命令攻击检测
1279
1466
  */
1280
1467
  IsRemoteCommandExecutionAnalysis?: number;
1281
1468
  /**
1282
- * 是否开启内存马检测分析
1283
- 注意:此字段可能返回 null,表示取不到有效值。
1469
+ * 是否开启内存马检测
1284
1470
  */
1285
1471
  IsMemoryHijackingAnalysis?: number;
1286
1472
  /**
@@ -1293,68 +1479,52 @@ export interface ApmAppConfig {
1293
1479
  LogTraceIdKey?: string;
1294
1480
  /**
1295
1481
  * 是否开启删除任意文件检测(0-关闭,1-开启)
1296
- 注意:此字段可能返回 null,表示取不到有效值。
1297
1482
  */
1298
1483
  IsDeleteAnyFileAnalysis?: number;
1299
1484
  /**
1300
1485
  * 是否开启读取任意文件检测(0-关闭,1-开启)
1301
- 注意:此字段可能返回 null,表示取不到有效值。
1302
1486
  */
1303
1487
  IsReadAnyFileAnalysis?: number;
1304
1488
  /**
1305
1489
  * 是否开启上传任意文件检测(0-关闭,1-开启)
1306
- 注意:此字段可能返回 null,表示取不到有效值。
1307
1490
  */
1308
1491
  IsUploadAnyFileAnalysis?: number;
1309
1492
  /**
1310
1493
  * 是否开启包含任意文件检测(0-关闭,1-开启)
1311
- 注意:此字段可能返回 null,表示取不到有效值。
1312
1494
  */
1313
1495
  IsIncludeAnyFileAnalysis?: number;
1314
1496
  /**
1315
1497
  * 是否开启目录遍历检测(0-关闭,1-开启)
1316
- 注意:此字段可能返回 null,表示取不到有效值。
1317
1498
  */
1318
1499
  IsDirectoryTraversalAnalysis?: number;
1319
1500
  /**
1320
1501
  * 是否开启模板引擎注入检测(0-关闭,1-开启)
1321
- 注意:此字段可能返回 null,表示取不到有效值。
1322
1502
  */
1323
1503
  IsTemplateEngineInjectionAnalysis?: number;
1324
1504
  /**
1325
1505
  * 是否开启脚本引擎注入检测(0-关闭,1-开启)
1326
- 注意:此字段可能返回 null,表示取不到有效值。
1327
1506
  */
1328
1507
  IsScriptEngineInjectionAnalysis?: number;
1329
1508
  /**
1330
1509
  * 是否开启表达式注入检测(0-关闭,1-开启)
1331
- 注意:此字段可能返回 null,表示取不到有效值。
1332
1510
  */
1333
1511
  IsExpressionInjectionAnalysis?: number;
1334
1512
  /**
1335
1513
  * 是否开启JNDI注入检测(0-关闭,1-开启)
1336
- 注意:此字段可能返回 null,表示取不到有效值。
1337
1514
  */
1338
1515
  IsJNDIInjectionAnalysis?: number;
1339
1516
  /**
1340
1517
  * 是否开启JNI注入检测(0-关闭,1-开启)
1341
- 注意:此字段可能返回 null,表示取不到有效值。
1342
1518
  */
1343
1519
  IsJNIInjectionAnalysis?: number;
1344
1520
  /**
1345
1521
  * 是否开启Webshell后门检测(0-关闭,1-开启)
1346
- 注意:此字段可能返回 null,表示取不到有效值。
1347
1522
  */
1348
1523
  IsWebshellBackdoorAnalysis?: number;
1349
1524
  /**
1350
1525
  * 是否开启反序列化检测(0-关闭,1-开启)
1351
- 注意:此字段可能返回 null,表示取不到有效值。
1352
1526
  */
1353
1527
  IsDeserializationAnalysis?: number;
1354
- /**
1355
- * 接口名称自动收敛开关(0-关闭,1-开启)
1356
- */
1357
- UrlAutoConvergenceEnable?: boolean;
1358
1528
  /**
1359
1529
  * URL长分段收敛阈值
1360
1530
  */
@@ -1363,168 +1533,235 @@ export interface ApmAppConfig {
1363
1533
  * URL数字分段收敛阈值
1364
1534
  */
1365
1535
  UrlNumberSegmentThreshold?: number;
1536
+ }
1537
+ /**
1538
+ * ModifyApmSampleConfig请求参数结构体
1539
+ */
1540
+ export interface ModifyApmSampleConfigRequest {
1366
1541
  /**
1367
- * 探针熔断内存阈值
1542
+ * 业务系统ID
1368
1543
  */
1369
- DisableMemoryUsed?: number;
1544
+ InstanceId: string;
1370
1545
  /**
1371
- * 探针熔断CPU阈值
1546
+ * 采样规则名
1372
1547
  */
1373
- DisableCpuUsed?: number;
1548
+ SampleName: string;
1374
1549
  /**
1375
- * 是否开启SQL参数获取
1550
+ * 采样率
1376
1551
  */
1377
- DbStatementParametersEnabled?: boolean;
1552
+ SampleRate: number;
1378
1553
  /**
1379
- * 慢SQL阈值
1554
+ * 应用名,生效于所有应用则填空
1380
1555
  */
1381
- SlowSQLThresholds?: Array<ApmTag>;
1382
- }
1383
- /**
1384
- * CreateApmSampleConfig返回参数结构体
1385
- */
1386
- export interface CreateApmSampleConfigResponse {
1556
+ ServiceName?: string;
1387
1557
  /**
1388
- * 采样配置参数
1558
+ * 接口名
1389
1559
  */
1390
- ApmSampleConfig?: ApmSampleConfig;
1560
+ OperationName?: string;
1391
1561
  /**
1392
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1562
+ * 采样tag
1393
1563
  */
1394
- RequestId?: string;
1395
- }
1396
- /**
1397
- * DescribeApmApplicationConfig请求参数结构体
1398
- */
1399
- export interface DescribeApmApplicationConfigRequest {
1564
+ Tags?: Array<APMKVItem>;
1400
1565
  /**
1401
- * 实例ID
1566
+ * 采样开关 0关 1开 2删除
1402
1567
  */
1403
- InstanceId: string;
1568
+ Status?: number;
1404
1569
  /**
1405
- * 服务名称
1570
+ * 配置Id
1406
1571
  */
1407
- ServiceName: string;
1572
+ Id?: number;
1573
+ /**
1574
+ * 0=精确匹配(默认);1=前缀匹配;2=后缀匹配
1575
+ */
1576
+ OperationType?: number;
1408
1577
  }
1409
1578
  /**
1410
- * 查询过滤参数
1579
+ * 查询
1411
1580
  */
1412
- export interface Filter {
1581
+ export interface QueryMetricItem {
1413
1582
  /**
1414
- * 过滤方式(=, !=, in)
1583
+ * 指标名
1415
1584
  */
1416
- Type: string;
1585
+ MetricName: string;
1417
1586
  /**
1418
- * 过滤维度名
1587
+ * 同比,现支持 CompareByYesterday (与昨天相比)和CompareByLastWeek (与上周相比)
1419
1588
  */
1420
- Key: string;
1589
+ Compares?: Array<string>;
1421
1590
  /**
1422
- * 过滤值,in过滤方式用逗号分割多个值
1591
+ * 同比,已弃用,不建议使用
1423
1592
  */
1424
- Value: string;
1593
+ Compare?: string;
1425
1594
  }
1426
1595
  /**
1427
- * 指标维度信息
1596
+ * 应用详细信息
1428
1597
  */
1429
- export interface ApmField {
1598
+ export interface ServiceDetail {
1430
1599
  /**
1431
- * 指标名
1600
+ * 应用ID
1601
+ 注意:此字段可能返回 null,表示取不到有效值。
1432
1602
  */
1433
- Key?: string;
1603
+ ServiceID?: string;
1434
1604
  /**
1435
- * 指标数值
1605
+ * 业务系统ID
1606
+ 注意:此字段可能返回 null,表示取不到有效值。
1436
1607
  */
1437
- Value?: number;
1608
+ InstanceKey?: string;
1438
1609
  /**
1439
- * 指标所对应的单位
1610
+ * 用户appid
1611
+ 注意:此字段可能返回 null,表示取不到有效值。
1440
1612
  */
1441
- Unit?: string;
1613
+ AppID?: number;
1442
1614
  /**
1443
- * 同比结果数组,推荐使用
1615
+ * 主账号uin
1444
1616
  注意:此字段可能返回 null,表示取不到有效值。
1445
1617
  */
1446
- CompareVals?: Array<APMKVItem>;
1618
+ CreateUIN?: string;
1447
1619
  /**
1448
- * 同比上一个周期的具体指标数值
1620
+ * 应用名
1449
1621
  注意:此字段可能返回 null,表示取不到有效值。
1450
1622
  */
1451
- LastPeriodValue?: Array<APMKV>;
1623
+ ServiceName?: string;
1452
1624
  /**
1453
- * 同比指标值,已弃用,不建议使用
1625
+ * 应用描述
1626
+ 注意:此字段可能返回 null,表示取不到有效值。
1454
1627
  */
1455
- CompareVal?: string;
1628
+ ServiceDescription?: string;
1456
1629
  /**
1457
- * 指标中文名
1630
+ * 地域
1631
+ 注意:此字段可能返回 null,表示取不到有效值。
1458
1632
  */
1459
- NameCN?: string;
1633
+ Region?: string;
1460
1634
  /**
1461
- * 指标英文名
1635
+ * 标签
1636
+ 注意:此字段可能返回 null,表示取不到有效值。
1462
1637
  */
1463
- NameEN?: string;
1638
+ Tags?: Array<ApmTag>;
1639
+ /**
1640
+ * 业务系统名称
1641
+ */
1642
+ InstanceName?: string;
1464
1643
  }
1465
1644
  /**
1466
- * 指标曲线数据
1645
+ * DescribeApmInstances返回参数结构体
1467
1646
  */
1468
- export interface Line {
1647
+ export interface DescribeApmInstancesResponse {
1469
1648
  /**
1470
- * 指标名
1649
+ * APM 业务系统列表
1471
1650
  */
1472
- MetricName?: string;
1651
+ Instances?: Array<ApmInstanceDetail>;
1473
1652
  /**
1474
- * 指标中文名
1653
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1475
1654
  */
1476
- MetricNameCN?: string;
1655
+ RequestId?: string;
1656
+ }
1657
+ /**
1658
+ * DescribeApmPrometheusRule返回参数结构体
1659
+ */
1660
+ export interface DescribeApmPrometheusRuleResponse {
1477
1661
  /**
1478
- * 时间序列
1662
+ * 指标匹配规则
1479
1663
  */
1480
- TimeSerial?: Array<number | bigint>;
1664
+ ApmPrometheusRules?: Array<ApmPrometheusRules>;
1481
1665
  /**
1482
- * 数据序列
1666
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1483
1667
  */
1484
- DataSerial?: Array<number>;
1668
+ RequestId?: string;
1669
+ }
1670
+ /**
1671
+ * ModifyApmSampleConfig返回参数结构体
1672
+ */
1673
+ export interface ModifyApmSampleConfigResponse {
1485
1674
  /**
1486
- * 维度列表
1675
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1487
1676
  */
1488
- Tags?: Array<ApmTag>;
1677
+ RequestId?: string;
1678
+ }
1679
+ /**
1680
+ * DescribeApmApplicationConfig请求参数结构体
1681
+ */
1682
+ export interface DescribeApmApplicationConfigRequest {
1489
1683
  /**
1490
- * 指标数据单位
1684
+ * 实例ID
1491
1685
  */
1492
- MetricUnit?: string;
1686
+ InstanceId: string;
1687
+ /**
1688
+ * 服务名称
1689
+ */
1690
+ ServiceName: string;
1493
1691
  }
1494
1692
  /**
1495
- * DescribeGeneralSpanList返回参数结构体
1693
+ * CreateProfileTask返回参数结构体
1496
1694
  */
1497
- export interface DescribeGeneralSpanListResponse {
1695
+ export interface CreateProfileTaskResponse {
1498
1696
  /**
1499
- * 总数量
1697
+ * 任务ID
1500
1698
  */
1501
- TotalCount?: number;
1699
+ TaskId?: number;
1502
1700
  /**
1503
- * Span 分页列表
1701
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1504
1702
  */
1505
- Spans?: Array<Span>;
1703
+ RequestId?: string;
1704
+ }
1705
+ /**
1706
+ * ModifyApmPrometheusRule返回参数结构体
1707
+ */
1708
+ export interface ModifyApmPrometheusRuleResponse {
1506
1709
  /**
1507
1710
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1508
1711
  */
1509
1712
  RequestId?: string;
1510
1713
  }
1511
1714
  /**
1512
- * CreateProfileTask返回参数结构体
1715
+ * DescribeMetricRecords返回参数结构体
1513
1716
  */
1514
- export interface CreateProfileTaskResponse {
1717
+ export interface DescribeMetricRecordsResponse {
1515
1718
  /**
1516
- * 任务ID
1719
+ * 指标结果集
1517
1720
  */
1518
- TaskId?: number;
1721
+ Records?: Array<ApmMetricRecord>;
1722
+ /**
1723
+ * 查询指标结果集条数
1724
+ */
1725
+ TotalCount?: number;
1519
1726
  /**
1520
1727
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1521
1728
  */
1522
1729
  RequestId?: string;
1523
1730
  }
1524
1731
  /**
1525
- * DescribeGeneralSpanList请求参数结构体
1732
+ * 维度(标签)对象
1526
1733
  */
1527
- export interface DescribeGeneralSpanListRequest {
1734
+ export interface ApmTag {
1735
+ /**
1736
+ * 维度Key(列名,标签Key)
1737
+ */
1738
+ Key: string;
1739
+ /**
1740
+ * 维度值(标签值)
1741
+ */
1742
+ Value: string;
1743
+ }
1744
+ /**
1745
+ * 查询过滤参数
1746
+ */
1747
+ export interface Filter {
1748
+ /**
1749
+ * 过滤方式(=, !=, in)
1750
+ */
1751
+ Type: string;
1752
+ /**
1753
+ * 过滤维度名
1754
+ */
1755
+ Key: string;
1756
+ /**
1757
+ * 过滤值,in过滤方式用逗号分割多个值
1758
+ */
1759
+ Value: string;
1760
+ }
1761
+ /**
1762
+ * DescribeGeneralOTSpanList请求参数结构体
1763
+ */
1764
+ export interface DescribeGeneralOTSpanListRequest {
1528
1765
  /**
1529
1766
  * 业务系统 ID
1530
1767
  */
@@ -1569,1006 +1806,1155 @@ export interface DescribeGeneralSpanListRequest {
1569
1806
  Offset?: number;
1570
1807
  }
1571
1808
  /**
1572
- * ModifyApmPrometheusRule返回参数结构体
1809
+ * DescribeGeneralApmApplicationConfig返回参数结构体
1573
1810
  */
1574
- export interface ModifyApmPrometheusRuleResponse {
1811
+ export interface DescribeGeneralApmApplicationConfigResponse {
1812
+ /**
1813
+ * 应用配置项
1814
+ */
1815
+ ApmApplicationConfigView?: ApmApplicationConfigView;
1575
1816
  /**
1576
1817
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1577
1818
  */
1578
1819
  RequestId?: string;
1579
1820
  }
1580
1821
  /**
1581
- * 展示apm业务系统与其他云产品关联关系返回体
1822
+ * CreateApmInstance返回参数结构体
1582
1823
  */
1583
- export interface ApmAssociation {
1584
- /**
1585
- * 关联产品的实例ID
1586
- 注意:此字段可能返回 null,表示取不到有效值。
1587
- */
1588
- PeerId?: string;
1824
+ export interface CreateApmInstanceResponse {
1589
1825
  /**
1590
- * 关联关系状态:1(启用)、2(不启用)、3(已失效)
1591
- 注意:此字段可能返回 null,表示取不到有效值。
1826
+ * 业务系统 ID
1592
1827
  */
1593
- Status?: number;
1828
+ InstanceId?: string;
1594
1829
  /**
1595
- * CKafka消息主题
1830
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1596
1831
  */
1597
- Topic?: string;
1832
+ RequestId?: string;
1598
1833
  }
1599
1834
  /**
1600
- * 排序字段
1835
+ * DeleteApmSampleConfig返回参数结构体
1601
1836
  */
1602
- export interface OrderBy {
1603
- /**
1604
- * 需要排序的字段,现支持 startTIme, endTime, duration
1605
- */
1606
- Key: string;
1837
+ export interface DeleteApmSampleConfigResponse {
1607
1838
  /**
1608
- * asc 顺序排序 / desc 倒序排序
1839
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1609
1840
  */
1610
- Value: string;
1841
+ RequestId?: string;
1611
1842
  }
1612
1843
  /**
1613
- * DescribeServiceOverview返回参数结构体
1844
+ * DescribeGeneralApmApplicationConfig请求参数结构体
1614
1845
  */
1615
- export interface DescribeServiceOverviewResponse {
1846
+ export interface DescribeGeneralApmApplicationConfigRequest {
1616
1847
  /**
1617
- * 指标结果集
1848
+ * 应用名
1618
1849
  */
1619
- Records?: Array<ApmMetricRecord>;
1850
+ ServiceName: string;
1620
1851
  /**
1621
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1852
+ * 业务系统ID
1622
1853
  */
1623
- RequestId?: string;
1854
+ InstanceId: string;
1624
1855
  }
1625
1856
  /**
1626
- * DescribeApmServiceMetric返回参数结构体
1857
+ * DescribeTopologyNew请求参数结构体
1627
1858
  */
1628
- export interface DescribeApmServiceMetricResponse {
1859
+ export interface DescribeTopologyNewRequest {
1629
1860
  /**
1630
- * 应用指标列表
1861
+ * 业务系统 ID
1631
1862
  */
1632
- ServiceMetricList?: Array<ApmServiceMetric>;
1863
+ InstanceId: string;
1633
1864
  /**
1634
- * 符合筛选条件的应用数
1865
+ * 查询开始时间
1635
1866
  */
1636
- TotalCount?: number;
1867
+ StartTime: number;
1637
1868
  /**
1638
- * 警示异常应用数
1869
+ * 查询结束时间
1639
1870
  */
1640
- WarningErrorCount?: number;
1871
+ EndTime: number;
1641
1872
  /**
1642
- * 应用总数
1873
+ * 应用名
1643
1874
  */
1644
- ApplicationCount?: number;
1875
+ ServiceName?: string;
1645
1876
  /**
1646
- * 页码
1877
+ * 上游层级
1647
1878
  */
1648
- Page?: number;
1879
+ UpLevel?: number;
1649
1880
  /**
1650
- * 页大小
1881
+ * 应用实例信息
1651
1882
  */
1652
- PageSize?: number;
1883
+ ServiceInstance?: string;
1653
1884
  /**
1654
- * 异常应用数
1885
+ * 下游层级
1655
1886
  */
1656
- ErrorCount?: number;
1887
+ DownLevel?: number;
1657
1888
  /**
1658
- * 警示应用数
1889
+ * 视角
1659
1890
  */
1660
- WarningCount?: number;
1891
+ View?: string;
1661
1892
  /**
1662
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1893
+ * 过滤器
1663
1894
  */
1664
- RequestId?: string;
1665
- }
1666
- /**
1667
- * ModifyApmAssociation返回参数结构体
1668
- */
1669
- export interface ModifyApmAssociationResponse {
1895
+ Filters?: Array<Filter>;
1670
1896
  /**
1671
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1897
+ * 表示Topic(MQ拓扑图用)
1672
1898
  */
1673
- RequestId?: string;
1674
- }
1675
- /**
1676
- * DescribeMetricRecords返回参数结构体
1677
- */
1678
- export interface DescribeMetricRecordsResponse {
1899
+ Topic?: string;
1679
1900
  /**
1680
- * 指标结果集
1901
+ * 视图筛选列表
1681
1902
  */
1682
- Records?: Array<ApmMetricRecord>;
1903
+ Selectors?: Selectors;
1683
1904
  /**
1684
- * 查询指标结果集条数
1905
+ * 视图ID
1685
1906
  */
1686
- TotalCount?: number;
1907
+ Id?: string;
1687
1908
  /**
1688
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1909
+ * TraceID
1689
1910
  */
1690
- RequestId?: string;
1691
- }
1692
- /**
1693
- * DescribeGeneralOTSpanList返回参数结构体
1694
- */
1695
- export interface DescribeGeneralOTSpanListResponse {
1911
+ TraceID?: string;
1696
1912
  /**
1697
- * 总数量
1913
+ * 查询top5慢响应节点
1698
1914
  */
1699
- TotalCount?: number;
1915
+ IsSlowTopFive?: boolean;
1700
1916
  /**
1701
- * Spans字段中包含了链路数据的全部内容,由于数据经过了压缩,需要对结果进行如下三步转换,以还原始的文本。
1702
- 1. 将Spans字段中的文本进行 Base64 解码,得到经过压缩后字节数组。
1703
- 2. 使用 gzip 对压缩后的字节数组进行解压,得到压缩前的字节数组。
1704
- 3. 使用 UTF-8 字符集,将压缩前的字节数组转换为文本。
1705
-
1917
+ * 是否获取资源层信息
1706
1918
  */
1707
- Spans?: string;
1919
+ GetResource?: boolean;
1708
1920
  /**
1709
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1921
+ * 根据应用标签过滤
1710
1922
  */
1711
- RequestId?: string;
1923
+ Tags?: Array<ApmTag>;
1924
+ /**
1925
+ * 不显示的节点类型
1926
+ */
1927
+ Hidden?: Selectors;
1712
1928
  }
1713
1929
  /**
1714
- * 维度(标签)对象
1930
+ * DescribeApmInstances请求参数结构体
1715
1931
  */
1716
- export interface ApmTag {
1932
+ export interface DescribeApmInstancesRequest {
1717
1933
  /**
1718
- * 维度Key(列名,标签Key)
1934
+ * Tag 列表
1719
1935
  */
1720
- Key: string;
1936
+ Tags?: Array<ApmTag>;
1721
1937
  /**
1722
- * 维度值(标签值)
1938
+ * 按业务系统名过滤,支持模糊检索
1723
1939
  */
1724
- Value: string;
1940
+ InstanceName?: string;
1941
+ /**
1942
+ * 按业务系统 ID 过滤,支持模糊检索
1943
+ */
1944
+ InstanceId?: string;
1945
+ /**
1946
+ * 按业务系统 ID 过滤
1947
+ */
1948
+ InstanceIds?: Array<string>;
1949
+ /**
1950
+ * 是否查询官方 Demo 业务系统(0=非 Demo 业务系统,1=Demo 业务系统,默认为0)
1951
+ */
1952
+ DemoInstanceFlag?: number;
1953
+ /**
1954
+ * 是否查询全地域业务系统(0=不查询全地域,1=查询全地域,默认为0)
1955
+ */
1956
+ AllRegionsFlag?: number;
1725
1957
  }
1726
1958
  /**
1727
- * ModifyApmApplicationConfig返回参数结构体
1959
+ * DeleteApmSampleConfig请求参数结构体
1728
1960
  */
1729
- export interface ModifyApmApplicationConfigResponse {
1961
+ export interface DeleteApmSampleConfigRequest {
1730
1962
  /**
1731
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1963
+ * 业务系统ID
1732
1964
  */
1733
- RequestId?: string;
1965
+ InstanceId: string;
1966
+ /**
1967
+ * 采样规则名
1968
+ */
1969
+ SampleName: string;
1734
1970
  }
1735
1971
  /**
1736
- * DescribeApmApplicationConfig返回参数结构体
1972
+ * Span日志部分
1973
+
1974
+
1737
1975
  */
1738
- export interface DescribeApmApplicationConfigResponse {
1976
+ export interface SpanLog {
1739
1977
  /**
1740
- * Apm应用配置
1741
- 注意:此字段可能返回 null,表示取不到有效值。
1978
+ * 日志时间戳
1742
1979
  */
1743
- ApmAppConfig: ApmAppConfig;
1980
+ Timestamp: number;
1744
1981
  /**
1745
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1982
+ * 标签
1746
1983
  */
1747
- RequestId?: string;
1984
+ Fields: Array<SpanTag>;
1748
1985
  }
1749
1986
  /**
1750
- * DescribeApmAssociation请求参数结构体
1987
+ * TerminateApmInstance请求参数结构体
1751
1988
  */
1752
- export interface DescribeApmAssociationRequest {
1753
- /**
1754
- * 关联的产品名,当前只支持Prometheus
1755
- */
1756
- ProductName: string;
1989
+ export interface TerminateApmInstanceRequest {
1757
1990
  /**
1758
- * 业务系统名
1991
+ * 业务系统ID
1759
1992
  */
1760
1993
  InstanceId: string;
1761
1994
  }
1762
1995
  /**
1763
- * ModifyApmApplicationConfig请求参数结构体
1996
+ * APM 业务系统信息
1764
1997
  */
1765
- export interface ModifyApmApplicationConfigRequest {
1998
+ export interface ApmInstanceDetail {
1766
1999
  /**
1767
2000
  * 业务系统 ID
1768
2001
  */
1769
- InstanceId: string;
2002
+ InstanceId?: string;
1770
2003
  /**
1771
- * 应用名
2004
+ * 业务系统名
1772
2005
  */
1773
- ServiceName: string;
2006
+ Name?: string;
1774
2007
  /**
1775
- * URL收敛开关,0 关 | 1 开
2008
+ * 业务系统描述信息
1776
2009
  */
1777
- UrlConvergenceSwitch: number;
2010
+ Description?: string;
1778
2011
  /**
1779
- * URL收敛阈值
2012
+ * 业务系统状态。{
2013
+ 1: 初始化中; 2: 运行中; 4: 限流}
1780
2014
  */
1781
- UrlConvergenceThreshold?: number;
2015
+ Status?: number;
1782
2016
  /**
1783
- * 异常过滤正则规则,逗号分隔
2017
+ * 业务系统所属地域
1784
2018
  */
1785
- ExceptionFilter?: string;
2019
+ Region?: string;
1786
2020
  /**
1787
- * URL收敛正则规则,逗号分隔
2021
+ * 业务系统 Tag 列表
1788
2022
  */
1789
- UrlConvergence?: string;
2023
+ Tags?: Array<ApmTag>;
1790
2024
  /**
1791
- * 错误码过滤,逗号分隔
2025
+ * AppID 信息
1792
2026
  */
1793
- ErrorCodeFilter?: string;
2027
+ AppId?: number;
1794
2028
  /**
1795
- * URL排除正则规则,逗号分隔
2029
+ * 创建人 Uin
1796
2030
  */
1797
- UrlExclude?: string;
2031
+ CreateUin?: string;
1798
2032
  /**
1799
- * 日志开关 0 关 1 开
2033
+ * 存储使用量(单位:MB)
1800
2034
  */
1801
- IsRelatedLog?: number;
2035
+ AmountOfUsedStorage?: number;
1802
2036
  /**
1803
- * 日志地域
2037
+ * 该业务系统服务端应用数量
2038
+ */
2039
+ ServiceCount?: number;
2040
+ /**
2041
+ * 日均上报 Span 数
2042
+ */
2043
+ CountOfReportSpanPerDay?: number;
2044
+ /**
2045
+ * Trace 数据保存时长(单位:天)
2046
+ */
2047
+ TraceDuration?: number;
2048
+ /**
2049
+ * 业务系统上报额度
2050
+ */
2051
+ SpanDailyCounters?: number;
2052
+ /**
2053
+ * 业务系统是否已开通计费(0=未开通,1=已开通)
2054
+ */
2055
+ BillingInstance?: number;
2056
+ /**
2057
+ * 错误警示线(单位:%)
2058
+ */
2059
+ ErrRateThreshold?: number;
2060
+ /**
2061
+ * 采样率(单位:%)
2062
+ */
2063
+ SampleRate?: number;
2064
+ /**
2065
+ * 是否开启错误采样(0=关, 1=开)
2066
+ */
2067
+ ErrorSample?: number;
2068
+ /**
2069
+ * 采样慢调用保存阈值(单位:ms)
2070
+ */
2071
+ SlowRequestSavedThreshold?: number;
2072
+ /**
2073
+ * CLS 日志所在地域
1804
2074
  */
1805
2075
  LogRegion?: string;
1806
2076
  /**
1807
- * 日志主题ID
2077
+ * 日志源
2078
+ */
2079
+ LogSource?: string;
2080
+ /**
2081
+ * 日志功能开关(0=关, 1=开)
2082
+ */
2083
+ IsRelatedLog?: number;
2084
+ /**
2085
+ * 日志主题 ID
1808
2086
  */
1809
2087
  LogTopicID?: string;
1810
2088
  /**
1811
- * CLS 日志集 | ES 集群ID
2089
+ * 该业务系统客户端应用数量
2090
+ */
2091
+ ClientCount?: number;
2092
+ /**
2093
+ * 该业务系统最近2天活跃应用数量
2094
+ */
2095
+ TotalCount?: number;
2096
+ /**
2097
+ * CLS 日志集
1812
2098
  */
1813
2099
  LogSet?: string;
1814
2100
  /**
1815
- * 日志来源 CLS | ES
2101
+ * Metric 数据保存时长(单位:天)
1816
2102
  */
1817
- LogSource?: string;
2103
+ MetricDuration?: number;
1818
2104
  /**
1819
- * 需过滤的接口
2105
+ * 用户自定义展示标签列表
1820
2106
  */
1821
- IgnoreOperationName?: string;
2107
+ CustomShowTags?: Array<string>;
1822
2108
  /**
1823
- * 是否开启线程剖析
2109
+ * 业务系统计费模式(1为预付费,0为按量付费)
1824
2110
  */
1825
- EnableSnapshot?: boolean;
2111
+ PayMode?: number;
1826
2112
  /**
1827
- * 线程剖析超时阈值
2113
+ * 业务系统计费模式是否生效
2114
+ */
2115
+ PayModeEffective?: boolean;
2116
+ /**
2117
+ * 响应时间警示线(单位:ms)
2118
+ */
2119
+ ResponseDurationWarningThreshold?: number;
2120
+ /**
2121
+ * 是否免费(0=否,1=限额免费,2=完全免费),默认0
2122
+ */
2123
+ Free?: number;
2124
+ /**
2125
+ * 是否 TSF 默认业务系统(0=否,1=是)
2126
+ */
2127
+ DefaultTSF?: number;
2128
+ /**
2129
+ * 是否关联 Dashboard(0=关, 1=开)
2130
+ */
2131
+ IsRelatedDashboard?: number;
2132
+ /**
2133
+ * 关联的 Dashboard ID
2134
+ */
2135
+ DashboardTopicID?: string;
2136
+ /**
2137
+ * 是否开启组件漏洞检测(0=关, 1=开)
2138
+ */
2139
+ IsInstrumentationVulnerabilityScan?: number;
2140
+ /**
2141
+ * 是否开启 SQL 注入分析(0=关, 1=开)
2142
+ */
2143
+ IsSqlInjectionAnalysis?: number;
2144
+ /**
2145
+ * 限流原因。{
2146
+ 1: 正式版限额;
2147
+ 2: 试用版限额;
2148
+ 4: 试用版到期;
2149
+ 8: 账号欠费
2150
+ }
2151
+ */
2152
+ StopReason?: number;
2153
+ /**
2154
+ * 是否开远程命令执行检测(0=关, 1=开)
2155
+ */
2156
+ IsRemoteCommandExecutionAnalysis?: number;
2157
+ /**
2158
+ * 是否开内存马执行检测(0=关, 1=开)
2159
+ */
2160
+ IsMemoryHijackingAnalysis?: number;
2161
+ /**
2162
+ * CLS索引类型(0=全文索引,1=键值索引)
2163
+ */
2164
+ LogIndexType?: number;
2165
+ /**
2166
+ * traceId的索引key: 当CLS索引类型为键值索引时生效
2167
+ */
2168
+ LogTraceIdKey?: string;
2169
+ /**
2170
+ * 是否开启删除任意文件检测(0-关闭,1-开启)
2171
+ */
2172
+ IsDeleteAnyFileAnalysis?: number;
2173
+ /**
2174
+ * 是否开启读取任意文件检测(0-关闭,1-开启)
2175
+ */
2176
+ IsReadAnyFileAnalysis?: number;
2177
+ /**
2178
+ * 是否开启上传任意文件检测(0-关闭,1-开启)
2179
+ */
2180
+ IsUploadAnyFileAnalysis?: number;
2181
+ /**
2182
+ * 是否开启包含任意文件检测(0-关闭,1-开启)
2183
+ */
2184
+ IsIncludeAnyFileAnalysis?: number;
2185
+ /**
2186
+ * 是否开启目录遍历检测(0-关闭,1-开启)
2187
+ */
2188
+ IsDirectoryTraversalAnalysis?: number;
2189
+ /**
2190
+ * 是否开启模板引擎注入检测(0-关闭,1-开启)
2191
+ */
2192
+ IsTemplateEngineInjectionAnalysis?: number;
2193
+ /**
2194
+ * 是否开启脚本引擎注入检测(0-关闭,1-开启)
2195
+ */
2196
+ IsScriptEngineInjectionAnalysis?: number;
2197
+ /**
2198
+ * 是否开启表达式注入检测(0-关闭,1-开启)
2199
+ */
2200
+ IsExpressionInjectionAnalysis?: number;
2201
+ /**
2202
+ * 是否开启JNDI注入检测(0-关闭,1-开启)
2203
+ */
2204
+ IsJNDIInjectionAnalysis?: number;
2205
+ /**
2206
+ * 是否开启JNI注入检测(0-关闭,1-开启)
2207
+ */
2208
+ IsJNIInjectionAnalysis?: number;
2209
+ /**
2210
+ * 是否开启Webshell后门检测(0-关闭,1-开启)
2211
+ */
2212
+ IsWebshellBackdoorAnalysis?: number;
2213
+ /**
2214
+ * 是否开启反序列化检测(0-关闭,1-开启)
2215
+ */
2216
+ IsDeserializationAnalysis?: number;
2217
+ /**
2218
+ * 业务系统鉴权 token
2219
+ */
2220
+ Token?: string;
2221
+ /**
2222
+ * URL长分段收敛阈值
2223
+ */
2224
+ UrlLongSegmentThreshold?: number;
2225
+ /**
2226
+ * URL数字分段收敛阈值
2227
+ */
2228
+ UrlNumberSegmentThreshold?: number;
2229
+ }
2230
+ /**
2231
+ * Span 对象
2232
+ */
2233
+ export interface Span {
2234
+ /**
2235
+ * Trace ID
2236
+ */
2237
+ TraceID?: string;
2238
+ /**
2239
+ * 日志
2240
+ */
2241
+ Logs?: Array<SpanLog>;
2242
+ /**
2243
+ * 标签
2244
+ */
2245
+ Tags?: Array<SpanTag>;
2246
+ /**
2247
+ * 上报应用服务信息
1828
2248
  */
1829
- SnapshotTimeout?: number;
2249
+ Process?: SpanProcess;
1830
2250
  /**
1831
- * 是否开启agent
2251
+ * 产生时间戳(毫秒)
1832
2252
  */
1833
- AgentEnable?: boolean;
2253
+ Timestamp?: number;
1834
2254
  /**
1835
- * 是否开启链路压缩
2255
+ * Span 名称
1836
2256
  */
1837
- TraceSquash?: boolean;
2257
+ OperationName?: string;
1838
2258
  /**
1839
- * 是否开启应用诊断的开关
2259
+ * 关联关系
1840
2260
  */
1841
- EventEnable?: boolean;
2261
+ References?: Array<SpanReference>;
1842
2262
  /**
1843
- * 组件列表
2263
+ * 产生时间戳(微秒)
1844
2264
  */
1845
- InstrumentList?: Array<Instrument>;
2265
+ StartTime?: number;
1846
2266
  /**
1847
- * 探针接口相关配置
2267
+ * 持续耗时(微妙)
1848
2268
  */
1849
- AgentOperationConfigView?: AgentOperationConfigView;
2269
+ Duration?: number;
1850
2270
  /**
1851
- * 是否开启应用日志配置
2271
+ * Span ID
1852
2272
  */
1853
- EnableLogConfig?: boolean;
2273
+ SpanID?: string;
1854
2274
  /**
1855
- * 应用是否开启dashboard配置: false 关(与业务系统保持一致)/true 开(应用级配置)
2275
+ * 产生时间戳(毫秒)
1856
2276
  */
1857
- EnableDashboardConfig?: boolean;
2277
+ StartTimeMillis?: number;
1858
2278
  /**
1859
- * 是否关联dashboard: 0 关 1 开
2279
+ * Parent Span ID
1860
2280
  */
1861
- IsRelatedDashboard?: number;
2281
+ ParentSpanID?: string;
2282
+ }
2283
+ /**
2284
+ * ModifyGeneralApmApplicationConfig请求参数结构体
2285
+ */
2286
+ export interface ModifyGeneralApmApplicationConfigRequest {
1862
2287
  /**
1863
- * dashboard ID
2288
+ * 业务系统Id
1864
2289
  */
1865
- DashboardTopicID?: string;
2290
+ InstanceId: string;
1866
2291
  /**
1867
- * CLS索引类型(0=全文索引,1=键值索引)
2292
+ * 需要修改的字段key value分别指定字段名、字段值
2293
+ [具体字段请见](https://cloud.tencent.com/document/product/248/111241)
1868
2294
  */
1869
- LogIndexType?: number;
2295
+ Tags: Array<ApmTag>;
1870
2296
  /**
1871
- * traceId的索引key: 当CLS索引类型为键值索引时生效
2297
+ * 需要修改配置的应用列表名称
1872
2298
  */
1873
- LogTraceIdKey?: string;
2299
+ ServiceNames: Array<string>;
2300
+ }
2301
+ /**
2302
+ * DescribeApmServiceMetric请求参数结构体
2303
+ */
2304
+ export interface DescribeApmServiceMetricRequest {
1874
2305
  /**
1875
- * 是否开启应用安全配置
2306
+ * 业务系统ID
1876
2307
  */
1877
- EnableSecurityConfig?: boolean;
2308
+ InstanceId: string;
1878
2309
  /**
1879
- * 是否开启SQL注入分析
2310
+ * 应用名
1880
2311
  */
1881
- IsSqlInjectionAnalysis?: number;
2312
+ ServiceName?: string;
1882
2313
  /**
1883
- * 是否开启组件漏洞检测
2314
+ * 应用ID
1884
2315
  */
1885
- IsInstrumentationVulnerabilityScan?: number;
2316
+ ServiceID?: string;
1886
2317
  /**
1887
- * 是否开启远程命令检测
2318
+ * 开始时间
1888
2319
  */
1889
- IsRemoteCommandExecutionAnalysis?: number;
2320
+ StartTime?: number;
1890
2321
  /**
1891
- * 是否开启内存马检测
2322
+ * 结束时间
1892
2323
  */
1893
- IsMemoryHijackingAnalysis?: number;
2324
+ EndTime?: number;
1894
2325
  /**
1895
- * 是否开启删除任意文件检测(0-关闭,1-开启)
2326
+ * 排序
1896
2327
  */
1897
- IsDeleteAnyFileAnalysis?: number;
2328
+ OrderBy?: OrderBy;
1898
2329
  /**
1899
- * 是否开启读取任意文件检测(0-关闭,1-开启)
2330
+ * 是否demo模式
1900
2331
  */
1901
- IsReadAnyFileAnalysis?: number;
2332
+ Demo?: boolean;
1902
2333
  /**
1903
- * 是否开启上传任意文件检测(0-关闭,1-开启)
2334
+ * 应用状态筛选,可枚举的值为:health、warning、error。如果选中多个状态用逗号隔开,例如:"warning,error"
1904
2335
  */
1905
- IsUploadAnyFileAnalysis?: number;
2336
+ ServiceStatus?: string;
1906
2337
  /**
1907
- * 是否开启包含任意文件检测(0-关闭,1-开启)
2338
+ * 标签列表
1908
2339
  */
1909
- IsIncludeAnyFileAnalysis?: number;
2340
+ Tags?: Array<ApmTag>;
1910
2341
  /**
1911
- * 是否开启目录遍历检测(0-关闭,1-开启)
2342
+ * 页码
1912
2343
  */
1913
- IsDirectoryTraversalAnalysis?: number;
2344
+ Page?: number;
1914
2345
  /**
1915
- * 是否开启模板引擎注入检测(0-关闭,1-开启)
2346
+ * 页大小
1916
2347
  */
1917
- IsTemplateEngineInjectionAnalysis?: number;
2348
+ PageSize?: number;
1918
2349
  /**
1919
- * 是否开启脚本引擎注入检测(0-关闭,1-开启)
2350
+ * 过滤条件
1920
2351
  */
1921
- IsScriptEngineInjectionAnalysis?: number;
2352
+ Filters?: Array<Filter>;
2353
+ }
2354
+ /**
2355
+ * CreateApmPrometheusRule请求参数结构体
2356
+ */
2357
+ export interface CreateApmPrometheusRuleRequest {
1922
2358
  /**
1923
- * 是否开启表达式注入检测(0-关闭,1-开启)
2359
+ * 指标匹配规则名
1924
2360
  */
1925
- IsExpressionInjectionAnalysis?: number;
2361
+ Name: string;
1926
2362
  /**
1927
- * 是否开启JNDI注入检测(0-关闭,1-开启)
2363
+ * 规则生效的应用。作用全部应用就传空字符串
1928
2364
  */
1929
- IsJNDIInjectionAnalysis?: number;
2365
+ ServiceName: string;
1930
2366
  /**
1931
- * 是否开启JNI注入检测(0-关闭,1-开启)
2367
+ * 指标匹配类型:0精准匹配,1前缀匹配,2后缀匹配
1932
2368
  */
1933
- IsJNIInjectionAnalysis?: number;
2369
+ MetricMatchType: number;
1934
2370
  /**
1935
- * 是否开启Webshell后门检测(0-关闭,1-开启)
2371
+ * 客户定义的命中指标名规则。
1936
2372
  */
1937
- IsWebshellBackdoorAnalysis?: number;
2373
+ MetricNameRule: string;
1938
2374
  /**
1939
- * 是否开启反序列化检测(0-关闭,1-开启)
2375
+ * 业务系统ID
1940
2376
  */
1941
- IsDeserializationAnalysis?: number;
2377
+ InstanceId: string;
2378
+ }
2379
+ /**
2380
+ * tke资源元数据
2381
+ */
2382
+ export interface TkeMeta {
1942
2383
  /**
1943
- * 接口自动收敛开关,0 关 | 1 开
2384
+ * 地域
1944
2385
  */
1945
- UrlAutoConvergenceEnable?: boolean;
2386
+ Region?: string;
1946
2387
  /**
1947
- * URL长分段收敛阈值
2388
+ * 集群ID
1948
2389
  */
1949
- UrlLongSegmentThreshold?: number;
2390
+ ClusterID?: string;
1950
2391
  /**
1951
- * URL数字分段收敛阈值
2392
+ * pod name
1952
2393
  */
1953
- UrlNumberSegmentThreshold?: number;
2394
+ PodName?: string;
1954
2395
  /**
1955
- * 探针熔断内存阈值
2396
+ * 命名空间
1956
2397
  */
1957
- DisableMemoryUsed?: number;
2398
+ Namespace?: string;
1958
2399
  /**
1959
- * 探针熔断CPU阈值
2400
+ * 工作负载
1960
2401
  */
1961
- DisableCpuUsed?: number;
2402
+ Deployment?: string;
1962
2403
  /**
1963
- * 是否开启SQL参数获取
2404
+ * pod ip
1964
2405
  */
1965
- DbStatementParametersEnabled?: boolean;
2406
+ PodIP?: string;
1966
2407
  /**
1967
- * 慢SQL阈值
2408
+ * node ip
1968
2409
  */
1969
- SlowSQLThresholds?: Array<ApmTag>;
2410
+ NodeIP?: string;
1970
2411
  }
1971
2412
  /**
1972
- * APM 浮点数类型键值对
2413
+ * 组件
1973
2414
  */
1974
- export interface APMKV {
2415
+ export interface Instrument {
1975
2416
  /**
1976
- * Key 值定义
2417
+ * 组件名称
1977
2418
  */
1978
- Key?: string;
2419
+ Name?: string;
1979
2420
  /**
1980
- * Value 值定义
2421
+ * 组件开关
1981
2422
  */
1982
- Value?: number;
2423
+ Enable?: boolean;
1983
2424
  }
1984
2425
  /**
1985
- * DescribeGeneralOTSpanList请求参数结构体
2426
+ * DescribeTagValues返回参数结构体
1986
2427
  */
1987
- export interface DescribeGeneralOTSpanListRequest {
2428
+ export interface DescribeTagValuesResponse {
1988
2429
  /**
1989
- * 业务系统 ID
2430
+ * 维度值列表
1990
2431
  */
1991
- InstanceId: string;
2432
+ Values?: Array<string>;
1992
2433
  /**
1993
- * Span 查询开始时间戳(单位:秒)
2434
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1994
2435
  */
1995
- StartTime: number;
2436
+ RequestId?: string;
2437
+ }
2438
+ /**
2439
+ * APM Agent 信息
2440
+ */
2441
+ export interface ApmAgentInfo {
1996
2442
  /**
1997
- * Span 查询结束时间戳(单位:秒)
2443
+ * Agent 下载地址
1998
2444
  */
1999
- EndTime: number;
2445
+ AgentDownloadURL?: string;
2000
2446
  /**
2001
- * 通用过滤参数
2447
+ * Collector 上报地址
2002
2448
  */
2003
- Filters?: Array<Filter>;
2449
+ CollectorURL?: string;
2004
2450
  /**
2005
- * 排序
2006
- 现支持的 Key 有:
2007
-
2008
- - startTime(开始时间)
2009
- - endTime(结束时间)
2010
- - duration(响应时间)
2011
-
2012
- 现支持的 Value 有:
2013
-
2014
- - desc(降序排序)
2015
- - asc(升序排序)
2451
+ * Token 信息
2016
2452
  */
2017
- OrderBy?: OrderBy;
2453
+ Token?: string;
2018
2454
  /**
2019
- * 业务自身服务名,控制台用户请填写taw
2455
+ * 外网上报地址
2020
2456
  */
2021
- BusinessName?: string;
2457
+ PublicCollectorURL?: string;
2022
2458
  /**
2023
- * 单页项目个数,默认为10000,合法取值范围为0~10000
2459
+ * 自研 VPC 上报地址
2024
2460
  */
2025
- Limit?: number;
2461
+ InnerCollectorURL?: string;
2026
2462
  /**
2027
- * 分页
2463
+ * 内网上报地址( Private Link 上报地址)
2028
2464
  */
2029
- Offset?: number;
2465
+ PrivateLinkCollectorURL?: string;
2030
2466
  }
2031
2467
  /**
2032
- * DescribeApmAgent请求参数结构体
2468
+ * 应用相关的配置列表项
2033
2469
  */
2034
- export interface DescribeApmAgentRequest {
2470
+ export interface ApmApplicationConfigView {
2035
2471
  /**
2036
2472
  * 业务系统 ID
2037
2473
  */
2038
- InstanceId: string;
2474
+ InstanceKey?: string;
2039
2475
  /**
2040
- * 接入方式,现支持 skywalking, ot, ebpf 方式接入上报,不填默认为 ot
2476
+ * 应用名
2041
2477
  */
2042
- AgentType?: string;
2478
+ ServiceName?: string;
2043
2479
  /**
2044
- * 上报环境,现支持 pl (内网上报), public (外网), inner (自研 VPC )环境上报,不传默认为 public
2480
+ * 接口过滤
2045
2481
  */
2046
- NetworkMode?: string;
2482
+ OperationNameFilter?: string;
2047
2483
  /**
2048
- * 语言,现支持 java, golang, php, python, dotNet, nodejs 语言上报,不传默认为 golang
2484
+ * 错误类型过滤
2049
2485
  */
2050
- LanguageEnvironment?: string;
2486
+ ExceptionFilter?: string;
2051
2487
  /**
2052
- * 上报方式,已弃用
2488
+ * HTTP 状态码过滤
2053
2489
  */
2054
- ReportMethod?: string;
2055
- }
2056
- /**
2057
- * DescribeMetricRecords请求参数结构体
2058
- */
2059
- export interface DescribeMetricRecordsRequest {
2490
+ ErrorCodeFilter?: string;
2491
+ /**
2492
+ * 应用诊断开关(已废弃)
2493
+ */
2494
+ EventEnable?: boolean;
2495
+ /**
2496
+ * URL 收敛开关 0 关 1 开
2497
+ */
2498
+ UrlConvergenceSwitch?: number;
2499
+ /**
2500
+ * URL 收敛阈值
2501
+ */
2502
+ UrlConvergenceThreshold?: number;
2503
+ /**
2504
+ * URL 收敛规则正则
2505
+ */
2506
+ UrlConvergence?: string;
2060
2507
  /**
2061
- * 业务系统 ID
2508
+ * URL 排除规则正则
2062
2509
  */
2063
- InstanceId: string;
2510
+ UrlExclude?: string;
2064
2511
  /**
2065
- * 指标列表
2512
+ * 是否开启日志 0 关 1 开
2066
2513
  */
2067
- Metrics: Array<QueryMetricItem>;
2514
+ IsRelatedLog?: number;
2068
2515
  /**
2069
- * 开始时间(单位为秒)
2516
+ * 日志源
2070
2517
  */
2071
- StartTime: number;
2518
+ LogSource?: string;
2072
2519
  /**
2073
- * 结束时间(单位为秒)
2520
+ * 日志集
2074
2521
  */
2075
- EndTime: number;
2522
+ LogSet?: string;
2076
2523
  /**
2077
- * 聚合维度
2524
+ * 日志主题
2078
2525
  */
2079
- GroupBy: Array<string>;
2526
+ LogTopicID?: string;
2080
2527
  /**
2081
- * 过滤条件
2528
+ * 方法栈快照开关 true 开启 false 关闭
2082
2529
  */
2083
- Filters?: Array<Filter>;
2530
+ SnapshotEnable?: boolean;
2084
2531
  /**
2085
- * Or 过滤条件
2532
+ * 慢调用监听触发阈值
2086
2533
  */
2087
- OrFilters?: Array<Filter>;
2534
+ SnapshotTimeout?: number;
2088
2535
  /**
2089
- * 排序
2090
- 现支持的 Key 有:
2091
-
2092
- - startTime(开始时间)
2093
- - endTime(结束时间)
2094
- - duration(响应时间)
2095
-
2096
- 现支持的 Value 有:
2097
-
2098
- - desc(降序排序)
2099
- - asc(升序排序)
2536
+ * 探针总开关
2100
2537
  */
2101
- OrderBy?: OrderBy;
2538
+ AgentEnable?: boolean;
2102
2539
  /**
2103
- * 业务名称,控制台用户请填写taw。
2540
+ * 组件列表开关(已废弃)
2104
2541
  */
2105
- BusinessName?: string;
2542
+ InstrumentList?: Array<Instrument>;
2106
2543
  /**
2107
- * 特殊处理查询结果
2544
+ * 链路压缩开关(已废弃)
2108
2545
  */
2109
- Type?: string;
2546
+ TraceSquash?: boolean;
2110
2547
  /**
2111
- * 每页大小,默认为1000,合法取值范围为0~1000
2548
+ * 探针熔断内存阈值
2112
2549
  */
2113
- Limit?: number;
2550
+ DisableMemoryUsed?: number;
2114
2551
  /**
2115
- * 分页起始点
2552
+ * 探针熔断CPU阈值
2116
2553
  */
2117
- Offset?: number;
2554
+ DisableCpuUsed?: number;
2118
2555
  /**
2119
- * 页码
2556
+ * 是否开启SQL参数获取
2120
2557
  */
2121
- PageIndex?: number;
2558
+ DbStatementParametersEnabled?: boolean;
2122
2559
  /**
2123
- * 页长
2560
+ * 慢SQL阈值
2124
2561
  */
2125
- PageSize?: number;
2562
+ SlowSQLThresholds?: Array<ApmTag>;
2126
2563
  }
2127
2564
  /**
2128
- * DescribeGeneralApmApplicationConfig返回参数结构体
2565
+ * 排序字段
2129
2566
  */
2130
- export interface DescribeGeneralApmApplicationConfigResponse {
2567
+ export interface OrderBy {
2131
2568
  /**
2132
- * 应用配置项
2569
+ * 需要排序的字段,现支持 startTIme, endTime, duration
2133
2570
  */
2134
- ApmApplicationConfigView?: ApmApplicationConfigView;
2571
+ Key: string;
2135
2572
  /**
2136
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2573
+ * asc 顺序排序 / desc 倒序排序
2137
2574
  */
2138
- RequestId?: string;
2575
+ Value: string;
2139
2576
  }
2140
2577
  /**
2141
- * DescribeGeneralMetricData请求参数结构体
2578
+ * 指标维度信息
2142
2579
  */
2143
- export interface DescribeGeneralMetricDataRequest {
2144
- /**
2145
- * 需要查询的指标名称,不可自定义输入,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
2146
- */
2147
- Metrics: Array<string>;
2148
- /**
2149
- * 业务系统 ID
2150
- */
2151
- InstanceId: string;
2580
+ export interface ApmField {
2152
2581
  /**
2153
- * 视图名称,不可自定义输入。[详情请见。](https://cloud.tencent.com/document/product/248/101681)
2582
+ * 指标名
2154
2583
  */
2155
- ViewName: string;
2584
+ Key?: string;
2156
2585
  /**
2157
- * 要过滤的维度信息,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
2586
+ * 指标数值
2158
2587
  */
2159
- Filters: Array<GeneralFilter>;
2588
+ Value?: number;
2160
2589
  /**
2161
- * 聚合维度,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
2590
+ * 指标所对应的单位
2162
2591
  */
2163
- GroupBy?: Array<string>;
2592
+ Unit?: string;
2164
2593
  /**
2165
- * 起始时间的时间戳,支持查询30天内的指标数据。(单位:秒)
2594
+ * 同比结果数组,推荐使用
2595
+ 注意:此字段可能返回 null,表示取不到有效值。
2166
2596
  */
2167
- StartTime?: number;
2597
+ CompareVals?: Array<APMKVItem>;
2168
2598
  /**
2169
- * 结束时间的时间戳,支持查询30天内的指标数据。(单位:秒)
2599
+ * 同比上一个周期的具体指标数值
2600
+ 注意:此字段可能返回 null,表示取不到有效值。
2170
2601
  */
2171
- EndTime?: number;
2602
+ LastPeriodValue?: Array<APMKV>;
2172
2603
  /**
2173
- * 是否按固定时间跨度聚合,填入1及大于1的值按1处理,不填按0处理。
2174
- - 填入0,则计算开始时间到截止时间的指标数据。
2175
- - 填入1,则会按照开始时间到截止时间的时间跨度选择聚合粒度:
2176
- - 时间跨度 (0,12) 小时,则按一分钟粒度聚合。
2177
- - 时间跨度 [12,48] 小时,则按五分钟粒度聚合。
2178
- - 时间跨度 (48, +∞) 小时,则按一小时粒度聚合。
2604
+ * 同比指标值,已弃用,不建议使用
2179
2605
  */
2180
- Period?: number;
2606
+ CompareVal?: string;
2181
2607
  /**
2182
- * 对查询指标进行排序:
2183
- Key 填写云 API 指标名称,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
2184
- Value 填写排序方式:
2185
- - asc:对查询指标进行升序排序
2186
- - desc:对查询指标进行降序排序
2608
+ * 指标中文名
2187
2609
  */
2188
- OrderBy?: OrderBy;
2610
+ NameCN?: string;
2189
2611
  /**
2190
- * 查询指标的限制条数,目前最多展示50条数据,PageSize取值为1-50,上送PageSize则根据PageSize的值展示限制条数。
2612
+ * 指标英文名
2191
2613
  */
2192
- PageSize?: number;
2614
+ NameEN?: string;
2193
2615
  }
2194
2616
  /**
2195
- * DescribeApmPrometheusRule请求参数结构体
2617
+ * DescribeGeneralSpanList返回参数结构体
2196
2618
  */
2197
- export interface DescribeApmPrometheusRuleRequest {
2619
+ export interface DescribeGeneralSpanListResponse {
2198
2620
  /**
2199
- * 业务系统ID
2621
+ * 总数量
2200
2622
  */
2201
- InstanceId: string;
2202
- }
2203
- /**
2204
- * CreateApmInstance返回参数结构体
2205
- */
2206
- export interface CreateApmInstanceResponse {
2623
+ TotalCount?: number;
2207
2624
  /**
2208
- * 业务系统 ID
2625
+ * Span 分页列表
2209
2626
  */
2210
- InstanceId?: string;
2627
+ Spans?: Array<Span>;
2211
2628
  /**
2212
2629
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2213
2630
  */
2214
2631
  RequestId?: string;
2215
2632
  }
2216
2633
  /**
2217
- * Span上下游关联关系
2634
+ * 展示apm业务系统与其他云产品关联关系返回体
2218
2635
  */
2219
- export interface SpanReference {
2636
+ export interface ApmAssociation {
2220
2637
  /**
2221
- * 关联关系类型
2638
+ * 关联产品的实例ID
2639
+ 注意:此字段可能返回 null,表示取不到有效值。
2222
2640
  */
2223
- RefType: string;
2641
+ PeerId?: string;
2224
2642
  /**
2225
- * Span ID
2643
+ * 关联关系状态:1(启用)、2(不启用)、3(已失效)
2644
+ 注意:此字段可能返回 null,表示取不到有效值。
2226
2645
  */
2227
- SpanID: string;
2646
+ Status?: number;
2228
2647
  /**
2229
- * Trace ID
2648
+ * CKafka消息主题
2230
2649
  */
2231
- TraceID: string;
2650
+ Topic?: string;
2232
2651
  }
2233
2652
  /**
2234
- * CreateProfileTask请求参数结构体
2653
+ * 资源层信息
2235
2654
  */
2236
- export interface CreateProfileTaskRequest {
2655
+ export interface Resource {
2237
2656
  /**
2238
- * 应用名称
2657
+ * 资源类型
2658
+ 注意:此字段可能返回 null,表示取不到有效值。
2239
2659
  */
2240
- ServiceName: string;
2660
+ Type?: Array<string>;
2241
2661
  /**
2242
- * APM业务系统ID
2662
+ * tke资源层信息
2243
2663
  */
2244
- InstanceId: string;
2664
+ TKEMeta?: Array<TkeMeta>;
2245
2665
  /**
2246
- * 应用实例(在线)
2666
+ * cvm资源信息
2667
+ 注意:此字段可能返回 null,表示取不到有效值。
2247
2668
  */
2248
- ServiceInstance: string;
2669
+ CVMMeta?: Array<CVMMeta>;
2670
+ }
2671
+ /**
2672
+ * 视图方案勾选情况
2673
+ */
2674
+ export interface Selectors {
2249
2675
  /**
2250
- * 事件类型(cpu、alloc)
2676
+ * 组件勾选情况
2677
+ 注意:此字段可能返回 null,表示取不到有效值。
2251
2678
  */
2252
- Event: string;
2679
+ Component?: Array<string>;
2680
+ }
2681
+ /**
2682
+ * ModifyApmApplicationConfig请求参数结构体
2683
+ */
2684
+ export interface ModifyApmApplicationConfigRequest {
2253
2685
  /**
2254
- * 任务持续时长(单位:毫秒),范围限制在5~180秒
2686
+ * 业务系统 ID
2255
2687
  */
2256
- Duration: number;
2688
+ InstanceId: string;
2257
2689
  /**
2258
- * 执行次数,范围限制在1~100次
2690
+ * 应用名
2259
2691
  */
2260
- AllTimes: number;
2692
+ ServiceName: string;
2261
2693
  /**
2262
- * 开始时间戳,0代表从当前开始(单位:秒)
2694
+ * URL收敛开关,0 关 | 1 开
2263
2695
  */
2264
- StartTime?: number;
2696
+ UrlConvergenceSwitch: number;
2265
2697
  /**
2266
- * 任务执行间隔(单位:毫秒),范围限制在10~600秒,不可小于1.5倍的Duration
2698
+ * URL收敛阈值
2267
2699
  */
2268
- TaskInterval?: number;
2269
- }
2270
- /**
2271
- * 服务相关信息
2272
- */
2273
- export interface SpanProcess {
2700
+ UrlConvergenceThreshold?: number;
2274
2701
  /**
2275
- * 应用服务名称
2702
+ * 异常过滤正则规则,逗号分隔
2276
2703
  */
2277
- ServiceName: string;
2704
+ ExceptionFilter?: string;
2278
2705
  /**
2279
- * Tags 标签数组
2706
+ * URL收敛正则规则,逗号分隔
2280
2707
  */
2281
- Tags: Array<SpanTag>;
2282
- }
2283
- /**
2284
- * DeleteApmSampleConfig返回参数结构体
2285
- */
2286
- export interface DeleteApmSampleConfigResponse {
2708
+ UrlConvergence?: string;
2287
2709
  /**
2288
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2710
+ * 错误码过滤,逗号分隔
2289
2711
  */
2290
- RequestId?: string;
2291
- }
2292
- /**
2293
- * ModifyApmAssociation请求参数结构体
2294
- */
2295
- export interface ModifyApmAssociationRequest {
2712
+ ErrorCodeFilter?: string;
2296
2713
  /**
2297
- * 关联的产品名,当前只支持Prometheus、CKafka
2714
+ * URL排除正则规则,逗号分隔
2298
2715
  */
2299
- ProductName: string;
2716
+ UrlExclude?: string;
2300
2717
  /**
2301
- * 关联关系的状态:// 关联关系状态:1(启用)、2(不启用)
2718
+ * 日志开关 0 关 1
2302
2719
  */
2303
- Status: number;
2720
+ IsRelatedLog?: number;
2304
2721
  /**
2305
- * 业务系统ID
2722
+ * 日志地域
2306
2723
  */
2307
- InstanceId: string;
2724
+ LogRegion?: string;
2308
2725
  /**
2309
- * 关联的产品实例ID
2726
+ * 日志主题ID
2310
2727
  */
2311
- PeerId?: string;
2728
+ LogTopicID?: string;
2312
2729
  /**
2313
- * CKafka消息主题
2730
+ * CLS 日志集 | ES 集群ID
2314
2731
  */
2315
- Topic?: string;
2316
- }
2317
- /**
2318
- * 展示apm业务系统关联prometheus关系返回体
2319
- */
2320
- export interface ApmPrometheusRules {
2732
+ LogSet?: string;
2321
2733
  /**
2322
- * 指标匹配规则ID
2734
+ * 日志来源 CLS | ES
2323
2735
  */
2324
- Id?: number;
2736
+ LogSource?: string;
2325
2737
  /**
2326
- * 指标匹配规则名
2327
- 注意:此字段可能返回 null,表示取不到有效值。
2738
+ * 需过滤的接口
2328
2739
  */
2329
- Name?: string;
2740
+ IgnoreOperationName?: string;
2330
2741
  /**
2331
- * 规则生效的应用。生效于全部应用就传空字符串
2332
- 注意:此字段可能返回 null,表示取不到有效值。
2742
+ * 是否开启线程剖析
2333
2743
  */
2334
- ServiceName?: string;
2744
+ EnableSnapshot?: boolean;
2335
2745
  /**
2336
- * 指标匹配规则状态:1(启用)、2(不启用)
2337
- 注意:此字段可能返回 null,表示取不到有效值。
2746
+ * 线程剖析超时阈值
2338
2747
  */
2339
- Status?: number;
2748
+ SnapshotTimeout?: number;
2340
2749
  /**
2341
- * 指标匹配规则
2342
- 注意:此字段可能返回 null,表示取不到有效值。
2750
+ * 是否开启agent
2343
2751
  */
2344
- MetricNameRule?: string;
2752
+ AgentEnable?: boolean;
2345
2753
  /**
2346
- * 匹配类型:0精准匹配,1前缀匹配,2后缀匹配
2347
- 注意:此字段可能返回 null,表示取不到有效值。
2754
+ * 是否开启链路压缩
2348
2755
  */
2349
- MetricMatchType?: number;
2350
- }
2351
- /**
2352
- * ModifyApmSampleConfig请求参数结构体
2353
- */
2354
- export interface ModifyApmSampleConfigRequest {
2756
+ TraceSquash?: boolean;
2355
2757
  /**
2356
- * 业务系统ID
2758
+ * 是否开启应用诊断的开关
2357
2759
  */
2358
- InstanceId: string;
2760
+ EventEnable?: boolean;
2359
2761
  /**
2360
- * 采样规则名
2762
+ * 组件列表
2361
2763
  */
2362
- SampleName: string;
2764
+ InstrumentList?: Array<Instrument>;
2363
2765
  /**
2364
- * 采样率
2766
+ * 探针接口相关配置
2365
2767
  */
2366
- SampleRate: number;
2768
+ AgentOperationConfigView?: AgentOperationConfigView;
2367
2769
  /**
2368
- * 应用名,生效于所有应用则填空
2770
+ * 是否开启应用日志配置
2369
2771
  */
2370
- ServiceName?: string;
2772
+ EnableLogConfig?: boolean;
2371
2773
  /**
2372
- * 接口名
2774
+ * 应用是否开启dashboard配置: false 关(与业务系统保持一致)/true 开(应用级配置)
2373
2775
  */
2374
- OperationName?: string;
2776
+ EnableDashboardConfig?: boolean;
2375
2777
  /**
2376
- * 采样tag
2778
+ * 是否关联dashboard: 0 关 1 开
2377
2779
  */
2378
- Tags?: Array<APMKVItem>;
2780
+ IsRelatedDashboard?: number;
2379
2781
  /**
2380
- * 采样开关 0关 1开 2删除
2782
+ * dashboard ID
2381
2783
  */
2382
- Status?: number;
2784
+ DashboardTopicID?: string;
2383
2785
  /**
2384
- * 配置Id
2786
+ * CLS索引类型(0=全文索引,1=键值索引)
2385
2787
  */
2386
- Id?: number;
2788
+ LogIndexType?: number;
2387
2789
  /**
2388
- * 0=精确匹配(默认);1=前缀匹配;2=后缀匹配
2790
+ * traceId的索引key: 当CLS索引类型为键值索引时生效
2389
2791
  */
2390
- OperationType?: number;
2391
- }
2392
- /**
2393
- * DescribeGeneralApmApplicationConfig请求参数结构体
2394
- */
2395
- export interface DescribeGeneralApmApplicationConfigRequest {
2792
+ LogTraceIdKey?: string;
2396
2793
  /**
2397
- * 应用名
2794
+ * 是否开启应用安全配置
2398
2795
  */
2399
- ServiceName: string;
2796
+ EnableSecurityConfig?: boolean;
2400
2797
  /**
2401
- * 业务系统ID
2798
+ * 是否开启SQL注入分析
2402
2799
  */
2403
- InstanceId: string;
2404
- }
2405
- /**
2406
- * 采样配置信息
2407
- */
2408
- export interface ApmSampleConfig {
2800
+ IsSqlInjectionAnalysis?: number;
2409
2801
  /**
2410
- * 实例ID
2802
+ * 是否开启组件漏洞检测
2411
2803
  */
2412
- InstanceKey?: string;
2804
+ IsInstrumentationVulnerabilityScan?: number;
2413
2805
  /**
2414
- * 服务名
2806
+ * 是否开启远程命令检测
2415
2807
  */
2416
- ServiceName?: string;
2808
+ IsRemoteCommandExecutionAnalysis?: number;
2417
2809
  /**
2418
- * 采样名字
2810
+ * 是否开启内存马检测
2419
2811
  */
2420
- SampleName?: string;
2812
+ IsMemoryHijackingAnalysis?: number;
2421
2813
  /**
2422
- * 接口名
2814
+ * 是否开启删除任意文件检测(0-关闭,1-开启)
2423
2815
  */
2424
- OperationName?: string;
2816
+ IsDeleteAnyFileAnalysis?: number;
2425
2817
  /**
2426
- * 采样的span数
2818
+ * 是否开启读取任意文件检测(0-关闭,1-开启)
2427
2819
  */
2428
- SpanNum?: number;
2820
+ IsReadAnyFileAnalysis?: number;
2429
2821
  /**
2430
- * 采样配置开关 01
2822
+ * 是否开启上传任意文件检测(0-关闭,1-开启)
2431
2823
  */
2432
- Status?: number;
2824
+ IsUploadAnyFileAnalysis?: number;
2433
2825
  /**
2434
- * tags数组
2435
- 注意:此字段可能返回 null,表示取不到有效值。
2826
+ * 是否开启包含任意文件检测(0-关闭,1-开启)
2436
2827
  */
2437
- Tags?: Array<APMKVItem>;
2828
+ IsIncludeAnyFileAnalysis?: number;
2438
2829
  /**
2439
- * 采样率
2830
+ * 是否开启目录遍历检测(0-关闭,1-开启)
2440
2831
  */
2441
- SampleRate?: number;
2832
+ IsDirectoryTraversalAnalysis?: number;
2442
2833
  /**
2443
- * 0=精确匹配(默认);1=前缀匹配;2=后缀匹配
2444
- 注意:此字段可能返回 null,表示取不到有效值。
2834
+ * 是否开启模板引擎注入检测(0-关闭,1-开启)
2445
2835
  */
2446
- OperationType?: number;
2836
+ IsTemplateEngineInjectionAnalysis?: number;
2447
2837
  /**
2448
- * 配置Id
2449
- 注意:此字段可能返回 null,表示取不到有效值。
2838
+ * 是否开启脚本引擎注入检测(0-关闭,1-开启)
2450
2839
  */
2451
- Id?: number;
2452
- }
2453
- /**
2454
- * 查询过滤参数
2455
- */
2456
- export interface GeneralFilter {
2840
+ IsScriptEngineInjectionAnalysis?: number;
2457
2841
  /**
2458
- * 过滤维度名
2842
+ * 是否开启表达式注入检测(0-关闭,1-开启)
2459
2843
  */
2460
- Key: string;
2844
+ IsExpressionInjectionAnalysis?: number;
2461
2845
  /**
2462
- * 过滤值
2846
+ * 是否开启JNDI注入检测(0-关闭,1-开启)
2463
2847
  */
2464
- Value: string;
2465
- }
2466
- /**
2467
- * DescribeApmInstances请求参数结构体
2468
- */
2469
- export interface DescribeApmInstancesRequest {
2848
+ IsJNDIInjectionAnalysis?: number;
2470
2849
  /**
2471
- * Tag 列表
2850
+ * 是否开启JNI注入检测(0-关闭,1-开启)
2472
2851
  */
2473
- Tags?: Array<ApmTag>;
2852
+ IsJNIInjectionAnalysis?: number;
2474
2853
  /**
2475
- * 按业务系统名过滤,支持模糊检索
2854
+ * 是否开启Webshell后门检测(0-关闭,1-开启)
2476
2855
  */
2477
- InstanceName?: string;
2856
+ IsWebshellBackdoorAnalysis?: number;
2478
2857
  /**
2479
- * 按业务系统 ID 过滤,支持模糊检索
2858
+ * 是否开启反序列化检测(0-关闭,1-开启)
2480
2859
  */
2481
- InstanceId?: string;
2860
+ IsDeserializationAnalysis?: number;
2482
2861
  /**
2483
- * 按业务系统 ID 过滤
2862
+ * 接口自动收敛开关,0 | 1 开
2484
2863
  */
2485
- InstanceIds?: Array<string>;
2864
+ UrlAutoConvergenceEnable?: boolean;
2486
2865
  /**
2487
- * 是否查询官方 Demo 业务系统(0=非 Demo 业务系统,1=Demo 业务系统,默认为0)
2866
+ * URL长分段收敛阈值
2488
2867
  */
2489
- DemoInstanceFlag?: number;
2868
+ UrlLongSegmentThreshold?: number;
2490
2869
  /**
2491
- * 是否查询全地域业务系统(0=不查询全地域,1=查询全地域,默认为0)
2870
+ * URL数字分段收敛阈值
2492
2871
  */
2493
- AllRegionsFlag?: number;
2494
- }
2495
- /**
2496
- * 标签
2497
- */
2498
- export interface SpanTag {
2872
+ UrlNumberSegmentThreshold?: number;
2499
2873
  /**
2500
- * 标签类型
2874
+ * 探针熔断内存阈值
2501
2875
  */
2502
- Type: string;
2876
+ DisableMemoryUsed?: number;
2503
2877
  /**
2504
- * 标签Key
2505
- 注意:此字段可能返回 null,表示取不到有效值。
2878
+ * 探针熔断CPU阈值
2506
2879
  */
2507
- Key: string;
2880
+ DisableCpuUsed?: number;
2508
2881
  /**
2509
- * 标签值
2510
- 注意:此字段可能返回 null,表示取不到有效值。
2882
+ * 是否开启SQL参数获取
2511
2883
  */
2512
- Value: string;
2884
+ DbStatementParametersEnabled?: boolean;
2885
+ /**
2886
+ * 慢SQL阈值
2887
+ */
2888
+ SlowSQLThresholds?: Array<ApmTag>;
2513
2889
  }
2514
2890
  /**
2515
- * DescribeGeneralMetricData返回参数结构体
2891
+ * ModifyGeneralApmApplicationConfig返回参数结构体
2516
2892
  */
2517
- export interface DescribeGeneralMetricDataResponse {
2893
+ export interface ModifyGeneralApmApplicationConfigResponse {
2518
2894
  /**
2519
- * 指标结果集
2895
+ * 返回值描述
2520
2896
  */
2521
- Records?: Array<Line>;
2897
+ Message?: string;
2522
2898
  /**
2523
2899
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2524
2900
  */
2525
2901
  RequestId?: string;
2526
2902
  }
2527
2903
  /**
2528
- * DeleteApmSampleConfig请求参数结构体
2904
+ * CVM元数据
2529
2905
  */
2530
- export interface DeleteApmSampleConfigRequest {
2906
+ export interface CVMMeta {
2531
2907
  /**
2532
- * 业务系统ID
2908
+ * 地域
2909
+ 注意:此字段可能返回 null,表示取不到有效值。
2533
2910
  */
2534
- InstanceId: string;
2911
+ Region?: string;
2535
2912
  /**
2536
- * 采样规则名
2913
+ * 实例ID
2914
+ 注意:此字段可能返回 null,表示取不到有效值。
2537
2915
  */
2538
- SampleName: string;
2916
+ InstanceID?: string;
2539
2917
  }
2540
2918
  /**
2541
- * APM 通用 KV 结构
2919
+ * Span上下游关联关系
2542
2920
  */
2543
- export interface APMKVItem {
2921
+ export interface SpanReference {
2544
2922
  /**
2545
- * Key 值定义
2923
+ * 关联关系类型
2546
2924
  */
2547
- Key: string;
2925
+ RefType: string;
2548
2926
  /**
2549
- * Value 值定义
2927
+ * Span ID
2550
2928
  */
2551
- Value: string;
2929
+ SpanID: string;
2930
+ /**
2931
+ * Trace ID
2932
+ */
2933
+ TraceID: string;
2552
2934
  }
2553
2935
  /**
2554
- * CreateApmPrometheusRule返回参数结构体
2936
+ * 服务相关信息
2555
2937
  */
2556
- export interface CreateApmPrometheusRuleResponse {
2938
+ export interface SpanProcess {
2557
2939
  /**
2558
- * 指标匹配规则的ID
2940
+ * 应用服务名称
2559
2941
  */
2560
- RuleId?: number;
2942
+ ServiceName: string;
2561
2943
  /**
2562
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2944
+ * Tags 标签数组
2563
2945
  */
2564
- RequestId?: string;
2946
+ Tags: Array<SpanTag>;
2565
2947
  }
2566
2948
  /**
2567
- * TerminateApmInstance返回参数结构体
2949
+ * 查询过滤参数
2568
2950
  */
2569
- export interface TerminateApmInstanceResponse {
2951
+ export interface GeneralFilter {
2570
2952
  /**
2571
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2953
+ * 过滤维度名
2572
2954
  */
2573
- RequestId?: string;
2955
+ Key: string;
2956
+ /**
2957
+ * 过滤值
2958
+ */
2959
+ Value: string;
2574
2960
  }