tencentcloud-sdk-nodejs-cls 4.0.618 → 4.0.620
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.
- package/CHANGELOG.md +487 -0
- package/SERVICE_CHANGELOG.md +478 -156
- package/package.json +1 -1
- package/products.md +30 -30
- package/src/services/cls/v20201016/cls_models.ts +393 -978
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +393 -389
|
@@ -69,19 +69,19 @@ export interface AlarmInfo {
|
|
|
69
69
|
*/
|
|
70
70
|
UpdateTime: string;
|
|
71
71
|
/**
|
|
72
|
-
|
|
72
|
+
* 自定义通知模板
|
|
73
73
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
74
|
-
|
|
74
|
+
*/
|
|
75
75
|
MessageTemplate: string;
|
|
76
76
|
/**
|
|
77
|
-
|
|
77
|
+
* 自定义回调模板
|
|
78
78
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
79
|
-
|
|
79
|
+
*/
|
|
80
80
|
CallBack: CallBackInfo;
|
|
81
81
|
/**
|
|
82
|
-
|
|
82
|
+
* 多维分析设置
|
|
83
83
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
84
|
-
|
|
84
|
+
*/
|
|
85
85
|
Analysis: Array<AnalysisDimensional>;
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
@@ -117,24 +117,24 @@ export interface LogInfo {
|
|
|
117
117
|
*/
|
|
118
118
|
PkgLogId: string;
|
|
119
119
|
/**
|
|
120
|
-
|
|
120
|
+
* 日志内容的Json序列化字符串
|
|
121
121
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
122
|
-
|
|
122
|
+
*/
|
|
123
123
|
LogJson: string;
|
|
124
124
|
/**
|
|
125
|
-
|
|
125
|
+
* 日志来源主机名称
|
|
126
126
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
127
|
-
|
|
127
|
+
*/
|
|
128
128
|
HostName: string;
|
|
129
129
|
/**
|
|
130
|
-
|
|
130
|
+
* 原始日志(仅在日志创建索引异常时有值)
|
|
131
131
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
132
|
-
|
|
132
|
+
*/
|
|
133
133
|
RawLog?: string;
|
|
134
134
|
/**
|
|
135
|
-
|
|
135
|
+
* 日志创建索引异常原因(仅在日志创建索引异常时有值)
|
|
136
136
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
137
|
-
|
|
137
|
+
*/
|
|
138
138
|
IndexStatus?: string;
|
|
139
139
|
}
|
|
140
140
|
/**
|
|
@@ -171,10 +171,10 @@ export interface DescribeLogHistogramRequest {
|
|
|
171
171
|
*/
|
|
172
172
|
Interval?: number;
|
|
173
173
|
/**
|
|
174
|
-
|
|
174
|
+
* 检索语法规则,默认值为0。
|
|
175
175
|
0:Lucene语法,1:CQL语法。
|
|
176
176
|
详细说明参见<a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules" target="_blank">检索条件语法规则</a>
|
|
177
|
-
|
|
177
|
+
*/
|
|
178
178
|
SyntaxRule?: number;
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
@@ -220,9 +220,9 @@ export interface DeleteShipperRequest {
|
|
|
220
220
|
*/
|
|
221
221
|
export interface DynamicIndex {
|
|
222
222
|
/**
|
|
223
|
-
|
|
223
|
+
* 动态索引配置开关
|
|
224
224
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
225
|
-
|
|
225
|
+
*/
|
|
226
226
|
Status?: boolean;
|
|
227
227
|
}
|
|
228
228
|
/**
|
|
@@ -247,9 +247,9 @@ export interface ParquetKeyInfo {
|
|
|
247
247
|
*/
|
|
248
248
|
KeyType: string;
|
|
249
249
|
/**
|
|
250
|
-
|
|
250
|
+
* 解析失败赋值信息
|
|
251
251
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
252
|
-
|
|
252
|
+
*/
|
|
253
253
|
KeyNonExistingField: string;
|
|
254
254
|
}
|
|
255
255
|
/**
|
|
@@ -257,9 +257,9 @@ export interface ParquetKeyInfo {
|
|
|
257
257
|
*/
|
|
258
258
|
export interface DescribeCosRechargesResponse {
|
|
259
259
|
/**
|
|
260
|
-
|
|
260
|
+
* 见: CosRechargeInfo 结构描述
|
|
261
261
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
262
|
-
|
|
262
|
+
*/
|
|
263
263
|
Data?: Array<CosRechargeInfo>;
|
|
264
264
|
/**
|
|
265
265
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -271,9 +271,9 @@ export interface DescribeCosRechargesResponse {
|
|
|
271
271
|
*/
|
|
272
272
|
export interface DescribeShipperTasksResponse {
|
|
273
273
|
/**
|
|
274
|
-
|
|
274
|
+
* 投递任务列表
|
|
275
275
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
276
|
-
|
|
276
|
+
*/
|
|
277
277
|
Tasks: Array<ShipperTaskInfo>;
|
|
278
278
|
/**
|
|
279
279
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -342,12 +342,12 @@ export interface CreateLogsetRequest {
|
|
|
342
342
|
*/
|
|
343
343
|
export interface DescribeShippersRequest {
|
|
344
344
|
/**
|
|
345
|
-
|
|
345
|
+
* - shipperName:按照【投递规则名称】进行过滤。类型:String。必选:否
|
|
346
346
|
- shipperId:按照【投递规则ID】进行过滤。类型:String。必选:否
|
|
347
347
|
- topicId:按照【日志主题】进行过滤。类型:String。必选:否
|
|
348
348
|
|
|
349
349
|
每次请求的Filters的上限为10,Filter.Values的上限为5。
|
|
350
|
-
|
|
350
|
+
*/
|
|
351
351
|
Filters?: Array<Filter>;
|
|
352
352
|
/**
|
|
353
353
|
* 分页的偏移量,默认值为0
|
|
@@ -380,47 +380,47 @@ export interface SearchLogResponse {
|
|
|
380
380
|
*/
|
|
381
381
|
Context?: string;
|
|
382
382
|
/**
|
|
383
|
-
|
|
383
|
+
* 符合检索条件的日志是否已全部返回,如未全部返回可使用Context参数获取后续更多日志
|
|
384
384
|
注意:仅当检索分析语句(Query)不包含SQL时有效
|
|
385
|
-
|
|
385
|
+
*/
|
|
386
386
|
ListOver?: boolean;
|
|
387
387
|
/**
|
|
388
388
|
* 返回的是否为统计分析(即SQL)结果
|
|
389
389
|
*/
|
|
390
390
|
Analysis?: boolean;
|
|
391
391
|
/**
|
|
392
|
-
|
|
392
|
+
* 匹配检索条件的原始日志
|
|
393
393
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
394
|
-
|
|
394
|
+
*/
|
|
395
395
|
Results?: Array<LogInfo>;
|
|
396
396
|
/**
|
|
397
|
-
|
|
397
|
+
* 日志统计分析结果的列名
|
|
398
398
|
当UseNewAnalysis为false时生效
|
|
399
399
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
400
|
-
|
|
400
|
+
*/
|
|
401
401
|
ColNames?: Array<string>;
|
|
402
402
|
/**
|
|
403
|
-
|
|
403
|
+
* 日志统计分析结果
|
|
404
404
|
当UseNewAnalysis为false时生效
|
|
405
405
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
406
|
-
|
|
406
|
+
*/
|
|
407
407
|
AnalysisResults?: Array<LogItems>;
|
|
408
408
|
/**
|
|
409
|
-
|
|
409
|
+
* 日志统计分析结果
|
|
410
410
|
当UseNewAnalysis为true时生效
|
|
411
411
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
412
|
-
|
|
412
|
+
*/
|
|
413
413
|
AnalysisRecords?: Array<string>;
|
|
414
414
|
/**
|
|
415
|
-
|
|
415
|
+
* 日志统计分析结果的列属性
|
|
416
416
|
当UseNewAnalysis为true时生效
|
|
417
417
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
418
|
-
|
|
418
|
+
*/
|
|
419
419
|
Columns?: Array<Column>;
|
|
420
420
|
/**
|
|
421
|
-
|
|
421
|
+
* 本次统计分析使用的采样率
|
|
422
422
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
423
|
-
|
|
423
|
+
*/
|
|
424
424
|
SamplingRate?: number;
|
|
425
425
|
/**
|
|
426
426
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -454,34 +454,34 @@ export interface ContainerStdoutInfo {
|
|
|
454
454
|
*/
|
|
455
455
|
AllContainers: boolean;
|
|
456
456
|
/**
|
|
457
|
-
|
|
457
|
+
* container为空表所有的,不为空采集指定的容器
|
|
458
458
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
459
|
-
|
|
459
|
+
*/
|
|
460
460
|
Container?: string;
|
|
461
461
|
/**
|
|
462
|
-
|
|
462
|
+
* namespace可以多个,用分隔号分割,例如A,B;为空或者没有这个字段,表示所有namespace
|
|
463
463
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
464
|
-
|
|
464
|
+
*/
|
|
465
465
|
Namespace?: string;
|
|
466
466
|
/**
|
|
467
|
-
|
|
467
|
+
* pod标签信息
|
|
468
468
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
469
|
-
|
|
469
|
+
*/
|
|
470
470
|
IncludeLabels?: Array<string>;
|
|
471
471
|
/**
|
|
472
|
-
|
|
472
|
+
* 工作负载信息
|
|
473
473
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
474
|
-
|
|
474
|
+
*/
|
|
475
475
|
WorkLoads?: Array<ContainerWorkLoadInfo>;
|
|
476
476
|
/**
|
|
477
|
-
|
|
477
|
+
* 需要排除的namespace可以多个,用分隔号分割,例如A,B
|
|
478
478
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
479
|
-
|
|
479
|
+
*/
|
|
480
480
|
ExcludeNamespace?: string;
|
|
481
481
|
/**
|
|
482
|
-
|
|
482
|
+
* 需要排除的pod标签信息
|
|
483
483
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
484
|
-
|
|
484
|
+
*/
|
|
485
485
|
ExcludeLabels?: Array<string>;
|
|
486
486
|
}
|
|
487
487
|
/**
|
|
@@ -515,7 +515,7 @@ export interface DescribeShipperTasksRequest {
|
|
|
515
515
|
*/
|
|
516
516
|
export interface DescribeAlarmsRequest {
|
|
517
517
|
/**
|
|
518
|
-
|
|
518
|
+
* name
|
|
519
519
|
- 按照【告警策略名称】进行过滤。
|
|
520
520
|
- 类型:String
|
|
521
521
|
- 必选:否
|
|
@@ -537,7 +537,7 @@ export interface DescribeAlarmsRequest {
|
|
|
537
537
|
- 必选:否
|
|
538
538
|
|
|
539
539
|
每次请求的Filters的上限为10,Filter.Values的上限为5。
|
|
540
|
-
|
|
540
|
+
*/
|
|
541
541
|
Filters?: Array<Filter>;
|
|
542
542
|
/**
|
|
543
543
|
* 分页的偏移量,默认值为0。
|
|
@@ -566,9 +566,9 @@ export interface MergePartitionRequest {
|
|
|
566
566
|
*/
|
|
567
567
|
export interface DescribeShippersResponse {
|
|
568
568
|
/**
|
|
569
|
-
|
|
569
|
+
* 投递规则列表
|
|
570
570
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
571
|
-
|
|
571
|
+
*/
|
|
572
572
|
Shippers?: Array<ShipperInfo>;
|
|
573
573
|
/**
|
|
574
574
|
* 本次查询获取到的总数
|
|
@@ -638,9 +638,9 @@ export interface ModifyTopicRequest {
|
|
|
638
638
|
*/
|
|
639
639
|
Describes?: string;
|
|
640
640
|
/**
|
|
641
|
-
|
|
641
|
+
* 0:关闭日志沉降。
|
|
642
642
|
非0:开启日志沉降后标准存储的天数。HotPeriod需要大于等于7,且小于Period。仅在StorageType为 hot 时生效
|
|
643
|
-
|
|
643
|
+
*/
|
|
644
644
|
HotPeriod?: number;
|
|
645
645
|
/**
|
|
646
646
|
* webtracking开关; false: 关闭 true: 开启
|
|
@@ -660,14 +660,14 @@ export interface ContainerWorkLoadInfo {
|
|
|
660
660
|
*/
|
|
661
661
|
Name: string;
|
|
662
662
|
/**
|
|
663
|
-
|
|
663
|
+
* 容器名
|
|
664
664
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
665
|
-
|
|
665
|
+
*/
|
|
666
666
|
Container?: string;
|
|
667
667
|
/**
|
|
668
|
-
|
|
668
|
+
* 命名空间
|
|
669
669
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
670
|
-
|
|
670
|
+
*/
|
|
671
671
|
Namespace?: string;
|
|
672
672
|
}
|
|
673
673
|
/**
|
|
@@ -675,9 +675,9 @@ export interface ContainerWorkLoadInfo {
|
|
|
675
675
|
*/
|
|
676
676
|
export interface DescribeConfigExtrasResponse {
|
|
677
677
|
/**
|
|
678
|
-
|
|
678
|
+
* 采集配置列表
|
|
679
679
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
680
|
-
|
|
680
|
+
*/
|
|
681
681
|
Configs: Array<ConfigExtraInfo>;
|
|
682
682
|
/**
|
|
683
683
|
* 过滤到的总数目
|
|
@@ -697,9 +697,9 @@ export interface CallBackInfo {
|
|
|
697
697
|
*/
|
|
698
698
|
Body: string;
|
|
699
699
|
/**
|
|
700
|
-
|
|
700
|
+
* 回调时的Headers
|
|
701
701
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
702
|
-
|
|
702
|
+
*/
|
|
703
703
|
Headers?: Array<string>;
|
|
704
704
|
}
|
|
705
705
|
/**
|
|
@@ -766,9 +766,9 @@ export interface DescribeIndexRequest {
|
|
|
766
766
|
*/
|
|
767
767
|
export interface DescribeConfigsResponse {
|
|
768
768
|
/**
|
|
769
|
-
|
|
769
|
+
* 采集配置列表
|
|
770
770
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
771
|
-
|
|
771
|
+
*/
|
|
772
772
|
Configs?: Array<ConfigInfo>;
|
|
773
773
|
/**
|
|
774
774
|
* 过滤到的总数目
|
|
@@ -788,9 +788,9 @@ export interface DeleteMachineGroupInfoRequest {
|
|
|
788
788
|
*/
|
|
789
789
|
GroupId: string;
|
|
790
790
|
/**
|
|
791
|
-
|
|
791
|
+
* 机器组类型
|
|
792
792
|
目前type支持 ip 和 label
|
|
793
|
-
|
|
793
|
+
*/
|
|
794
794
|
MachineGroupType: MachineGroupTypeInfo;
|
|
795
795
|
}
|
|
796
796
|
/**
|
|
@@ -820,14 +820,14 @@ export interface DeleteMachineGroupResponse {
|
|
|
820
820
|
*/
|
|
821
821
|
export interface Tag {
|
|
822
822
|
/**
|
|
823
|
-
|
|
823
|
+
* 标签键
|
|
824
824
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
825
|
-
|
|
825
|
+
*/
|
|
826
826
|
Key: string;
|
|
827
827
|
/**
|
|
828
|
-
|
|
828
|
+
* 标签值
|
|
829
829
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
830
|
-
|
|
830
|
+
*/
|
|
831
831
|
Value: string;
|
|
832
832
|
}
|
|
833
833
|
/**
|
|
@@ -872,9 +872,9 @@ export interface CreateCosRechargeRequest {
|
|
|
872
872
|
*/
|
|
873
873
|
Prefix: string;
|
|
874
874
|
/**
|
|
875
|
-
|
|
875
|
+
* 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文;
|
|
876
876
|
默认为minimalist_log
|
|
877
|
-
|
|
877
|
+
*/
|
|
878
878
|
LogType: string;
|
|
879
879
|
/**
|
|
880
880
|
* supported: "", "gzip", "lzop", "snappy”; 默认空
|
|
@@ -890,93 +890,93 @@ export interface CreateCosRechargeRequest {
|
|
|
890
890
|
*/
|
|
891
891
|
export interface ExtractRuleInfo {
|
|
892
892
|
/**
|
|
893
|
-
|
|
893
|
+
* 时间字段的key名字,time_key和time_format必须成对出现
|
|
894
894
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
895
|
-
|
|
895
|
+
*/
|
|
896
896
|
TimeKey?: string;
|
|
897
897
|
/**
|
|
898
|
-
|
|
898
|
+
* 时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数
|
|
899
899
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
900
|
-
|
|
900
|
+
*/
|
|
901
901
|
TimeFormat?: string;
|
|
902
902
|
/**
|
|
903
|
-
|
|
903
|
+
* 分隔符类型日志的分隔符,只有log_type为delimiter_log时有效
|
|
904
904
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
905
|
-
|
|
905
|
+
*/
|
|
906
906
|
Delimiter?: string;
|
|
907
907
|
/**
|
|
908
|
-
|
|
908
|
+
* 整条日志匹配规则,只有log_type为fullregex_log时有效
|
|
909
909
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
910
|
-
|
|
910
|
+
*/
|
|
911
911
|
LogRegex?: string;
|
|
912
912
|
/**
|
|
913
|
-
|
|
913
|
+
* 行首匹配规则,只有log_type为multiline_log或fullregex_log时有效
|
|
914
914
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
915
|
-
|
|
915
|
+
*/
|
|
916
916
|
BeginRegex?: string;
|
|
917
917
|
/**
|
|
918
|
-
|
|
918
|
+
* 取的每个字段的key名字,为空的key代表丢弃这个字段,只有log_type为delimiter_log时有效,json_log的日志使用json本身的key
|
|
919
919
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
920
|
-
|
|
920
|
+
*/
|
|
921
921
|
Keys?: Array<string>;
|
|
922
922
|
/**
|
|
923
|
-
|
|
923
|
+
* 需要过滤日志的key,及其对应的regex
|
|
924
924
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
925
|
-
|
|
925
|
+
*/
|
|
926
926
|
FilterKeyRegex?: Array<KeyRegexInfo>;
|
|
927
927
|
/**
|
|
928
|
-
|
|
928
|
+
* 解析失败日志是否上传,true表示上传,false表示不上传
|
|
929
929
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
930
|
-
|
|
930
|
+
*/
|
|
931
931
|
UnMatchUpLoadSwitch?: boolean;
|
|
932
932
|
/**
|
|
933
|
-
|
|
933
|
+
* 失败日志的key
|
|
934
934
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
935
|
-
|
|
935
|
+
*/
|
|
936
936
|
UnMatchLogKey?: string;
|
|
937
937
|
/**
|
|
938
|
-
|
|
938
|
+
* 增量采集模式下的回溯数据量,默认-1(全量采集)
|
|
939
939
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
940
|
-
|
|
940
|
+
*/
|
|
941
941
|
Backtracking?: number;
|
|
942
942
|
/**
|
|
943
|
-
|
|
943
|
+
* 是否为Gbk编码. 0: 否, 1: 是
|
|
944
944
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
945
|
-
|
|
945
|
+
*/
|
|
946
946
|
IsGBK?: number;
|
|
947
947
|
/**
|
|
948
|
-
|
|
948
|
+
* 是否为标准json. 0: 否, 1: 是
|
|
949
949
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
950
|
-
|
|
950
|
+
*/
|
|
951
951
|
JsonStandard?: number;
|
|
952
952
|
/**
|
|
953
|
-
|
|
953
|
+
* syslog传输协议,取值为tcp或者udp。
|
|
954
954
|
该字段适用于:创建采集规则配置、修改采集规则配置
|
|
955
955
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
956
|
-
|
|
956
|
+
*/
|
|
957
957
|
Protocol?: string;
|
|
958
958
|
/**
|
|
959
|
-
|
|
959
|
+
* syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port]。举例:127.0.0.1:9000
|
|
960
960
|
该字段适用于:创建采集规则配置、修改采集规则配置
|
|
961
961
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
962
|
-
|
|
962
|
+
*/
|
|
963
963
|
Address?: string;
|
|
964
964
|
/**
|
|
965
|
-
|
|
965
|
+
* rfc3164:指定系统日志采集使用RFC3164协议解析日志。
|
|
966
966
|
rfc5424:指定系统日志采集使用RFC5424协议解析日志。
|
|
967
967
|
auto:自动匹配rfc3164或者rfc5424其中一种协议
|
|
968
968
|
该字段适用于:创建采集规则配置、修改采集规则配置
|
|
969
969
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
970
|
-
|
|
970
|
+
*/
|
|
971
971
|
ParseProtocol?: string;
|
|
972
972
|
/**
|
|
973
973
|
* 元数据类型,0: 不使用元数据信息,1:使用机器组元数据,2:使用用户自定义元数据,3:使用采集配置路径,
|
|
974
974
|
*/
|
|
975
975
|
MetadataType?: number;
|
|
976
976
|
/**
|
|
977
|
-
|
|
977
|
+
* 采集配置路径正则表达式,MetadataType为1时必填
|
|
978
978
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
979
|
-
|
|
979
|
+
*/
|
|
980
980
|
PathRegex?: string;
|
|
981
981
|
/**
|
|
982
982
|
* 用户自定义元数据信息,MetadataType为2时必填
|
|
@@ -1008,9 +1008,9 @@ export interface TopicInfo {
|
|
|
1008
1008
|
*/
|
|
1009
1009
|
Index: boolean;
|
|
1010
1010
|
/**
|
|
1011
|
-
|
|
1011
|
+
* 云产品标识,日志主题由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
|
|
1012
1012
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1013
|
-
|
|
1013
|
+
*/
|
|
1014
1014
|
AssumerName: string;
|
|
1015
1015
|
/**
|
|
1016
1016
|
* 创建时间
|
|
@@ -1021,45 +1021,45 @@ export interface TopicInfo {
|
|
|
1021
1021
|
*/
|
|
1022
1022
|
Status: boolean;
|
|
1023
1023
|
/**
|
|
1024
|
-
|
|
1024
|
+
* 日志主题绑定的标签信息
|
|
1025
1025
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1026
|
-
|
|
1026
|
+
*/
|
|
1027
1027
|
Tags: Array<Tag>;
|
|
1028
1028
|
/**
|
|
1029
|
-
|
|
1029
|
+
* 该主题是否开启自动分裂
|
|
1030
1030
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1031
|
-
|
|
1031
|
+
*/
|
|
1032
1032
|
AutoSplit: boolean;
|
|
1033
1033
|
/**
|
|
1034
|
-
|
|
1034
|
+
* 若开启自动分裂的话,该主题能够允许的最大分区数
|
|
1035
1035
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1036
|
-
|
|
1036
|
+
*/
|
|
1037
1037
|
MaxSplitPartitions: number;
|
|
1038
1038
|
/**
|
|
1039
|
-
|
|
1039
|
+
* 日主题的存储类型
|
|
1040
1040
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1041
|
-
|
|
1041
|
+
*/
|
|
1042
1042
|
StorageType: string;
|
|
1043
1043
|
/**
|
|
1044
|
-
|
|
1044
|
+
* 生命周期,单位天,可取值范围1~3600。取值为3640时代表永久保存
|
|
1045
1045
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1046
|
-
|
|
1046
|
+
*/
|
|
1047
1047
|
Period: number;
|
|
1048
1048
|
/**
|
|
1049
|
-
|
|
1049
|
+
* 云产品二级标识,日志主题由其它云产品创建时,该字段会显示云产品名称及其日志类型的二级分类,例如TKE-Audit、TKE-Event。部分云产品仅有云产品标识(AssumerName),无该字段。
|
|
1050
1050
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1051
|
-
|
|
1051
|
+
*/
|
|
1052
1052
|
SubAssumerName: string;
|
|
1053
1053
|
/**
|
|
1054
|
-
|
|
1054
|
+
* 日志主题描述
|
|
1055
1055
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1056
|
-
|
|
1056
|
+
*/
|
|
1057
1057
|
Describes: string;
|
|
1058
1058
|
/**
|
|
1059
|
-
|
|
1059
|
+
* 开启日志沉降,热存储的生命周期, hotPeriod < Period。
|
|
1060
1060
|
热存储为 hotPeriod, 冷存储则为 Period-hotPeriod。
|
|
1061
1061
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1062
|
-
|
|
1062
|
+
*/
|
|
1063
1063
|
HotPeriod: number;
|
|
1064
1064
|
}
|
|
1065
1065
|
/**
|
|
@@ -1150,24 +1150,24 @@ export interface ModifyMachineGroupResponse {
|
|
|
1150
1150
|
*/
|
|
1151
1151
|
export interface RuleInfo {
|
|
1152
1152
|
/**
|
|
1153
|
-
|
|
1153
|
+
* 全文索引配置, 如果为空时代表未开启全文索引
|
|
1154
1154
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1155
|
-
|
|
1155
|
+
*/
|
|
1156
1156
|
FullText?: FullTextInfo;
|
|
1157
1157
|
/**
|
|
1158
|
-
|
|
1158
|
+
* 键值索引配置,如果为空时代表未开启键值索引
|
|
1159
1159
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1160
|
-
|
|
1160
|
+
*/
|
|
1161
1161
|
KeyValue?: RuleKeyValueInfo;
|
|
1162
1162
|
/**
|
|
1163
|
-
|
|
1163
|
+
* 元字段索引配置,如果为空时代表未开启元字段索引
|
|
1164
1164
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1165
|
-
|
|
1165
|
+
*/
|
|
1166
1166
|
Tag?: RuleTagInfo;
|
|
1167
1167
|
/**
|
|
1168
|
-
|
|
1168
|
+
* 动态索引配置,如果为空时代表未开启动态段索引
|
|
1169
1169
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1170
|
-
|
|
1170
|
+
*/
|
|
1171
1171
|
DynamicIndex?: DynamicIndex;
|
|
1172
1172
|
}
|
|
1173
1173
|
/**
|
|
@@ -1188,15 +1188,15 @@ export interface FullTextInfo {
|
|
|
1188
1188
|
*/
|
|
1189
1189
|
CaseSensitive: boolean;
|
|
1190
1190
|
/**
|
|
1191
|
-
|
|
1191
|
+
* 全文索引的分词符,其中的每个字符代表一个分词符;
|
|
1192
1192
|
仅支持英文符号、\n\t\r及转义符\;
|
|
1193
1193
|
注意:\n\t\r本身已被转义,直接使用双引号包裹即可作为入参,无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式,以避免\n\t\r被重复转义
|
|
1194
|
-
|
|
1194
|
+
*/
|
|
1195
1195
|
Tokenizer: string;
|
|
1196
1196
|
/**
|
|
1197
|
-
|
|
1197
|
+
* 是否包含中文
|
|
1198
1198
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1199
|
-
|
|
1199
|
+
*/
|
|
1200
1200
|
ContainZH?: boolean;
|
|
1201
1201
|
}
|
|
1202
1202
|
/**
|
|
@@ -1217,9 +1217,9 @@ export interface DescribePartitionsResponse {
|
|
|
1217
1217
|
*/
|
|
1218
1218
|
export interface DescribeConfigMachineGroupsResponse {
|
|
1219
1219
|
/**
|
|
1220
|
-
|
|
1220
|
+
* 采集规则配置绑定的机器组列表
|
|
1221
1221
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1222
|
-
|
|
1222
|
+
*/
|
|
1223
1223
|
MachineGroups: Array<MachineGroupInfo>;
|
|
1224
1224
|
/**
|
|
1225
1225
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1318,11 +1318,11 @@ export interface ModifyAlarmNoticeRequest {
|
|
|
1318
1318
|
*/
|
|
1319
1319
|
Name?: string;
|
|
1320
1320
|
/**
|
|
1321
|
-
|
|
1321
|
+
* 通知类型。可选值:
|
|
1322
1322
|
<li> Trigger - 告警触发
|
|
1323
1323
|
<li> Recovery - 告警恢复
|
|
1324
1324
|
<li> All - 告警触发和告警恢复
|
|
1325
|
-
|
|
1325
|
+
*/
|
|
1326
1326
|
Type?: string;
|
|
1327
1327
|
/**
|
|
1328
1328
|
* 通知接收对象。
|
|
@@ -1429,9 +1429,9 @@ export interface PartitionInfo {
|
|
|
1429
1429
|
*/
|
|
1430
1430
|
CreateTime: string;
|
|
1431
1431
|
/**
|
|
1432
|
-
|
|
1432
|
+
* 只读分区数据停止写入时间
|
|
1433
1433
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1434
|
-
|
|
1434
|
+
*/
|
|
1435
1435
|
LastWriteTime: string;
|
|
1436
1436
|
}
|
|
1437
1437
|
/**
|
|
@@ -1491,20 +1491,20 @@ export interface AlertHistoryRecord {
|
|
|
1491
1491
|
*/
|
|
1492
1492
|
CreateTime: number;
|
|
1493
1493
|
/**
|
|
1494
|
-
|
|
1494
|
+
* 告警分组触发时对应的分组信息
|
|
1495
1495
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1496
|
-
|
|
1496
|
+
*/
|
|
1497
1497
|
GroupTriggerCondition?: Array<GroupTriggerConditionInfo>;
|
|
1498
1498
|
/**
|
|
1499
|
-
|
|
1499
|
+
* 告警级别,0代表警告(Warn),1代表提醒(Info),2代表紧急 (Critical)
|
|
1500
1500
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1501
|
-
|
|
1501
|
+
*/
|
|
1502
1502
|
AlarmLevel?: number;
|
|
1503
1503
|
/**
|
|
1504
|
-
|
|
1504
|
+
* 监控对象类型。
|
|
1505
1505
|
0:执行语句共用监控对象; 1:每个执行语句单独选择监控对象。
|
|
1506
1506
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1507
|
-
|
|
1507
|
+
*/
|
|
1508
1508
|
MonitorObjectType?: number;
|
|
1509
1509
|
}
|
|
1510
1510
|
/**
|
|
@@ -1558,39 +1558,39 @@ export interface ConfigExtraInfo {
|
|
|
1558
1558
|
*/
|
|
1559
1559
|
Type: string;
|
|
1560
1560
|
/**
|
|
1561
|
-
|
|
1561
|
+
* 节点文件配置信息
|
|
1562
1562
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1563
|
-
|
|
1563
|
+
*/
|
|
1564
1564
|
HostFile: HostFileInfo;
|
|
1565
1565
|
/**
|
|
1566
|
-
|
|
1566
|
+
* 容器文件路径信息
|
|
1567
1567
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1568
|
-
|
|
1568
|
+
*/
|
|
1569
1569
|
ContainerFile: ContainerFileInfo;
|
|
1570
1570
|
/**
|
|
1571
|
-
|
|
1571
|
+
* 容器标准输出信息
|
|
1572
1572
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1573
|
-
|
|
1573
|
+
*/
|
|
1574
1574
|
ContainerStdout: ContainerStdoutInfo;
|
|
1575
1575
|
/**
|
|
1576
|
-
|
|
1576
|
+
* 日志格式化方式
|
|
1577
1577
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1578
|
-
|
|
1578
|
+
*/
|
|
1579
1579
|
LogFormat: string;
|
|
1580
1580
|
/**
|
|
1581
|
-
|
|
1581
|
+
* 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
|
|
1582
1582
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1583
|
-
|
|
1583
|
+
*/
|
|
1584
1584
|
LogType: string;
|
|
1585
1585
|
/**
|
|
1586
|
-
|
|
1586
|
+
* 提取规则,如果设置了ExtractRule,则必须设置LogType
|
|
1587
1587
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1588
|
-
|
|
1588
|
+
*/
|
|
1589
1589
|
ExtractRule: ExtractRuleInfo;
|
|
1590
1590
|
/**
|
|
1591
|
-
|
|
1591
|
+
* 采集黑名单路径列表
|
|
1592
1592
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1593
|
-
|
|
1593
|
+
*/
|
|
1594
1594
|
ExcludePaths: Array<ExcludePathInfo>;
|
|
1595
1595
|
/**
|
|
1596
1596
|
* 更新时间
|
|
@@ -1601,33 +1601,33 @@ export interface ConfigExtraInfo {
|
|
|
1601
1601
|
*/
|
|
1602
1602
|
CreateTime: string;
|
|
1603
1603
|
/**
|
|
1604
|
-
|
|
1604
|
+
* 用户自定义解析字符串
|
|
1605
1605
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1606
|
-
|
|
1606
|
+
*/
|
|
1607
1607
|
UserDefineRule: string;
|
|
1608
1608
|
/**
|
|
1609
1609
|
* 机器组ID
|
|
1610
1610
|
*/
|
|
1611
1611
|
GroupId: string;
|
|
1612
1612
|
/**
|
|
1613
|
-
|
|
1613
|
+
* 自建采集配置标
|
|
1614
1614
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1615
|
-
|
|
1615
|
+
*/
|
|
1616
1616
|
ConfigFlag: string;
|
|
1617
1617
|
/**
|
|
1618
|
-
|
|
1618
|
+
* 日志集ID
|
|
1619
1619
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1620
|
-
|
|
1620
|
+
*/
|
|
1621
1621
|
LogsetId: string;
|
|
1622
1622
|
/**
|
|
1623
|
-
|
|
1623
|
+
* 日志集name
|
|
1624
1624
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1625
|
-
|
|
1625
|
+
*/
|
|
1626
1626
|
LogsetName: string;
|
|
1627
1627
|
/**
|
|
1628
|
-
|
|
1628
|
+
* 日志主题name
|
|
1629
1629
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1630
|
-
|
|
1630
|
+
*/
|
|
1631
1631
|
TopicName: string;
|
|
1632
1632
|
}
|
|
1633
1633
|
/**
|
|
@@ -1665,9 +1665,9 @@ export interface SplitPartitionRequest {
|
|
|
1665
1665
|
*/
|
|
1666
1666
|
export interface DescribeMachineGroupConfigsResponse {
|
|
1667
1667
|
/**
|
|
1668
|
-
|
|
1668
|
+
* 采集规则配置列表
|
|
1669
1669
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1670
|
-
|
|
1670
|
+
*/
|
|
1671
1671
|
Configs: Array<ConfigInfo>;
|
|
1672
1672
|
/**
|
|
1673
1673
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1712,29 +1712,29 @@ export interface MachineGroupInfo {
|
|
|
1712
1712
|
*/
|
|
1713
1713
|
CreateTime: string;
|
|
1714
1714
|
/**
|
|
1715
|
-
|
|
1715
|
+
* 机器组绑定的标签列表
|
|
1716
1716
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1717
|
-
|
|
1717
|
+
*/
|
|
1718
1718
|
Tags: Array<Tag>;
|
|
1719
1719
|
/**
|
|
1720
|
-
|
|
1720
|
+
* 是否开启机器组自动更新
|
|
1721
1721
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1722
|
-
|
|
1722
|
+
*/
|
|
1723
1723
|
AutoUpdate: string;
|
|
1724
1724
|
/**
|
|
1725
|
-
|
|
1725
|
+
* 升级开始时间,建议业务低峰期升级LogListener
|
|
1726
1726
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1727
|
-
|
|
1727
|
+
*/
|
|
1728
1728
|
UpdateStartTime: string;
|
|
1729
1729
|
/**
|
|
1730
|
-
|
|
1730
|
+
* 升级结束时间,建议业务低峰期升级LogListener
|
|
1731
1731
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1732
|
-
|
|
1732
|
+
*/
|
|
1733
1733
|
UpdateEndTime: string;
|
|
1734
1734
|
/**
|
|
1735
|
-
|
|
1735
|
+
* 是否开启服务日志,用于记录因Loglistener 服务自身产生的log,开启后,会创建内部日志集cls_service_logging和日志主题loglistener_status,loglistener_alarm,loglistener_business,不产生计费
|
|
1736
1736
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1737
|
-
|
|
1737
|
+
*/
|
|
1738
1738
|
ServiceLogging: boolean;
|
|
1739
1739
|
/**
|
|
1740
1740
|
* 机器组元数据信息列表
|
|
@@ -1776,7 +1776,7 @@ export interface CloseKafkaConsumerResponse {
|
|
|
1776
1776
|
*/
|
|
1777
1777
|
export interface DescribeMachineGroupsRequest {
|
|
1778
1778
|
/**
|
|
1779
|
-
|
|
1779
|
+
* machineGroupName
|
|
1780
1780
|
- 按照【机器组名称】进行过滤。
|
|
1781
1781
|
- 类型:String
|
|
1782
1782
|
- 必选:否
|
|
@@ -1797,7 +1797,7 @@ export interface DescribeMachineGroupsRequest {
|
|
|
1797
1797
|
- 必选:否
|
|
1798
1798
|
|
|
1799
1799
|
每次请求的Filters的上限为10,Filter.Values的上限为5。
|
|
1800
|
-
|
|
1800
|
+
*/
|
|
1801
1801
|
Filters?: Array<Filter>;
|
|
1802
1802
|
/**
|
|
1803
1803
|
* 分页的偏移量,默认值为0
|
|
@@ -1898,29 +1898,29 @@ export interface GetAlarmLogResponse {
|
|
|
1898
1898
|
*/
|
|
1899
1899
|
Analysis?: boolean;
|
|
1900
1900
|
/**
|
|
1901
|
-
|
|
1901
|
+
* 如果Analysis为True,则返回分析结果的列名,否则为空
|
|
1902
1902
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1903
|
-
|
|
1903
|
+
*/
|
|
1904
1904
|
ColNames?: Array<string>;
|
|
1905
1905
|
/**
|
|
1906
|
-
|
|
1906
|
+
* 日志查询结果;当Analysis为True时,可能返回为null
|
|
1907
1907
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1908
|
-
|
|
1908
|
+
*/
|
|
1909
1909
|
Results?: Array<LogInfo>;
|
|
1910
1910
|
/**
|
|
1911
|
-
|
|
1911
|
+
* 日志分析结果;当Analysis为False时,可能返回为null
|
|
1912
1912
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1913
|
-
|
|
1913
|
+
*/
|
|
1914
1914
|
AnalysisResults?: Array<LogItems>;
|
|
1915
1915
|
/**
|
|
1916
|
-
|
|
1916
|
+
* 新的日志分析结果; UseNewAnalysis为true有效
|
|
1917
1917
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1918
|
-
|
|
1918
|
+
*/
|
|
1919
1919
|
AnalysisRecords?: Array<string>;
|
|
1920
1920
|
/**
|
|
1921
|
-
|
|
1921
|
+
* 日志分析的列属性; UseNewAnalysis为true有效
|
|
1922
1922
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1923
|
-
|
|
1923
|
+
*/
|
|
1924
1924
|
Columns?: Array<Column>;
|
|
1925
1925
|
/**
|
|
1926
1926
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -1968,9 +1968,9 @@ export interface CreateTopicRequest {
|
|
|
1968
1968
|
*/
|
|
1969
1969
|
Describes?: string;
|
|
1970
1970
|
/**
|
|
1971
|
-
|
|
1971
|
+
* 0:关闭日志沉降。
|
|
1972
1972
|
非0:开启日志沉降后标准存储的天数。HotPeriod需要大于等于7,且小于Period。仅在StorageType为 hot 时生效
|
|
1973
|
-
|
|
1973
|
+
*/
|
|
1974
1974
|
HotPeriod?: number;
|
|
1975
1975
|
/**
|
|
1976
1976
|
* webtracking开关; false: 关闭 true: 开启
|
|
@@ -2023,10 +2023,10 @@ export interface AlarmTarget {
|
|
|
2023
2023
|
*/
|
|
2024
2024
|
LogsetId: string;
|
|
2025
2025
|
/**
|
|
2026
|
-
|
|
2026
|
+
* 检索语法规则,默认值为0。
|
|
2027
2027
|
0:Lucene语法,1:CQL语法。
|
|
2028
2028
|
详细说明参见<a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules" target="_blank">检索条件语法规则</a>
|
|
2029
|
-
|
|
2029
|
+
*/
|
|
2030
2030
|
SyntaxRule?: number;
|
|
2031
2031
|
}
|
|
2032
2032
|
/**
|
|
@@ -2091,18 +2091,18 @@ export interface DescribeConsumerResponse {
|
|
|
2091
2091
|
*/
|
|
2092
2092
|
NeedContent: boolean;
|
|
2093
2093
|
/**
|
|
2094
|
-
|
|
2094
|
+
* 如果需要投递元数据信息,元数据信息的描述
|
|
2095
2095
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2096
|
-
|
|
2096
|
+
*/
|
|
2097
2097
|
Content: ConsumerContent;
|
|
2098
2098
|
/**
|
|
2099
2099
|
* CKafka的描述
|
|
2100
2100
|
*/
|
|
2101
2101
|
Ckafka: Ckafka;
|
|
2102
2102
|
/**
|
|
2103
|
-
|
|
2103
|
+
* 压缩方式[0:NONE;2:SNAPPY;3:LZ4]
|
|
2104
2104
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2105
|
-
|
|
2105
|
+
*/
|
|
2106
2106
|
Compression: number;
|
|
2107
2107
|
/**
|
|
2108
2108
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2156,13 +2156,13 @@ export interface DescribeAlertRecordHistoryRequest {
|
|
|
2156
2156
|
*/
|
|
2157
2157
|
Limit: number;
|
|
2158
2158
|
/**
|
|
2159
|
-
|
|
2159
|
+
* - alertId:按照告警策略ID进行过滤。类型:String 必选:否
|
|
2160
2160
|
- topicId:按照监控对象ID进行过滤。类型:String 必选:否
|
|
2161
2161
|
- status:按照告警状态进行过滤。类型:String 必选:否,0代表未恢复,1代表已恢复,2代表已失效
|
|
2162
2162
|
- alarmLevel:按照告警等级进行过滤。类型:String 必选:否,0代表警告,1代表提醒,2代表紧急
|
|
2163
2163
|
|
|
2164
2164
|
每次请求的Filters的上限为10,Filter.Values的上限为100。
|
|
2165
|
-
|
|
2165
|
+
*/
|
|
2166
2166
|
Filters?: Array<Filter>;
|
|
2167
2167
|
}
|
|
2168
2168
|
/**
|
|
@@ -2170,7 +2170,7 @@ export interface DescribeAlertRecordHistoryRequest {
|
|
|
2170
2170
|
*/
|
|
2171
2171
|
export interface DescribeConfigsRequest {
|
|
2172
2172
|
/**
|
|
2173
|
-
|
|
2173
|
+
* configName
|
|
2174
2174
|
- 按照【采集配置名称】进行模糊匹配过滤。
|
|
2175
2175
|
- 类型:String
|
|
2176
2176
|
- 必选:否
|
|
@@ -2186,7 +2186,7 @@ export interface DescribeConfigsRequest {
|
|
|
2186
2186
|
- 必选:否
|
|
2187
2187
|
|
|
2188
2188
|
每次请求的Filters的上限为10,Filter.Values的上限为5。
|
|
2189
|
-
|
|
2189
|
+
*/
|
|
2190
2190
|
Filters?: Array<Filter>;
|
|
2191
2191
|
/**
|
|
2192
2192
|
* 分页的偏移量,默认值为0
|
|
@@ -2214,14 +2214,14 @@ export interface LogsetInfo {
|
|
|
2214
2214
|
*/
|
|
2215
2215
|
CreateTime: string;
|
|
2216
2216
|
/**
|
|
2217
|
-
|
|
2217
|
+
* 云产品标识,日志集由其它云产品创建时,该字段会显示云产品名称,例如CDN、TKE
|
|
2218
2218
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2219
|
-
|
|
2219
|
+
*/
|
|
2220
2220
|
AssumerName: string;
|
|
2221
2221
|
/**
|
|
2222
|
-
|
|
2222
|
+
* 日志集绑定的标签
|
|
2223
2223
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2224
|
-
|
|
2224
|
+
*/
|
|
2225
2225
|
Tags: Array<Tag>;
|
|
2226
2226
|
/**
|
|
2227
2227
|
* 日志集下日志主题的数目
|
|
@@ -2246,24 +2246,24 @@ export interface DeleteConfigRequest {
|
|
|
2246
2246
|
*/
|
|
2247
2247
|
export interface AnalysisDimensional {
|
|
2248
2248
|
/**
|
|
2249
|
-
|
|
2249
|
+
* 分析名称
|
|
2250
2250
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2251
|
-
|
|
2251
|
+
*/
|
|
2252
2252
|
Name: string;
|
|
2253
2253
|
/**
|
|
2254
|
-
|
|
2254
|
+
* 分析类型:query,field ,original
|
|
2255
2255
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2256
|
-
|
|
2256
|
+
*/
|
|
2257
2257
|
Type: string;
|
|
2258
2258
|
/**
|
|
2259
|
-
|
|
2259
|
+
* 分析内容
|
|
2260
2260
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2261
|
-
|
|
2261
|
+
*/
|
|
2262
2262
|
Content: string;
|
|
2263
2263
|
/**
|
|
2264
|
-
|
|
2264
|
+
* 配置
|
|
2265
2265
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2266
|
-
|
|
2266
|
+
*/
|
|
2267
2267
|
ConfigInfo?: Array<AlarmAnalysisConfig>;
|
|
2268
2268
|
}
|
|
2269
2269
|
/**
|
|
@@ -2367,9 +2367,9 @@ export interface CreateExportRequest {
|
|
|
2367
2367
|
*/
|
|
2368
2368
|
export interface DescribeAlarmNoticesResponse {
|
|
2369
2369
|
/**
|
|
2370
|
-
|
|
2370
|
+
* 告警通知模板列表。
|
|
2371
2371
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2372
|
-
|
|
2372
|
+
*/
|
|
2373
2373
|
AlarmNotices: Array<AlarmNotice>;
|
|
2374
2374
|
/**
|
|
2375
2375
|
* 符合条件的告警通知模板总数。
|
|
@@ -2385,9 +2385,9 @@ export interface DescribeAlarmNoticesResponse {
|
|
|
2385
2385
|
*/
|
|
2386
2386
|
export interface DescribeMachineGroupsResponse {
|
|
2387
2387
|
/**
|
|
2388
|
-
|
|
2388
|
+
* 机器组信息列表
|
|
2389
2389
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2390
|
-
|
|
2390
|
+
*/
|
|
2391
2391
|
MachineGroups?: Array<MachineGroupInfo>;
|
|
2392
2392
|
/**
|
|
2393
2393
|
* 分页的总数目
|
|
@@ -2453,9 +2453,9 @@ export interface AddMachineGroupInfoRequest {
|
|
|
2453
2453
|
*/
|
|
2454
2454
|
GroupId: string;
|
|
2455
2455
|
/**
|
|
2456
|
-
|
|
2456
|
+
* 机器组类型
|
|
2457
2457
|
目前type支持 ip 和 label
|
|
2458
|
-
|
|
2458
|
+
*/
|
|
2459
2459
|
MachineGroupType: MachineGroupTypeInfo;
|
|
2460
2460
|
}
|
|
2461
2461
|
/**
|
|
@@ -2467,14 +2467,14 @@ export interface JsonInfo {
|
|
|
2467
2467
|
*/
|
|
2468
2468
|
EnableTag: boolean;
|
|
2469
2469
|
/**
|
|
2470
|
-
|
|
2470
|
+
* 元数据信息列表, 可选值为 __SOURCE__、__FILENAME__、__TIMESTAMP__、__HOSTNAME__。
|
|
2471
2471
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2472
|
-
|
|
2472
|
+
*/
|
|
2473
2473
|
MetaFields: Array<string>;
|
|
2474
2474
|
/**
|
|
2475
|
-
|
|
2475
|
+
* 投递Json格式,0:字符串方式投递;1:以结构化方式投递
|
|
2476
2476
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2477
|
-
|
|
2477
|
+
*/
|
|
2478
2478
|
JsonType?: number;
|
|
2479
2479
|
}
|
|
2480
2480
|
/**
|
|
@@ -2565,30 +2565,30 @@ export interface WebCallback {
|
|
|
2565
2565
|
*/
|
|
2566
2566
|
Url: string;
|
|
2567
2567
|
/**
|
|
2568
|
-
|
|
2568
|
+
* 回调的类型。可选值:
|
|
2569
2569
|
<li> WeCom
|
|
2570
2570
|
<li> Http
|
|
2571
|
-
|
|
2571
|
+
*/
|
|
2572
2572
|
CallbackType: string;
|
|
2573
2573
|
/**
|
|
2574
|
-
|
|
2574
|
+
* 回调方法。可选值:
|
|
2575
2575
|
<li> POST
|
|
2576
2576
|
<li> PUT
|
|
2577
2577
|
默认值为POST。CallbackType为Http时为必选。
|
|
2578
2578
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2579
|
-
|
|
2579
|
+
*/
|
|
2580
2580
|
Method?: string;
|
|
2581
2581
|
/**
|
|
2582
|
-
|
|
2582
|
+
* 请求头。
|
|
2583
2583
|
注意:该参数已废弃,请在<a href="https://cloud.tencent.com/document/product/614/56466">创建告警策略</a>接口CallBack参数中指定请求头。
|
|
2584
2584
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2585
|
-
|
|
2585
|
+
*/
|
|
2586
2586
|
Headers?: Array<string>;
|
|
2587
2587
|
/**
|
|
2588
|
-
|
|
2588
|
+
* 请求内容。
|
|
2589
2589
|
注意:该参数已废弃,请在<a href="https://cloud.tencent.com/document/product/614/56466">创建告警策略</a>接口CallBack参数中指定请求内容。
|
|
2590
2590
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2591
|
-
|
|
2591
|
+
*/
|
|
2592
2592
|
Body?: string;
|
|
2593
2593
|
/**
|
|
2594
2594
|
* 序号
|
|
@@ -2666,6 +2666,10 @@ export interface CreateConfigRequest {
|
|
|
2666
2666
|
* 用户自定义采集规则,Json格式序列化的字符串
|
|
2667
2667
|
*/
|
|
2668
2668
|
UserDefineRule?: string;
|
|
2669
|
+
/**
|
|
2670
|
+
* 高级采集配置
|
|
2671
|
+
*/
|
|
2672
|
+
AdvancedConfig?: string;
|
|
2669
2673
|
}
|
|
2670
2674
|
/**
|
|
2671
2675
|
* CreateShipper返回参数结构体
|
|
@@ -2754,19 +2758,19 @@ export interface ContentInfo {
|
|
|
2754
2758
|
*/
|
|
2755
2759
|
Format: string;
|
|
2756
2760
|
/**
|
|
2757
|
-
|
|
2761
|
+
* csv格式内容描述
|
|
2758
2762
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2759
|
-
|
|
2763
|
+
*/
|
|
2760
2764
|
Csv?: CsvInfo;
|
|
2761
2765
|
/**
|
|
2762
|
-
|
|
2766
|
+
* json格式内容描述
|
|
2763
2767
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2764
|
-
|
|
2768
|
+
*/
|
|
2765
2769
|
Json?: JsonInfo;
|
|
2766
2770
|
/**
|
|
2767
|
-
|
|
2771
|
+
* parquet格式内容描述
|
|
2768
2772
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2769
|
-
|
|
2773
|
+
*/
|
|
2770
2774
|
Parquet?: ParquetInfo;
|
|
2771
2775
|
}
|
|
2772
2776
|
/**
|
|
@@ -2778,20 +2782,20 @@ export interface ValueInfo {
|
|
|
2778
2782
|
*/
|
|
2779
2783
|
Type: string;
|
|
2780
2784
|
/**
|
|
2781
|
-
|
|
2785
|
+
* 字段的分词符,其中的每个字符代表一个分词符;
|
|
2782
2786
|
仅支持英文符号、\n\t\r及转义符\;
|
|
2783
2787
|
long及double类型字段需为空;
|
|
2784
2788
|
注意:\n\t\r本身已被转义,直接使用双引号包裹即可作为入参,无需再次转义。使用API Explorer进行调试时请使用JSON参数输入方式,以避免\n\t\r被重复转义
|
|
2785
|
-
|
|
2789
|
+
*/
|
|
2786
2790
|
Tokenizer?: string;
|
|
2787
2791
|
/**
|
|
2788
2792
|
* 字段是否开启分析功能
|
|
2789
2793
|
*/
|
|
2790
2794
|
SqlFlag?: boolean;
|
|
2791
2795
|
/**
|
|
2792
|
-
|
|
2796
|
+
* 是否包含中文,long及double类型字段需为false
|
|
2793
2797
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2794
|
-
|
|
2798
|
+
*/
|
|
2795
2799
|
ContainZH?: boolean;
|
|
2796
2800
|
}
|
|
2797
2801
|
/**
|
|
@@ -2936,52 +2940,52 @@ export interface ConfigInfo {
|
|
|
2936
2940
|
*/
|
|
2937
2941
|
ConfigId: string;
|
|
2938
2942
|
/**
|
|
2939
|
-
|
|
2943
|
+
* 采集规则配置名称
|
|
2940
2944
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2941
|
-
|
|
2945
|
+
*/
|
|
2942
2946
|
Name: string;
|
|
2943
2947
|
/**
|
|
2944
|
-
|
|
2948
|
+
* 日志格式化方式
|
|
2945
2949
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2946
|
-
|
|
2950
|
+
*/
|
|
2947
2951
|
LogFormat: string;
|
|
2948
2952
|
/**
|
|
2949
|
-
|
|
2953
|
+
* 日志采集路径
|
|
2950
2954
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2951
|
-
|
|
2955
|
+
*/
|
|
2952
2956
|
Path: string;
|
|
2953
2957
|
/**
|
|
2954
|
-
|
|
2958
|
+
* 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表极简日志,multiline_log代表多行日志,fullregex_log代表完整正则,默认为minimalist_log
|
|
2955
2959
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2956
|
-
|
|
2960
|
+
*/
|
|
2957
2961
|
LogType: string;
|
|
2958
2962
|
/**
|
|
2959
|
-
|
|
2963
|
+
* 提取规则,如果设置了ExtractRule,则必须设置LogType
|
|
2960
2964
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2961
|
-
|
|
2965
|
+
*/
|
|
2962
2966
|
ExtractRule: ExtractRuleInfo;
|
|
2963
2967
|
/**
|
|
2964
|
-
|
|
2968
|
+
* 采集黑名单路径列表
|
|
2965
2969
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2966
|
-
|
|
2970
|
+
*/
|
|
2967
2971
|
ExcludePaths: Array<ExcludePathInfo>;
|
|
2968
2972
|
/**
|
|
2969
2973
|
* 采集配置所属日志主题ID即TopicId
|
|
2970
2974
|
*/
|
|
2971
2975
|
Output: string;
|
|
2972
2976
|
/**
|
|
2973
|
-
|
|
2977
|
+
* 更新时间
|
|
2974
2978
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2975
|
-
|
|
2979
|
+
*/
|
|
2976
2980
|
UpdateTime: string;
|
|
2977
2981
|
/**
|
|
2978
2982
|
* 创建时间
|
|
2979
2983
|
*/
|
|
2980
2984
|
CreateTime: string;
|
|
2981
2985
|
/**
|
|
2982
|
-
|
|
2986
|
+
* 用户自定义解析字符串
|
|
2983
2987
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2984
|
-
|
|
2988
|
+
*/
|
|
2985
2989
|
UserDefineRule: string;
|
|
2986
2990
|
}
|
|
2987
2991
|
/**
|
|
@@ -3035,19 +3039,19 @@ export interface LogContextInfo {
|
|
|
3035
3039
|
*/
|
|
3036
3040
|
BTime: number;
|
|
3037
3041
|
/**
|
|
3038
|
-
|
|
3042
|
+
* 日志来源主机名称
|
|
3039
3043
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3040
|
-
|
|
3044
|
+
*/
|
|
3041
3045
|
HostName: string;
|
|
3042
3046
|
/**
|
|
3043
|
-
|
|
3047
|
+
* 原始日志(仅在日志创建索引异常时有值)
|
|
3044
3048
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3045
|
-
|
|
3049
|
+
*/
|
|
3046
3050
|
RawLog?: string;
|
|
3047
3051
|
/**
|
|
3048
|
-
|
|
3052
|
+
* 日志创建索引异常原因(仅在日志创建索引异常时有值)
|
|
3049
3053
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3050
|
-
|
|
3054
|
+
*/
|
|
3051
3055
|
IndexStatus?: string;
|
|
3052
3056
|
}
|
|
3053
3057
|
/**
|
|
@@ -3210,36 +3214,36 @@ export interface AlarmNotice {
|
|
|
3210
3214
|
*/
|
|
3211
3215
|
Name: string;
|
|
3212
3216
|
/**
|
|
3213
|
-
|
|
3217
|
+
* 告警模板的类型。可选值:
|
|
3214
3218
|
<br><li> Trigger - 告警触发
|
|
3215
3219
|
<br><li> Recovery - 告警恢复
|
|
3216
3220
|
<br><li> All - 告警触发和告警恢复
|
|
3217
|
-
|
|
3221
|
+
*/
|
|
3218
3222
|
Type: string;
|
|
3219
3223
|
/**
|
|
3220
|
-
|
|
3224
|
+
* 告警通知模板接收者信息。
|
|
3221
3225
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3222
|
-
|
|
3226
|
+
*/
|
|
3223
3227
|
NoticeReceivers: Array<NoticeReceiver>;
|
|
3224
3228
|
/**
|
|
3225
|
-
|
|
3229
|
+
* 告警通知模板回调信息。
|
|
3226
3230
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3227
|
-
|
|
3231
|
+
*/
|
|
3228
3232
|
WebCallbacks: Array<WebCallback>;
|
|
3229
3233
|
/**
|
|
3230
|
-
|
|
3234
|
+
* 告警通知模板ID。
|
|
3231
3235
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3232
|
-
|
|
3236
|
+
*/
|
|
3233
3237
|
AlarmNoticeId: string;
|
|
3234
3238
|
/**
|
|
3235
|
-
|
|
3239
|
+
* 创建时间。
|
|
3236
3240
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3237
|
-
|
|
3241
|
+
*/
|
|
3238
3242
|
CreateTime: string;
|
|
3239
3243
|
/**
|
|
3240
|
-
|
|
3244
|
+
* 最近更新时间。
|
|
3241
3245
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3242
|
-
|
|
3246
|
+
*/
|
|
3243
3247
|
UpdateTime: string;
|
|
3244
3248
|
}
|
|
3245
3249
|
/**
|
|
@@ -3349,7 +3353,7 @@ export interface CreateConfigResponse {
|
|
|
3349
3353
|
/**
|
|
3350
3354
|
* 采集配置ID
|
|
3351
3355
|
*/
|
|
3352
|
-
ConfigId
|
|
3356
|
+
ConfigId?: string;
|
|
3353
3357
|
/**
|
|
3354
3358
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3355
3359
|
*/
|
|
@@ -3418,62 +3422,62 @@ export interface ShipperInfo {
|
|
|
3418
3422
|
*/
|
|
3419
3423
|
Status: boolean;
|
|
3420
3424
|
/**
|
|
3421
|
-
|
|
3425
|
+
* 投递日志的过滤规则
|
|
3422
3426
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3423
|
-
|
|
3427
|
+
*/
|
|
3424
3428
|
FilterRules: Array<FilterRuleInfo>;
|
|
3425
3429
|
/**
|
|
3426
3430
|
* 投递日志的分区规则,支持strftime的时间格式表示
|
|
3427
3431
|
*/
|
|
3428
3432
|
Partition: string;
|
|
3429
3433
|
/**
|
|
3430
|
-
|
|
3434
|
+
* 投递日志的压缩配置
|
|
3431
3435
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3432
|
-
|
|
3436
|
+
*/
|
|
3433
3437
|
Compress: CompressInfo;
|
|
3434
3438
|
/**
|
|
3435
|
-
|
|
3439
|
+
* 投递日志的内容格式配置
|
|
3436
3440
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3437
|
-
|
|
3441
|
+
*/
|
|
3438
3442
|
Content: ContentInfo;
|
|
3439
3443
|
/**
|
|
3440
3444
|
* 投递日志的创建时间
|
|
3441
3445
|
*/
|
|
3442
3446
|
CreateTime: string;
|
|
3443
3447
|
/**
|
|
3444
|
-
|
|
3448
|
+
* 投递文件命名配置,0:随机数命名,1:投递时间命名,默认0(随机数命名)
|
|
3445
3449
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3446
|
-
|
|
3450
|
+
*/
|
|
3447
3451
|
FilenameMode: number;
|
|
3448
3452
|
/**
|
|
3449
|
-
|
|
3453
|
+
* 投递数据范围的开始时间点
|
|
3450
3454
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3451
|
-
|
|
3455
|
+
*/
|
|
3452
3456
|
StartTime: number;
|
|
3453
3457
|
/**
|
|
3454
|
-
|
|
3458
|
+
* 投递数据范围的结束时间点
|
|
3455
3459
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3456
|
-
|
|
3460
|
+
*/
|
|
3457
3461
|
EndTime: number;
|
|
3458
3462
|
/**
|
|
3459
|
-
|
|
3463
|
+
* 历史数据投递的进度(仅当用户选择的数据内中历史数据时才有效)
|
|
3460
3464
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3461
|
-
|
|
3465
|
+
*/
|
|
3462
3466
|
Progress: number;
|
|
3463
3467
|
/**
|
|
3464
|
-
|
|
3468
|
+
* 历史数据全部投递完成剩余的时间(仅当用户选择的数据中有历史数据时才有效)
|
|
3465
3469
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3466
|
-
|
|
3470
|
+
*/
|
|
3467
3471
|
RemainTime: number;
|
|
3468
3472
|
/**
|
|
3469
|
-
|
|
3473
|
+
* 历史任务状态:
|
|
3470
3474
|
0:实时任务
|
|
3471
3475
|
1:任务准备中
|
|
3472
3476
|
2:任务运行中
|
|
3473
3477
|
3:任务运行异常
|
|
3474
3478
|
4:任务运行结束
|
|
3475
3479
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3476
|
-
|
|
3480
|
+
*/
|
|
3477
3481
|
HistoryStatus: number;
|
|
3478
3482
|
}
|
|
3479
3483
|
/**
|
|
@@ -3481,9 +3485,9 @@ export interface ShipperInfo {
|
|
|
3481
3485
|
*/
|
|
3482
3486
|
export interface CreateCosRechargeResponse {
|
|
3483
3487
|
/**
|
|
3484
|
-
|
|
3488
|
+
* cos_recharge记录id
|
|
3485
3489
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3486
|
-
|
|
3490
|
+
*/
|
|
3487
3491
|
Id?: string;
|
|
3488
3492
|
/**
|
|
3489
3493
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -3512,14 +3516,14 @@ export interface DescribeAlertRecordHistoryResponse {
|
|
|
3512
3516
|
*/
|
|
3513
3517
|
export interface KeyValueInfo {
|
|
3514
3518
|
/**
|
|
3515
|
-
|
|
3519
|
+
* 需要配置键值或者元字段索引的字段名称,仅支持字母、数字、下划线和-./@,且不能以下划线开头
|
|
3516
3520
|
|
|
3517
3521
|
注意:
|
|
3518
3522
|
1,元字段(tag)的Key无需额外添加`__TAG__.`前缀,与上传日志时对应的字段Key一致即可,腾讯云控制台展示时将自动添加`__TAG__.`前缀
|
|
3519
3523
|
2,键值索引(KeyValue)及元字段索引(Tag)中的Key总数不能超过300
|
|
3520
3524
|
3,Key的层级不能超过10层,例如a.b.c.d.e.f.g.h.j.k
|
|
3521
3525
|
4,不允许同时包含json父子级字段,例如a及a.b
|
|
3522
|
-
|
|
3526
|
+
*/
|
|
3523
3527
|
Key: string;
|
|
3524
3528
|
/**
|
|
3525
3529
|
* 字段的索引描述信息
|
|
@@ -3581,7 +3585,7 @@ export interface ModifyMachineGroupRequest {
|
|
|
3581
3585
|
*/
|
|
3582
3586
|
export interface DescribeAlarmNoticesRequest {
|
|
3583
3587
|
/**
|
|
3584
|
-
|
|
3588
|
+
* <li> name
|
|
3585
3589
|
按照【通知渠道组名称】进行过滤。
|
|
3586
3590
|
类型:String
|
|
3587
3591
|
必选:否
|
|
@@ -3599,7 +3603,7 @@ export interface DescribeAlarmNoticesRequest {
|
|
|
3599
3603
|
必选:否
|
|
3600
3604
|
|
|
3601
3605
|
每次请求的Filters的上限为10,Filter.Values的上限为5。
|
|
3602
|
-
|
|
3606
|
+
*/
|
|
3603
3607
|
Filters?: Array<Filter>;
|
|
3604
3608
|
/**
|
|
3605
3609
|
* 分页的偏移量,默认值为0。
|
|
@@ -3615,23 +3619,23 @@ export interface DescribeAlarmNoticesRequest {
|
|
|
3615
3619
|
*/
|
|
3616
3620
|
export interface NoticeReceiver {
|
|
3617
3621
|
/**
|
|
3618
|
-
|
|
3622
|
+
* 接受者类型。可选值:
|
|
3619
3623
|
<br><li> Uin - 用户ID
|
|
3620
3624
|
<br><li> Group - 用户组ID
|
|
3621
3625
|
暂不支持其余接收者类型。
|
|
3622
|
-
|
|
3626
|
+
*/
|
|
3623
3627
|
ReceiverType: string;
|
|
3624
3628
|
/**
|
|
3625
3629
|
* 接收者。
|
|
3626
3630
|
*/
|
|
3627
3631
|
ReceiverIds: Array<number>;
|
|
3628
3632
|
/**
|
|
3629
|
-
|
|
3633
|
+
* 通知接收渠道。
|
|
3630
3634
|
<br><li> Email - 邮件
|
|
3631
3635
|
<br><li> Sms - 短信
|
|
3632
3636
|
<br><li> WeChat - 微信
|
|
3633
3637
|
<br><li> Phone - 电话
|
|
3634
|
-
|
|
3638
|
+
*/
|
|
3635
3639
|
ReceiverChannels: Array<string>;
|
|
3636
3640
|
/**
|
|
3637
3641
|
* 允许接收信息的开始时间。
|
|
@@ -3753,10 +3757,10 @@ export interface ModifyLogsetResponse {
|
|
|
3753
3757
|
*/
|
|
3754
3758
|
export interface MonitorTime {
|
|
3755
3759
|
/**
|
|
3756
|
-
|
|
3760
|
+
* 可选值:
|
|
3757
3761
|
<br><li> Period - 周期执行
|
|
3758
3762
|
<br><li> Fixed - 定期执行
|
|
3759
|
-
|
|
3763
|
+
*/
|
|
3760
3764
|
Type: string;
|
|
3761
3765
|
/**
|
|
3762
3766
|
* 执行的周期,或者定制执行的时间节点。单位为分钟,取值范围为1~1440。
|
|
@@ -3776,56 +3780,56 @@ export interface SearchLogRequest {
|
|
|
3776
3780
|
*/
|
|
3777
3781
|
To: number;
|
|
3778
3782
|
/**
|
|
3779
|
-
|
|
3783
|
+
* 检索分析语句,最大长度为12KB
|
|
3780
3784
|
语句由 <a href="https://cloud.tencent.com/document/product/614/47044" target="_blank">[检索条件]</a> | <a href="https://cloud.tencent.com/document/product/614/44061" target="_blank">[SQL语句]</a>构成,无需对日志进行统计分析时,可省略其中的管道符<code> | </code>及SQL语句
|
|
3781
3785
|
使用*或空字符串可查询所有日志
|
|
3782
|
-
|
|
3786
|
+
*/
|
|
3783
3787
|
Query: string;
|
|
3784
3788
|
/**
|
|
3785
3789
|
* 要检索分析的日志主题ID
|
|
3786
3790
|
*/
|
|
3787
3791
|
TopicId?: string;
|
|
3788
3792
|
/**
|
|
3789
|
-
|
|
3793
|
+
* 表示单次查询返回的原始日志条数,最大值为1000,获取后续日志需使用Context参数
|
|
3790
3794
|
注意:
|
|
3791
3795
|
* 仅当检索分析语句(Query)不包含SQL时有效
|
|
3792
3796
|
* SQL结果条数指定方式参考<a href="https://cloud.tencent.com/document/product/614/58977" target="_blank">SQL LIMIT语法</a>
|
|
3793
|
-
|
|
3797
|
+
*/
|
|
3794
3798
|
Limit?: number;
|
|
3795
3799
|
/**
|
|
3796
|
-
|
|
3800
|
+
* 透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时
|
|
3797
3801
|
注意:
|
|
3798
3802
|
* 透传该参数时,请勿修改除该参数外的其它参数
|
|
3799
3803
|
* 仅当检索分析语句(Query)不包含SQL时有效
|
|
3800
3804
|
* SQL获取后续结果参考<a href="https://cloud.tencent.com/document/product/614/58977" target="_blank">SQL LIMIT语法</a>
|
|
3801
|
-
|
|
3805
|
+
*/
|
|
3802
3806
|
Context?: string;
|
|
3803
3807
|
/**
|
|
3804
|
-
|
|
3808
|
+
* 原始日志是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc
|
|
3805
3809
|
注意:
|
|
3806
3810
|
* 仅当检索分析语句(Query)不包含SQL时有效
|
|
3807
3811
|
* SQL结果排序方式参考<a href="https://cloud.tencent.com/document/product/614/58978" target="_blank">SQL ORDER BY语法</a>
|
|
3808
|
-
|
|
3812
|
+
*/
|
|
3809
3813
|
Sort?: string;
|
|
3810
3814
|
/**
|
|
3811
|
-
|
|
3815
|
+
* 为true代表使用新的检索结果返回方式,输出参数AnalysisRecords和Columns有效
|
|
3812
3816
|
为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效
|
|
3813
3817
|
两种返回方式在编码格式上有少量区别,建议使用true
|
|
3814
|
-
|
|
3818
|
+
*/
|
|
3815
3819
|
UseNewAnalysis?: boolean;
|
|
3816
3820
|
/**
|
|
3817
|
-
|
|
3821
|
+
* 执行统计分析(Query中包含SQL)时,是否对原始日志先进行采样,再进行统计分析。
|
|
3818
3822
|
0:自动采样;
|
|
3819
3823
|
0~1:按指定采样率采样,例如0.02;
|
|
3820
3824
|
1:不采样,即精确分析
|
|
3821
3825
|
默认值为1
|
|
3822
|
-
|
|
3826
|
+
*/
|
|
3823
3827
|
SamplingRate?: number;
|
|
3824
3828
|
/**
|
|
3825
|
-
|
|
3829
|
+
* 检索语法规则,默认值为0。
|
|
3826
3830
|
0:Lucene语法,1:CQL语法。
|
|
3827
3831
|
详细说明参见<a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules" target="_blank">检索条件语法规则</a>
|
|
3828
|
-
|
|
3832
|
+
*/
|
|
3829
3833
|
SyntaxRule?: number;
|
|
3830
3834
|
}
|
|
3831
3835
|
/**
|
|
@@ -3916,24 +3920,24 @@ export interface ContainerFileInfo {
|
|
|
3916
3920
|
*/
|
|
3917
3921
|
FilePattern: string;
|
|
3918
3922
|
/**
|
|
3919
|
-
|
|
3923
|
+
* pod标签信息
|
|
3920
3924
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3921
|
-
|
|
3925
|
+
*/
|
|
3922
3926
|
IncludeLabels?: Array<string>;
|
|
3923
3927
|
/**
|
|
3924
|
-
|
|
3928
|
+
* 工作负载信息
|
|
3925
3929
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3926
|
-
|
|
3930
|
+
*/
|
|
3927
3931
|
WorkLoad?: ContainerWorkLoadInfo;
|
|
3928
3932
|
/**
|
|
3929
|
-
|
|
3933
|
+
* 需要排除的namespace可以多个,用分隔号分割,例如A,B
|
|
3930
3934
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3931
|
-
|
|
3935
|
+
*/
|
|
3932
3936
|
ExcludeNamespace?: string;
|
|
3933
3937
|
/**
|
|
3934
|
-
|
|
3938
|
+
* 需要排除的pod标签信息
|
|
3935
3939
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3936
|
-
|
|
3940
|
+
*/
|
|
3937
3941
|
ExcludeLabels?: Array<string>;
|
|
3938
3942
|
}
|
|
3939
3943
|
/**
|
|
@@ -3945,9 +3949,9 @@ export interface CsvInfo {
|
|
|
3945
3949
|
*/
|
|
3946
3950
|
PrintKey: boolean;
|
|
3947
3951
|
/**
|
|
3948
|
-
|
|
3952
|
+
* 每列key的名字
|
|
3949
3953
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3950
|
-
|
|
3954
|
+
*/
|
|
3951
3955
|
Keys: Array<string>;
|
|
3952
3956
|
/**
|
|
3953
3957
|
* 各字段间的分隔符
|
|
@@ -3988,11 +3992,11 @@ export interface CreateAlarmNoticeRequest {
|
|
|
3988
3992
|
*/
|
|
3989
3993
|
Name: string;
|
|
3990
3994
|
/**
|
|
3991
|
-
|
|
3995
|
+
* 通知类型。可选值:
|
|
3992
3996
|
<li> Trigger - 告警触发
|
|
3993
3997
|
<li> Recovery - 告警恢复
|
|
3994
3998
|
<li> All - 告警触发和告警恢复
|
|
3995
|
-
|
|
3999
|
+
*/
|
|
3996
4000
|
Type: string;
|
|
3997
4001
|
/**
|
|
3998
4002
|
* 通知接收对象。
|
|
@@ -4016,28 +4020,28 @@ export interface DescribeIndexResponse {
|
|
|
4016
4020
|
*/
|
|
4017
4021
|
Status: boolean;
|
|
4018
4022
|
/**
|
|
4019
|
-
|
|
4023
|
+
* 索引配置信息
|
|
4020
4024
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4021
|
-
|
|
4025
|
+
*/
|
|
4022
4026
|
Rule: RuleInfo;
|
|
4023
4027
|
/**
|
|
4024
4028
|
* 索引修改时间,初始值为索引创建时间。
|
|
4025
4029
|
*/
|
|
4026
4030
|
ModifyTime: string;
|
|
4027
4031
|
/**
|
|
4028
|
-
|
|
4032
|
+
* 内置保留字段(`__FILENAME__`,`__HOSTNAME__`及`__SOURCE__`)是否包含至全文索引
|
|
4029
4033
|
* false:不包含
|
|
4030
4034
|
* true:包含
|
|
4031
4035
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4032
|
-
|
|
4036
|
+
*/
|
|
4033
4037
|
IncludeInternalFields: boolean;
|
|
4034
4038
|
/**
|
|
4035
|
-
|
|
4039
|
+
* 元数据字段(前缀为`__TAG__`的字段)是否包含至全文索引
|
|
4036
4040
|
* 0:仅包含开启键值索引的元数据字段
|
|
4037
4041
|
* 1:包含所有元数据字段
|
|
4038
4042
|
* 2:不包含任何元数据字段
|
|
4039
4043
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4040
|
-
|
|
4044
|
+
*/
|
|
4041
4045
|
MetadataFlag: number;
|
|
4042
4046
|
/**
|
|
4043
4047
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -4191,7 +4195,7 @@ export interface ModifyCosRechargeRequest {
|
|
|
4191
4195
|
*/
|
|
4192
4196
|
export interface DescribeLogsetsRequest {
|
|
4193
4197
|
/**
|
|
4194
|
-
|
|
4198
|
+
* logsetName
|
|
4195
4199
|
- 按照【日志集名称】进行过滤。
|
|
4196
4200
|
- 类型:String
|
|
4197
4201
|
- 必选:否
|
|
@@ -4212,7 +4216,7 @@ export interface DescribeLogsetsRequest {
|
|
|
4212
4216
|
- 必选:否
|
|
4213
4217
|
|
|
4214
4218
|
每次请求的Filters的上限为10,Filter.Values的上限为5。
|
|
4215
|
-
|
|
4219
|
+
*/
|
|
4216
4220
|
Filters?: Array<Filter>;
|
|
4217
4221
|
/**
|
|
4218
4222
|
* 分页的偏移量,默认值为0
|
|
@@ -4246,80 +4250,80 @@ export interface DeleteTopicResponse {
|
|
|
4246
4250
|
*/
|
|
4247
4251
|
export interface CosRechargeInfo {
|
|
4248
4252
|
/**
|
|
4249
|
-
|
|
4253
|
+
* COS导入配置ID
|
|
4250
4254
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4251
|
-
|
|
4255
|
+
*/
|
|
4252
4256
|
Id: string;
|
|
4253
4257
|
/**
|
|
4254
|
-
|
|
4258
|
+
* 日志主题ID
|
|
4255
4259
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4256
|
-
|
|
4260
|
+
*/
|
|
4257
4261
|
TopicId: string;
|
|
4258
4262
|
/**
|
|
4259
|
-
|
|
4263
|
+
* 日志集ID
|
|
4260
4264
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4261
|
-
|
|
4265
|
+
*/
|
|
4262
4266
|
LogsetId: string;
|
|
4263
4267
|
/**
|
|
4264
|
-
|
|
4268
|
+
* COS导入任务名称
|
|
4265
4269
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4266
|
-
|
|
4270
|
+
*/
|
|
4267
4271
|
Name: string;
|
|
4268
4272
|
/**
|
|
4269
|
-
|
|
4273
|
+
* COS存储桶
|
|
4270
4274
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4271
|
-
|
|
4275
|
+
*/
|
|
4272
4276
|
Bucket: string;
|
|
4273
4277
|
/**
|
|
4274
|
-
|
|
4278
|
+
* COS存储桶所在地域
|
|
4275
4279
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4276
|
-
|
|
4280
|
+
*/
|
|
4277
4281
|
BucketRegion: string;
|
|
4278
4282
|
/**
|
|
4279
|
-
|
|
4283
|
+
* COS文件所在文件夹的前缀
|
|
4280
4284
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4281
|
-
|
|
4285
|
+
*/
|
|
4282
4286
|
Prefix: string;
|
|
4283
4287
|
/**
|
|
4284
|
-
|
|
4288
|
+
* 采集的日志类型,json_log代表json格式日志,delimiter_log代表分隔符格式日志,minimalist_log代表单行全文;
|
|
4285
4289
|
默认为minimalist_log
|
|
4286
4290
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4287
|
-
|
|
4291
|
+
*/
|
|
4288
4292
|
LogType: string;
|
|
4289
4293
|
/**
|
|
4290
|
-
|
|
4294
|
+
* 状态 status 0: 已创建, 1: 运行中, 2: 已停止, 3: 已完成, 4: 运行失败。
|
|
4291
4295
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4292
|
-
|
|
4296
|
+
*/
|
|
4293
4297
|
Status: number;
|
|
4294
4298
|
/**
|
|
4295
|
-
|
|
4299
|
+
* 是否启用: 0: 未启用 , 1:启用
|
|
4296
4300
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4297
|
-
|
|
4301
|
+
*/
|
|
4298
4302
|
Enable: number;
|
|
4299
4303
|
/**
|
|
4300
|
-
|
|
4304
|
+
* 创建时间
|
|
4301
4305
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4302
|
-
|
|
4306
|
+
*/
|
|
4303
4307
|
CreateTime: string;
|
|
4304
4308
|
/**
|
|
4305
|
-
|
|
4309
|
+
* 更新时间
|
|
4306
4310
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4307
|
-
|
|
4311
|
+
*/
|
|
4308
4312
|
UpdateTime: string;
|
|
4309
4313
|
/**
|
|
4310
|
-
|
|
4314
|
+
* 进度条百分值
|
|
4311
4315
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4312
|
-
|
|
4316
|
+
*/
|
|
4313
4317
|
Progress: number;
|
|
4314
4318
|
/**
|
|
4315
|
-
|
|
4319
|
+
* supported: "", "gzip", "lzop", "snappy”; 默认空
|
|
4316
4320
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4317
|
-
|
|
4321
|
+
*/
|
|
4318
4322
|
Compress: string;
|
|
4319
4323
|
/**
|
|
4320
|
-
|
|
4324
|
+
* 见: ExtractRuleInfo 结构描述
|
|
4321
4325
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4322
|
-
|
|
4326
|
+
*/
|
|
4323
4327
|
ExtractRuleInfo: ExtractRuleInfo;
|
|
4324
4328
|
}
|
|
4325
4329
|
/**
|
|
@@ -4327,24 +4331,24 @@ export interface CosRechargeInfo {
|
|
|
4327
4331
|
*/
|
|
4328
4332
|
export interface ConsumerContent {
|
|
4329
4333
|
/**
|
|
4330
|
-
|
|
4334
|
+
* 是否投递 TAG 信息
|
|
4331
4335
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4332
|
-
|
|
4336
|
+
*/
|
|
4333
4337
|
EnableTag: boolean;
|
|
4334
4338
|
/**
|
|
4335
|
-
|
|
4339
|
+
* 需要投递的元数据列表,目前仅支持:\_\_SOURCE\_\_,\_\_FILENAME\_\_,\_\_TIMESTAMP\_\_,\_\_HOSTNAME\_\_和\_\_PKGID\_\_
|
|
4336
4340
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4337
|
-
|
|
4341
|
+
*/
|
|
4338
4342
|
MetaFields: Array<string>;
|
|
4339
4343
|
/**
|
|
4340
|
-
|
|
4344
|
+
* 当EnableTag为true时,必须填写TagJsonNotTiled字段,TagJsonNotTiled用于标识tag信息是否json平铺,TagJsonNotTiled为true时不平铺,false时平铺
|
|
4341
4345
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4342
|
-
|
|
4346
|
+
*/
|
|
4343
4347
|
TagJsonNotTiled?: boolean;
|
|
4344
4348
|
/**
|
|
4345
|
-
|
|
4349
|
+
* 投递时间戳精度,可选项 [1:秒;2:毫秒] ,默认是秒
|
|
4346
4350
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4347
|
-
|
|
4351
|
+
*/
|
|
4348
4352
|
TimestampAccuracy?: number;
|
|
4349
4353
|
}
|
|
4350
4354
|
/**
|
|
@@ -4386,9 +4390,9 @@ export interface HostFileInfo {
|
|
|
4386
4390
|
*/
|
|
4387
4391
|
FilePattern: string;
|
|
4388
4392
|
/**
|
|
4389
|
-
|
|
4393
|
+
* metadata信息
|
|
4390
4394
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4391
|
-
|
|
4395
|
+
*/
|
|
4392
4396
|
CustomLabels?: Array<string>;
|
|
4393
4397
|
}
|
|
4394
4398
|
/**
|