tencentcloud-sdk-nodejs-cls 4.1.203 → 4.1.204
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/package.json
CHANGED
|
@@ -313,55 +313,48 @@ export interface CreateConsoleSharingRequest {
|
|
|
313
313
|
*/
|
|
314
314
|
export interface SearchLogResponse {
|
|
315
315
|
/**
|
|
316
|
-
*
|
|
317
|
-
注意:
|
|
318
|
-
* 仅适用于单日志主题检索,检索多个日志主题时,请使用Topics中的Context
|
|
316
|
+
* <p>透传本次接口返回的Context值,可获取后续更多日志,过期时间1小时。<br>注意:</p><ul><li>仅适用于单日志主题检索,检索多个日志主题时,请使用Topics中的Context</li></ul>
|
|
319
317
|
*/
|
|
320
318
|
Context?: string;
|
|
321
319
|
/**
|
|
322
|
-
*
|
|
323
|
-
注意:仅当检索分析语句(Query)不包含SQL时有效
|
|
320
|
+
* <p>符合检索条件的日志是否已全部返回,如未全部返回可使用Context参数获取后续更多日志<br>注意:仅当检索分析语句(Query)不包含SQL时有效</p>
|
|
324
321
|
*/
|
|
325
322
|
ListOver?: boolean;
|
|
326
323
|
/**
|
|
327
|
-
*
|
|
324
|
+
* <p>返回的是否为统计分析(即SQL)结果</p>
|
|
328
325
|
*/
|
|
329
326
|
Analysis?: boolean;
|
|
330
327
|
/**
|
|
331
|
-
*
|
|
328
|
+
* <p>匹配检索条件的原始日志</p>
|
|
332
329
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
333
330
|
*/
|
|
334
331
|
Results?: Array<LogInfo>;
|
|
335
332
|
/**
|
|
336
|
-
*
|
|
337
|
-
当UseNewAnalysis为false时生效
|
|
333
|
+
* <p>日志统计分析结果的列名<br>当UseNewAnalysis为false时生效</p>
|
|
338
334
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
339
335
|
*/
|
|
340
336
|
ColNames?: Array<string>;
|
|
341
337
|
/**
|
|
342
|
-
*
|
|
343
|
-
当UseNewAnalysis为false时生效
|
|
338
|
+
* <p>日志统计分析结果<br>当UseNewAnalysis为false时生效</p>
|
|
344
339
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
345
340
|
*/
|
|
346
341
|
AnalysisResults?: Array<LogItems>;
|
|
347
342
|
/**
|
|
348
|
-
*
|
|
349
|
-
当UseNewAnalysis为true时生效
|
|
343
|
+
* <p>日志统计分析结果<br>当UseNewAnalysis为true时生效</p>
|
|
350
344
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
351
345
|
*/
|
|
352
346
|
AnalysisRecords?: Array<string>;
|
|
353
347
|
/**
|
|
354
|
-
*
|
|
355
|
-
当UseNewAnalysis为true时生效
|
|
348
|
+
* <p>日志统计分析结果的列属性<br>当UseNewAnalysis为true时生效</p>
|
|
356
349
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
357
350
|
*/
|
|
358
351
|
Columns?: Array<Column>;
|
|
359
352
|
/**
|
|
360
|
-
*
|
|
353
|
+
* <p>本次统计分析使用的采样率</p>
|
|
361
354
|
*/
|
|
362
355
|
SamplingRate?: number;
|
|
363
356
|
/**
|
|
364
|
-
*
|
|
357
|
+
* <p>使用多日志主题检索时,各个日志主题的基本信息,例如报错信息。</p>
|
|
365
358
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
366
359
|
*/
|
|
367
360
|
Topics?: SearchLogTopics;
|
|
@@ -2512,81 +2505,73 @@ export interface DeleteTopicRequest {
|
|
|
2512
2505
|
*/
|
|
2513
2506
|
export interface ModifyShipperRequest {
|
|
2514
2507
|
/**
|
|
2515
|
-
*
|
|
2516
|
-
|
|
2517
|
-
- 通过 [获取投递任务列表](https://cloud.tencent.com/document/product/614/58745)获取ShipperId。
|
|
2508
|
+
* <p>投递规则Id。</p><ul><li>通过 <a href="https://cloud.tencent.com/document/product/614/58745">获取投递任务列表</a>获取ShipperId。</li></ul>
|
|
2518
2509
|
*/
|
|
2519
2510
|
ShipperId: string;
|
|
2520
2511
|
/**
|
|
2521
|
-
* COS
|
|
2522
|
-
|
|
2523
|
-
- 通过[GET Service(List Buckets)](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。
|
|
2512
|
+
* <p>COS存储桶,详见产品支持的<a href="https://cloud.tencent.com/document/product/436/13312">存储桶命名规范</a>。 </p><ul><li>通过<a href="https://cloud.tencent.com/document/product/436/8291">GET Service(List Buckets)</a>获取COS存储桶。</li></ul>
|
|
2524
2513
|
*/
|
|
2525
2514
|
Bucket?: string;
|
|
2526
2515
|
/**
|
|
2527
|
-
*
|
|
2528
|
-
- 仅支持0-9A-Za-z-_/
|
|
2529
|
-
- 最大支持256个字符
|
|
2516
|
+
* <p>投递规则投递的新的目录前缀。</p><ul><li>仅支持0-9A-Za-z-_/</li><li>最大支持256个字符</li></ul>
|
|
2530
2517
|
*/
|
|
2531
2518
|
Prefix?: string;
|
|
2532
2519
|
/**
|
|
2533
|
-
*
|
|
2520
|
+
* <p>投递规则的开关状态。true:开启投递任务;false:关闭投递任务。</p>
|
|
2534
2521
|
*/
|
|
2535
2522
|
Status?: boolean;
|
|
2536
2523
|
/**
|
|
2537
|
-
*
|
|
2524
|
+
* <p>投递规则的名字</p>
|
|
2538
2525
|
*/
|
|
2539
2526
|
ShipperName?: string;
|
|
2540
2527
|
/**
|
|
2541
|
-
*
|
|
2528
|
+
* <p>投递的时间间隔,单位 秒,默认300,范围 300-900</p>
|
|
2542
2529
|
*/
|
|
2543
2530
|
Interval?: number;
|
|
2544
2531
|
/**
|
|
2545
|
-
*
|
|
2532
|
+
* <p>投递的文件的最大值,单位 MB,默认256,范围 5-256</p>
|
|
2546
2533
|
*/
|
|
2547
2534
|
MaxSize?: number;
|
|
2548
2535
|
/**
|
|
2549
|
-
*
|
|
2536
|
+
* <p>投递日志的过滤规则,匹配的日志进行投递,各rule之间是and关系,最多5个,数组为空则表示不过滤而全部投递</p>
|
|
2550
2537
|
*/
|
|
2551
2538
|
FilterRules?: Array<FilterRuleInfo>;
|
|
2552
2539
|
/**
|
|
2553
|
-
*
|
|
2540
|
+
* <p>投递日志的分区规则,支持strftime的时间格式表示</p>
|
|
2554
2541
|
*/
|
|
2555
2542
|
Partition?: string;
|
|
2556
2543
|
/**
|
|
2557
|
-
*
|
|
2544
|
+
* <p>投递日志的压缩配置</p>
|
|
2558
2545
|
*/
|
|
2559
2546
|
Compress?: CompressInfo;
|
|
2560
2547
|
/**
|
|
2561
|
-
*
|
|
2548
|
+
* <p>投递日志的内容格式配置</p>
|
|
2562
2549
|
*/
|
|
2563
2550
|
Content?: ContentInfo;
|
|
2564
2551
|
/**
|
|
2565
|
-
*
|
|
2552
|
+
* <p>投递文件命名配置,0:随机数命名,1:投递时间命名。</p>
|
|
2566
2553
|
*/
|
|
2567
2554
|
FilenameMode?: number;
|
|
2568
2555
|
/**
|
|
2569
|
-
*
|
|
2570
|
-
参考值有:
|
|
2571
|
-
|
|
2572
|
-
- STANDARD:标准存储
|
|
2573
|
-
- STANDARD_IA:低频存储
|
|
2574
|
-
- ARCHIVE:归档存储
|
|
2575
|
-
- DEEP_ARCHIVE:深度归档存储
|
|
2576
|
-
- MAZ_STANDARD:标准存储(多 AZ)
|
|
2577
|
-
- MAZ_STANDARD_IA:低频存储(多 AZ)
|
|
2578
|
-
- INTELLIGENT_TIERING:智能分层存储
|
|
2579
|
-
- MAZ_INTELLIGENT_TIERING:智能分层存储(多 AZ)
|
|
2556
|
+
* <p>对象存储类型,默认值为 STANDARD。枚举值请参见<a href="https://cloud.tencent.com/document/product/436/33417"> 存储类型概述</a> 文档。<br>参考值有:</p><ul><li>STANDARD:标准存储</li><li>STANDARD_IA:低频存储</li><li>ARCHIVE:归档存储</li><li>DEEP_ARCHIVE:深度归档存储</li><li>MAZ_STANDARD:标准存储(多 AZ)</li><li>MAZ_STANDARD_IA:低频存储(多 AZ)</li><li>INTELLIGENT_TIERING:智能分层存储</li><li>MAZ_INTELLIGENT_TIERING:智能分层存储(多 AZ)</li></ul>
|
|
2580
2557
|
*/
|
|
2581
2558
|
StorageType?: string;
|
|
2582
2559
|
/**
|
|
2583
|
-
*
|
|
2560
|
+
* <p>角色访问描述名 <a href="https://cloud.tencent.com/document/product/598/19381">创建角色</a></p>
|
|
2584
2561
|
*/
|
|
2585
2562
|
RoleArn?: string;
|
|
2586
2563
|
/**
|
|
2587
|
-
*
|
|
2564
|
+
* <p>外部ID</p>
|
|
2588
2565
|
*/
|
|
2589
2566
|
ExternalId?: string;
|
|
2567
|
+
/**
|
|
2568
|
+
* <p>用于生成投递到COS 的文件路径中的时间变量</p><p>入参限制:支持下面时区列表</p><ul><li>GMT-12:00</li><li>GMT-11:00</li><li>GMT-10:00</li><li>GMT-09:30</li><li>GMT-09:00</li><li>GMT-08:00</li><li>GMT-07:00</li><li>GMT-06:00</li><li>GMT-05:00</li><li>GMT-04:00</li><li>GMT-03:30</li><li>GMT-03:00</li><li>GMT-02:00</li><li>GMT-01:00</li><li>GMT+00:00</li><li>GMT+01:00</li><li>GMT+02:00</li><li>GMT+03:30</li><li>GMT+04:00</li><li>GMT+04:30</li><li>GMT+05:00</li><li>GMT+05:30</li><li>GMT+05:45</li><li>GMT+06:00</li><li>GMT+06:30</li><li>GMT+07:00</li><li>GMT+08:00</li><li>GMT+09:00</li><li>GMT+09:30</li><li>GMT+10:00</li><li>GMT+10:30</li><li>GMT+11:00</li><li>GMT+11:30</li><li>GMT+12:00</li><li>GMT+12:45</li><li>GMT+13:00</li><li>GMT+14:00</li><li>UTC-11:00</li><li>UTC-10:00</li><li>UTC-09:00</li><li>UTC-08:00</li><li>UTC-12:00</li><li>UTC-07:00</li><li>UTC-06:00</li><li>UTC-05:00</li><li>UTC-04:30</li><li>UTC-04:00</li><li>UTC-03:30</li><li>UTC-03:00</li><li>UTC-02:00</li><li>UTC-01:00</li><li>UTC+00:00</li><li>UTC+01:00</li><li>UTC+02:00</li><li>UTC+03:00</li><li>UTC+03:30</li><li>UTC+04:00</li><li>UTC+04:30</li><li>UTC+05:00</li><li>UTC+05:45</li><li>UTC+06:00</li><li>UTC+06:30</li><li>UTC+07:00</li><li>UTC+08:00</li><li>UTC+09:00</li><li>UTC+09:30</li><li>UTC+10:00</li><li>UTC+11:00</li><li>UTC+12:00</li><li>UTC+13:00</li></ul>
|
|
2569
|
+
*/
|
|
2570
|
+
TimeZone?: string;
|
|
2571
|
+
/**
|
|
2572
|
+
* <p>预过滤处理-对写入COS原始数据进行预过滤处理</p>
|
|
2573
|
+
*/
|
|
2574
|
+
DSLFilter?: string;
|
|
2590
2575
|
}
|
|
2591
2576
|
/**
|
|
2592
2577
|
* 腾讯云可观测平台通知渠道组信息
|
|
@@ -4195,129 +4180,95 @@ export interface DescribeConfigsResponse {
|
|
|
4195
4180
|
*/
|
|
4196
4181
|
export interface ExtractRuleInfo {
|
|
4197
4182
|
/**
|
|
4198
|
-
*
|
|
4183
|
+
* <p>时间字段的key名字,TimeKey和TimeFormat必须成对出现</p>
|
|
4199
4184
|
*/
|
|
4200
4185
|
TimeKey?: string;
|
|
4201
4186
|
/**
|
|
4202
|
-
*
|
|
4203
|
-
- 参考 [配置时间格式](https://cloud.tencent.com/document/product/614/38614) 文档
|
|
4187
|
+
* <p>时间字段的格式,参考c语言的strftime函数对于时间的格式说明输出参数</p><ul><li>参考 <a href="https://cloud.tencent.com/document/product/614/38614">配置时间格式</a> 文档</li></ul>
|
|
4204
4188
|
*/
|
|
4205
4189
|
TimeFormat?: string;
|
|
4206
4190
|
/**
|
|
4207
|
-
*
|
|
4191
|
+
* <p>分隔符类型日志的分隔符,只有LogType为delimiter_log时有效</p>
|
|
4208
4192
|
*/
|
|
4209
4193
|
Delimiter?: string;
|
|
4210
4194
|
/**
|
|
4211
|
-
*
|
|
4195
|
+
* <p>整条日志匹配规则,只有LogType为fullregex_log时有效</p>
|
|
4212
4196
|
*/
|
|
4213
4197
|
LogRegex?: string;
|
|
4214
4198
|
/**
|
|
4215
|
-
*
|
|
4199
|
+
* <p>行首匹配规则,只有LogType为multiline_log或fullregex_log时有效</p>
|
|
4216
4200
|
*/
|
|
4217
4201
|
BeginRegex?: string;
|
|
4218
4202
|
/**
|
|
4219
|
-
*
|
|
4203
|
+
* <p>取的每个字段的key名字,为空的key代表丢弃这个字段,只有LogType为delimiter_log时有效,json_log的日志使用json本身的key。限制100个。</p>
|
|
4220
4204
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4221
4205
|
*/
|
|
4222
4206
|
Keys?: Array<string>;
|
|
4223
4207
|
/**
|
|
4224
|
-
*
|
|
4225
|
-
注意:2.9.3及以上版本LogListener ,建议使用AdvanceFilterRules配置日志过滤规则。
|
|
4226
|
-
|
|
4208
|
+
* <p>日志过滤规则列表(旧版),需要过滤日志的key,及其对应的regex。<br> 注意:2.9.3及以上版本LogListener ,建议使用AdvanceFilterRules配置日志过滤规则。</p>
|
|
4227
4209
|
*/
|
|
4228
4210
|
FilterKeyRegex?: Array<KeyRegexInfo>;
|
|
4229
4211
|
/**
|
|
4230
|
-
*
|
|
4212
|
+
* <p>解析失败日志是否上传,true表示上传,false表示不上传</p>
|
|
4231
4213
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4232
4214
|
*/
|
|
4233
4215
|
UnMatchUpLoadSwitch?: boolean;
|
|
4234
4216
|
/**
|
|
4235
|
-
*
|
|
4217
|
+
* <p>失败日志的key,当UnMatchUpLoadSwitch为true时必填</p>
|
|
4236
4218
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4237
4219
|
*/
|
|
4238
4220
|
UnMatchLogKey?: string;
|
|
4239
4221
|
/**
|
|
4240
|
-
*
|
|
4241
|
-
注意:
|
|
4242
|
-
- COS导入不支持此字段。
|
|
4222
|
+
* <p>增量采集模式下的回溯数据量,默认:-1(全量采集);其他非负数表示增量采集(从最新的位置,往前采集${Backtracking}字节(Byte)的日志)最大支持1073741824(1G)。<br>注意:</p><ul><li>COS导入不支持此字段。</li></ul>
|
|
4243
4223
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4244
4224
|
*/
|
|
4245
4225
|
Backtracking?: number;
|
|
4246
4226
|
/**
|
|
4247
|
-
*
|
|
4248
|
-
注意
|
|
4249
|
-
- 目前取0值时,表示UTF-8编码
|
|
4250
|
-
- COS导入不支持此字段。
|
|
4227
|
+
* <p>是否为Gbk编码。 0:否;1:是。<br>注意</p><ul><li>目前取0值时,表示UTF-8编码</li><li>COS导入不支持此字段。</li></ul>
|
|
4251
4228
|
*/
|
|
4252
4229
|
IsGBK?: number;
|
|
4253
4230
|
/**
|
|
4254
|
-
*
|
|
4255
|
-
- 标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。
|
|
4231
|
+
* <p>是否为标准json。 0:否; 1:是。</p><ul><li>标准json指采集器使用业界标准开源解析器进行json解析,非标json指采集器使用CLS自研json解析器进行解析,两种解析器没有本质区别,建议客户使用标准json进行解析。</li></ul>
|
|
4256
4232
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4257
4233
|
*/
|
|
4258
4234
|
JsonStandard?: number;
|
|
4259
4235
|
/**
|
|
4260
|
-
* syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog
|
|
4261
|
-
注意:
|
|
4262
|
-
- 该字段适用于:创建采集规则配置、修改采集规则配置。
|
|
4263
|
-
- COS导入不支持此字段。
|
|
4236
|
+
* <p>syslog传输协议,取值为tcp或者udp,只有在LogType为service_syslog时生效,其余类型无需填写。<br>注意:</p><ul><li>该字段适用于:创建采集规则配置、修改采集规则配置。</li><li>COS导入不支持此字段。</li></ul>
|
|
4264
4237
|
*/
|
|
4265
4238
|
Protocol?: string;
|
|
4266
4239
|
/**
|
|
4267
|
-
* syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog
|
|
4268
|
-
注意:
|
|
4269
|
-
- 该字段适用于:创建采集规则配置、修改采集规则配置。
|
|
4270
|
-
- COS导入不支持此字段。
|
|
4240
|
+
* <p>syslog系统日志采集指定采集器监听的地址和端口 ,形式:[ip]:[port],只有在LogType为service_syslog时生效,其余类型无需填写。<br>注意:</p><ul><li>该字段适用于:创建采集规则配置、修改采集规则配置。</li><li>COS导入不支持此字段。</li></ul>
|
|
4271
4241
|
*/
|
|
4272
4242
|
Address?: string;
|
|
4273
4243
|
/**
|
|
4274
|
-
* rfc3164:指定系统日志采集使用RFC3164
|
|
4275
|
-
rfc5424:指定系统日志采集使用RFC5424协议解析日志。
|
|
4276
|
-
auto:自动匹配rfc3164或者rfc5424其中一种协议。
|
|
4277
|
-
只有在LogType为service_syslog时生效,其余类型无需填写。
|
|
4278
|
-
注意:
|
|
4279
|
-
- 该字段适用于:创建采集规则配置、修改采集规则配置
|
|
4280
|
-
- COS导入不支持此字段。
|
|
4244
|
+
* <p>rfc3164:指定系统日志采集使用RFC3164协议解析日志。<br>rfc5424:指定系统日志采集使用RFC5424协议解析日志。<br>auto:自动匹配rfc3164或者rfc5424其中一种协议。<br>只有在LogType为service_syslog时生效,其余类型无需填写。<br>注意:</p><ul><li>该字段适用于:创建采集规则配置、修改采集规则配置</li><li>COS导入不支持此字段。</li></ul>
|
|
4281
4245
|
*/
|
|
4282
4246
|
ParseProtocol?: string;
|
|
4283
4247
|
/**
|
|
4284
|
-
*
|
|
4285
|
-
注意:
|
|
4286
|
-
- COS导入不支持此字段。
|
|
4248
|
+
* <p>元数据类型。0: 不使用元数据信息;1:使用机器组元数据;2:使用用户自定义元数据;3:使用采集配置路径。<br>注意:</p><ul><li>COS导入不支持此字段。</li></ul>
|
|
4287
4249
|
*/
|
|
4288
4250
|
MetadataType?: number;
|
|
4289
4251
|
/**
|
|
4290
|
-
*
|
|
4291
|
-
|
|
4292
|
-
```
|
|
4293
|
-
请用"()"标识路径中目标字段对应的正则表达式,解析时将"()"视为捕获组,并以__TAG__.{i}:{目标字段}的形式与日志一起上报,其中i为捕获组的序号。
|
|
4294
|
-
若不希望以序号为键名,可以通过命名捕获组"(?<{键名}>{正则})"自定义键名,并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组
|
|
4295
|
-
```
|
|
4296
|
-
|
|
4297
|
-
注意:
|
|
4298
|
-
- MetadataType为3时必填。
|
|
4299
|
-
- COS导入不支持此字段。
|
|
4252
|
+
* <p>采集配置路径正则表达式。</p><p><pre><code>请用"()"标识路径中目标字段对应的正则表达式,解析时将"()"视为捕获组,并以__TAG__.{i}:{目标字段}的形式与日志一起上报,其中i为捕获组的序号。若不希望以序号为键名,可以通过命名捕获组"(?<{键名}>{正则})"自定义键名,并以__TAG__.{键名}:{目标字段}的形式与日志一起上报。最多支持5个捕获组</code></pre></p><p>注意:</p><ul><li>MetadataType为3时必填。</li><li>COS导入不支持此字段。</li></ul>
|
|
4300
4253
|
*/
|
|
4301
4254
|
PathRegex?: string;
|
|
4302
4255
|
/**
|
|
4303
|
-
*
|
|
4304
|
-
注意:
|
|
4305
|
-
- MetadataType为2时必填。
|
|
4306
|
-
- COS导入不支持此字段。
|
|
4256
|
+
* <p>用户自定义元数据信息。<br>注意:</p><ul><li>MetadataType为2时必填。</li><li>COS导入不支持此字段。</li></ul>
|
|
4307
4257
|
*/
|
|
4308
4258
|
MetaTags?: Array<MetaTagInfo>;
|
|
4309
4259
|
/**
|
|
4310
|
-
* Windows事件日志采集规则,只有在LogType为windows_event_log
|
|
4260
|
+
* <p>Windows事件日志采集规则,只有在LogType为windows_event_log时生效,其余类型无需填写。</p>
|
|
4311
4261
|
*/
|
|
4312
4262
|
EventLogRules?: Array<EventLog>;
|
|
4313
4263
|
/**
|
|
4314
|
-
*
|
|
4315
|
-
注意:
|
|
4316
|
-
- 2.9.3以下版本LogListener不支持, 请使用FilterKeyRegex配置日志过滤规则。
|
|
4317
|
-
- 自建k8s采集配置(CreateConfigExtra、ModifyConfigExtra)不支持此字段。
|
|
4264
|
+
* <p>日志过滤规则列表(新版)。<br>注意:</p><ul><li>2.9.3以下版本LogListener不支持, 请使用FilterKeyRegex配置日志过滤规则。</li><li>自建k8s采集配置(CreateConfigExtra、ModifyConfigExtra)不支持此字段。</li></ul>
|
|
4318
4265
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
4319
4266
|
*/
|
|
4320
4267
|
AdvanceFilterRules?: Array<AdvanceFilterRuleInfo>;
|
|
4268
|
+
/**
|
|
4269
|
+
* <p>原始日志的键名称(Key);所有原始日志, 均以您指定的键名称(Key),原始日志内容作为值(Value)进行上传,为空时表示不开启原始日志上传。</p><ul><li>COS导入不支持此字段。</li></ul>
|
|
4270
|
+
*/
|
|
4271
|
+
RawLogKey?: string;
|
|
4321
4272
|
}
|
|
4322
4273
|
/**
|
|
4323
4274
|
* 主题基本信息
|
|
@@ -9608,6 +9559,14 @@ export interface ShipperInfo {
|
|
|
9608
9559
|
* <p>任务运行状态。支持<code>0</code>,<code>1</code>,<code>2</code></p><ul><li><code>0</code>: 停止</li><li><code>1</code>: 运行中</li><li><code>2</code>: 异常</li></ul>
|
|
9609
9560
|
*/
|
|
9610
9561
|
TaskStatus?: number;
|
|
9562
|
+
/**
|
|
9563
|
+
* <p>用于生成投递到COS 的文件路径中的时间变量</p>
|
|
9564
|
+
*/
|
|
9565
|
+
TimeZone?: string;
|
|
9566
|
+
/**
|
|
9567
|
+
* <p>预过滤处理-对写入COS原始数据进行预过滤处理</p>
|
|
9568
|
+
*/
|
|
9569
|
+
DSLFilter?: string;
|
|
9611
9570
|
}
|
|
9612
9571
|
/**
|
|
9613
9572
|
* DescribeAlertRecordHistory返回参数结构体
|
|
@@ -11777,86 +11736,77 @@ export interface ModifyKafkaConsumerGroupOffsetResponse {
|
|
|
11777
11736
|
*/
|
|
11778
11737
|
export interface CreateShipperRequest {
|
|
11779
11738
|
/**
|
|
11780
|
-
*
|
|
11781
|
-
- 通过[获取日志主题列表](https://cloud.tencent.com/document/product/614/56454)获取日志主题Id。
|
|
11739
|
+
* <p>创建的投递规则所属的日志主题Id。</p><ul><li>通过<a href="https://cloud.tencent.com/document/product/614/56454">获取日志主题列表</a>获取日志主题Id。</li></ul>
|
|
11782
11740
|
*/
|
|
11783
11741
|
TopicId: string;
|
|
11784
11742
|
/**
|
|
11785
|
-
* COS
|
|
11786
|
-
|
|
11787
|
-
- 通过[GET Service(List Buckets)](https://cloud.tencent.com/document/product/436/8291)获取COS存储桶。
|
|
11743
|
+
* <p>COS存储桶,详见产品支持的<a href="https://cloud.tencent.com/document/product/436/13312">存储桶命名规范</a>。 </p><ul><li>通过<a href="https://cloud.tencent.com/document/product/436/8291">GET Service(List Buckets)</a>获取COS存储桶。</li></ul>
|
|
11788
11744
|
*/
|
|
11789
11745
|
Bucket: string;
|
|
11790
11746
|
/**
|
|
11791
|
-
*
|
|
11792
|
-
- 仅支持0-9A-Za-z-_/
|
|
11793
|
-
- 最大支持256个字符
|
|
11747
|
+
* <p>投递规则投递的新的目录前缀。</p><ul><li>仅支持0-9A-Za-z-_/</li><li>最大支持256个字符</li></ul>
|
|
11794
11748
|
*/
|
|
11795
11749
|
Prefix: string;
|
|
11796
11750
|
/**
|
|
11797
|
-
*
|
|
11751
|
+
* <p>投递规则的名字。最大支持255个字符</p>
|
|
11798
11752
|
*/
|
|
11799
11753
|
ShipperName: string;
|
|
11800
11754
|
/**
|
|
11801
|
-
*
|
|
11755
|
+
* <p>投递的时间间隔,单位 秒,默认300,范围 300-900</p>
|
|
11802
11756
|
*/
|
|
11803
11757
|
Interval?: number;
|
|
11804
11758
|
/**
|
|
11805
|
-
*
|
|
11759
|
+
* <p>投递的文件的最大值,单位 MB,默认256,范围 5-256</p>
|
|
11806
11760
|
*/
|
|
11807
11761
|
MaxSize?: number;
|
|
11808
11762
|
/**
|
|
11809
|
-
*
|
|
11763
|
+
* <p>投递日志的过滤规则,匹配的日志进行投递,各rule之间是and关系,最多5个,数组为空则表示不过滤而全部投递</p>
|
|
11810
11764
|
*/
|
|
11811
11765
|
FilterRules?: Array<FilterRuleInfo>;
|
|
11812
11766
|
/**
|
|
11813
|
-
*
|
|
11767
|
+
* <p>投递日志的分区规则,支持strftime的时间格式表示</p>
|
|
11814
11768
|
*/
|
|
11815
11769
|
Partition?: string;
|
|
11816
11770
|
/**
|
|
11817
|
-
*
|
|
11771
|
+
* <p>投递日志的压缩配置</p>
|
|
11818
11772
|
*/
|
|
11819
11773
|
Compress?: CompressInfo;
|
|
11820
11774
|
/**
|
|
11821
|
-
*
|
|
11775
|
+
* <p>投递日志的内容格式配置</p>
|
|
11822
11776
|
*/
|
|
11823
11777
|
Content?: ContentInfo;
|
|
11824
11778
|
/**
|
|
11825
|
-
*
|
|
11779
|
+
* <p>投递文件命名配置,0:随机数命名,1:投递时间命名,默认0(随机数命名)</p>
|
|
11826
11780
|
*/
|
|
11827
11781
|
FilenameMode?: number;
|
|
11828
11782
|
/**
|
|
11829
|
-
*
|
|
11830
|
-
如果用户不填写,默认为用户新建投递任务的时间。
|
|
11783
|
+
* <p>投递数据范围的开始时间点(秒级时间戳),不能超出日志主题的生命周期起点。<br>如果用户不填写,默认为用户新建投递任务的时间。</p>
|
|
11831
11784
|
*/
|
|
11832
11785
|
StartTime?: number;
|
|
11833
11786
|
/**
|
|
11834
|
-
*
|
|
11835
|
-
如果用户不填写,默认为持续投递,即无限。
|
|
11787
|
+
* <p>投递数据范围的结束时间点(秒级时间戳),不能填写未来时间。<br>如果用户不填写,默认为持续投递,即无限。</p>
|
|
11836
11788
|
*/
|
|
11837
11789
|
EndTime?: number;
|
|
11838
11790
|
/**
|
|
11839
|
-
*
|
|
11840
|
-
参考值有:
|
|
11841
|
-
|
|
11842
|
-
- STANDARD:标准存储
|
|
11843
|
-
- STANDARD_IA:低频存储
|
|
11844
|
-
- ARCHIVE:归档存储
|
|
11845
|
-
- DEEP_ARCHIVE:深度归档存储
|
|
11846
|
-
- MAZ_STANDARD:标准存储(多 AZ)
|
|
11847
|
-
- MAZ_STANDARD_IA:低频存储(多 AZ)
|
|
11848
|
-
- INTELLIGENT_TIERING:智能分层存储
|
|
11849
|
-
- MAZ_INTELLIGENT_TIERING:智能分层存储(多 AZ)
|
|
11791
|
+
* <p>对象存储类型,默认值为 STANDARD。枚举值请参见<a href="https://cloud.tencent.com/document/product/436/33417"> 存储类型概述</a> 文档。<br>参考值有:</p><ul><li>STANDARD:标准存储</li><li>STANDARD_IA:低频存储</li><li>ARCHIVE:归档存储</li><li>DEEP_ARCHIVE:深度归档存储</li><li>MAZ_STANDARD:标准存储(多 AZ)</li><li>MAZ_STANDARD_IA:低频存储(多 AZ)</li><li>INTELLIGENT_TIERING:智能分层存储</li><li>MAZ_INTELLIGENT_TIERING:智能分层存储(多 AZ)</li></ul>
|
|
11850
11792
|
*/
|
|
11851
11793
|
StorageType?: string;
|
|
11852
11794
|
/**
|
|
11853
|
-
*
|
|
11795
|
+
* <p>角色访问描述名 <a href="https://cloud.tencent.com/document/product/598/19381">创建角色</a></p>
|
|
11854
11796
|
*/
|
|
11855
11797
|
RoleArn?: string;
|
|
11856
11798
|
/**
|
|
11857
|
-
*
|
|
11799
|
+
* <p>外部ID</p>
|
|
11858
11800
|
*/
|
|
11859
11801
|
ExternalId?: string;
|
|
11802
|
+
/**
|
|
11803
|
+
* <p>用于生成投递到COS 的文件路径中的时间变量</p><p>入参限制:支持下面时区列表</p><ul><li>GMT-12:00</li><li>GMT-11:00</li><li>GMT-10:00</li><li>GMT-09:30</li><li>GMT-09:00</li><li>GMT-08:00</li><li>GMT-07:00</li><li>GMT-06:00</li><li>GMT-05:00</li><li>GMT-04:00</li><li>GMT-03:30</li><li>GMT-03:00</li><li>GMT-02:00</li><li>GMT-01:00</li><li>GMT+00:00</li><li>GMT+01:00</li><li>GMT+02:00</li><li>GMT+03:30</li><li>GMT+04:00</li><li>GMT+04:30</li><li>GMT+05:00</li><li>GMT+05:30</li><li>GMT+05:45</li><li>GMT+06:00</li><li>GMT+06:30</li><li>GMT+07:00</li><li>GMT+08:00</li><li>GMT+09:00</li><li>GMT+09:30</li><li>GMT+10:00</li><li>GMT+10:30</li><li>GMT+11:00</li><li>GMT+11:30</li><li>GMT+12:00</li><li>GMT+12:45</li><li>GMT+13:00</li><li>GMT+14:00</li><li>UTC-11:00</li><li>UTC-10:00</li><li>UTC-09:00</li><li>UTC-08:00</li><li>UTC-12:00</li><li>UTC-07:00</li><li>UTC-06:00</li><li>UTC-05:00</li><li>UTC-04:30</li><li>UTC-04:00</li><li>UTC-03:30</li><li>UTC-03:00</li><li>UTC-02:00</li><li>UTC-01:00</li><li>UTC+00:00</li><li>UTC+01:00</li><li>UTC+02:00</li><li>UTC+03:00</li><li>UTC+03:30</li><li>UTC+04:00</li><li>UTC+04:30</li><li>UTC+05:00</li><li>UTC+05:45</li><li>UTC+06:00</li><li>UTC+06:30</li><li>UTC+07:00</li><li>UTC+08:00</li><li>UTC+09:00</li><li>UTC+09:30</li><li>UTC+10:00</li><li>UTC+11:00</li><li>UTC+12:00</li><li>UTC+13:00</li></ul>
|
|
11804
|
+
*/
|
|
11805
|
+
TimeZone?: string;
|
|
11806
|
+
/**
|
|
11807
|
+
* <p>预过滤处理-对写入COS原始数据进行预过滤处理</p>
|
|
11808
|
+
*/
|
|
11809
|
+
DSLFilter?: string;
|
|
11860
11810
|
}
|
|
11861
11811
|
/**
|
|
11862
11812
|
* 云产品指标订阅预览结果实例信息
|
|
@@ -11936,7 +11886,7 @@ export interface HostMetricConfig {
|
|
|
11936
11886
|
*/
|
|
11937
11887
|
export interface CreateShipperResponse {
|
|
11938
11888
|
/**
|
|
11939
|
-
*
|
|
11889
|
+
* <p>投递任务ID</p>
|
|
11940
11890
|
*/
|
|
11941
11891
|
ShipperId?: string;
|
|
11942
11892
|
/**
|
|
@@ -12970,93 +12920,67 @@ export interface DeleteConsumerGroupResponse {
|
|
|
12970
12920
|
*/
|
|
12971
12921
|
export interface SearchLogRequest {
|
|
12972
12922
|
/**
|
|
12973
|
-
*
|
|
12923
|
+
* <p>要检索分析的日志的起始时间,<strong>Unix时间戳(毫秒)</strong></p>
|
|
12974
12924
|
*/
|
|
12975
12925
|
From: number;
|
|
12976
12926
|
/**
|
|
12977
|
-
*
|
|
12927
|
+
* <p>要检索分析的日志的结束时间,<strong>Unix时间戳(毫秒)</strong></p>
|
|
12978
12928
|
*/
|
|
12979
12929
|
To: number;
|
|
12980
12930
|
/**
|
|
12981
|
-
*
|
|
12982
|
-
语句由 <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语句
|
|
12983
|
-
使用*或空字符串可查询所有日志
|
|
12931
|
+
* <p>检索分析语句,最大长度为12KB<br>语句由 <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语句<br>使用*或空字符串可查询所有日志</p><p>默认值:空字符串</p>
|
|
12984
12932
|
*/
|
|
12985
|
-
|
|
12933
|
+
QueryString?: string;
|
|
12986
12934
|
/**
|
|
12987
|
-
*
|
|
12988
|
-
- 0:Lucene语法
|
|
12989
|
-
- 1:CQL语法(CLS Query Language,日志服务专用检索语法)
|
|
12990
|
-
|
|
12991
|
-
⚠️⚠️ **注意**
|
|
12992
|
-
**该参数值建议设置为 1,使用 CQL 语法规则,控制台日志检索及仪表盘默认均使用该语法规则。**
|
|
12993
|
-
该参数值未指定或者为 0 时,将使用 Lucene 语法,语法容易报错且查询结果与控制台默认语法规则不一致。详细说明参见<a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules" target="_blank">检索条件语法规则</a>。
|
|
12935
|
+
* <p>检索语法规则,默认值为1,推荐使用1 。</p><ul><li>0:Lucene语法</li><li>1:CQL语法(CLS Query Language,日志服务专用检索语法)</li></ul><p>详细说明参见<a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules" target="_blank">检索条件语法规则</a>。</p><p>默认值:1</p>
|
|
12994
12936
|
*/
|
|
12995
|
-
|
|
12937
|
+
QuerySyntax?: number;
|
|
12996
12938
|
/**
|
|
12997
|
-
*
|
|
12998
|
-
- 如需同时检索多个日志主题,请使用Topics参数。
|
|
12999
|
-
- TopicId 和 Topics 不能同时使用,在一次请求中有且只能选择一个。
|
|
12939
|
+
* <ul><li>要检索分析的日志主题ID,仅能指定一个日志主题。</li><li>如需同时检索多个日志主题,请使用Topics参数。</li><li>TopicId 和 Topics 不能同时使用,在一次请求中有且只能选择一个。</li></ul>
|
|
13000
12940
|
*/
|
|
13001
12941
|
TopicId?: string;
|
|
13002
12942
|
/**
|
|
13003
|
-
*
|
|
13004
|
-
- 检索单个日志主题时请使用TopicId。
|
|
13005
|
-
- TopicId 和 Topics 不能同时使用,在一次请求中有且只能选择一个。
|
|
12943
|
+
* <ul><li>要检索分析的日志主题列表,最大支持50个日志主题。</li><li>检索单个日志主题时请使用TopicId。</li><li>TopicId 和 Topics 不能同时使用,在一次请求中有且只能选择一个。</li></ul>
|
|
13006
12944
|
*/
|
|
13007
12945
|
Topics?: Array<MultiTopicSearchInformation>;
|
|
13008
12946
|
/**
|
|
13009
|
-
*
|
|
13010
|
-
注意:
|
|
13011
|
-
* 仅当检索分析语句(Query)不包含SQL时有效
|
|
13012
|
-
* SQL结果排序方式参考<a href="https://cloud.tencent.com/document/product/614/58978" target="_blank">SQL ORDER BY语法</a>
|
|
12947
|
+
* <p>原始日志是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc<br>注意:</p><ul><li>仅当检索分析语句(Query)不包含SQL时有效</li><li>SQL结果排序方式参考<a href="https://cloud.tencent.com/document/product/614/58978" target="_blank">SQL ORDER BY语法</a></li></ul>
|
|
13013
12948
|
*/
|
|
13014
12949
|
Sort?: string;
|
|
13015
12950
|
/**
|
|
13016
|
-
*
|
|
13017
|
-
注意:
|
|
13018
|
-
* 仅当检索分析语句(Query)不包含SQL时有效
|
|
13019
|
-
* SQL结果条数指定方式参考<a href="https://cloud.tencent.com/document/product/614/58977" target="_blank">SQL LIMIT语法</a>
|
|
13020
|
-
|
|
13021
|
-
可通过两种方式获取后续更多日志:
|
|
13022
|
-
* Context:透传上次接口返回的Context值,获取后续更多日志,总计最多可获取1万条原始日志
|
|
13023
|
-
* Offset:偏移量,表示从第几行开始返回原始日志,无日志条数限制
|
|
12951
|
+
* <p>表示单次查询返回的原始日志条数,默认为100,最大值为1000。<br>注意:</p><ul><li>仅当检索分析语句(Query)不包含SQL时有效</li><li>SQL结果条数指定方式参考<a href="https://cloud.tencent.com/document/product/614/58977" target="_blank">SQL LIMIT语法</a></li></ul><p>可通过两种方式获取后续更多日志:</p><ul><li>Context:透传上次接口返回的Context值,获取后续更多日志,总计最多可获取1万条原始日志</li><li>Offset:偏移量,表示从第几行开始返回原始日志,无日志条数限制</li></ul>
|
|
13024
12952
|
*/
|
|
13025
12953
|
Limit?: number;
|
|
13026
12954
|
/**
|
|
13027
|
-
*
|
|
13028
|
-
注意:
|
|
13029
|
-
* 仅当检索分析语句(Query)不包含SQL时有效
|
|
13030
|
-
* 不能与Context参数同时使用
|
|
13031
|
-
* 仅适用于单日志主题检索
|
|
12955
|
+
* <p>查询原始日志的偏移量,表示从第几行开始返回原始日志,默认为0。<br>注意:</p><ul><li>仅当检索分析语句(Query)不包含SQL时有效</li><li>不能与Context参数同时使用</li><li>仅适用于单日志主题检索</li></ul>
|
|
13032
12956
|
*/
|
|
13033
12957
|
Offset?: number;
|
|
13034
12958
|
/**
|
|
13035
|
-
*
|
|
13036
|
-
注意:
|
|
13037
|
-
* 透传该参数时,请勿修改除该参数外的其它参数
|
|
13038
|
-
* 仅适用于单日志主题检索,检索多个日志主题时,请使用Topics中的Context
|
|
13039
|
-
* 仅当检索分析语句(Query)不包含SQL时有效,SQL获取后续结果参考<a href="https://cloud.tencent.com/document/product/614/58977" target="_blank">SQL LIMIT语法</a>
|
|
12959
|
+
* <p>透传上次接口返回的Context值,可获取后续更多日志,总计最多可获取1万条原始日志,过期时间1小时。<br>注意:</p><ul><li>透传该参数时,请勿修改除该参数外的其它参数</li><li>仅适用于单日志主题检索,检索多个日志主题时,请使用Topics中的Context</li><li>仅当检索分析语句(Query)不包含SQL时有效,SQL获取后续结果参考<a href="https://cloud.tencent.com/document/product/614/58977" target="_blank">SQL LIMIT语法</a></li></ul>
|
|
13040
12960
|
*/
|
|
13041
12961
|
Context?: string;
|
|
13042
12962
|
/**
|
|
13043
|
-
*
|
|
13044
|
-
0:自动采样;
|
|
13045
|
-
0~1:按指定采样率采样,例如0.02;
|
|
13046
|
-
1:不采样,即精确分析
|
|
13047
|
-
默认值为1
|
|
12963
|
+
* <p>执行统计分析(Query中包含SQL)时,是否对原始日志先进行采样,再进行统计分析。<br>0:自动采样;<br>0~1:按指定采样率采样,例如0.02;<br>1:不采样,即精确分析<br>默认值为1</p>
|
|
13048
12964
|
*/
|
|
13049
12965
|
SamplingRate?: number;
|
|
13050
12966
|
/**
|
|
13051
|
-
*
|
|
13052
|
-
为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效
|
|
13053
|
-
两种返回方式在编码格式上有少量区别,建议使用true
|
|
12967
|
+
* <p>为true代表使用新的检索结果返回方式,输出参数AnalysisRecords和Columns有效<br>为false时代表使用老的检索结果返回方式, 输出AnalysisResults和ColNames有效<br>两种返回方式在编码格式上有少量区别,建议使用true</p>
|
|
13054
12968
|
*/
|
|
13055
12969
|
UseNewAnalysis?: boolean;
|
|
13056
12970
|
/**
|
|
13057
|
-
*
|
|
12971
|
+
* <p>是否高亮符合检索条件的关键词,一般用于高亮显示。仅支持键值检索,不支持全文检索</p>
|
|
13058
12972
|
*/
|
|
13059
12973
|
HighLight?: boolean;
|
|
12974
|
+
/**
|
|
12975
|
+
* <p><strong>Query字段已废弃,请使用QueryString字段</strong><br>字段差异:未指定语法规则时,Query默认使用Lucene语法,QueryString默认使用CQL语法,语法差异详见 <a href="https://cloud.tencent.com/document/product/614/47044#RetrievesConditionalRules">语法规则</a></p>
|
|
12976
|
+
* @deprecated
|
|
12977
|
+
*/
|
|
12978
|
+
Query?: string;
|
|
12979
|
+
/**
|
|
12980
|
+
* <p><strong>SyntaxRule字段已废弃,请使用QuerySyntax字段</strong></p><p>字段差异:</p><ul><li>SyntaxRule与Query字段搭配使用,默认使用Lucene语法</li><li>QuerySyntax与QueryString字段搭配使用,默认使用CQL语法</li></ul><p>SyntaxRule参数说明:</p><ul><li>0:Lucene语法</li><li>1:CQL语法(CLS Query Language,日志服务专用检索语法)</li></ul>
|
|
12981
|
+
* @deprecated
|
|
12982
|
+
*/
|
|
12983
|
+
SyntaxRule?: number;
|
|
13060
12984
|
}
|
|
13061
12985
|
/**
|
|
13062
12986
|
* DescribeKafkaConsumerGroupDetail请求参数结构体
|