tencentcloud-sdk-nodejs-apm 4.0.618 → 4.0.619

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.
@@ -72,132 +72,132 @@ export interface ModifyApmInstanceRequest {
72
72
  */
73
73
  export interface ApmInstanceDetail {
74
74
  /**
75
- * 存储使用量(MB)
75
+ * 存储使用量(MB)
76
76
  注意:此字段可能返回 null,表示取不到有效值。
77
- */
77
+ */
78
78
  AmountOfUsedStorage: number;
79
79
  /**
80
- * 实例名
80
+ * 实例名
81
81
  注意:此字段可能返回 null,表示取不到有效值。
82
- */
82
+ */
83
83
  Name: string;
84
84
  /**
85
- * 实例所属tag列表
85
+ * 实例所属tag列表
86
86
  注意:此字段可能返回 null,表示取不到有效值。
87
- */
87
+ */
88
88
  Tags: Array<ApmTag>;
89
89
  /**
90
90
  * 实例ID
91
91
  */
92
92
  InstanceId: string;
93
93
  /**
94
- * 创建人Uin
94
+ * 创建人Uin
95
95
  注意:此字段可能返回 null,表示取不到有效值。
96
- */
96
+ */
97
97
  CreateUin: string;
98
98
  /**
99
- * 该实例已上报的服务端应用数量
99
+ * 该实例已上报的服务端应用数量
100
100
  注意:此字段可能返回 null,表示取不到有效值。
101
- */
101
+ */
102
102
  ServiceCount: number;
103
103
  /**
104
- * 日均上报Span数
104
+ * 日均上报Span数
105
105
  注意:此字段可能返回 null,表示取不到有效值。
106
- */
106
+ */
107
107
  CountOfReportSpanPerDay: number;
108
108
  /**
109
109
  * AppId信息
110
110
  */
111
111
  AppId: number;
112
112
  /**
113
- * Trace数据保存时长
113
+ * Trace数据保存时长
114
114
  注意:此字段可能返回 null,表示取不到有效值。
115
- */
115
+ */
116
116
  TraceDuration: number;
117
117
  /**
118
- * 实例描述信息
118
+ * 实例描述信息
119
119
  注意:此字段可能返回 null,表示取不到有效值。
120
- */
120
+ */
121
121
  Description: string;
122
122
  /**
123
- * 实例状态
123
+ * 实例状态
124
124
  注意:此字段可能返回 null,表示取不到有效值。
125
- */
125
+ */
126
126
  Status: number;
127
127
  /**
128
- * 实例所属地域
128
+ * 实例所属地域
129
129
  注意:此字段可能返回 null,表示取不到有效值。
130
- */
130
+ */
131
131
  Region: string;
132
132
  /**
133
- * 实例上报额度
133
+ * 实例上报额度
134
134
  注意:此字段可能返回 null,表示取不到有效值。
135
- */
135
+ */
136
136
  SpanDailyCounters: number;
137
137
  /**
138
- * 实例是否开通计费
138
+ * 实例是否开通计费
139
139
  注意:此字段可能返回 null,表示取不到有效值。
140
- */
140
+ */
141
141
  BillingInstance: number;
142
142
  /**
143
- * 错误率阈值
143
+ * 错误率阈值
144
144
  注意:此字段可能返回 null,表示取不到有效值。
145
- */
145
+ */
146
146
  ErrRateThreshold: number;
147
147
  /**
148
- * 采样率阈值
148
+ * 采样率阈值
149
149
  注意:此字段可能返回 null,表示取不到有效值。
150
- */
150
+ */
151
151
  SampleRate: number;
152
152
  /**
153
- * 是否开启错误采样 0 关 1 开
153
+ * 是否开启错误采样 0 关 1 开
154
154
  注意:此字段可能返回 null,表示取不到有效值。
155
- */
155
+ */
156
156
  ErrorSample: number;
157
157
  /**
158
- * 慢调用保存阈值
158
+ * 慢调用保存阈值
159
159
  注意:此字段可能返回 null,表示取不到有效值。
160
- */
160
+ */
161
161
  SlowRequestSavedThreshold: number;
162
162
  /**
163
- * cls日志所在地域
163
+ * cls日志所在地域
164
164
  注意:此字段可能返回 null,表示取不到有效值。
165
- */
165
+ */
166
166
  LogRegion: string;
167
167
  /**
168
- * 日志来源
168
+ * 日志来源
169
169
  注意:此字段可能返回 null,表示取不到有效值。
170
- */
170
+ */
171
171
  LogSource: string;
172
172
  /**
173
- * 日志功能开关 0 关 | 1 开
173
+ * 日志功能开关 0 关 | 1 开
174
174
  注意:此字段可能返回 null,表示取不到有效值。
175
- */
175
+ */
176
176
  IsRelatedLog: number;
177
177
  /**
178
- * 日志主题ID
178
+ * 日志主题ID
179
179
  注意:此字段可能返回 null,表示取不到有效值。
180
- */
180
+ */
181
181
  LogTopicID: string;
182
182
  /**
183
- * 该实例已上报的客户端应用数量
183
+ * 该实例已上报的客户端应用数量
184
184
  注意:此字段可能返回 null,表示取不到有效值。
185
- */
185
+ */
186
186
  ClientCount: number;
187
187
  /**
188
- * 该实例已上报的总应用数量
188
+ * 该实例已上报的总应用数量
189
189
  注意:此字段可能返回 null,表示取不到有效值。
190
- */
190
+ */
191
191
  TotalCount: number;
192
192
  /**
193
- * CLS日志集 | ES集群ID
193
+ * CLS日志集 | ES集群ID
194
194
  注意:此字段可能返回 null,表示取不到有效值。
195
- */
195
+ */
196
196
  LogSet: string;
197
197
  /**
198
- * Metric数据保存时长
198
+ * Metric数据保存时长
199
199
  注意:此字段可能返回 null,表示取不到有效值。
200
- */
200
+ */
201
201
  MetricDuration: number;
202
202
  }
203
203
  /**
@@ -230,9 +230,9 @@ export interface CreateApmInstanceRequest {
230
230
  */
231
231
  export interface DescribeServiceOverviewResponse {
232
232
  /**
233
- * 指标结果集
233
+ * 指标结果集
234
234
  注意:此字段可能返回 null,表示取不到有效值。
235
- */
235
+ */
236
236
  Records: Array<ApmMetricRecord>;
237
237
  /**
238
238
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -270,9 +270,9 @@ export interface TerminateApmInstanceRequest {
270
270
  */
271
271
  export interface DescribeApmInstancesResponse {
272
272
  /**
273
- * apm实例列表
273
+ * apm实例列表
274
274
  注意:此字段可能返回 null,表示取不到有效值。
275
- */
275
+ */
276
276
  Instances: Array<ApmInstanceDetail>;
277
277
  /**
278
278
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -284,34 +284,34 @@ export interface DescribeApmInstancesResponse {
284
284
  */
285
285
  export interface ApmAgentInfo {
286
286
  /**
287
- * Agent下载地址
287
+ * Agent下载地址
288
288
  注意:此字段可能返回 null,表示取不到有效值。
289
- */
289
+ */
290
290
  AgentDownloadURL: string;
291
291
  /**
292
- * Collector上报地址
292
+ * Collector上报地址
293
293
  注意:此字段可能返回 null,表示取不到有效值。
294
- */
294
+ */
295
295
  CollectorURL: string;
296
296
  /**
297
- * Token信息
297
+ * Token信息
298
298
  注意:此字段可能返回 null,表示取不到有效值。
299
- */
299
+ */
300
300
  Token: string;
301
301
  /**
302
- * 外网上报地址
302
+ * 外网上报地址
303
303
  注意:此字段可能返回 null,表示取不到有效值。
304
- */
304
+ */
305
305
  PublicCollectorURL: string;
306
306
  /**
307
- * 自研VPC上报地址
307
+ * 自研VPC上报地址
308
308
  注意:此字段可能返回 null,表示取不到有效值。
309
- */
309
+ */
310
310
  InnerCollectorURL: string;
311
311
  /**
312
- * 内网上报地址(Private Link上报地址)
312
+ * 内网上报地址(Private Link上报地址)
313
313
  注意:此字段可能返回 null,表示取不到有效值。
314
- */
314
+ */
315
315
  PrivateLinkCollectorURL: string;
316
316
  }
317
317
  /**
@@ -373,9 +373,9 @@ export interface DescribeServiceOverviewRequest {
373
373
  */
374
374
  export interface DescribeApmAgentResponse {
375
375
  /**
376
- * Agent信息
376
+ * Agent信息
377
377
  注意:此字段可能返回 null,表示取不到有效值。
378
- */
378
+ */
379
379
  ApmAgent: ApmAgentInfo;
380
380
  /**
381
381
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -387,33 +387,33 @@ export interface DescribeApmAgentResponse {
387
387
  */
388
388
  export interface ApmField {
389
389
  /**
390
- * 昨日同比指标值,已弃用,不建议使用
390
+ * 昨日同比指标值,已弃用,不建议使用
391
391
  注意:此字段可能返回 null,表示取不到有效值。
392
- */
392
+ */
393
393
  CompareVal: string;
394
394
  /**
395
- * Compare值结果数组,推荐使用
395
+ * Compare值结果数组,推荐使用
396
396
  注意:此字段可能返回 null,表示取不到有效值。
397
- */
397
+ */
398
398
  CompareVals: Array<APMKVItem>;
399
399
  /**
400
- * 指标值
400
+ * 指标值
401
401
  注意:此字段可能返回 null,表示取不到有效值。
402
- */
402
+ */
403
403
  Value: number;
404
404
  /**
405
- * 指标所对应的单位
405
+ * 指标所对应的单位
406
406
  注意:此字段可能返回 null,表示取不到有效值。
407
- */
407
+ */
408
408
  Unit: string;
409
409
  /**
410
410
  * 请求数
411
411
  */
412
412
  Key: string;
413
413
  /**
414
- * 同环比上周期具体数值
414
+ * 同环比上周期具体数值
415
415
  注意:此字段可能返回 null,表示取不到有效值。
416
- */
416
+ */
417
417
  LastPeriodValue: Array<APMKV>;
418
418
  }
419
419
  /**
@@ -433,14 +433,14 @@ export interface Line {
433
433
  */
434
434
  TimeSerial: Array<number>;
435
435
  /**
436
- * 数据序列
436
+ * 数据序列
437
437
  注意:此字段可能返回 null,表示取不到有效值。
438
- */
438
+ */
439
439
  DataSerial: Array<number>;
440
440
  /**
441
- * 维度列表
441
+ * 维度列表
442
442
  注意:此字段可能返回 null,表示取不到有效值。
443
- */
443
+ */
444
444
  Tags: Array<ApmTag>;
445
445
  }
446
446
  /**
@@ -448,14 +448,14 @@ export interface Line {
448
448
  */
449
449
  export interface APMKVItem {
450
450
  /**
451
- * Key值定义
451
+ * Key值定义
452
452
  注意:此字段可能返回 null,表示取不到有效值。
453
- */
453
+ */
454
454
  Key: string;
455
455
  /**
456
- * Value值定义
456
+ * Value值定义
457
457
  注意:此字段可能返回 null,表示取不到有效值。
458
- */
458
+ */
459
459
  Value: string;
460
460
  }
461
461
  /**
@@ -476,14 +476,14 @@ export interface OrderBy {
476
476
  */
477
477
  export interface DescribeMetricRecordsResponse {
478
478
  /**
479
- * 指标结果集
479
+ * 指标结果集
480
480
  注意:此字段可能返回 null,表示取不到有效值。
481
- */
481
+ */
482
482
  Records: Array<ApmMetricRecord>;
483
483
  /**
484
- * 查询指标结果集条数
484
+ * 查询指标结果集条数
485
485
  注意:此字段可能返回 null,表示取不到有效值。
486
- */
486
+ */
487
487
  TotalCount: number;
488
488
  /**
489
489
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -525,14 +525,14 @@ export interface Filter {
525
525
  */
526
526
  export interface APMKV {
527
527
  /**
528
- * Key值定义
528
+ * Key值定义
529
529
  注意:此字段可能返回 null,表示取不到有效值。
530
- */
530
+ */
531
531
  Key: string;
532
532
  /**
533
- * Value值定义
533
+ * Value值定义
534
534
  注意:此字段可能返回 null,表示取不到有效值。
535
- */
535
+ */
536
536
  Value: number;
537
537
  }
538
538
  /**
@@ -618,7 +618,7 @@ export interface DescribeMetricRecordsRequest {
618
618
  */
619
619
  export interface DescribeGeneralMetricDataRequest {
620
620
  /**
621
- * 要过滤的维度信息:
621
+ * 要过滤的维度信息:
622
622
  service_metric视图支持:service.name(服务名)、span.kind(客户端/服务端视角)为维度进行过滤,service.name(服务名)必填。
623
623
  span.kind:
624
624
  server:服务端视角
@@ -626,14 +626,14 @@ export interface DescribeGeneralMetricDataRequest {
626
626
  默认为服务端视角进行查询。
627
627
  runtime_metric视图支持:service.name(服务名)维度进行过滤,service.name(服务名)必填。
628
628
  sql_metric视图支持:service.name(服务名)、db.instance(数据库名称)、db.ip(数据库实例ip)维度进行过滤,查询service_slow_sql_count(慢sql)指标时service.name必填,查询sql_duration_avg(耗时)指标时db.instance(数据库名称)必填。
629
- */
629
+ */
630
630
  Filters: Array<GeneralFilter>;
631
631
  /**
632
- * 需要查询的指标,不可自定义输入。
632
+ * 需要查询的指标,不可自定义输入。
633
633
  service_metric视图支持:service_request_count(总请求)、service_duration(平均响应时间)、service_error_req_rate(平均错误率)、service_slow_call_count(慢调用)、service_error_request_count(异常数量)。
634
634
  runtime_metric视图支持:service_gc_full_count(Full GC)。
635
635
  sql_metric视图支持:service_slow_sql_count(慢sql)、sql_duration_avg(耗时)。
636
- */
636
+ */
637
637
  Metrics: Array<string>;
638
638
  /**
639
639
  * 业务系统ID
@@ -644,11 +644,11 @@ export interface DescribeGeneralMetricDataRequest {
644
644
  */
645
645
  ViewName: string;
646
646
  /**
647
- * 聚合维度:
647
+ * 聚合维度:
648
648
  service_metric视图支持:service.name(服务名)、span.kind (客户端/服务端视角)维度进行聚合,service.name(服务名)必填。
649
649
  runtime_metric视图支持:service.name(服务名)维度进行聚合,service.name(服务名)必填。
650
650
  sql_metric视图支持:service.name(服务名)、db.statement(sql语句)维度进行聚合,查询service_slow_sql_count(慢sql)时service.name(服务名)必填,查询sql_duration_avg(耗时)指标时service.name(服务名)、db.statement(sql语句)必填。
651
- */
651
+ */
652
652
  GroupBy?: Array<string>;
653
653
  /**
654
654
  * 起始时间的时间戳,单位为秒,只支持查询2天内最多1小时的指标数据。
@@ -663,13 +663,13 @@ export interface DescribeGeneralMetricDataRequest {
663
663
  */
664
664
  Period?: number;
665
665
  /**
666
- * 对查询指标进行排序:
666
+ * 对查询指标进行排序:
667
667
  service_metric视图支持:service_request_count(总请求)、service_duration(平均响应时间)、service_error_req_rate(平均错误率)、service_slow_call_count(慢调用)、service_error_request_count(异常数量)。
668
668
  runtime_metric视图支持:service_gc_full_count(Full GC)。
669
669
  sql_metric视图支持:service_slow_sql_count(慢sql)、sql_duration_avg(耗时)。
670
670
  asc:对查询指标进行升序排序
671
671
  desc:对查询指标进行降序排序
672
- */
672
+ */
673
673
  OrderBy?: OrderBy;
674
674
  /**
675
675
  * 查询指标的限制条数,目前最多展示50条数据,PageSize取值为1-50,上送PageSize则根据PageSize的值展示限制条数。
@@ -681,9 +681,9 @@ export interface DescribeGeneralMetricDataRequest {
681
681
  */
682
682
  export interface CreateApmInstanceResponse {
683
683
  /**
684
- * 实例ID
684
+ * 实例ID
685
685
  注意:此字段可能返回 null,表示取不到有效值。
686
- */
686
+ */
687
687
  InstanceId: string;
688
688
  /**
689
689
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -738,9 +738,9 @@ export interface DescribeApmInstancesRequest {
738
738
  */
739
739
  export interface DescribeGeneralMetricDataResponse {
740
740
  /**
741
- * 指标结果集
741
+ * 指标结果集
742
742
  注意:此字段可能返回 null,表示取不到有效值。
743
- */
743
+ */
744
744
  Records: Array<Line>;
745
745
  /**
746
746
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。