tencentcloud-sdk-nodejs-apm 4.0.1046 → 4.1.33

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.
@@ -1,1325 +0,0 @@
1
- /*
2
- * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing,
11
- * software distributed under the License is distributed on an
12
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13
- * KIND, either express or implied. See the License for the
14
- * specific language governing permissions and limitations
15
- * under the License.
16
- */
17
-
18
- /**
19
- * Span日志部分
20
-
21
-
22
- */
23
- export interface SpanLog {
24
- /**
25
- * 日志时间戳
26
- */
27
- Timestamp: number
28
- /**
29
- * 标签
30
- */
31
- Fields: Array<SpanTag>
32
- }
33
-
34
- /**
35
- * ModifyApmInstance请求参数结构体
36
- */
37
- export interface ModifyApmInstanceRequest {
38
- /**
39
- * 业务系统 ID
40
- */
41
- InstanceId: string
42
- /**
43
- * 业务系统名
44
- */
45
- Name: string
46
- /**
47
- * Tag 列表
48
- */
49
- Tags?: Array<ApmTag>
50
- /**
51
- * 业务系统描述
52
- */
53
- Description?: string
54
- /**
55
- * Trace 数据保存时长(单位:天)
56
- */
57
- TraceDuration?: number
58
- /**
59
- * 是否开启计费
60
- */
61
- OpenBilling?: boolean
62
- /**
63
- * 业务系统上报额度
64
- */
65
- SpanDailyCounters?: number
66
- /**
67
- * 错误率警示线,当应用的平均错误率超出该阈值时,系统会给出异常提示。
68
- */
69
- ErrRateThreshold?: number
70
- /**
71
- * 采样率(单位:%)
72
- */
73
- SampleRate?: number
74
- /**
75
- * 是否开启错误采样(0=关, 1=开)
76
- */
77
- ErrorSample?: number
78
- /**
79
- * 采样慢调用保存阈值(单位:ms)
80
- */
81
- SlowRequestSavedThreshold?: number
82
- /**
83
- * 是否开启日志功能(0=关, 1=开)
84
- */
85
- IsRelatedLog?: number
86
- /**
87
- * 日志地域,开启日志功能后才会生效
88
- */
89
- LogRegion?: string
90
- /**
91
- * CLS 日志主题 ID,开启日志功能后才会生效
92
- */
93
- LogTopicID?: string
94
- /**
95
- * 日志集,开启日志功能后才会生效
96
- */
97
- LogSet?: string
98
- /**
99
- * 日志源,开启日志功能后才会生效
100
- */
101
- LogSource?: string
102
- /**
103
- * 用户自定义展示标签列表
104
- */
105
- CustomShowTags?: Array<string>
106
- /**
107
- * 修改计费模式(1为预付费,0为按量付费)
108
- */
109
- PayMode?: number
110
- /**
111
- * 响应时间警示线
112
- */
113
- ResponseDurationWarningThreshold?: number
114
- /**
115
- * 是否免费(0=付费版;1=TSF 受限免费版;2=免费版),默认0
116
- */
117
- Free?: number
118
- /**
119
- * 是否关联 Dashboard(0=关,1=开)
120
- */
121
- IsRelatedDashboard?: number
122
- /**
123
- * 关联的 Dashboard ID,开启关联 Dashboard 后才会生效
124
- */
125
- DashboardTopicID?: string
126
- /**
127
- * 是否开启 SQL 注入检测(0=关,1=开)
128
- */
129
- IsSqlInjectionAnalysis?: number
130
- /**
131
- * 是否开启组件漏洞检测(0=关,1=开)
132
- */
133
- IsInstrumentationVulnerabilityScan?: number
134
- }
135
-
136
- /**
137
- * APM 业务系统信息
138
- */
139
- export interface ApmInstanceDetail {
140
- /**
141
- * 业务系统 ID
142
- */
143
- InstanceId?: string
144
- /**
145
- * 业务系统名
146
- */
147
- Name?: string
148
- /**
149
- * 业务系统描述信息
150
- */
151
- Description?: string
152
- /**
153
- * 业务系统状态。{
154
- 1: 初始化中; 2: 运行中; 4: 限流}
155
- */
156
- Status?: number
157
- /**
158
- * 业务系统所属地域
159
- */
160
- Region?: string
161
- /**
162
- * 业务系统 Tag 列表
163
- */
164
- Tags?: Array<ApmTag>
165
- /**
166
- * AppID 信息
167
- */
168
- AppId?: number
169
- /**
170
- * 创建人 Uin
171
- */
172
- CreateUin?: string
173
- /**
174
- * 存储使用量(单位:MB)
175
- */
176
- AmountOfUsedStorage?: number
177
- /**
178
- * 该业务系统服务端应用数量
179
- */
180
- ServiceCount?: number
181
- /**
182
- * 日均上报 Span 数
183
- */
184
- CountOfReportSpanPerDay?: number
185
- /**
186
- * Trace 数据保存时长(单位:天)
187
- */
188
- TraceDuration?: number
189
- /**
190
- * 业务系统上报额度
191
- */
192
- SpanDailyCounters?: number
193
- /**
194
- * 业务系统是否已开通计费(0=未开通,1=已开通)
195
- */
196
- BillingInstance?: number
197
- /**
198
- * 错误警示线(单位:%)
199
- */
200
- ErrRateThreshold?: number
201
- /**
202
- * 采样率(单位:%)
203
- */
204
- SampleRate?: number
205
- /**
206
- * 是否开启错误采样(0=关, 1=开)
207
- */
208
- ErrorSample?: number
209
- /**
210
- * 采样慢调用保存阈值(单位:ms)
211
- */
212
- SlowRequestSavedThreshold?: number
213
- /**
214
- * CLS 日志所在地域
215
- */
216
- LogRegion?: string
217
- /**
218
- * 日志源
219
- */
220
- LogSource?: string
221
- /**
222
- * 日志功能开关(0=关, 1=开)
223
- */
224
- IsRelatedLog?: number
225
- /**
226
- * 日志主题 ID
227
- */
228
- LogTopicID?: string
229
- /**
230
- * 该业务系统客户端应用数量
231
- */
232
- ClientCount?: number
233
- /**
234
- * 该业务系统最近2天活跃应用数量
235
- */
236
- TotalCount?: number
237
- /**
238
- * CLS 日志集
239
- */
240
- LogSet?: string
241
- /**
242
- * Metric 数据保存时长(单位:天)
243
- */
244
- MetricDuration?: number
245
- /**
246
- * 用户自定义展示标签列表
247
- */
248
- CustomShowTags?: Array<string>
249
- /**
250
- * 业务系统计费模式(1为预付费,0为按量付费)
251
- */
252
- PayMode?: number
253
- /**
254
- * 业务系统计费模式是否生效
255
- */
256
- PayModeEffective?: boolean
257
- /**
258
- * 响应时间警示线(单位:ms)
259
- */
260
- ResponseDurationWarningThreshold?: number
261
- /**
262
- * 是否免费(0=否,1=限额免费,2=完全免费),默认0
263
- */
264
- Free?: number
265
- /**
266
- * 是否 TSF 默认业务系统(0=否,1=是)
267
- */
268
- DefaultTSF?: number
269
- /**
270
- * 是否关联 Dashboard(0=关, 1=开)
271
- */
272
- IsRelatedDashboard?: number
273
- /**
274
- * 关联的 Dashboard ID
275
- */
276
- DashboardTopicID?: string
277
- /**
278
- * 是否开启组件漏洞检测(0=关, 1=开)
279
- */
280
- IsInstrumentationVulnerabilityScan?: number
281
- /**
282
- * 是否开启 SQL 注入分析(0=关, 1=开)
283
- */
284
- IsSqlInjectionAnalysis?: number
285
- /**
286
- * 限流原因。{
287
- 1: 正式版限额;
288
- 2: 试用版限额;
289
- 4: 试用版到期;
290
- 8: 账号欠费
291
- }
292
- */
293
- StopReason?: number
294
- }
295
-
296
- /**
297
- * CreateApmInstance请求参数结构体
298
- */
299
- export interface CreateApmInstanceRequest {
300
- /**
301
- * 业务系统名
302
- */
303
- Name: string
304
- /**
305
- * 业务系统描述信息
306
- */
307
- Description?: string
308
- /**
309
- * Trace 数据保存时长(单位:天,默认存储时长为3天)
310
- */
311
- TraceDuration?: number
312
- /**
313
- * 业务系统 Tag 列表
314
- */
315
- Tags?: Array<ApmTag>
316
- /**
317
- * 业务系统上报额度值,默认赋值为0表示不限制上报额度,已废弃
318
- */
319
- SpanDailyCounters?: number
320
- /**
321
- * 业务系统的计费模式(0=按量付费,1=预付费)
322
- */
323
- PayMode?: number
324
- /**
325
- * 是否为免费版业务系统(0=付费版;1=TSF 受限免费版;2=免费版)
326
- */
327
- Free?: number
328
- }
329
-
330
- /**
331
- * ModifyGeneralApmApplicationConfig请求参数结构体
332
- */
333
- export interface ModifyGeneralApmApplicationConfigRequest {
334
- /**
335
- * 业务系统Id
336
- */
337
- InstanceId: string
338
- /**
339
- * 需要修改的字段key value分别指定字段名、字段值
340
- [具体字段请见](https://cloud.tencent.com/document/product/248/111241)
341
- */
342
- Tags: Array<ApmTag>
343
- /**
344
- * 需要修改配置的应用列表名称
345
- */
346
- ServiceNames: Array<string>
347
- }
348
-
349
- /**
350
- * DescribeServiceOverview返回参数结构体
351
- */
352
- export interface DescribeServiceOverviewResponse {
353
- /**
354
- * 指标结果集
355
- */
356
- Records?: Array<ApmMetricRecord>
357
- /**
358
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
359
- */
360
- RequestId?: string
361
- }
362
-
363
- /**
364
- * 查询
365
- */
366
- export interface QueryMetricItem {
367
- /**
368
- * 指标名
369
- */
370
- MetricName: string
371
- /**
372
- * 同比,现支持 CompareByYesterday (与昨天相比)和CompareByLastWeek (与上周相比)
373
- */
374
- Compares?: Array<string>
375
- /**
376
- * 同比,已弃用,不建议使用
377
- */
378
- Compare?: string
379
- }
380
-
381
- /**
382
- * TerminateApmInstance请求参数结构体
383
- */
384
- export interface TerminateApmInstanceRequest {
385
- /**
386
- * 业务系统ID
387
- */
388
- InstanceId: string
389
- }
390
-
391
- /**
392
- * DescribeApmInstances返回参数结构体
393
- */
394
- export interface DescribeApmInstancesResponse {
395
- /**
396
- * APM 业务系统列表
397
- */
398
- Instances?: Array<ApmInstanceDetail>
399
- /**
400
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
401
- */
402
- RequestId?: string
403
- }
404
-
405
- /**
406
- * 组件
407
- */
408
- export interface Instrument {
409
- /**
410
- * 组件名称
411
- */
412
- Name?: string
413
- /**
414
- * 组件开关
415
- */
416
- Enable?: boolean
417
- }
418
-
419
- /**
420
- * DescribeTagValues返回参数结构体
421
- */
422
- export interface DescribeTagValuesResponse {
423
- /**
424
- * 维度值列表
425
- */
426
- Values?: Array<string>
427
- /**
428
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
429
- */
430
- RequestId?: string
431
- }
432
-
433
- /**
434
- * Span 对象
435
- */
436
- export interface Span {
437
- /**
438
- * Trace ID
439
- */
440
- TraceID?: string
441
- /**
442
- * 日志
443
- */
444
- Logs?: Array<SpanLog>
445
- /**
446
- * 标签
447
- */
448
- Tags?: Array<SpanTag>
449
- /**
450
- * 上报应用服务信息
451
- */
452
- Process?: SpanProcess
453
- /**
454
- * 产生时间戳(毫秒)
455
- */
456
- Timestamp?: number
457
- /**
458
- * Span 名称
459
- */
460
- OperationName?: string
461
- /**
462
- * 关联关系
463
- */
464
- References?: Array<SpanReference>
465
- /**
466
- * 产生时间戳(微秒)
467
- */
468
- StartTime?: number
469
- /**
470
- * 持续耗时(微妙)
471
- */
472
- Duration?: number
473
- /**
474
- * Span ID
475
- */
476
- SpanID?: string
477
- /**
478
- * 产生时间戳(毫秒)
479
- */
480
- StartTimeMillis?: number
481
- /**
482
- * Parent Span ID
483
- */
484
- ParentSpanID?: string
485
- }
486
-
487
- /**
488
- * APM Agent 信息
489
- */
490
- export interface ApmAgentInfo {
491
- /**
492
- * Agent 下载地址
493
- */
494
- AgentDownloadURL?: string
495
- /**
496
- * Collector 上报地址
497
- */
498
- CollectorURL?: string
499
- /**
500
- * Token 信息
501
- */
502
- Token?: string
503
- /**
504
- * 外网上报地址
505
- */
506
- PublicCollectorURL?: string
507
- /**
508
- * 自研 VPC 上报地址
509
- */
510
- InnerCollectorURL?: string
511
- /**
512
- * 内网上报地址( Private Link 上报地址)
513
- */
514
- PrivateLinkCollectorURL?: string
515
- }
516
-
517
- /**
518
- * DescribeGeneralSpanList返回参数结构体
519
- */
520
- export interface DescribeGeneralSpanListResponse {
521
- /**
522
- * 总数量
523
- */
524
- TotalCount?: number
525
- /**
526
- * Span 分页列表
527
- */
528
- Spans?: Array<Span>
529
- /**
530
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
531
- */
532
- RequestId?: string
533
- }
534
-
535
- /**
536
- * 指标列表单元
537
- */
538
- export interface ApmMetricRecord {
539
- /**
540
- * field数组,用于指标的查询结果
541
- */
542
- Fields?: Array<ApmField>
543
- /**
544
- * tag数组,用于区分 Groupby 的对象
545
- */
546
- Tags?: Array<ApmTag>
547
- }
548
-
549
- /**
550
- * DescribeServiceOverview请求参数结构体
551
- */
552
- export interface DescribeServiceOverviewRequest {
553
- /**
554
- * 业务系统 ID
555
- */
556
- InstanceId: string
557
- /**
558
- * 指标列表
559
- */
560
- Metrics: Array<QueryMetricItem>
561
- /**
562
- * 聚合维度
563
- */
564
- GroupBy: Array<string>
565
- /**
566
- * 过滤条件
567
- */
568
- Filters?: Array<Filter>
569
- /**
570
- * 开始时间(单位:秒)
571
- */
572
- StartTime?: number
573
- /**
574
- * 结束时间(单位:秒)
575
- */
576
- EndTime?: number
577
- /**
578
- * 排序方式
579
- Value 填写:
580
- - asc:对查询指标进行升序排序
581
- - desc:对查询指标进行降序排序
582
- */
583
- OrderBy?: OrderBy
584
- /**
585
- * 每页大小
586
- */
587
- Limit?: number
588
- /**
589
- * 分页起始点
590
- */
591
- Offset?: number
592
- }
593
-
594
- /**
595
- * DescribeApmAgent返回参数结构体
596
- */
597
- export interface DescribeApmAgentResponse {
598
- /**
599
- * Agent 信息
600
- */
601
- ApmAgent?: ApmAgentInfo
602
- /**
603
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
604
- */
605
- RequestId?: string
606
- }
607
-
608
- /**
609
- * DescribeTagValues请求参数结构体
610
- */
611
- export interface DescribeTagValuesRequest {
612
- /**
613
- * 业务系统 ID
614
- */
615
- InstanceId: string
616
- /**
617
- * 维度名
618
- */
619
- TagKey: string
620
- /**
621
- * 开始时间(单位为秒)
622
- */
623
- StartTime?: number
624
- /**
625
- * 结束时间(单位为秒)
626
- */
627
- EndTime?: number
628
- /**
629
- * 过滤条件
630
- */
631
- Filters?: Array<Filter>
632
- /**
633
- * Or 过滤条件
634
- */
635
- OrFilters?: Array<Filter>
636
- /**
637
- * 使用类型
638
- */
639
- Type?: string
640
- }
641
-
642
- /**
643
- * 指标维度信息
644
- */
645
- export interface ApmField {
646
- /**
647
- * 指标名
648
- */
649
- Key?: string
650
- /**
651
- * 指标数值
652
- */
653
- Value?: number
654
- /**
655
- * 指标所对应的单位
656
- */
657
- Unit?: string
658
- /**
659
- * 同比结果数组,推荐使用
660
- 注意:此字段可能返回 null,表示取不到有效值。
661
- */
662
- CompareVals?: Array<APMKVItem>
663
- /**
664
- * 同比上一个周期的具体指标数值
665
- 注意:此字段可能返回 null,表示取不到有效值。
666
- */
667
- LastPeriodValue?: Array<APMKV>
668
- /**
669
- * 同比指标值,已弃用,不建议使用
670
- */
671
- CompareVal?: string
672
- }
673
-
674
- /**
675
- * 指标曲线数据
676
- */
677
- export interface Line {
678
- /**
679
- * 指标名
680
- */
681
- MetricName?: string
682
- /**
683
- * 指标中文名
684
- */
685
- MetricNameCN?: string
686
- /**
687
- * 时间序列
688
- */
689
- TimeSerial?: Array<number | bigint>
690
- /**
691
- * 数据序列
692
- */
693
- DataSerial?: Array<number>
694
- /**
695
- * 维度列表
696
- */
697
- Tags?: Array<ApmTag>
698
- }
699
-
700
- /**
701
- * 应用相关的配置列表项
702
- */
703
- export interface ApmApplicationConfigView {
704
- /**
705
- * 业务系统 ID
706
- */
707
- InstanceKey?: string
708
- /**
709
- * 应用名
710
- */
711
- ServiceName?: string
712
- /**
713
- * 接口过滤
714
- */
715
- OperationNameFilter?: string
716
- /**
717
- * 错误类型过滤
718
- */
719
- ExceptionFilter?: string
720
- /**
721
- * HTTP 状态码过滤
722
- */
723
- ErrorCodeFilter?: string
724
- /**
725
- * 应用诊断开关(已废弃)
726
- */
727
- EventEnable?: boolean
728
- /**
729
- * URL 收敛开关 0 关 1 开
730
- */
731
- UrlConvergenceSwitch?: number
732
- /**
733
- * URL 收敛阈值
734
- */
735
- UrlConvergenceThreshold?: number
736
- /**
737
- * URL 收敛规则正则
738
- */
739
- UrlConvergence?: string
740
- /**
741
- * URL 排除规则正则
742
- */
743
- UrlExclude?: string
744
- /**
745
- * 是否开启日志 0 关 1 开
746
- */
747
- IsRelatedLog?: number
748
- /**
749
- * 日志源
750
- */
751
- LogSource?: string
752
- /**
753
- * 日志集
754
- */
755
- LogSet?: string
756
- /**
757
- * 日志主题
758
- */
759
- LogTopicID?: string
760
- /**
761
- * 方法栈快照开关 true 开启 false 关闭
762
- */
763
- SnapshotEnable?: boolean
764
- /**
765
- * 慢调用监听触发阈值
766
- */
767
- SnapshotTimeout?: number
768
- /**
769
- * 探针总开关
770
- */
771
- AgentEnable?: boolean
772
- /**
773
- * 组件列表开关(已废弃)
774
- */
775
- InstrumentList?: Array<Instrument>
776
- /**
777
- * 链路压缩开关(已废弃)
778
- */
779
- TraceSquash?: boolean
780
- }
781
-
782
- /**
783
- * 维度(标签)对象
784
- */
785
- export interface ApmTag {
786
- /**
787
- * 维度Key(列名,标签Key)
788
- */
789
- Key: string
790
- /**
791
- * 维度值(标签值)
792
- */
793
- Value: string
794
- }
795
-
796
- /**
797
- * APM 通用 KV 结构
798
- */
799
- export interface APMKVItem {
800
- /**
801
- * Key 值定义
802
- */
803
- Key: string
804
- /**
805
- * Value 值定义
806
- */
807
- Value: string
808
- }
809
-
810
- /**
811
- * 排序字段
812
- */
813
- export interface OrderBy {
814
- /**
815
- * 需要排序的字段,现支持 startTIme, endTime, duration
816
- */
817
- Key: string
818
- /**
819
- * asc 顺序排序 / desc 倒序排序
820
- */
821
- Value: string
822
- }
823
-
824
- /**
825
- * DescribeMetricRecords返回参数结构体
826
- */
827
- export interface DescribeMetricRecordsResponse {
828
- /**
829
- * 指标结果集
830
- */
831
- Records?: Array<ApmMetricRecord>
832
- /**
833
- * 查询指标结果集条数
834
- */
835
- TotalCount?: number
836
- /**
837
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
838
- */
839
- RequestId?: string
840
- }
841
-
842
- /**
843
- * DescribeGeneralOTSpanList返回参数结构体
844
- */
845
- export interface DescribeGeneralOTSpanListResponse {
846
- /**
847
- * 总数量
848
- */
849
- TotalCount?: number
850
- /**
851
- * Spans字段中包含了链路数据的全部内容,由于数据经过了压缩,需要对结果进行如下三步转换,以还原始的文本。
852
- 1. 将Spans字段中的文本进行 Base64 解码,得到经过压缩后字节数组。
853
- 2. 使用 gzip 对压缩后的字节数组进行解压,得到压缩前的字节数组。
854
- 3. 使用 UTF-8 字符集,将压缩前的字节数组转换为文本。
855
-
856
- */
857
- Spans?: string
858
- /**
859
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
860
- */
861
- RequestId?: string
862
- }
863
-
864
- /**
865
- * DescribeGeneralSpanList请求参数结构体
866
- */
867
- export interface DescribeGeneralSpanListRequest {
868
- /**
869
- * 业务系统 ID
870
- */
871
- InstanceId?: string
872
- /**
873
- * Span 查询开始时间戳(单位:秒)
874
- */
875
- StartTime?: number
876
- /**
877
- * Span 查询结束时间戳(单位:秒)
878
- */
879
- EndTime?: number
880
- /**
881
- * 通用过滤参数
882
- */
883
- Filters?: Array<Filter>
884
- /**
885
- * 排序
886
- 现支持的 Key 有:
887
-
888
- - startTime(开始时间)
889
- - endTime(结束时间)
890
- - duration(响应时间)
891
-
892
- 现支持的 Value 有:
893
-
894
- - desc(降序排序)
895
- - asc(升序排序)
896
- */
897
- OrderBy?: OrderBy
898
- /**
899
- * 业务自身服务名,控制台用户请填写taw
900
- */
901
- BusinessName?: string
902
- /**
903
- * 单页项目个数,默认为10000,合法取值范围为0~10000
904
- */
905
- Limit?: number
906
- /**
907
- * 分页
908
- */
909
- Offset?: number
910
- }
911
-
912
- /**
913
- * 查询过滤参数
914
- */
915
- export interface Filter {
916
- /**
917
- * 过滤方式(=, !=, in)
918
- */
919
- Type: string
920
- /**
921
- * 过滤维度名
922
- */
923
- Key: string
924
- /**
925
- * 过滤值,in过滤方式用逗号分割多个值
926
- */
927
- Value: string
928
- }
929
-
930
- /**
931
- * APM 浮点数类型键值对
932
- */
933
- export interface APMKV {
934
- /**
935
- * Key 值定义
936
- */
937
- Key?: string
938
- /**
939
- * Value 值定义
940
- */
941
- Value?: number
942
- }
943
-
944
- /**
945
- * DescribeGeneralOTSpanList请求参数结构体
946
- */
947
- export interface DescribeGeneralOTSpanListRequest {
948
- /**
949
- * 业务系统 ID
950
- */
951
- InstanceId: string
952
- /**
953
- * Span 查询开始时间戳(单位:秒)
954
- */
955
- StartTime: number
956
- /**
957
- * Span 查询结束时间戳(单位:秒)
958
- */
959
- EndTime: number
960
- /**
961
- * 通用过滤参数
962
- */
963
- Filters?: Array<Filter>
964
- /**
965
- * 排序
966
- 现支持的 Key 有:
967
-
968
- - startTime(开始时间)
969
- - endTime(结束时间)
970
- - duration(响应时间)
971
-
972
- 现支持的 Value 有:
973
-
974
- - desc(降序排序)
975
- - asc(升序排序)
976
- */
977
- OrderBy?: OrderBy
978
- /**
979
- * 业务自身服务名,控制台用户请填写taw
980
- */
981
- BusinessName?: string
982
- /**
983
- * 单页项目个数,默认为10000,合法取值范围为0~10000
984
- */
985
- Limit?: number
986
- /**
987
- * 分页
988
- */
989
- Offset?: number
990
- }
991
-
992
- /**
993
- * DescribeApmAgent请求参数结构体
994
- */
995
- export interface DescribeApmAgentRequest {
996
- /**
997
- * 业务系统 ID
998
- */
999
- InstanceId: string
1000
- /**
1001
- * 接入方式,现支持 skywalking, ot, ebpf 方式接入上报,不填默认为 ot
1002
- */
1003
- AgentType?: string
1004
- /**
1005
- * 上报环境,现支持 pl (内网上报), public (外网), inner (自研 VPC )环境上报,不传默认为 public
1006
- */
1007
- NetworkMode?: string
1008
- /**
1009
- * 语言,现支持 java, golang, php, python, dotNet, nodejs 语言上报,不传默认为 golang
1010
- */
1011
- LanguageEnvironment?: string
1012
- /**
1013
- * 上报方式,已弃用
1014
- */
1015
- ReportMethod?: string
1016
- }
1017
-
1018
- /**
1019
- * DescribeMetricRecords请求参数结构体
1020
- */
1021
- export interface DescribeMetricRecordsRequest {
1022
- /**
1023
- * 指标列表
1024
- */
1025
- Metrics: Array<QueryMetricItem>
1026
- /**
1027
- * 业务系统 ID
1028
- */
1029
- InstanceId?: string
1030
- /**
1031
- * 开始时间(单位为秒)
1032
- */
1033
- StartTime?: number
1034
- /**
1035
- * 结束时间(单位为秒)
1036
- */
1037
- EndTime?: number
1038
- /**
1039
- * 过滤条件
1040
- */
1041
- Filters?: Array<Filter>
1042
- /**
1043
- * Or 过滤条件
1044
- */
1045
- OrFilters?: Array<Filter>
1046
- /**
1047
- * 聚合维度
1048
- */
1049
- GroupBy?: Array<string>
1050
- /**
1051
- * 排序
1052
- 现支持的 Key 有:
1053
-
1054
- - startTime(开始时间)
1055
- - endTime(结束时间)
1056
- - duration(响应时间)
1057
-
1058
- 现支持的 Value 有:
1059
-
1060
- - desc(降序排序)
1061
- - asc(升序排序)
1062
- */
1063
- OrderBy?: OrderBy
1064
- /**
1065
- * 业务名称,控制台用户请填写taw。
1066
- */
1067
- BusinessName?: string
1068
- /**
1069
- * 特殊处理查询结果
1070
- */
1071
- Type?: string
1072
- /**
1073
- * 每页大小,默认为1000,合法取值范围为0~1000
1074
- */
1075
- Limit?: number
1076
- /**
1077
- * 分页起始点
1078
- */
1079
- Offset?: number
1080
- /**
1081
- * 页码
1082
- */
1083
- PageIndex?: number
1084
- /**
1085
- * 页长
1086
- */
1087
- PageSize?: number
1088
- }
1089
-
1090
- /**
1091
- * DescribeGeneralApmApplicationConfig返回参数结构体
1092
- */
1093
- export interface DescribeGeneralApmApplicationConfigResponse {
1094
- /**
1095
- * 应用配置项
1096
- */
1097
- ApmApplicationConfigView?: ApmApplicationConfigView
1098
- /**
1099
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1100
- */
1101
- RequestId?: string
1102
- }
1103
-
1104
- /**
1105
- * DescribeGeneralMetricData请求参数结构体
1106
- */
1107
- export interface DescribeGeneralMetricDataRequest {
1108
- /**
1109
- * 需要查询的指标名称,不可自定义输入,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1110
- */
1111
- Metrics: Array<string>
1112
- /**
1113
- * 业务系统 ID
1114
- */
1115
- InstanceId: string
1116
- /**
1117
- * 视图名称,不可自定义输入。[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1118
- */
1119
- ViewName: string
1120
- /**
1121
- * 要过滤的维度信息,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1122
- */
1123
- Filters: Array<GeneralFilter>
1124
- /**
1125
- * 聚合维度,不同视图有对应的指标维度,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1126
- */
1127
- GroupBy?: Array<string>
1128
- /**
1129
- * 起始时间的时间戳,支持查询30天内的指标数据。(单位:秒)
1130
- */
1131
- StartTime?: number
1132
- /**
1133
- * 结束时间的时间戳,支持查询30天内的指标数据。(单位:秒)
1134
- */
1135
- EndTime?: number
1136
- /**
1137
- * 是否按固定时间跨度聚合,填入1及大于1的值按1处理,不填按0处理。
1138
- - 填入0,则计算开始时间到截止时间的指标数据。
1139
- - 填入1,则会按照开始时间到截止时间的时间跨度选择聚合粒度:
1140
- - 时间跨度 (0,12) 小时,则按一分钟粒度聚合。
1141
- - 时间跨度 [12,48] 小时,则按五分钟粒度聚合。
1142
- - 时间跨度 (48, +∞) 小时,则按一小时粒度聚合。
1143
- */
1144
- Period?: number
1145
- /**
1146
- * 对查询指标进行排序:
1147
- Key 填写云 API 指标名称,[详情请见。](https://cloud.tencent.com/document/product/248/101681)
1148
- Value 填写排序方式:
1149
- - asc:对查询指标进行升序排序
1150
- - desc:对查询指标进行降序排序
1151
- */
1152
- OrderBy?: OrderBy
1153
- /**
1154
- * 查询指标的限制条数,目前最多展示50条数据,PageSize取值为1-50,上送PageSize则根据PageSize的值展示限制条数。
1155
- */
1156
- PageSize?: number
1157
- }
1158
-
1159
- /**
1160
- * CreateApmInstance返回参数结构体
1161
- */
1162
- export interface CreateApmInstanceResponse {
1163
- /**
1164
- * 业务系统 ID
1165
- */
1166
- InstanceId?: string
1167
- /**
1168
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1169
- */
1170
- RequestId?: string
1171
- }
1172
-
1173
- /**
1174
- * Span上下游关联关系
1175
- */
1176
- export interface SpanReference {
1177
- /**
1178
- * 关联关系类型
1179
- */
1180
- RefType: string
1181
- /**
1182
- * Span ID
1183
- */
1184
- SpanID: string
1185
- /**
1186
- * Trace ID
1187
- */
1188
- TraceID: string
1189
- }
1190
-
1191
- /**
1192
- * 服务相关信息
1193
- */
1194
- export interface SpanProcess {
1195
- /**
1196
- * 应用服务名称
1197
- */
1198
- ServiceName: string
1199
- /**
1200
- * Tags 标签数组
1201
- */
1202
- Tags: Array<SpanTag>
1203
- }
1204
-
1205
- /**
1206
- * DescribeGeneralApmApplicationConfig请求参数结构体
1207
- */
1208
- export interface DescribeGeneralApmApplicationConfigRequest {
1209
- /**
1210
- * 应用名
1211
- */
1212
- ServiceName: string
1213
- /**
1214
- * 业务系统ID
1215
- */
1216
- InstanceId: string
1217
- }
1218
-
1219
- /**
1220
- * ModifyApmInstance返回参数结构体
1221
- */
1222
- export interface ModifyApmInstanceResponse {
1223
- /**
1224
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1225
- */
1226
- RequestId?: string
1227
- }
1228
-
1229
- /**
1230
- * 查询过滤参数
1231
- */
1232
- export interface GeneralFilter {
1233
- /**
1234
- * 过滤维度名
1235
- */
1236
- Key: string
1237
- /**
1238
- * 过滤值
1239
- */
1240
- Value: string
1241
- }
1242
-
1243
- /**
1244
- * DescribeApmInstances请求参数结构体
1245
- */
1246
- export interface DescribeApmInstancesRequest {
1247
- /**
1248
- * Tag 列表
1249
- */
1250
- Tags?: Array<ApmTag>
1251
- /**
1252
- * 按业务系统名过滤
1253
- */
1254
- InstanceName?: string
1255
- /**
1256
- * 按业务系统 ID 过滤
1257
- */
1258
- InstanceIds?: Array<string>
1259
- /**
1260
- * 是否查询官方 Demo 业务系统(0=非 Demo 业务系统,1=Demo 业务系统,默认为0)
1261
- */
1262
- DemoInstanceFlag?: number
1263
- /**
1264
- * 是否查询全地域业务系统(0=不查询全地域,1=查询全地域,默认为0)
1265
- */
1266
- AllRegionsFlag?: number
1267
- }
1268
-
1269
- /**
1270
- * 标签
1271
- */
1272
- export interface SpanTag {
1273
- /**
1274
- * 标签类型
1275
- */
1276
- Type: string
1277
- /**
1278
- * 标签Key
1279
- 注意:此字段可能返回 null,表示取不到有效值。
1280
- */
1281
- Key: string
1282
- /**
1283
- * 标签值
1284
- 注意:此字段可能返回 null,表示取不到有效值。
1285
- */
1286
- Value: string
1287
- }
1288
-
1289
- /**
1290
- * DescribeGeneralMetricData返回参数结构体
1291
- */
1292
- export interface DescribeGeneralMetricDataResponse {
1293
- /**
1294
- * 指标结果集
1295
- */
1296
- Records?: Array<Line>
1297
- /**
1298
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1299
- */
1300
- RequestId?: string
1301
- }
1302
-
1303
- /**
1304
- * ModifyGeneralApmApplicationConfig返回参数结构体
1305
- */
1306
- export interface ModifyGeneralApmApplicationConfigResponse {
1307
- /**
1308
- * 返回值描述
1309
- */
1310
- Message?: string
1311
- /**
1312
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1313
- */
1314
- RequestId?: string
1315
- }
1316
-
1317
- /**
1318
- * TerminateApmInstance返回参数结构体
1319
- */
1320
- export interface TerminateApmInstanceResponse {
1321
- /**
1322
- * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1323
- */
1324
- RequestId?: string
1325
- }