tencentcloud-sdk-nodejs-waf 4.0.325 → 4.0.328

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.
@@ -15,16 +15,6 @@
15
15
  * under the License.
16
16
  */
17
17
 
18
- /**
19
- * DescribeAccessFastAnalysis返回参数结构体
20
- */
21
- export interface DescribeAccessFastAnalysisResponse {
22
- /**
23
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
24
- */
25
- RequestId?: string
26
- }
27
-
28
18
  /**
29
19
  * CreateAccessExport请求参数结构体
30
20
  */
@@ -65,6 +55,52 @@ export interface CreateAccessExportRequest {
65
55
  Order?: string
66
56
  }
67
57
 
58
+ /**
59
+ * DescribeWafAutoDenyRules返回参数结构体
60
+ */
61
+ export interface DescribeWafAutoDenyRulesResponse {
62
+ /**
63
+ * 攻击次数阈值
64
+ */
65
+ AttackThreshold: number
66
+
67
+ /**
68
+ * 攻击时间阈值
69
+ */
70
+ TimeThreshold: number
71
+
72
+ /**
73
+ * 自动封禁时间
74
+ */
75
+ DenyTimeThreshold: number
76
+
77
+ /**
78
+ * 自动封禁状态
79
+ */
80
+ DefenseStatus: number
81
+
82
+ /**
83
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
84
+ */
85
+ RequestId?: string
86
+ }
87
+
88
+ /**
89
+ * DescribeIpHitItems返回参数结构体
90
+ */
91
+ export interface DescribeIpHitItemsResponse {
92
+ /**
93
+ * 结果
94
+ 注意:此字段可能返回 null,表示取不到有效值。
95
+ */
96
+ Data?: IpHitItemsData
97
+
98
+ /**
99
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
100
+ */
101
+ RequestId?: string
102
+ }
103
+
68
104
  /**
69
105
  * DescribeCustomRules接口回包中的复杂类型
70
106
  */
@@ -120,60 +156,6 @@ export interface DescribeCustomRulesRspRuleListItem {
120
156
  Strategies: Array<Strategy>
121
157
  }
122
158
 
123
- /**
124
- * DescribeAccessIndex
125
- */
126
- export interface AccessFullTextInfo {
127
- /**
128
- * 是否大小写敏感
129
- 注意:此字段可能返回 null,表示取不到有效值。
130
- */
131
- CaseSensitive: boolean
132
-
133
- /**
134
- * 全文索引的分词符,字符串中每个字符代表一个分词符
135
- 注意:此字段可能返回 null,表示取不到有效值。
136
- */
137
- Tokenizer: string
138
-
139
- /**
140
- * 是否包含中文
141
- 注意:此字段可能返回 null,表示取不到有效值。
142
- 注意:此字段可能返回 null,表示取不到有效值。
143
- */
144
- ContainZH: boolean
145
- }
146
-
147
- /**
148
- * ModifyCustomRuleStatus返回参数结构体
149
- */
150
- export interface ModifyCustomRuleStatusResponse {
151
- /**
152
- * 操作的状态码,如果所有的资源操作成功则返回的是成功的状态码,如果有资源操作失败则需要解析Message的内容来查看哪个资源失败
153
- */
154
- Success: ResponseCode
155
-
156
- /**
157
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
158
- */
159
- RequestId?: string
160
- }
161
-
162
- /**
163
- * 响应体的返回码
164
- */
165
- export interface ResponseCode {
166
- /**
167
- * 如果成功则返回Success,失败则返回yunapi定义的错误码
168
- */
169
- Code: string
170
-
171
- /**
172
- * 如果成功则返回Success,失败则返回WAF定义的二级错误码
173
- */
174
- Message: string
175
- }
176
-
177
159
  /**
178
160
  * DescribeUserClbWafRegions返回参数结构体
179
161
  */
@@ -191,40 +173,24 @@ export interface DescribeUserClbWafRegionsResponse {
191
173
  }
192
174
 
193
175
  /**
194
- * DeleteAttackDownloadRecord返回参数结构体
176
+ * 封装参数
195
177
  */
196
- export interface DeleteAttackDownloadRecordResponse {
178
+ export interface IpHitItemsData {
197
179
  /**
198
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
180
+ * 数组封装
199
181
  */
200
- RequestId?: string
201
- }
182
+ Res: Array<IpHitItem>
202
183
 
203
- /**
204
- * ModifyAccessPeriod返回参数结构体
205
- */
206
- export interface ModifyAccessPeriodResponse {
207
184
  /**
208
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
185
+ * 总数目
209
186
  */
210
- RequestId?: string
187
+ TotalCount: number
211
188
  }
212
189
 
213
190
  /**
214
- * DescribeAccessExports返回参数结构体
191
+ * DeleteAttackDownloadRecord返回参数结构体
215
192
  */
216
- export interface DescribeAccessExportsResponse {
217
- /**
218
- * 日志导出ID。
219
- */
220
- TotalCount: number
221
-
222
- /**
223
- * 日志导出列表
224
- 注意:此字段可能返回 null,表示取不到有效值。
225
- */
226
- Exports: Array<ExportAccessInfo>
227
-
193
+ export interface DeleteAttackDownloadRecordResponse {
228
194
  /**
229
195
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
230
196
  */
@@ -251,6 +217,11 @@ export interface DescribeFlowTrendRequest {
251
217
  EndTs: number
252
218
  }
253
219
 
220
+ /**
221
+ * DescribeWafAutoDenyStatus请求参数结构体
222
+ */
223
+ export type DescribeWafAutoDenyStatusRequest = null
224
+
254
225
  /**
255
226
  * 日志KeyValue对数组,用于搜索访问日志
256
227
  */
@@ -263,86 +234,29 @@ export interface AccessLogItems {
263
234
  }
264
235
 
265
236
  /**
266
- * ModifyCustomRuleStatus请求参数结构体
237
+ * AddDomainWhiteRule返回参数结构体
267
238
  */
268
- export interface ModifyCustomRuleStatusRequest {
269
- /**
270
- * 域名
271
- */
272
- Domain: string
273
-
274
- /**
275
- * 规则ID
276
- */
277
- RuleId: number
278
-
239
+ export interface AddDomainWhiteRuleResponse {
279
240
  /**
280
- * 开关的状态,1是开启、0是关闭
241
+ * 规则id
281
242
  */
282
- Status: number
243
+ Id?: number
283
244
 
284
245
  /**
285
- * WAF的版本,clb-waf代表负载均衡WAF、sparta-waf代表SaaS WAF,默认是sparta-waf
246
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
286
247
  */
287
- Edition?: string
288
- }
289
-
290
- /**
291
- * DescribeAccessIndex接口的出参
292
- */
293
- export interface AccessRuleKeyValueInfo {
294
- /**
295
- * 是否大小写敏感
296
- 注意:此字段可能返回 null,表示取不到有效值。
297
- */
298
- CaseSensitive: boolean
299
-
300
- /**
301
- * 需要建立索引的键值对信息;最大只能配置100个键值对
302
- 注意:此字段可能返回 null,表示取不到有效值。
303
- */
304
- KeyValues: Array<AccessKeyValueInfo>
248
+ RequestId?: string
305
249
  }
306
250
 
307
251
  /**
308
- * SearchAccessLog返回参数结构体
252
+ * DescribeIpAccessControl返回参数结构体
309
253
  */
310
- export interface SearchAccessLogResponse {
311
- /**
312
- * 加载后续内容的Context
313
- */
314
- Context: string
315
-
316
- /**
317
- * 日志查询结果是否全部返回
318
- */
319
- ListOver: boolean
320
-
321
- /**
322
- * 返回的是否为分析结果
323
- */
324
- Analysis: boolean
325
-
326
- /**
327
- * 如果Analysis为True,则返回分析结果的列名,否则为空
328
- 注意:此字段可能返回 null,表示取不到有效值。
329
- 注意:此字段可能返回 null,表示取不到有效值。
330
- */
331
- ColNames: Array<string>
332
-
333
- /**
334
- * 日志查询结果;当Analysis为True时,可能返回为null
335
- 注意:此字段可能返回 null,表示取不到有效值
336
- 注意:此字段可能返回 null,表示取不到有效值。
337
- */
338
- Results: Array<AccessLogInfo>
339
-
254
+ export interface DescribeIpAccessControlResponse {
340
255
  /**
341
- * 日志分析结果;当Analysis为False时,可能返回为null
342
- 注意:此字段可能返回 null,表示取不到有效值
256
+ * 输出
343
257
  注意:此字段可能返回 null,表示取不到有效值。
344
258
  */
345
- AnalysisResults: Array<AccessLogItems>
259
+ Data?: IpAccessControlData
346
260
 
347
261
  /**
348
262
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -351,58 +265,38 @@ export interface SearchAccessLogResponse {
351
265
  }
352
266
 
353
267
  /**
354
- * DeleteDownloadRecord返回参数结构体
268
+ * ModifyDomainWhiteRule请求参数结构体
355
269
  */
356
- export interface DeleteDownloadRecordResponse {
270
+ export interface ModifyDomainWhiteRuleRequest {
357
271
  /**
358
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
272
+ * 需要更改的规则的域名
359
273
  */
360
- RequestId?: string
361
- }
274
+ Domain: string
362
275
 
363
- /**
364
- * DeleteAccessExport请求参数结构体
365
- */
366
- export interface DeleteAccessExportRequest {
367
276
  /**
368
- * 日志导出ID
277
+ * 白名单id
369
278
  */
370
- ExportId: string
279
+ Id: number
371
280
 
372
281
  /**
373
- * 日志主题
282
+ * 规则的id列表
374
283
  */
375
- TopicId: string
376
- }
284
+ Rules: Array<number>
377
285
 
378
- /**
379
- * ModifyAccessPeriod请求参数结构体
380
- */
381
- export interface ModifyAccessPeriodRequest {
382
286
  /**
383
- * 访问日志保存期限,范围为[1, 30]
287
+ * 规则匹配路径
384
288
  */
385
- Period: number
289
+ Url: string
386
290
 
387
291
  /**
388
- * 日志主题
292
+ * 规则匹配方法
389
293
  */
390
- TopicId: string
391
- }
392
-
393
- /**
394
- * DescribeUserClbWafRegions请求参数结构体
395
- */
396
- export type DescribeUserClbWafRegionsRequest = null
294
+ Function: string
397
295
 
398
- /**
399
- * DeleteAttackDownloadRecord请求参数结构体
400
- */
401
- export interface DeleteAttackDownloadRecordRequest {
402
296
  /**
403
- * 下载任务记录唯一标记
297
+ * 规则的开关状态
404
298
  */
405
- Id: number
299
+ Status: number
406
300
  }
407
301
 
408
302
  /**
@@ -428,100 +322,96 @@ export interface AccessRuleTagInfo {
428
322
  export type DescribeAccessIndexRequest = null
429
323
 
430
324
  /**
431
- * DescribeAccessIndex接口的出参数
325
+ * 日志KeyValue对
432
326
  */
433
- export interface AccessRuleInfo {
434
- /**
435
- * 全文索引配置
436
- 注意:此字段可能返回 null,表示取不到有效值。
437
- 注意:此字段可能返回 null,表示取不到有效值。
438
- */
439
- FullText: AccessFullTextInfo
440
-
327
+ export interface AccessLogItem {
441
328
  /**
442
- * 键值索引配置
443
- 注意:此字段可能返回 null,表示取不到有效值。
329
+ * 日记Key
444
330
  注意:此字段可能返回 null,表示取不到有效值。
445
331
  */
446
- KeyValue: AccessRuleKeyValueInfo
332
+ Key: string
447
333
 
448
334
  /**
449
- * 元字段索引配置
450
- 注意:此字段可能返回 null,表示取不到有效值。
335
+ * 日志Value
451
336
  注意:此字段可能返回 null,表示取不到有效值。
452
337
  */
453
- Tag: AccessRuleTagInfo
338
+ Value: string
454
339
  }
455
340
 
456
341
  /**
457
- * DescribeAccessFastAnalysis请求参数结构体
342
+ * DescribeCustomRules返回参数结构体
458
343
  */
459
- export interface DescribeAccessFastAnalysisRequest {
344
+ export interface DescribeCustomRulesResponse {
460
345
  /**
461
- * 客户要查询的日志主题ID,每个客户都有对应的一个主题
346
+ * 规则详情
462
347
  */
463
- TopicId: string
348
+ RuleList: Array<DescribeCustomRulesRspRuleListItem>
464
349
 
465
350
  /**
466
- * 要查询的日志的起始时间,Unix时间戳,单位ms
351
+ * 规则条数
467
352
  */
468
- From: number
353
+ TotalCount: string
469
354
 
470
355
  /**
471
- * 要查询的日志的结束时间,Unix时间戳,单位ms
356
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
472
357
  */
473
- To: number
358
+ RequestId?: string
359
+ }
474
360
 
361
+ /**
362
+ * DeleteSession请求参数结构体
363
+ */
364
+ export interface DeleteSessionRequest {
475
365
  /**
476
- * 查询语句,语句长度最大为4096,由于本接口是分析接口,如果无过滤条件,必须传 * 表示匹配所有,参考CLS的分析统计语句的文档
366
+ * 域名
477
367
  */
478
- Query: string
368
+ Domain: string
479
369
 
480
370
  /**
481
- * 需要分析统计的字段名
371
+ * clb-waf 或者 sprta-waf
482
372
  */
483
- FieldName: string
373
+ Edition?: string
484
374
  }
485
375
 
486
376
  /**
487
- * 用于DescribeAccessIndex接口的出参
377
+ * DescribeWafAutoDenyRules请求参数结构体
488
378
  */
489
- export interface AccessValueInfo {
379
+ export interface DescribeWafAutoDenyRulesRequest {
490
380
  /**
491
- * 字段类型,目前支持的类型有:long、text、double
492
- 注意:此字段可能返回 null,表示取不到有效值。
493
- */
494
- Type: string
381
+ * 域名
382
+ */
383
+ Domain: string
384
+ }
495
385
 
386
+ /**
387
+ * AddCustomRule返回参数结构体
388
+ */
389
+ export interface AddCustomRuleResponse {
496
390
  /**
497
- * 字段的分词符,只有当字段类型为text时才有意义;输入字符串中的每个字符代表一个分词符
498
- 注意:此字段可能返回 null,表示取不到有效值。
499
- */
500
- Tokenizer: string
391
+ * 操作的状态码,如果所有的资源操作成功则返回的是成功的状态码,如果有资源操作失败则需要解析Message的内容来查看哪个资源失败
392
+ */
393
+ Success: ResponseCode
501
394
 
502
395
  /**
503
- * 字段是否开启分析功能
396
+ * 添加成功的规则ID
504
397
  注意:此字段可能返回 null,表示取不到有效值。
505
398
  */
506
- SqlFlag: boolean
399
+ RuleId: number
507
400
 
508
401
  /**
509
- * 是否包含中文
510
- 注意:此字段可能返回 null,表示取不到有效值。
511
- 注意:此字段可能返回 null,表示取不到有效值。
512
- */
513
- ContainZH: boolean
402
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
403
+ */
404
+ RequestId?: string
514
405
  }
515
406
 
516
407
  /**
517
- * DeleteSession返回参数结构体
408
+ * DescribeFlowTrend返回参数结构体
518
409
  */
519
- export interface DeleteSessionResponse {
410
+ export interface DescribeFlowTrendResponse {
520
411
  /**
521
- * 结果
522
- 注意:此字段可能返回 null,表示取不到有效值。
523
- */
524
- Data: string
412
+ * 流量趋势数据
413
+ */
414
+ Data: Array<BotStatPointItem>
525
415
 
526
416
  /**
527
417
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -530,89 +420,83 @@ export interface DeleteSessionResponse {
530
420
  }
531
421
 
532
422
  /**
533
- * 日志KeyValue对
423
+ * UpsertIpAccessControl请求参数结构体
534
424
  */
535
- export interface AccessLogItem {
425
+ export interface UpsertIpAccessControlRequest {
536
426
  /**
537
- * 日记Key
538
- 注意:此字段可能返回 null,表示取不到有效值。
539
- */
540
- Key: string
427
+ * 域名
428
+ */
429
+ Domain: string
541
430
 
542
431
  /**
543
- * 日志Value
544
- 注意:此字段可能返回 null,表示取不到有效值。
545
- */
546
- Value: string
432
+ * ip 参数列表,json数组由ip,source,note,action,valid_ts组成。ip对应配置的ip地址,source固定为custom值,note为注释,action值42为黑名单,40为白名单,valid_ts为有效日期,值为秒级时间戳
433
+ */
434
+ Items: Array<string>
435
+
436
+ /**
437
+ * clb-waf或者sparta-waf
438
+ */
439
+ Edition?: string
547
440
  }
548
441
 
549
442
  /**
550
- * 单条日志数据描述
443
+ * DescribeCustomRules接口的翻页参数
551
444
  */
552
- export interface AccessLogInfo {
553
- /**
554
- * 日志时间,单位ms
555
- 注意:此字段可能返回 null,表示取不到有效值。
556
- */
557
- Time: number
558
-
445
+ export interface DescribeCustomRulesPagingInfo {
559
446
  /**
560
- * 日志主题ID
561
- 注意:此字段可能返回 null,表示取不到有效值。
562
- */
563
- TopicId: string
447
+ * 当前页码
448
+ */
449
+ Offset: number
564
450
 
565
451
  /**
566
- * 日志主题名称
567
- 注意:此字段可能返回 null,表示取不到有效值。
568
- */
569
- TopicName: string
452
+ * 当前页的最大数据条数
453
+ */
454
+ Limit: number
455
+ }
570
456
 
457
+ /**
458
+ * DeleteDownloadRecord请求参数结构体
459
+ */
460
+ export interface DeleteDownloadRecordRequest {
571
461
  /**
572
- * 日志来源IP
573
- 注意:此字段可能返回 null,表示取不到有效值。
574
- */
575
- Source: string
462
+ * 记录id
463
+ */
464
+ Flow: string
465
+ }
576
466
 
467
+ /**
468
+ * 规则白名单
469
+ */
470
+ export interface RuleList {
577
471
  /**
578
- * 日志文件名称
579
- 注意:此字段可能返回 null,表示取不到有效值。
580
- */
581
- FileName: string
472
+ * 规则Id
473
+ */
474
+ Id: number
582
475
 
583
476
  /**
584
- * 日志上报请求包的ID
585
- 注意:此字段可能返回 null,表示取不到有效值。
586
- */
587
- PkgId: string
477
+ * 规则列表的id
478
+ */
479
+ Rules: Array<number>
588
480
 
589
481
  /**
590
- * 请求包内日志的ID
591
- 注意:此字段可能返回 null,表示取不到有效值。
592
- */
593
- PkgLogId: string
482
+ * 请求url
483
+ */
484
+ Url: string
594
485
 
595
486
  /**
596
- * 日志内容的Json序列化字符串
597
- 注意:此字段可能返回 null,表示取不到有效值。
598
- 注意:此字段可能返回 null,表示取不到有效值。
599
- */
600
- LogJson: string
601
- }
487
+ * 请求的方法
488
+ */
489
+ Function: string
602
490
 
603
- /**
604
- * DeleteSession请求参数结构体
605
- */
606
- export interface DeleteSessionRequest {
607
491
  /**
608
- * 域名
492
+ * 时间戳
609
493
  */
610
- Domain: string
494
+ Time: string
611
495
 
612
496
  /**
613
- * clb-waf 或者 sprta-waf
497
+ * 开关状态
614
498
  */
615
- Edition?: string
499
+ Status: number
616
500
  }
617
501
 
618
502
  /**
@@ -636,26 +520,24 @@ export interface DescribeAccessExportsRequest {
636
520
  }
637
521
 
638
522
  /**
639
- * DescribeAccessIndex返回参数结构体
523
+ * 响应体的返回码
640
524
  */
641
- export interface DescribeAccessIndexResponse {
525
+ export interface ResponseCode {
642
526
  /**
643
- * 是否生效
527
+ * 如果成功则返回Success,失败则返回yunapi定义的错误码
644
528
  */
645
- Status: boolean
646
-
647
- /**
648
- * 索引配置信息
649
- 注意:此字段可能返回 null,表示取不到有效值。
650
- 注意:此字段可能返回 null,表示取不到有效值。
651
- */
652
- Rule: AccessRuleInfo
529
+ Code: string
653
530
 
654
531
  /**
655
- * 索引修改时间,初始值为索引创建时间。
532
+ * 如果成功则返回Success,失败则返回WAF定义的二级错误码
656
533
  */
657
- ModifyTime: string
534
+ Message: string
535
+ }
658
536
 
537
+ /**
538
+ * ModifyAccessPeriod返回参数结构体
539
+ */
540
+ export interface ModifyAccessPeriodResponse {
659
541
  /**
660
542
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
661
543
  */
@@ -663,14 +545,9 @@ export interface DescribeAccessIndexResponse {
663
545
  }
664
546
 
665
547
  /**
666
- * CreateAttackDownloadTask返回参数结构体
548
+ * DeleteAccessExport返回参数结构体
667
549
  */
668
- export interface CreateAttackDownloadTaskResponse {
669
- /**
670
- * 任务ID
671
- */
672
- Flow: string
673
-
550
+ export interface DeleteAccessExportResponse {
674
551
  /**
675
552
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
676
553
  */
@@ -678,13 +555,13 @@ export interface CreateAttackDownloadTaskResponse {
678
555
  }
679
556
 
680
557
  /**
681
- * CreateAccessExport返回参数结构体
558
+ * DescribeAutoDenyIP返回参数结构体
682
559
  */
683
- export interface CreateAccessExportResponse {
560
+ export interface DescribeAutoDenyIPResponse {
684
561
  /**
685
- * 日志导出ID。
562
+ * 查询IP封禁状态返回结果
686
563
  */
687
- ExportId: string
564
+ Data?: IpHitItemsData
688
565
 
689
566
  /**
690
567
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -693,308 +570,397 @@ export interface CreateAccessExportResponse {
693
570
  }
694
571
 
695
572
  /**
696
- * AddCustomRule返回参数结构体
573
+ * SearchAccessLog返回参数结构体
697
574
  */
698
- export interface AddCustomRuleResponse {
575
+ export interface SearchAccessLogResponse {
699
576
  /**
700
- * 操作的状态码,如果所有的资源操作成功则返回的是成功的状态码,如果有资源操作失败则需要解析Message的内容来查看哪个资源失败
577
+ * 加载后续内容的Context
701
578
  */
702
- Success: ResponseCode
579
+ Context: string
703
580
 
704
581
  /**
705
- * 添加成功的规则ID
706
- 注意:此字段可能返回 null,表示取不到有效值。
707
- */
708
- RuleId: number
582
+ * 日志查询结果是否全部返回
583
+ */
584
+ ListOver: boolean
709
585
 
710
586
  /**
711
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
587
+ * 返回的是否为分析结果
712
588
  */
713
- RequestId?: string
714
- }
589
+ Analysis: boolean
715
590
 
716
- /**
717
- * 用于 DescribeAccessIndex 的出参
718
- */
719
- export interface AccessKeyValueInfo {
720
591
  /**
721
- * 需要配置键值或者元字段索引的字段
592
+ * 如果Analysis为True,则返回分析结果的列名,否则为空
593
+ 注意:此字段可能返回 null,表示取不到有效值。
722
594
  注意:此字段可能返回 null,表示取不到有效值。
723
595
  */
724
- Key: string
596
+ ColNames: Array<string>
725
597
 
726
598
  /**
727
- * 字段的索引描述信息
599
+ * 日志查询结果;当Analysis为True时,可能返回为null
600
+ 注意:此字段可能返回 null,表示取不到有效值
728
601
  注意:此字段可能返回 null,表示取不到有效值。
729
602
  */
730
- Value: AccessValueInfo
603
+ Results: Array<AccessLogInfo>
604
+
605
+ /**
606
+ * 日志分析结果;当Analysis为False时,可能返回为null
607
+ 注意:此字段可能返回 null,表示取不到有效值
608
+ 注意:此字段可能返回 null,表示取不到有效值。
609
+ */
610
+ AnalysisResults: Array<AccessLogItems>
611
+
612
+ /**
613
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
614
+ */
615
+ RequestId?: string
731
616
  }
732
617
 
733
618
  /**
734
- * bot的趋势图对象
619
+ * ip黑白名单
735
620
  */
736
- export interface BotStatPointItem {
621
+ export interface IpAccessControlItem {
737
622
  /**
738
- * 横坐标
623
+ * 动作
739
624
  */
740
- TimeStamp: string
625
+ ActionType: number
741
626
 
742
627
  /**
743
- * value的所属对象
628
+ * ip
744
629
  */
745
- Key: string
630
+ Ip: string
746
631
 
747
632
  /**
748
- * 纵列表
633
+ * 备注
749
634
  */
750
- Value: number
635
+ Note: string
751
636
 
752
637
  /**
753
- * Key对应的页面展示内容
638
+ * 来源
754
639
  */
755
- Label: string
756
- }
640
+ Source: string
641
+
642
+ /**
643
+ * 更新时间戳
644
+ 注意:此字段可能返回 null,表示取不到有效值。
645
+ */
646
+ TsVersion: number
647
+
648
+ /**
649
+ * 有效截止时间戳
650
+ */
651
+ ValidTs: number
652
+ }
757
653
 
758
654
  /**
759
- * AddCustomRule请求参数结构体
655
+ * DescribeAutoDenyIP请求参数结构体
760
656
  */
761
- export interface AddCustomRuleRequest {
657
+ export interface DescribeAutoDenyIPRequest {
762
658
  /**
763
- * 规则名称
659
+ * 域名
764
660
  */
765
- Name: string
661
+ Domain: string
766
662
 
767
663
  /**
768
- * 优先级
664
+ * 查询IP自动封禁状态
769
665
  */
770
- SortId: string
666
+ Ip?: string
771
667
 
772
668
  /**
773
- * 过期时间
669
+ * 计数标识
774
670
  */
775
- ExpireTime: string
671
+ Count?: number
776
672
 
777
673
  /**
778
- * 策略详情
674
+ * 类别
779
675
  */
780
- Strategies: Array<Strategy>
676
+ Category?: string
781
677
 
782
678
  /**
783
- * 需要添加策略的域名
679
+ * 有效时间最小时间戳
784
680
  */
785
- Domain: string
681
+ VtsMin?: number
786
682
 
787
683
  /**
788
- * 动作类型
684
+ * 有效时间最大时间戳
789
685
  */
790
- ActionType: string
686
+ VtsMax?: number
791
687
 
792
688
  /**
793
- * 如果动作是重定向,则表示重定向的地址;其他情况可以为空
689
+ * 创建时间最小时间戳
794
690
  */
795
- Redirect?: string
691
+ CtsMin?: number
796
692
 
797
693
  /**
798
- * "clb-waf"或者"sparta-waf"
694
+ * 创建时间最大时间戳
799
695
  */
800
- Edition?: string
696
+ CtsMax?: number
801
697
 
802
698
  /**
803
- * 放行的详情
699
+ * 偏移量
804
700
  */
805
- Bypass?: string
806
- }
701
+ Skip?: number
807
702
 
808
- /**
809
- * DescribeCustomRules返回参数结构体
810
- */
811
- export interface DescribeCustomRulesResponse {
812
703
  /**
813
- * 规则详情
704
+ * 限制条数
814
705
  */
815
- RuleList: Array<DescribeCustomRulesRspRuleListItem>
706
+ Limit?: number
816
707
 
817
708
  /**
818
- * 规则条数
709
+ * 策略名字
819
710
  */
820
- TotalCount: string
711
+ Name?: string
821
712
 
822
713
  /**
823
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
714
+ * 排序参数
824
715
  */
825
- RequestId?: string
716
+ Sort?: string
826
717
  }
827
718
 
828
719
  /**
829
- * DescribeFlowTrend返回参数结构体
720
+ * DescribeIpAccessControl请求参数结构体
830
721
  */
831
- export interface DescribeFlowTrendResponse {
722
+ export interface DescribeIpAccessControlRequest {
832
723
  /**
833
- * 流量趋势数据
724
+ * 域名
834
725
  */
835
- Data: Array<BotStatPointItem>
726
+ Domain: string
836
727
 
837
728
  /**
838
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
729
+ * 计数标识
839
730
  */
840
- RequestId?: string
841
- }
731
+ Count: number
842
732
 
843
- /**
844
- * 自定义规则的匹配条件结构体
845
- */
846
- export interface Strategy {
847
733
  /**
848
- * 匹配字段
734
+ * 动作
849
735
  */
850
- Field: string
736
+ ActionType?: number
851
737
 
852
738
  /**
853
- * 逻辑符号
739
+ * 有效时间最小时间戳
854
740
  */
855
- CompareFunc: string
741
+ VtsMin?: number
856
742
 
857
743
  /**
858
- * 匹配内容
744
+ * 有效时间最大时间戳
859
745
  */
860
- Content: string
746
+ VtsMax?: number
861
747
 
862
748
  /**
863
- * 匹配参数
749
+ * 创建时间最小时间戳
864
750
  */
865
- Arg: string
751
+ CtsMin?: number
752
+
753
+ /**
754
+ * 创建时间最大时间戳
755
+ */
756
+ CtsMax?: number
757
+
758
+ /**
759
+ * 偏移
760
+ */
761
+ OffSet?: number
762
+
763
+ /**
764
+ * 限制
765
+ */
766
+ Limit?: number
767
+
768
+ /**
769
+ * 来源
770
+ */
771
+ Source?: string
772
+
773
+ /**
774
+ * 排序参数
775
+ */
776
+ Sort?: string
777
+
778
+ /**
779
+ * ip
780
+ */
781
+ Ip?: string
866
782
  }
867
783
 
868
784
  /**
869
- * DescribeCustomRules请求参数结构体
785
+ * AddSpartaProtection请求参数结构体
870
786
  */
871
- export interface DescribeCustomRulesRequest {
787
+ export interface AddSpartaProtectionRequest {
872
788
  /**
873
- * 域名
789
+ * 需要防御的域名
874
790
  */
875
791
  Domain: string
876
792
 
877
793
  /**
878
- * 分页参数
794
+ * 证书类型,0表示没有证书,CertType=1表示自有证书,2 为托管证书
879
795
  */
880
- Paging: DescribeCustomRulesPagingInfo
796
+ CertType: number
881
797
 
882
798
  /**
883
- * clb-waf或者sparta-waf
799
+ * 表示是否开启了CDN代理,1:有部署CDN,0:未部署CDN
884
800
  */
885
- Edition?: string
801
+ IsCdn: number
886
802
 
887
803
  /**
888
- * 过滤参数:动作类型:0放行,1阻断,2人机识别,3观察,4重定向
804
+ * 回源类型,0表示通过IP回源,1 表示通过域名回源
889
805
  */
890
- ActionType?: string
806
+ UpstreamType: number
891
807
 
892
808
  /**
893
- * 过滤参数:规则名称过滤条件
809
+ * 是否开启WebSocket支持,1表示开启,0不开启
894
810
  */
895
- Search?: string
896
- }
811
+ IsWebsocket: number
897
812
 
898
- /**
899
- * DescribeCustomRules接口的翻页参数
900
- */
901
- export interface DescribeCustomRulesPagingInfo {
902
813
  /**
903
- * 当前页码
814
+ * 负载均衡策略,0表示轮徇,1表示IP hash
904
815
  */
905
- Offset: number
816
+ LoadBalance: string
906
817
 
907
818
  /**
908
- * 当前页的最大数据条数
819
+ * CertType=1时,需要填次参数,表示证书内容
909
820
  */
910
- Limit: number
911
- }
821
+ Cert?: string
912
822
 
913
- /**
914
- * DeleteDownloadRecord请求参数结构体
915
- */
916
- export interface DeleteDownloadRecordRequest {
917
823
  /**
918
- * 记录id
824
+ * CertType=1时,需要填次参数,表示证书的私钥
919
825
  */
920
- Flow: string
921
- }
826
+ PrivateKey?: string
922
827
 
923
- /**
924
- * DescribeAccessExports接口
925
- */
926
- export interface ExportAccessInfo {
927
828
  /**
928
- * 日志导出任务ID
929
- 注意:此字段可能返回 null,表示取不到有效值。
930
- */
931
- ExportId: string
829
+ * CertType=2时,需要填次参数,表示证书的ID
830
+ */
831
+ SSLId?: string
932
832
 
933
833
  /**
934
- * 日志导出查询语句
935
- 注意:此字段可能返回 null,表示取不到有效值。
936
- */
937
- Query: string
834
+ * Waf的资源ID
835
+ */
836
+ ResourceId?: string
938
837
 
939
838
  /**
940
- * 日志导出文件名
941
- 注意:此字段可能返回 null,表示取不到有效值。
942
- */
943
- FileName: string
839
+ * HTTPS回源协议,填http或者https
840
+ */
841
+ UpstreamScheme?: string
944
842
 
945
843
  /**
946
- * 日志文件大小
844
+ * HTTPS回源端口,仅UpstreamScheme为http时需要填当前字段
947
845
  */
948
- FileSize: number
846
+ HttpsUpstreamPort?: string
949
847
 
950
848
  /**
951
- * 日志导出时间排序
952
- 注意:此字段可能返回 null,表示取不到有效值。
953
- */
954
- Order: string
849
+ * 是否开启灰度,0表示不开启灰度
850
+ */
851
+ IsGray?: number
955
852
 
956
853
  /**
957
- * 日志导出格式
958
- 注意:此字段可能返回 null,表示取不到有效值。
959
- */
960
- Format: string
854
+ * 灰度的地区
855
+ */
856
+ GrayAreas?: Array<string>
961
857
 
962
858
  /**
963
- * 日志导出数量
964
- 注意:此字段可能返回 null,表示取不到有效值。
965
- */
966
- Count: number
859
+ * UpstreamType=1时,填次字段表示回源域名
860
+ */
861
+ UpstreamDomain?: string
967
862
 
968
863
  /**
969
- * 日志下载状态。Processing:导出正在进行中,Complete:导出完成,Failed:导出失败,Expired:日志导出已过期(三天有效期)
864
+ * UpstreamType=0时,填次字段表示回源ip
970
865
  */
971
- Status: string
866
+ SrcList?: Array<string>
972
867
 
973
868
  /**
974
- * 日志导出起始时间
869
+ * 是否开启HTTP2,开启HTTP2需要HTTPS支持
870
+ */
871
+ IsHttp2?: number
872
+
873
+ /**
874
+ * 表示是否强制跳转到HTTPS,1强制跳转Https,0不强制跳转
875
+ */
876
+ HttpsRewrite?: number
877
+
878
+ /**
879
+ * 服务有多端口需要设置此字段
880
+ */
881
+ Ports?: Array<PortItem>
882
+
883
+ /**
884
+ * 版本:sparta-waf、clb-waf、cdn-waf
885
+ */
886
+ Edition?: string
887
+
888
+ /**
889
+ * 是否开启长连接,仅IP回源时可以用填次参数,域名回源时这个参数无效
890
+ */
891
+ IsKeepAlive?: string
892
+
893
+ /**
894
+ * 实例id,上线之后带上此字段
895
+ */
896
+ InstanceID?: string
897
+
898
+ /**
899
+ * anycast ip类型开关: 0 普通ip 1 Anycast ip
900
+ */
901
+ Anycast?: number
902
+ }
903
+
904
+ /**
905
+ * DescribeAccessFastAnalysis请求参数结构体
906
+ */
907
+ export interface DescribeAccessFastAnalysisRequest {
908
+ /**
909
+ * 客户要查询的日志主题ID,每个客户都有对应的一个主题
910
+ */
911
+ TopicId: string
912
+
913
+ /**
914
+ * 要查询的日志的起始时间,Unix时间戳,单位ms
975
915
  */
976
916
  From: number
977
917
 
978
918
  /**
979
- * 日志导出结束时间
919
+ * 要查询的日志的结束时间,Unix时间戳,单位ms
980
920
  */
981
921
  To: number
982
922
 
983
923
  /**
984
- * 日志导出路径
924
+ * 查询语句,语句长度最大为4096,由于本接口是分析接口,如果无过滤条件,必须传 * 表示匹配所有,参考CLS的分析统计语句的文档
985
925
  */
986
- CosPath: string
926
+ Query: string
987
927
 
988
928
  /**
989
- * 日志导出创建时间
929
+ * 需要分析统计的字段名
990
930
  */
991
- CreateTime: string
931
+ FieldName: string
992
932
  }
993
933
 
994
934
  /**
995
- * DeleteAccessExport返回参数结构体
935
+ * DeleteIpAccessControl请求参数结构体
996
936
  */
997
- export interface DeleteAccessExportResponse {
937
+ export interface DeleteIpAccessControlRequest {
938
+ /**
939
+ * 域名
940
+ */
941
+ Domain: string
942
+
943
+ /**
944
+ * 删除的ip数组
945
+ */
946
+ Items: Array<string>
947
+
948
+ /**
949
+ * 删除对应的域名下的所有黑/白IP名额单
950
+ */
951
+ DeleteAll?: boolean
952
+ }
953
+
954
+ /**
955
+ * DeleteDomainWhiteRules返回参数结构体
956
+ */
957
+ export interface DeleteDomainWhiteRulesResponse {
958
+ /**
959
+ * 出参
960
+ 注意:此字段可能返回 null,表示取不到有效值。
961
+ */
962
+ Data?: string
963
+
998
964
  /**
999
965
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1000
966
  */
@@ -1052,41 +1018,1105 @@ export interface CreateAttackDownloadTaskRequest {
1052
1018
  }
1053
1019
 
1054
1020
  /**
1055
- * SearchAccessLog请求参数结构体
1021
+ * DescribeWafAutoDenyStatus返回参数结构体
1056
1022
  */
1057
- export interface SearchAccessLogRequest {
1023
+ export interface DescribeWafAutoDenyStatusResponse {
1058
1024
  /**
1059
- * 客户要查询的日志主题ID,每个客户都有对应的一个主题
1025
+ * WAF 自动封禁详情
1060
1026
  */
1061
- TopicId: string
1027
+ WafAutoDenyDetails?: AutoDenyDetail
1062
1028
 
1063
1029
  /**
1064
- * 要查询的日志的起始时间,Unix时间戳,单位ms
1030
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1065
1031
  */
1066
- From: number
1032
+ RequestId?: string
1033
+ }
1067
1034
 
1035
+ /**
1036
+ * DeleteDomainWhiteRules请求参数结构体
1037
+ */
1038
+ export interface DeleteDomainWhiteRulesRequest {
1068
1039
  /**
1069
- * 要查询的日志的结束时间,Unix时间戳,单位ms
1040
+ * 需要删除的规则域名
1070
1041
  */
1071
- To: number
1042
+ Domain: string
1072
1043
 
1073
1044
  /**
1074
- * 查询语句,语句长度最大为4096
1045
+ * 需要删除的白名单规则
1075
1046
  */
1076
- Query: string
1047
+ Ids: Array<number>
1048
+ }
1077
1049
 
1050
+ /**
1051
+ * ModifyCustomRuleStatus返回参数结构体
1052
+ */
1053
+ export interface ModifyCustomRuleStatusResponse {
1078
1054
  /**
1079
- * 单次查询返回的日志条数,最大值为100
1055
+ * 操作的状态码,如果所有的资源操作成功则返回的是成功的状态码,如果有资源操作失败则需要解析Message的内容来查看哪个资源失败
1080
1056
  */
1081
- Limit?: number
1057
+ Success: ResponseCode
1082
1058
 
1083
1059
  /**
1084
- * 加载更多日志时使用,透传上次返回的Context值,获取后续的日志内容
1060
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1085
1061
  */
1086
- Context?: string
1062
+ RequestId?: string
1063
+ }
1087
1064
 
1065
+ /**
1066
+ * AddSpartaProtection返回参数结构体
1067
+ */
1068
+ export interface AddSpartaProtectionResponse {
1088
1069
  /**
1089
- * 日志接口是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc
1070
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1090
1071
  */
1091
- Sort?: string
1072
+ RequestId?: string
1073
+ }
1074
+
1075
+ /**
1076
+ * 数据封装
1077
+ */
1078
+ export interface IpAccessControlData {
1079
+ /**
1080
+ * ip黑白名单
1081
+ 注意:此字段可能返回 null,表示取不到有效值。
1082
+ */
1083
+ Res: Array<IpAccessControlItem>
1084
+
1085
+ /**
1086
+ * 计数
1087
+ */
1088
+ TotalCount: number
1089
+ }
1090
+
1091
+ /**
1092
+ * 防护域名端口配置信息
1093
+ */
1094
+ export interface PortItem {
1095
+ /**
1096
+ * 监听端口配置
1097
+ */
1098
+ Port: string
1099
+
1100
+ /**
1101
+ * 与Port一一对应,表示端口对应的协议
1102
+ */
1103
+ Protocol: string
1104
+
1105
+ /**
1106
+ * 与Port一一对应, 表示回源端口
1107
+ */
1108
+ UpstreamPort: string
1109
+
1110
+ /**
1111
+ * 与Port一一对应, 表示回源协议
1112
+ */
1113
+ UpstreamProtocol: string
1114
+
1115
+ /**
1116
+ * Nginx的服务器ID
1117
+ */
1118
+ NginxServerId: string
1119
+ }
1120
+
1121
+ /**
1122
+ * CreateAttackDownloadTask返回参数结构体
1123
+ */
1124
+ export interface CreateAttackDownloadTaskResponse {
1125
+ /**
1126
+ * 任务ID
1127
+ */
1128
+ Flow: string
1129
+
1130
+ /**
1131
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1132
+ */
1133
+ RequestId?: string
1134
+ }
1135
+
1136
+ /**
1137
+ * Waf 威胁情报封禁模块配置详情
1138
+ */
1139
+ export interface WafThreatenIntelligenceDetails {
1140
+ /**
1141
+ * 封禁模组启用状态
1142
+ */
1143
+ DefenseStatus: number
1144
+
1145
+ /**
1146
+ * 封禁属性标签
1147
+ 注意:此字段可能返回 null,表示取不到有效值。
1148
+ */
1149
+ Tags?: Array<string>
1150
+
1151
+ /**
1152
+ * 最后更新时间
1153
+ */
1154
+ LastUpdateTime?: string
1155
+ }
1156
+
1157
+ /**
1158
+ * DescribeDomainWhiteRules请求参数结构体
1159
+ */
1160
+ export interface DescribeDomainWhiteRulesRequest {
1161
+ /**
1162
+ * 需要查询的域名
1163
+ */
1164
+ Domain: string
1165
+
1166
+ /**
1167
+ * 请求的白名单匹配路径
1168
+ */
1169
+ Url?: string
1170
+
1171
+ /**
1172
+ * 翻到多少页
1173
+ */
1174
+ Page?: number
1175
+
1176
+ /**
1177
+ * 每页展示的条数
1178
+ */
1179
+ Count?: number
1180
+
1181
+ /**
1182
+ * 排序方式
1183
+ */
1184
+ Sort?: string
1185
+
1186
+ /**
1187
+ * 规则ID
1188
+ */
1189
+ RuleId?: string
1190
+ }
1191
+
1192
+ /**
1193
+ * ModifyCustomRuleStatus请求参数结构体
1194
+ */
1195
+ export interface ModifyCustomRuleStatusRequest {
1196
+ /**
1197
+ * 域名
1198
+ */
1199
+ Domain: string
1200
+
1201
+ /**
1202
+ * 规则ID
1203
+ */
1204
+ RuleId: number
1205
+
1206
+ /**
1207
+ * 开关的状态,1是开启、0是关闭
1208
+ */
1209
+ Status: number
1210
+
1211
+ /**
1212
+ * WAF的版本,clb-waf代表负载均衡WAF、sparta-waf代表SaaS WAF,默认是sparta-waf。
1213
+ */
1214
+ Edition?: string
1215
+ }
1216
+
1217
+ /**
1218
+ * DeleteDownloadRecord返回参数结构体
1219
+ */
1220
+ export interface DeleteDownloadRecordResponse {
1221
+ /**
1222
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1223
+ */
1224
+ RequestId?: string
1225
+ }
1226
+
1227
+ /**
1228
+ * ModifyAccessPeriod请求参数结构体
1229
+ */
1230
+ export interface ModifyAccessPeriodRequest {
1231
+ /**
1232
+ * 访问日志保存期限,范围为[1, 30]
1233
+ */
1234
+ Period: number
1235
+
1236
+ /**
1237
+ * 日志主题
1238
+ */
1239
+ TopicId: string
1240
+ }
1241
+
1242
+ /**
1243
+ * ModifyWafAutoDenyRules返回参数结构体
1244
+ */
1245
+ export interface ModifyWafAutoDenyRulesResponse {
1246
+ /**
1247
+ * 成功的状态码,需要JSON解码后再使用,返回的格式是{"域名":"状态"},成功的状态码为Success,其它的为失败的状态码(yunapi定义的错误码)
1248
+ */
1249
+ Success: ResponseCode
1250
+
1251
+ /**
1252
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1253
+ */
1254
+ RequestId?: string
1255
+ }
1256
+
1257
+ /**
1258
+ * 用于DescribeAccessIndex接口的出参
1259
+ */
1260
+ export interface AccessValueInfo {
1261
+ /**
1262
+ * 字段类型,目前支持的类型有:long、text、double
1263
+ 注意:此字段可能返回 null,表示取不到有效值。
1264
+ */
1265
+ Type: string
1266
+
1267
+ /**
1268
+ * 字段的分词符,只有当字段类型为text时才有意义;输入字符串中的每个字符代表一个分词符
1269
+ 注意:此字段可能返回 null,表示取不到有效值。
1270
+ */
1271
+ Tokenizer: string
1272
+
1273
+ /**
1274
+ * 字段是否开启分析功能
1275
+ 注意:此字段可能返回 null,表示取不到有效值。
1276
+ */
1277
+ SqlFlag: boolean
1278
+
1279
+ /**
1280
+ * 是否包含中文
1281
+ 注意:此字段可能返回 null,表示取不到有效值。
1282
+ 注意:此字段可能返回 null,表示取不到有效值。
1283
+ */
1284
+ ContainZH: boolean
1285
+ }
1286
+
1287
+ /**
1288
+ * DeleteIpAccessControl返回参数结构体
1289
+ */
1290
+ export interface DeleteIpAccessControlResponse {
1291
+ /**
1292
+ * 删除失败的条目
1293
+ 注意:此字段可能返回 null,表示取不到有效值。
1294
+ */
1295
+ FailedItems: string
1296
+
1297
+ /**
1298
+ * 删除失败的条目数
1299
+ 注意:此字段可能返回 null,表示取不到有效值。
1300
+ */
1301
+ FailedCount: number
1302
+
1303
+ /**
1304
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1305
+ */
1306
+ RequestId?: string
1307
+ }
1308
+
1309
+ /**
1310
+ * SearchAccessLog请求参数结构体
1311
+ */
1312
+ export interface SearchAccessLogRequest {
1313
+ /**
1314
+ * 客户要查询的日志主题ID,每个客户都有对应的一个主题
1315
+ */
1316
+ TopicId: string
1317
+
1318
+ /**
1319
+ * 要查询的日志的起始时间,Unix时间戳,单位ms
1320
+ */
1321
+ From: number
1322
+
1323
+ /**
1324
+ * 要查询的日志的结束时间,Unix时间戳,单位ms
1325
+ */
1326
+ To: number
1327
+
1328
+ /**
1329
+ * 查询语句,语句长度最大为4096
1330
+ */
1331
+ Query: string
1332
+
1333
+ /**
1334
+ * 单次查询返回的日志条数,最大值为100
1335
+ */
1336
+ Limit?: number
1337
+
1338
+ /**
1339
+ * 加载更多日志时使用,透传上次返回的Context值,获取后续的日志内容
1340
+ */
1341
+ Context?: string
1342
+
1343
+ /**
1344
+ * 日志接口是否按时间排序返回;可选值:asc(升序)、desc(降序),默认为 desc
1345
+ */
1346
+ Sort?: string
1347
+ }
1348
+
1349
+ /**
1350
+ * 用于 DescribeAccessIndex 的出参
1351
+ */
1352
+ export interface AccessKeyValueInfo {
1353
+ /**
1354
+ * 需要配置键值或者元字段索引的字段
1355
+ 注意:此字段可能返回 null,表示取不到有效值。
1356
+ */
1357
+ Key: string
1358
+
1359
+ /**
1360
+ * 字段的索引描述信息
1361
+ 注意:此字段可能返回 null,表示取不到有效值。
1362
+ */
1363
+ Value: AccessValueInfo
1364
+ }
1365
+
1366
+ /**
1367
+ * AddCustomRule请求参数结构体
1368
+ */
1369
+ export interface AddCustomRuleRequest {
1370
+ /**
1371
+ * 规则名称
1372
+ */
1373
+ Name: string
1374
+
1375
+ /**
1376
+ * 优先级
1377
+ */
1378
+ SortId: string
1379
+
1380
+ /**
1381
+ * 过期时间
1382
+ */
1383
+ ExpireTime: string
1384
+
1385
+ /**
1386
+ * 策略详情
1387
+ */
1388
+ Strategies: Array<Strategy>
1389
+
1390
+ /**
1391
+ * 需要添加策略的域名
1392
+ */
1393
+ Domain: string
1394
+
1395
+ /**
1396
+ * 动作类型
1397
+ */
1398
+ ActionType: string
1399
+
1400
+ /**
1401
+ * 如果动作是重定向,则表示重定向的地址;其他情况可以为空
1402
+ */
1403
+ Redirect?: string
1404
+
1405
+ /**
1406
+ * "clb-waf"或者"sparta-waf"
1407
+ */
1408
+ Edition?: string
1409
+
1410
+ /**
1411
+ * 放行的详情
1412
+ */
1413
+ Bypass?: string
1414
+ }
1415
+
1416
+ /**
1417
+ * DescribeCustomRules请求参数结构体
1418
+ */
1419
+ export interface DescribeCustomRulesRequest {
1420
+ /**
1421
+ * 域名
1422
+ */
1423
+ Domain: string
1424
+
1425
+ /**
1426
+ * 分页参数
1427
+ */
1428
+ Paging: DescribeCustomRulesPagingInfo
1429
+
1430
+ /**
1431
+ * clb-waf或者sparta-waf
1432
+ */
1433
+ Edition?: string
1434
+
1435
+ /**
1436
+ * 过滤参数:动作类型:0放行,1阻断,2人机识别,3观察,4重定向
1437
+ */
1438
+ ActionType?: string
1439
+
1440
+ /**
1441
+ * 过滤参数:规则名称过滤条件
1442
+ */
1443
+ Search?: string
1444
+ }
1445
+
1446
+ /**
1447
+ * ModifyDomainWhiteRule返回参数结构体
1448
+ */
1449
+ export interface ModifyDomainWhiteRuleResponse {
1450
+ /**
1451
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1452
+ */
1453
+ RequestId?: string
1454
+ }
1455
+
1456
+ /**
1457
+ * DescribeAccessExports接口
1458
+ */
1459
+ export interface ExportAccessInfo {
1460
+ /**
1461
+ * 日志导出任务ID
1462
+ 注意:此字段可能返回 null,表示取不到有效值。
1463
+ */
1464
+ ExportId: string
1465
+
1466
+ /**
1467
+ * 日志导出查询语句
1468
+ 注意:此字段可能返回 null,表示取不到有效值。
1469
+ */
1470
+ Query: string
1471
+
1472
+ /**
1473
+ * 日志导出文件名
1474
+ 注意:此字段可能返回 null,表示取不到有效值。
1475
+ */
1476
+ FileName: string
1477
+
1478
+ /**
1479
+ * 日志文件大小
1480
+ */
1481
+ FileSize: number
1482
+
1483
+ /**
1484
+ * 日志导出时间排序
1485
+ 注意:此字段可能返回 null,表示取不到有效值。
1486
+ */
1487
+ Order: string
1488
+
1489
+ /**
1490
+ * 日志导出格式
1491
+ 注意:此字段可能返回 null,表示取不到有效值。
1492
+ */
1493
+ Format: string
1494
+
1495
+ /**
1496
+ * 日志导出数量
1497
+ 注意:此字段可能返回 null,表示取不到有效值。
1498
+ */
1499
+ Count: number
1500
+
1501
+ /**
1502
+ * 日志下载状态。Processing:导出正在进行中,Complete:导出完成,Failed:导出失败,Expired:日志导出已过期(三天有效期)
1503
+ */
1504
+ Status: string
1505
+
1506
+ /**
1507
+ * 日志导出起始时间
1508
+ */
1509
+ From: number
1510
+
1511
+ /**
1512
+ * 日志导出结束时间
1513
+ */
1514
+ To: number
1515
+
1516
+ /**
1517
+ * 日志导出路径
1518
+ */
1519
+ CosPath: string
1520
+
1521
+ /**
1522
+ * 日志导出创建时间
1523
+ */
1524
+ CreateTime: string
1525
+ }
1526
+
1527
+ /**
1528
+ * ModifyWafAutoDenyRules请求参数结构体
1529
+ */
1530
+ export interface ModifyWafAutoDenyRulesRequest {
1531
+ /**
1532
+ * 域名
1533
+ */
1534
+ Domain: string
1535
+
1536
+ /**
1537
+ * 攻击次数阈值
1538
+ */
1539
+ AttackThreshold: number
1540
+
1541
+ /**
1542
+ * 攻击时间阈值
1543
+ */
1544
+ TimeThreshold: number
1545
+
1546
+ /**
1547
+ * 自动封禁时间
1548
+ */
1549
+ DenyTimeThreshold: number
1550
+
1551
+ /**
1552
+ * 自动封禁状态
1553
+ */
1554
+ DefenseStatus: number
1555
+ }
1556
+
1557
+ /**
1558
+ * DescribeAccessFastAnalysis返回参数结构体
1559
+ */
1560
+ export interface DescribeAccessFastAnalysisResponse {
1561
+ /**
1562
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1563
+ */
1564
+ RequestId?: string
1565
+ }
1566
+
1567
+ /**
1568
+ * Waf 攻击自动封禁详情
1569
+ */
1570
+ export interface AutoDenyDetail {
1571
+ /**
1572
+ * 攻击封禁类型标签
1573
+ */
1574
+ AttackTags: Array<string>
1575
+
1576
+ /**
1577
+ * 攻击次数阈值
1578
+ */
1579
+ AttackThreshold: number
1580
+
1581
+ /**
1582
+ * 自动封禁状态
1583
+ */
1584
+ DefenseStatus: number
1585
+
1586
+ /**
1587
+ * 攻击时间阈值
1588
+ */
1589
+ TimeThreshold: number
1590
+
1591
+ /**
1592
+ * 自动封禁时间
1593
+ */
1594
+ DenyTimeThreshold: number
1595
+
1596
+ /**
1597
+ * 最后更新时间
1598
+ */
1599
+ LastUpdateTime?: string
1600
+ }
1601
+
1602
+ /**
1603
+ * ModifyWafAutoDenyStatus请求参数结构体
1604
+ */
1605
+ export interface ModifyWafAutoDenyStatusRequest {
1606
+ /**
1607
+ * WAF 自动封禁配置项
1608
+ */
1609
+ WafAutoDenyDetails: AutoDenyDetail
1610
+ }
1611
+
1612
+ /**
1613
+ * ModifyWafThreatenIntelligence请求参数结构体
1614
+ */
1615
+ export interface ModifyWafThreatenIntelligenceRequest {
1616
+ /**
1617
+ * 配置WAF威胁情报封禁模块详情
1618
+ */
1619
+ WafThreatenIntelligenceDetails: WafThreatenIntelligenceDetails
1620
+ }
1621
+
1622
+ /**
1623
+ * 自定义规则的匹配条件结构体
1624
+ */
1625
+ export interface Strategy {
1626
+ /**
1627
+ * 匹配字段
1628
+ */
1629
+ Field: string
1630
+
1631
+ /**
1632
+ * 逻辑符号
1633
+ */
1634
+ CompareFunc: string
1635
+
1636
+ /**
1637
+ * 匹配内容
1638
+ */
1639
+ Content: string
1640
+
1641
+ /**
1642
+ * 匹配参数
1643
+ */
1644
+ Arg: string
1645
+ }
1646
+
1647
+ /**
1648
+ * DescribeAccessIndex
1649
+ */
1650
+ export interface AccessFullTextInfo {
1651
+ /**
1652
+ * 是否大小写敏感
1653
+ 注意:此字段可能返回 null,表示取不到有效值。
1654
+ */
1655
+ CaseSensitive: boolean
1656
+
1657
+ /**
1658
+ * 全文索引的分词符,字符串中每个字符代表一个分词符
1659
+ 注意:此字段可能返回 null,表示取不到有效值。
1660
+ */
1661
+ Tokenizer: string
1662
+
1663
+ /**
1664
+ * 是否包含中文
1665
+ 注意:此字段可能返回 null,表示取不到有效值。
1666
+ 注意:此字段可能返回 null,表示取不到有效值。
1667
+ */
1668
+ ContainZH: boolean
1669
+ }
1670
+
1671
+ /**
1672
+ * DescribeIpHitItems请求参数结构体
1673
+ */
1674
+ export interface DescribeIpHitItemsRequest {
1675
+ /**
1676
+ * 域名
1677
+ */
1678
+ Domain: string
1679
+
1680
+ /**
1681
+ * 计数标识
1682
+ */
1683
+ Count: number
1684
+
1685
+ /**
1686
+ * 类别
1687
+ */
1688
+ Category: string
1689
+
1690
+ /**
1691
+ * 有效时间最小时间戳
1692
+ */
1693
+ VtsMin?: number
1694
+
1695
+ /**
1696
+ * 有效时间最大时间戳
1697
+ */
1698
+ VtsMax?: number
1699
+
1700
+ /**
1701
+ * 创建时间最小时间戳
1702
+ */
1703
+ CtsMin?: number
1704
+
1705
+ /**
1706
+ * 创建时间最大时间戳
1707
+ */
1708
+ CtsMax?: number
1709
+
1710
+ /**
1711
+ * 偏移参数
1712
+ */
1713
+ Skip?: number
1714
+
1715
+ /**
1716
+ * 限制数目
1717
+ */
1718
+ Limit?: number
1719
+
1720
+ /**
1721
+ * 策略名称
1722
+ */
1723
+ Name?: string
1724
+
1725
+ /**
1726
+ * 排序参数
1727
+ */
1728
+ Sort?: string
1729
+
1730
+ /**
1731
+ * IP
1732
+ */
1733
+ Ip?: string
1734
+ }
1735
+
1736
+ /**
1737
+ * DescribeAccessIndex接口的出参数
1738
+ */
1739
+ export interface AccessRuleInfo {
1740
+ /**
1741
+ * 全文索引配置
1742
+ 注意:此字段可能返回 null,表示取不到有效值。
1743
+ 注意:此字段可能返回 null,表示取不到有效值。
1744
+ */
1745
+ FullText: AccessFullTextInfo
1746
+
1747
+ /**
1748
+ * 键值索引配置
1749
+ 注意:此字段可能返回 null,表示取不到有效值。
1750
+ 注意:此字段可能返回 null,表示取不到有效值。
1751
+ */
1752
+ KeyValue: AccessRuleKeyValueInfo
1753
+
1754
+ /**
1755
+ * 元字段索引配置
1756
+ 注意:此字段可能返回 null,表示取不到有效值。
1757
+ 注意:此字段可能返回 null,表示取不到有效值。
1758
+ */
1759
+ Tag: AccessRuleTagInfo
1760
+ }
1761
+
1762
+ /**
1763
+ * DeleteAccessExport请求参数结构体
1764
+ */
1765
+ export interface DeleteAccessExportRequest {
1766
+ /**
1767
+ * 日志导出ID
1768
+ */
1769
+ ExportId: string
1770
+
1771
+ /**
1772
+ * 日志主题
1773
+ */
1774
+ TopicId: string
1775
+ }
1776
+
1777
+ /**
1778
+ * DescribeUserClbWafRegions请求参数结构体
1779
+ */
1780
+ export type DescribeUserClbWafRegionsRequest = null
1781
+
1782
+ /**
1783
+ * DescribeDomainWhiteRules返回参数结构体
1784
+ */
1785
+ export interface DescribeDomainWhiteRulesResponse {
1786
+ /**
1787
+ * 规则列表
1788
+ */
1789
+ RuleList: Array<RuleList>
1790
+
1791
+ /**
1792
+ * 规则的数量
1793
+ */
1794
+ Total: number
1795
+
1796
+ /**
1797
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1798
+ */
1799
+ RequestId?: string
1800
+ }
1801
+
1802
+ /**
1803
+ * DeleteAttackDownloadRecord请求参数结构体
1804
+ */
1805
+ export interface DeleteAttackDownloadRecordRequest {
1806
+ /**
1807
+ * 下载任务记录唯一标记
1808
+ */
1809
+ Id: number
1810
+ }
1811
+
1812
+ /**
1813
+ * DescribeWafThreatenIntelligence返回参数结构体
1814
+ */
1815
+ export interface DescribeWafThreatenIntelligenceResponse {
1816
+ /**
1817
+ * WAF 威胁情报封禁信息
1818
+ */
1819
+ WafThreatenIntelligenceDetails?: WafThreatenIntelligenceDetails
1820
+
1821
+ /**
1822
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1823
+ */
1824
+ RequestId?: string
1825
+ }
1826
+
1827
+ /**
1828
+ * AddDomainWhiteRule请求参数结构体
1829
+ */
1830
+ export interface AddDomainWhiteRuleRequest {
1831
+ /**
1832
+ * 需要添加的域名
1833
+ */
1834
+ Domain: string
1835
+
1836
+ /**
1837
+ * 需要添加的规则
1838
+ */
1839
+ Rules: Array<number>
1840
+
1841
+ /**
1842
+ * 需要添加的规则url
1843
+ */
1844
+ Url: string
1845
+
1846
+ /**
1847
+ * 规则的方法
1848
+ */
1849
+ Function: string
1850
+
1851
+ /**
1852
+ * 规则的开关
1853
+ */
1854
+ Status: number
1855
+ }
1856
+
1857
+ /**
1858
+ * UpsertIpAccessControl返回参数结构体
1859
+ */
1860
+ export interface UpsertIpAccessControlResponse {
1861
+ /**
1862
+ * 添加或修改失败的条目
1863
+ 注意:此字段可能返回 null,表示取不到有效值。
1864
+ */
1865
+ FailedItems: string
1866
+
1867
+ /**
1868
+ * 添加或修改失败的数目
1869
+ 注意:此字段可能返回 null,表示取不到有效值。
1870
+ */
1871
+ FailedCount: number
1872
+
1873
+ /**
1874
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1875
+ */
1876
+ RequestId?: string
1877
+ }
1878
+
1879
+ /**
1880
+ * ip封堵状态数据
1881
+ */
1882
+ export interface IpHitItem {
1883
+ /**
1884
+ * 动作
1885
+ */
1886
+ Action: number
1887
+
1888
+ /**
1889
+ * 类别
1890
+ */
1891
+ Category: string
1892
+
1893
+ /**
1894
+ * ip
1895
+ */
1896
+ Ip: string
1897
+
1898
+ /**
1899
+ * 规则名称
1900
+ */
1901
+ Name: string
1902
+
1903
+ /**
1904
+ * 时间戳
1905
+ */
1906
+ TsVersion: number
1907
+
1908
+ /**
1909
+ * 有效截止时间戳
1910
+ */
1911
+ ValidTs: number
1912
+ }
1913
+
1914
+ /**
1915
+ * DeleteSession返回参数结构体
1916
+ */
1917
+ export interface DeleteSessionResponse {
1918
+ /**
1919
+ * 结果
1920
+ 注意:此字段可能返回 null,表示取不到有效值。
1921
+ */
1922
+ Data: string
1923
+
1924
+ /**
1925
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1926
+ */
1927
+ RequestId?: string
1928
+ }
1929
+
1930
+ /**
1931
+ * ModifyWafAutoDenyStatus返回参数结构体
1932
+ */
1933
+ export interface ModifyWafAutoDenyStatusResponse {
1934
+ /**
1935
+ * WAF 自动封禁配置项
1936
+ */
1937
+ WafAutoDenyDetails?: AutoDenyDetail
1938
+
1939
+ /**
1940
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1941
+ */
1942
+ RequestId?: string
1943
+ }
1944
+
1945
+ /**
1946
+ * DescribeWafThreatenIntelligence请求参数结构体
1947
+ */
1948
+ export type DescribeWafThreatenIntelligenceRequest = null
1949
+
1950
+ /**
1951
+ * DescribeAccessIndex返回参数结构体
1952
+ */
1953
+ export interface DescribeAccessIndexResponse {
1954
+ /**
1955
+ * 是否生效
1956
+ */
1957
+ Status: boolean
1958
+
1959
+ /**
1960
+ * 索引配置信息
1961
+ 注意:此字段可能返回 null,表示取不到有效值。
1962
+ 注意:此字段可能返回 null,表示取不到有效值。
1963
+ */
1964
+ Rule: AccessRuleInfo
1965
+
1966
+ /**
1967
+ * 索引修改时间,初始值为索引创建时间。
1968
+ */
1969
+ ModifyTime: string
1970
+
1971
+ /**
1972
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1973
+ */
1974
+ RequestId?: string
1975
+ }
1976
+
1977
+ /**
1978
+ * DescribeAccessExports返回参数结构体
1979
+ */
1980
+ export interface DescribeAccessExportsResponse {
1981
+ /**
1982
+ * 日志导出ID。
1983
+ */
1984
+ TotalCount: number
1985
+
1986
+ /**
1987
+ * 日志导出列表
1988
+ 注意:此字段可能返回 null,表示取不到有效值。
1989
+ */
1990
+ Exports: Array<ExportAccessInfo>
1991
+
1992
+ /**
1993
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1994
+ */
1995
+ RequestId?: string
1996
+ }
1997
+
1998
+ /**
1999
+ * CreateAccessExport返回参数结构体
2000
+ */
2001
+ export interface CreateAccessExportResponse {
2002
+ /**
2003
+ * 日志导出ID。
2004
+ */
2005
+ ExportId: string
2006
+
2007
+ /**
2008
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2009
+ */
2010
+ RequestId?: string
2011
+ }
2012
+
2013
+ /**
2014
+ * bot的趋势图对象
2015
+ */
2016
+ export interface BotStatPointItem {
2017
+ /**
2018
+ * 横坐标
2019
+ */
2020
+ TimeStamp: string
2021
+
2022
+ /**
2023
+ * value的所属对象
2024
+ */
2025
+ Key: string
2026
+
2027
+ /**
2028
+ * 纵列表
2029
+ */
2030
+ Value: number
2031
+
2032
+ /**
2033
+ * Key对应的页面展示内容
2034
+ */
2035
+ Label: string
2036
+ }
2037
+
2038
+ /**
2039
+ * 单条日志数据描述
2040
+ */
2041
+ export interface AccessLogInfo {
2042
+ /**
2043
+ * 日志时间,单位ms
2044
+ 注意:此字段可能返回 null,表示取不到有效值。
2045
+ */
2046
+ Time: number
2047
+
2048
+ /**
2049
+ * 日志主题ID
2050
+ 注意:此字段可能返回 null,表示取不到有效值。
2051
+ */
2052
+ TopicId: string
2053
+
2054
+ /**
2055
+ * 日志主题名称
2056
+ 注意:此字段可能返回 null,表示取不到有效值。
2057
+ */
2058
+ TopicName: string
2059
+
2060
+ /**
2061
+ * 日志来源IP
2062
+ 注意:此字段可能返回 null,表示取不到有效值。
2063
+ */
2064
+ Source: string
2065
+
2066
+ /**
2067
+ * 日志文件名称
2068
+ 注意:此字段可能返回 null,表示取不到有效值。
2069
+ */
2070
+ FileName: string
2071
+
2072
+ /**
2073
+ * 日志上报请求包的ID
2074
+ 注意:此字段可能返回 null,表示取不到有效值。
2075
+ */
2076
+ PkgId: string
2077
+
2078
+ /**
2079
+ * 请求包内日志的ID
2080
+ 注意:此字段可能返回 null,表示取不到有效值。
2081
+ */
2082
+ PkgLogId: string
2083
+
2084
+ /**
2085
+ * 日志内容的Json序列化字符串
2086
+ 注意:此字段可能返回 null,表示取不到有效值。
2087
+ 注意:此字段可能返回 null,表示取不到有效值。
2088
+ */
2089
+ LogJson: string
2090
+ }
2091
+
2092
+ /**
2093
+ * DescribeAccessIndex接口的出参
2094
+ */
2095
+ export interface AccessRuleKeyValueInfo {
2096
+ /**
2097
+ * 是否大小写敏感
2098
+ 注意:此字段可能返回 null,表示取不到有效值。
2099
+ */
2100
+ CaseSensitive: boolean
2101
+
2102
+ /**
2103
+ * 需要建立索引的键值对信息;最大只能配置100个键值对
2104
+ 注意:此字段可能返回 null,表示取不到有效值。
2105
+ */
2106
+ KeyValues: Array<AccessKeyValueInfo>
2107
+ }
2108
+
2109
+ /**
2110
+ * ModifyWafThreatenIntelligence返回参数结构体
2111
+ */
2112
+ export interface ModifyWafThreatenIntelligenceResponse {
2113
+ /**
2114
+ * 当前WAF威胁情报封禁模块详情
2115
+ */
2116
+ WafThreatenIntelligenceDetails?: WafThreatenIntelligenceDetails
2117
+
2118
+ /**
2119
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2120
+ */
2121
+ RequestId?: string
1092
2122
  }