tencentcloud-sdk-nodejs-apm 4.0.431 → 4.0.432

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.
@@ -19,627 +19,608 @@
19
19
  * apm实例信息
20
20
  */
21
21
  export interface ApmInstanceDetail {
22
-
23
- /**
22
+ /**
24
23
  * 存储使用量(MB)
25
24
  注意:此字段可能返回 null,表示取不到有效值。
26
25
  */
27
- AmountOfUsedStorage: number;
28
-
29
- /**
26
+ AmountOfUsedStorage: number
27
+
28
+ /**
30
29
  * 实例名
31
30
  注意:此字段可能返回 null,表示取不到有效值。
32
31
  */
33
- Name: string;
34
-
35
- /**
32
+ Name: string
33
+
34
+ /**
36
35
  * 实例所属tag列表
37
36
  注意:此字段可能返回 null,表示取不到有效值。
38
37
  */
39
- Tags: Array<ApmTag>;
40
-
41
- /**
42
- * 实例ID
43
- */
44
- InstanceId: string;
45
-
46
- /**
38
+ Tags: Array<ApmTag>
39
+
40
+ /**
41
+ * 实例ID
42
+ */
43
+ InstanceId: string
44
+
45
+ /**
47
46
  * 创建人Uin
48
47
  注意:此字段可能返回 null,表示取不到有效值。
49
48
  */
50
- CreateUin: string;
51
-
52
- /**
49
+ CreateUin: string
50
+
51
+ /**
53
52
  * 该实例已上报的服务端应用数量
54
53
  注意:此字段可能返回 null,表示取不到有效值。
55
54
  */
56
- ServiceCount: number;
57
-
58
- /**
55
+ ServiceCount: number
56
+
57
+ /**
59
58
  * 日均上报Span数
60
59
  注意:此字段可能返回 null,表示取不到有效值。
61
60
  */
62
- CountOfReportSpanPerDay: number;
63
-
64
- /**
65
- * AppId信息
66
- */
67
- AppId: number;
68
-
69
- /**
61
+ CountOfReportSpanPerDay: number
62
+
63
+ /**
64
+ * AppId信息
65
+ */
66
+ AppId: number
67
+
68
+ /**
70
69
  * Trace数据保存时长
71
70
  注意:此字段可能返回 null,表示取不到有效值。
72
71
  */
73
- TraceDuration: number;
74
-
75
- /**
72
+ TraceDuration: number
73
+
74
+ /**
76
75
  * 实例描述信息
77
76
  注意:此字段可能返回 null,表示取不到有效值。
78
77
  */
79
- Description: string;
80
-
81
- /**
78
+ Description: string
79
+
80
+ /**
82
81
  * 实例状态
83
82
  注意:此字段可能返回 null,表示取不到有效值。
84
83
  */
85
- Status: number;
86
-
87
- /**
84
+ Status: number
85
+
86
+ /**
88
87
  * 实例所属地域
89
88
  注意:此字段可能返回 null,表示取不到有效值。
90
89
  */
91
- Region: string;
92
-
93
- /**
90
+ Region: string
91
+
92
+ /**
94
93
  * 实例上报额度
95
94
  注意:此字段可能返回 null,表示取不到有效值。
96
95
  */
97
- SpanDailyCounters: number;
98
-
99
- /**
96
+ SpanDailyCounters: number
97
+
98
+ /**
100
99
  * 实例是否开通计费
101
100
  注意:此字段可能返回 null,表示取不到有效值。
102
101
  */
103
- BillingInstance: number;
104
-
105
- /**
102
+ BillingInstance: number
103
+
104
+ /**
106
105
  * 错误率阈值
107
106
  注意:此字段可能返回 null,表示取不到有效值。
108
107
  */
109
- ErrRateThreshold: number;
110
-
111
- /**
108
+ ErrRateThreshold: number
109
+
110
+ /**
112
111
  * 采样率阈值
113
112
  注意:此字段可能返回 null,表示取不到有效值。
114
113
  */
115
- SampleRate: number;
116
-
117
- /**
114
+ SampleRate: number
115
+
116
+ /**
118
117
  * 是否开启错误采样 0 关 1 开
119
118
  注意:此字段可能返回 null,表示取不到有效值。
120
119
  */
121
- ErrorSample: number;
122
-
123
- /**
120
+ ErrorSample: number
121
+
122
+ /**
124
123
  * 慢调用保存阈值
125
124
  注意:此字段可能返回 null,表示取不到有效值。
126
125
  */
127
- SlowRequestSavedThreshold: number;
128
-
129
- /**
126
+ SlowRequestSavedThreshold: number
127
+
128
+ /**
130
129
  * cls日志所在地域
131
130
  注意:此字段可能返回 null,表示取不到有效值。
132
131
  */
133
- LogRegion: string;
134
-
135
- /**
132
+ LogRegion: string
133
+
134
+ /**
136
135
  * 日志来源
137
136
  注意:此字段可能返回 null,表示取不到有效值。
138
137
  */
139
- LogSource: string;
140
-
141
- /**
138
+ LogSource: string
139
+
140
+ /**
142
141
  * 日志功能开关 0 关 | 1 开
143
142
  注意:此字段可能返回 null,表示取不到有效值。
144
143
  */
145
- IsRelatedLog: number;
146
-
147
- /**
144
+ IsRelatedLog: number
145
+
146
+ /**
148
147
  * 日志主题ID
149
148
  注意:此字段可能返回 null,表示取不到有效值。
150
149
  */
151
- LogTopicID: string;
152
-
153
- /**
150
+ LogTopicID: string
151
+
152
+ /**
154
153
  * 该实例已上报的客户端应用数量
155
154
  注意:此字段可能返回 null,表示取不到有效值。
156
155
  */
157
- ClientCount: number;
158
-
159
- /**
156
+ ClientCount: number
157
+
158
+ /**
160
159
  * 该实例已上报的总应用数量
161
160
  注意:此字段可能返回 null,表示取不到有效值。
162
161
  */
163
- TotalCount: number;
162
+ TotalCount: number
164
163
  }
165
164
 
166
165
  /**
167
166
  * CreateApmInstance请求参数结构体
168
167
  */
169
168
  export interface CreateApmInstanceRequest {
170
-
171
- /**
172
- * 实例名
173
- */
174
- Name: string;
175
-
176
- /**
177
- * 实例描述信息
178
- */
179
- Description?: string;
180
-
181
- /**
182
- * Trace数据保存时长
183
- */
184
- TraceDuration?: number;
185
-
186
- /**
187
- * 标签列表
188
- */
189
- Tags?: Array<ApmTag>;
190
-
191
- /**
192
- * 实例上报额度值
193
- */
194
- SpanDailyCounters?: number;
169
+ /**
170
+ * 实例名
171
+ */
172
+ Name: string
173
+
174
+ /**
175
+ * 实例描述信息
176
+ */
177
+ Description?: string
178
+
179
+ /**
180
+ * Trace数据保存时长
181
+ */
182
+ TraceDuration?: number
183
+
184
+ /**
185
+ * 标签列表
186
+ */
187
+ Tags?: Array<ApmTag>
188
+
189
+ /**
190
+ * 实例上报额度值
191
+ */
192
+ SpanDailyCounters?: number
195
193
  }
196
194
 
197
195
  /**
198
196
  * DescribeServiceOverview返回参数结构体
199
197
  */
200
198
  export interface DescribeServiceOverviewResponse {
201
-
202
- /**
199
+ /**
203
200
  * 指标结果集
204
201
  注意:此字段可能返回 null,表示取不到有效值。
205
202
  */
206
- Records: Array<ApmMetricRecord>;
207
-
208
- /**
209
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
210
- */
211
- RequestId?: string;
203
+ Records: Array<ApmMetricRecord>
204
+
205
+ /**
206
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
207
+ */
208
+ RequestId?: string
212
209
  }
213
210
 
214
211
  /**
215
212
  * 查询
216
213
  */
217
214
  export interface QueryMetricItem {
218
-
219
- /**
220
- * 指标名
221
- */
222
- MetricName: string;
223
-
224
- /**
225
- * 同比,已弃用,不建议使用
226
- */
227
- Compare?: string;
228
-
229
- /**
230
- * 同比,支持多种同比方式
231
- */
232
- Compares?: Array<string>;
215
+ /**
216
+ * 指标名
217
+ */
218
+ MetricName: string
219
+
220
+ /**
221
+ * 同比,已弃用,不建议使用
222
+ */
223
+ Compare?: string
224
+
225
+ /**
226
+ * 同比,支持多种同比方式
227
+ */
228
+ Compares?: Array<string>
233
229
  }
234
230
 
235
231
  /**
236
232
  * DescribeApmInstances返回参数结构体
237
233
  */
238
234
  export interface DescribeApmInstancesResponse {
239
-
240
- /**
235
+ /**
241
236
  * apm实例列表
242
237
  注意:此字段可能返回 null,表示取不到有效值。
243
238
  */
244
- Instances: Array<ApmInstanceDetail>;
245
-
246
- /**
247
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
248
- */
249
- RequestId?: string;
239
+ Instances: Array<ApmInstanceDetail>
240
+
241
+ /**
242
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
243
+ */
244
+ RequestId?: string
250
245
  }
251
246
 
252
247
  /**
253
248
  * apm Agent信息
254
249
  */
255
250
  export interface ApmAgentInfo {
256
-
257
- /**
251
+ /**
258
252
  * Agent下载地址
259
253
  注意:此字段可能返回 null,表示取不到有效值。
260
254
  */
261
- AgentDownloadURL: string;
262
-
263
- /**
255
+ AgentDownloadURL: string
256
+
257
+ /**
264
258
  * Collector上报地址
265
259
  注意:此字段可能返回 null,表示取不到有效值。
266
260
  */
267
- CollectorURL: string;
268
-
269
- /**
261
+ CollectorURL: string
262
+
263
+ /**
270
264
  * Token信息
271
265
  注意:此字段可能返回 null,表示取不到有效值。
272
266
  */
273
- Token: string;
274
-
275
- /**
267
+ Token: string
268
+
269
+ /**
276
270
  * 外网上报地址
277
271
  注意:此字段可能返回 null,表示取不到有效值。
278
272
  */
279
- PublicCollectorURL: string;
280
-
281
- /**
273
+ PublicCollectorURL: string
274
+
275
+ /**
282
276
  * 自研VPC上报地址
283
277
  注意:此字段可能返回 null,表示取不到有效值。
284
278
  */
285
- InnerCollectorURL: string;
286
-
287
- /**
279
+ InnerCollectorURL: string
280
+
281
+ /**
288
282
  * 内网上报地址(Private Link上报地址)
289
283
  注意:此字段可能返回 null,表示取不到有效值。
290
284
  */
291
- PrivateLinkCollectorURL: string;
285
+ PrivateLinkCollectorURL: string
292
286
  }
293
287
 
294
288
  /**
295
289
  * 指标列表单元
296
290
  */
297
291
  export interface ApmMetricRecord {
298
-
299
- /**
300
- * field数组
301
- */
302
- Fields: Array<ApmField>;
303
-
304
- /**
305
- * tag数组
306
- */
307
- Tags: Array<ApmTag>;
292
+ /**
293
+ * field数组
294
+ */
295
+ Fields: Array<ApmField>
296
+
297
+ /**
298
+ * tag数组
299
+ */
300
+ Tags: Array<ApmTag>
308
301
  }
309
302
 
310
303
  /**
311
304
  * DescribeServiceOverview请求参数结构体
312
305
  */
313
306
  export interface DescribeServiceOverviewRequest {
314
-
315
- /**
316
- * 过滤条件
317
- */
318
- Filters: Array<Filter>;
319
-
320
- /**
321
- * 指标列表
322
- */
323
- Metrics: Array<QueryMetricItem>;
324
-
325
- /**
326
- * 聚合维度
327
- */
328
- GroupBy: Array<string>;
329
-
330
- /**
331
- * 排序
332
- */
333
- OrderBy?: OrderBy;
334
-
335
- /**
336
- * 实例ID
337
- */
338
- InstanceId?: string;
339
-
340
- /**
341
- * 每页大小
342
- */
343
- Limit?: number;
344
-
345
- /**
346
- * 开始时间
347
- */
348
- StartTime?: number;
349
-
350
- /**
351
- * 分页起始点
352
- */
353
- Offset?: number;
354
-
355
- /**
356
- * 结束时间
357
- */
358
- EndTime?: number;
307
+ /**
308
+ * 过滤条件
309
+ */
310
+ Filters: Array<Filter>
311
+
312
+ /**
313
+ * 指标列表
314
+ */
315
+ Metrics: Array<QueryMetricItem>
316
+
317
+ /**
318
+ * 聚合维度
319
+ */
320
+ GroupBy: Array<string>
321
+
322
+ /**
323
+ * 排序
324
+ */
325
+ OrderBy?: OrderBy
326
+
327
+ /**
328
+ * 实例ID
329
+ */
330
+ InstanceId?: string
331
+
332
+ /**
333
+ * 每页大小
334
+ */
335
+ Limit?: number
336
+
337
+ /**
338
+ * 开始时间
339
+ */
340
+ StartTime?: number
341
+
342
+ /**
343
+ * 分页起始点
344
+ */
345
+ Offset?: number
346
+
347
+ /**
348
+ * 结束时间
349
+ */
350
+ EndTime?: number
359
351
  }
360
352
 
361
353
  /**
362
354
  * DescribeApmAgent返回参数结构体
363
355
  */
364
356
  export interface DescribeApmAgentResponse {
365
-
366
- /**
357
+ /**
367
358
  * Agent信息
368
359
  注意:此字段可能返回 null,表示取不到有效值。
369
360
  */
370
- ApmAgent: ApmAgentInfo;
371
-
372
- /**
373
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
374
- */
375
- RequestId?: string;
361
+ ApmAgent: ApmAgentInfo
362
+
363
+ /**
364
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
365
+ */
366
+ RequestId?: string
376
367
  }
377
368
 
378
369
  /**
379
370
  * 指标维度信息
380
371
  */
381
372
  export interface ApmField {
382
-
383
- /**
373
+ /**
384
374
  * 昨日同比指标值,已弃用,不建议使用
385
375
  注意:此字段可能返回 null,表示取不到有效值。
386
376
  */
387
- CompareVal: string;
388
-
389
- /**
377
+ CompareVal: string
378
+
379
+ /**
390
380
  * Compare值结果数组,推荐使用
391
381
  注意:此字段可能返回 null,表示取不到有效值。
392
382
  */
393
- CompareVals: Array<APMKVItem>;
394
-
395
- /**
383
+ CompareVals: Array<APMKVItem>
384
+
385
+ /**
396
386
  * 指标值
397
387
  注意:此字段可能返回 null,表示取不到有效值。
398
388
  */
399
- Value: number;
400
-
401
- /**
389
+ Value: number
390
+
391
+ /**
402
392
  * 指标所对应的单位
403
393
  注意:此字段可能返回 null,表示取不到有效值。
404
394
  */
405
- Unit: string;
406
-
407
- /**
408
- * 请求数
409
- */
410
- Key: string;
395
+ Unit: string
396
+
397
+ /**
398
+ * 请求数
399
+ */
400
+ Key: string
411
401
  }
412
402
 
413
403
  /**
414
404
  * 指标曲线数据
415
405
  */
416
406
  export interface Line {
417
-
418
- /**
419
- * 指标名
420
- */
421
- MetricName: string;
422
-
423
- /**
424
- * 指标中文名
425
- */
426
- MetricNameCN: string;
427
-
428
- /**
429
- * 时间序列
430
- */
431
- TimeSerial: Array<number>;
432
-
433
- /**
407
+ /**
408
+ * 指标名
409
+ */
410
+ MetricName: string
411
+
412
+ /**
413
+ * 指标中文名
414
+ */
415
+ MetricNameCN: string
416
+
417
+ /**
418
+ * 时间序列
419
+ */
420
+ TimeSerial: Array<number>
421
+
422
+ /**
434
423
  * 数据序列
435
424
  注意:此字段可能返回 null,表示取不到有效值。
436
425
  */
437
- DataSerial: Array<number>;
438
-
439
- /**
426
+ DataSerial: Array<number>
427
+
428
+ /**
440
429
  * 维度列表
441
430
  注意:此字段可能返回 null,表示取不到有效值。
442
431
  */
443
- Tags: Array<ApmTag>;
432
+ Tags: Array<ApmTag>
444
433
  }
445
434
 
446
435
  /**
447
436
  * Apm通用KV结构
448
437
  */
449
438
  export interface APMKVItem {
450
-
451
- /**
439
+ /**
452
440
  * Key值定义
453
441
  注意:此字段可能返回 null,表示取不到有效值。
454
442
  */
455
- Key: string;
456
-
457
- /**
443
+ Key: string
444
+
445
+ /**
458
446
  * Value值定义
459
447
  注意:此字段可能返回 null,表示取不到有效值。
460
448
  */
461
- Value: string;
449
+ Value: string
462
450
  }
463
451
 
464
452
  /**
465
453
  * sql排序字段
466
454
  */
467
455
  export interface OrderBy {
468
-
469
- /**
470
- * 需要排序的字段
471
- */
472
- Key: string;
473
-
474
- /**
475
- * 顺序排序/倒序排序
476
- */
477
- Value: string;
456
+ /**
457
+ * 需要排序的字段
458
+ */
459
+ Key: string
460
+
461
+ /**
462
+ * 顺序排序/倒序排序
463
+ */
464
+ Value: string
478
465
  }
479
466
 
480
467
  /**
481
468
  * DescribeMetricRecords返回参数结构体
482
469
  */
483
470
  export interface DescribeMetricRecordsResponse {
484
-
485
- /**
471
+ /**
486
472
  * 指标结果集
487
473
  注意:此字段可能返回 null,表示取不到有效值。
488
474
  */
489
- Records: Array<ApmMetricRecord>;
490
-
491
- /**
475
+ Records: Array<ApmMetricRecord>
476
+
477
+ /**
492
478
  * 查询指标结果集条数
493
479
  注意:此字段可能返回 null,表示取不到有效值。
494
480
  */
495
- TotalCount: number;
496
-
497
- /**
498
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
499
- */
500
- RequestId?: string;
481
+ TotalCount: number
482
+
483
+ /**
484
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
485
+ */
486
+ RequestId?: string
501
487
  }
502
488
 
503
489
  /**
504
490
  * 维度(标签)对象
505
491
  */
506
492
  export interface ApmTag {
507
-
508
- /**
509
- * 维度Key(列名,标签Key)
510
- */
511
- Key: string;
512
-
513
- /**
514
- * 维度值(标签值)
515
- */
516
- Value: string;
493
+ /**
494
+ * 维度Key(列名,标签Key)
495
+ */
496
+ Key: string
497
+
498
+ /**
499
+ * 维度值(标签值)
500
+ */
501
+ Value: string
517
502
  }
518
503
 
519
504
  /**
520
505
  * 查询过滤参数
521
506
  */
522
507
  export interface Filter {
523
-
524
- /**
525
- * 过滤方式(=, !=, in)
526
- */
527
- Type: string;
528
-
529
- /**
530
- * 过滤维度名
531
- */
532
- Key: string;
533
-
534
- /**
535
- * 过滤值,in过滤方式用逗号分割多个值
536
- */
537
- Value: string;
508
+ /**
509
+ * 过滤方式(=, !=, in)
510
+ */
511
+ Type: string
512
+
513
+ /**
514
+ * 过滤维度名
515
+ */
516
+ Key: string
517
+
518
+ /**
519
+ * 过滤值,in过滤方式用逗号分割多个值
520
+ */
521
+ Value: string
538
522
  }
539
523
 
540
524
  /**
541
525
  * DescribeApmAgent请求参数结构体
542
526
  */
543
527
  export interface DescribeApmAgentRequest {
544
-
545
- /**
546
- * 实例ID
547
- */
548
- InstanceId: string;
549
-
550
- /**
551
- * 接入方式
552
- */
553
- AgentType?: string;
554
-
555
- /**
556
- * 环境
557
- */
558
- NetworkMode?: string;
559
-
560
- /**
561
- * 语言
562
- */
563
- LanguageEnvironment?: string;
564
-
565
- /**
566
- * 上报方式
567
- */
568
- ReportMethod?: string;
528
+ /**
529
+ * 实例ID
530
+ */
531
+ InstanceId: string
532
+
533
+ /**
534
+ * 接入方式
535
+ */
536
+ AgentType?: string
537
+
538
+ /**
539
+ * 环境
540
+ */
541
+ NetworkMode?: string
542
+
543
+ /**
544
+ * 语言
545
+ */
546
+ LanguageEnvironment?: string
547
+
548
+ /**
549
+ * 上报方式
550
+ */
551
+ ReportMethod?: string
569
552
  }
570
553
 
571
554
  /**
572
555
  * DescribeMetricRecords请求参数结构体
573
556
  */
574
557
  export interface DescribeMetricRecordsRequest {
575
-
576
- /**
577
- * 过滤条件
578
- */
579
- Filters: Array<Filter>;
580
-
581
- /**
582
- * 指标列表
583
- */
584
- Metrics: Array<QueryMetricItem>;
585
-
586
- /**
587
- * 聚合维度
588
- */
589
- GroupBy: Array<string>;
590
-
591
- /**
592
- * 排序
593
- */
594
- OrderBy?: OrderBy;
595
-
596
- /**
597
- * 实例ID
598
- */
599
- InstanceId?: string;
600
-
601
- /**
602
- * 每页大小
603
- */
604
- Limit?: number;
605
-
606
- /**
607
- * 开始时间
608
- */
609
- StartTime?: number;
610
-
611
- /**
612
- * 分页起始点
613
- */
614
- Offset?: number;
615
-
616
- /**
617
- * 结束时间
618
- */
619
- EndTime?: number;
620
-
621
- /**
622
- * 业务名称(默认值:taw)
623
- */
624
- BusinessName?: string;
625
-
626
- /**
627
- * 页码
628
- */
629
- PageIndex?: number;
630
-
631
- /**
632
- * 页长
633
- */
634
- PageSize?: number;
558
+ /**
559
+ * 过滤条件
560
+ */
561
+ Filters: Array<Filter>
562
+
563
+ /**
564
+ * 指标列表
565
+ */
566
+ Metrics: Array<QueryMetricItem>
567
+
568
+ /**
569
+ * 聚合维度
570
+ */
571
+ GroupBy: Array<string>
572
+
573
+ /**
574
+ * 排序
575
+ */
576
+ OrderBy?: OrderBy
577
+
578
+ /**
579
+ * 实例ID
580
+ */
581
+ InstanceId?: string
582
+
583
+ /**
584
+ * 每页大小
585
+ */
586
+ Limit?: number
587
+
588
+ /**
589
+ * 开始时间
590
+ */
591
+ StartTime?: number
592
+
593
+ /**
594
+ * 分页起始点
595
+ */
596
+ Offset?: number
597
+
598
+ /**
599
+ * 结束时间
600
+ */
601
+ EndTime?: number
602
+
603
+ /**
604
+ * 业务名称(默认值:taw)
605
+ */
606
+ BusinessName?: string
607
+
608
+ /**
609
+ * 页码
610
+ */
611
+ PageIndex?: number
612
+
613
+ /**
614
+ * 页长
615
+ */
616
+ PageSize?: number
635
617
  }
636
618
 
637
619
  /**
638
620
  * DescribeGeneralMetricData请求参数结构体
639
621
  */
640
622
  export interface DescribeGeneralMetricDataRequest {
641
-
642
- /**
623
+ /**
643
624
  * 要过滤的维度信息:
644
625
  service_metric视图支持:service.name(服务名)、span.kind(客户端/服务端视角)为维度进行过滤,service.name(服务名)必填。
645
626
  span.kind:
@@ -649,50 +630,50 @@ span.kind:
649
630
  runtime_metric视图支持:service.name(服务名)维度进行过滤,service.name(服务名)必填。
650
631
  sql_metric视图支持:service.name(服务名)、db.instance(数据库名称)、db.ip(数据库实例ip)维度进行过滤,查询service_slow_sql_count(慢sql)指标时service.name必填,查询sql_duration_avg(耗时)指标时db.instance(数据库名称)必填。
651
632
  */
652
- Filters: Array<GeneralFilter>;
653
-
654
- /**
633
+ Filters: Array<GeneralFilter>
634
+
635
+ /**
655
636
  * 需要查询的指标,不可自定义输入。
656
637
  service_metric视图支持:service_request_count(总请求)、service_duration(平均响应时间)、service_error_req_rate(平均错误率)、service_slow_call_count(慢调用)、service_error_request_count(异常数量)。
657
638
  runtime_metric视图支持:service_gc_full_count(Full GC)。
658
639
  sql_metric视图支持:service_slow_sql_count(慢sql)、sql_duration_avg(耗时)。
659
640
  */
660
- Metrics: Array<string>;
661
-
662
- /**
663
- * 业务系统ID
664
- */
665
- InstanceId: string;
666
-
667
- /**
668
- * 视图名称,不可自定义输入。支持:service_metric、runtime_metric、sql_metric。
669
- */
670
- ViewName: string;
671
-
672
- /**
641
+ Metrics: Array<string>
642
+
643
+ /**
644
+ * 业务系统ID
645
+ */
646
+ InstanceId: string
647
+
648
+ /**
649
+ * 视图名称,不可自定义输入。支持:service_metric、runtime_metric、sql_metric。
650
+ */
651
+ ViewName: string
652
+
653
+ /**
673
654
  * 聚合维度:
674
655
  service_metric视图支持:service.name(服务名)、span.kind (客户端/服务端视角)维度进行聚合,service.name(服务名)必填。
675
656
  runtime_metric视图支持:service.name(服务名)维度进行聚合,service.name(服务名)必填。
676
657
  sql_metric视图支持:service.name(服务名)、db.statement(sql语句)维度进行聚合,查询service_slow_sql_count(慢sql)时service.name(服务名)必填,查询sql_duration_avg(耗时)指标时service.name(服务名)、db.statement(sql语句)必填。
677
658
  */
678
- GroupBy?: Array<string>;
679
-
680
- /**
681
- * 起始时间的时间戳,单位为秒,只支持查询2天内最多1小时的指标数据。
682
- */
683
- StartTime?: number;
684
-
685
- /**
686
- * 结束时间的时间戳,单位为秒,只支持查询2天内最多1小时的指标数据。
687
- */
688
- EndTime?: number;
689
-
690
- /**
691
- * 聚合粒度,单位为秒,最小为60s,即一分钟的聚合粒度;如果为空或0则计算开始时间到截止时间的指标数据,上报其他值会报错。
692
- */
693
- Period?: number;
694
-
695
- /**
659
+ GroupBy?: Array<string>
660
+
661
+ /**
662
+ * 起始时间的时间戳,单位为秒,只支持查询2天内最多1小时的指标数据。
663
+ */
664
+ StartTime?: number
665
+
666
+ /**
667
+ * 结束时间的时间戳,单位为秒,只支持查询2天内最多1小时的指标数据。
668
+ */
669
+ EndTime?: number
670
+
671
+ /**
672
+ * 聚合粒度,单位为秒,最小为60s,即一分钟的聚合粒度;如果为空或0则计算开始时间到截止时间的指标数据,上报其他值会报错。
673
+ */
674
+ Period?: number
675
+
676
+ /**
696
677
  * 对查询指标进行排序:
697
678
  service_metric视图支持:service_request_count(总请求)、service_duration(平均响应时间)、service_error_req_rate(平均错误率)、service_slow_call_count(慢调用)、service_error_request_count(异常数量)。
698
679
  runtime_metric视图支持:service_gc_full_count(Full GC)。
@@ -700,87 +681,82 @@ sql_metric视图支持:service_slow_sql_count(慢sql)、sql_duration_avg
700
681
  asc:对查询指标进行升序排序
701
682
  desc:对查询指标进行降序排序
702
683
  */
703
- OrderBy?: OrderBy;
704
-
705
- /**
706
- * 查询指标的限制条数,目前最多展示50条数据,PageSize取值为1-50,上送PageSize则根据PageSize的值展示限制条数。
707
- */
708
- PageSize?: number;
684
+ OrderBy?: OrderBy
685
+
686
+ /**
687
+ * 查询指标的限制条数,目前最多展示50条数据,PageSize取值为1-50,上送PageSize则根据PageSize的值展示限制条数。
688
+ */
689
+ PageSize?: number
709
690
  }
710
691
 
711
692
  /**
712
693
  * CreateApmInstance返回参数结构体
713
694
  */
714
695
  export interface CreateApmInstanceResponse {
715
-
716
- /**
696
+ /**
717
697
  * 实例ID
718
698
  注意:此字段可能返回 null,表示取不到有效值。
719
699
  */
720
- InstanceId: string;
721
-
722
- /**
723
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
724
- */
725
- RequestId?: string;
700
+ InstanceId: string
701
+
702
+ /**
703
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
704
+ */
705
+ RequestId?: string
726
706
  }
727
707
 
728
708
  /**
729
709
  * 查询过滤参数
730
710
  */
731
711
  export interface GeneralFilter {
732
-
733
- /**
734
- * 过滤维度名
735
- */
736
- Key: string;
737
-
738
- /**
739
- * 过滤值
740
- */
741
- Value: string;
712
+ /**
713
+ * 过滤维度名
714
+ */
715
+ Key: string
716
+
717
+ /**
718
+ * 过滤值
719
+ */
720
+ Value: string
742
721
  }
743
722
 
744
723
  /**
745
724
  * DescribeApmInstances请求参数结构体
746
725
  */
747
726
  export interface DescribeApmInstancesRequest {
748
-
749
- /**
750
- * Tag列表
751
- */
752
- Tags?: Array<ApmTag>;
753
-
754
- /**
755
- * 搜索实例名
756
- */
757
- InstanceName?: string;
758
-
759
- /**
760
- * 过滤实例ID
761
- */
762
- InstanceIds?: Array<string>;
763
-
764
- /**
765
- * 是否查询官方demo实例
766
- */
767
- DemoInstanceFlag?: number;
727
+ /**
728
+ * Tag列表
729
+ */
730
+ Tags?: Array<ApmTag>
731
+
732
+ /**
733
+ * 搜索实例名
734
+ */
735
+ InstanceName?: string
736
+
737
+ /**
738
+ * 过滤实例ID
739
+ */
740
+ InstanceIds?: Array<string>
741
+
742
+ /**
743
+ * 是否查询官方demo实例
744
+ */
745
+ DemoInstanceFlag?: number
768
746
  }
769
747
 
770
748
  /**
771
749
  * DescribeGeneralMetricData返回参数结构体
772
750
  */
773
751
  export interface DescribeGeneralMetricDataResponse {
774
-
775
- /**
752
+ /**
776
753
  * 指标结果集
777
754
  注意:此字段可能返回 null,表示取不到有效值。
778
755
  */
779
- Records: Array<Line>;
780
-
781
- /**
782
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
783
- */
784
- RequestId?: string;
785
- }
756
+ Records: Array<Line>
786
757
 
758
+ /**
759
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
760
+ */
761
+ RequestId?: string
762
+ }