tencentcloud-sdk-nodejs-apm 4.0.388 → 4.0.431

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