tccli-intl-en 3.0.1255.1__py2.py3-none-any.whl → 3.0.1257.1__py2.py3-none-any.whl
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.
- tccli/__init__.py +1 -1
- tccli/services/ccc/ccc_client.py +305 -40
- tccli/services/ccc/v20200210/api.json +1137 -90
- tccli/services/ccc/v20200210/examples.json +40 -0
- tccli/services/cmq/cmq_client.py +4 -799
- tccli/services/cmq/v20190304/api.json +173 -1367
- tccli/services/cmq/v20190304/examples.json +0 -120
- tccli/services/cvm/cvm_client.py +65 -12
- tccli/services/cvm/v20170312/api.json +52 -0
- tccli/services/cvm/v20170312/examples.json +8 -0
- tccli/services/faceid/v20180301/api.json +18 -0
- tccli/services/waf/v20180125/api.json +1372 -194
- tccli/services/waf/v20180125/examples.json +89 -1
- tccli/services/waf/waf_client.py +632 -49
- {tccli_intl_en-3.0.1255.1.dist-info → tccli_intl_en-3.0.1257.1.dist-info}/METADATA +2 -2
- {tccli_intl_en-3.0.1255.1.dist-info → tccli_intl_en-3.0.1257.1.dist-info}/RECORD +20 -20
- {tccli_intl_en-3.0.1255.1.dist-info → tccli_intl_en-3.0.1257.1.dist-info}/LICENSE +0 -0
- {tccli_intl_en-3.0.1255.1.dist-info → tccli_intl_en-3.0.1257.1.dist-info}/WHEEL +0 -0
- {tccli_intl_en-3.0.1255.1.dist-info → tccli_intl_en-3.0.1257.1.dist-info}/entry_points.txt +0 -0
- {tccli_intl_en-3.0.1255.1.dist-info → tccli_intl_en-3.0.1257.1.dist-info}/top_level.txt +0 -0
|
@@ -56,6 +56,13 @@
|
|
|
56
56
|
"output": "CreateIpAccessControlResponse",
|
|
57
57
|
"status": "online"
|
|
58
58
|
},
|
|
59
|
+
"CreateOwaspWhiteRule": {
|
|
60
|
+
"document": "This API is used to add a rule engine allowlist.",
|
|
61
|
+
"input": "CreateOwaspWhiteRuleRequest",
|
|
62
|
+
"name": "Add a rule engine allowlist",
|
|
63
|
+
"output": "CreateOwaspWhiteRuleResponse",
|
|
64
|
+
"status": "online"
|
|
65
|
+
},
|
|
59
66
|
"DeleteAntiFakeUrl": {
|
|
60
67
|
"document": "Delete tamper-proof URL",
|
|
61
68
|
"input": "DeleteAntiFakeUrlRequest",
|
|
@@ -105,6 +112,20 @@
|
|
|
105
112
|
"output": "DeleteIpAccessControlV2Response",
|
|
106
113
|
"status": "online"
|
|
107
114
|
},
|
|
115
|
+
"DeleteOwaspRuleStatus": {
|
|
116
|
+
"document": "This API is used to unlock the Door God rule status.",
|
|
117
|
+
"input": "DeleteOwaspRuleStatusRequest",
|
|
118
|
+
"name": "Delete a user-defined rule status",
|
|
119
|
+
"output": "DeleteOwaspRuleStatusResponse",
|
|
120
|
+
"status": "online"
|
|
121
|
+
},
|
|
122
|
+
"DeleteOwaspWhiteRule": {
|
|
123
|
+
"document": "This API is used to delete a user rule engine allowlist.",
|
|
124
|
+
"input": "DeleteOwaspWhiteRuleRequest",
|
|
125
|
+
"name": "Delete a user rule engine allowlist",
|
|
126
|
+
"output": "DeleteOwaspWhiteRuleResponse",
|
|
127
|
+
"status": "online"
|
|
128
|
+
},
|
|
108
129
|
"DeleteSession": {
|
|
109
130
|
"document": "Delete CC attack session settings",
|
|
110
131
|
"input": "DeleteSessionRequest",
|
|
@@ -294,6 +315,27 @@
|
|
|
294
315
|
"output": "DescribeObjectsResponse",
|
|
295
316
|
"status": "online"
|
|
296
317
|
},
|
|
318
|
+
"DescribeOwaspRuleTypes": {
|
|
319
|
+
"document": "This API is used to query the rule types of the rule engine.",
|
|
320
|
+
"input": "DescribeOwaspRuleTypesRequest",
|
|
321
|
+
"name": "Query the rule type list of the rule engine",
|
|
322
|
+
"output": "DescribeOwaspRuleTypesResponse",
|
|
323
|
+
"status": "online"
|
|
324
|
+
},
|
|
325
|
+
"DescribeOwaspRules": {
|
|
326
|
+
"document": "This API is used to query the rule list of the rule engine.",
|
|
327
|
+
"input": "DescribeOwaspRulesRequest",
|
|
328
|
+
"name": "Query the rule list of the rule engine",
|
|
329
|
+
"output": "DescribeOwaspRulesResponse",
|
|
330
|
+
"status": "online"
|
|
331
|
+
},
|
|
332
|
+
"DescribeOwaspWhiteRules": {
|
|
333
|
+
"document": "This API is used to retrieve the allowlist for the rule engine.",
|
|
334
|
+
"input": "DescribeOwaspWhiteRulesRequest",
|
|
335
|
+
"name": "Obtain user rule engine allowlist",
|
|
336
|
+
"output": "DescribeOwaspWhiteRulesResponse",
|
|
337
|
+
"status": "online"
|
|
338
|
+
},
|
|
297
339
|
"DescribePeakPoints": {
|
|
298
340
|
"document": "Query business and attack summary trends",
|
|
299
341
|
"input": "DescribePeakPointsRequest",
|
|
@@ -595,6 +637,41 @@
|
|
|
595
637
|
"output": "ModifyObjectResponse",
|
|
596
638
|
"status": "online"
|
|
597
639
|
},
|
|
640
|
+
"ModifyOwaspRuleStatus": {
|
|
641
|
+
"document": "This API is used to refresh the rule switch.",
|
|
642
|
+
"input": "ModifyOwaspRuleStatusRequest",
|
|
643
|
+
"name": "Refresh the rule switch",
|
|
644
|
+
"output": "ModifyOwaspRuleStatusResponse",
|
|
645
|
+
"status": "online"
|
|
646
|
+
},
|
|
647
|
+
"ModifyOwaspRuleTypeAction": {
|
|
648
|
+
"document": "This API is used to update the protection mode of the rule type.",
|
|
649
|
+
"input": "ModifyOwaspRuleTypeActionRequest",
|
|
650
|
+
"name": "Update the protection mode of the rule type",
|
|
651
|
+
"output": "ModifyOwaspRuleTypeActionResponse",
|
|
652
|
+
"status": "online"
|
|
653
|
+
},
|
|
654
|
+
"ModifyOwaspRuleTypeLevel": {
|
|
655
|
+
"document": "This API is used to update the protection level of a rule type.",
|
|
656
|
+
"input": "ModifyOwaspRuleTypeLevelRequest",
|
|
657
|
+
"name": "Update the protection level of the rule type",
|
|
658
|
+
"output": "ModifyOwaspRuleTypeLevelResponse",
|
|
659
|
+
"status": "online"
|
|
660
|
+
},
|
|
661
|
+
"ModifyOwaspRuleTypeStatus": {
|
|
662
|
+
"document": "This API is used to update the rule type switch.",
|
|
663
|
+
"input": "ModifyOwaspRuleTypeStatusRequest",
|
|
664
|
+
"name": "Update the rule type switch",
|
|
665
|
+
"output": "ModifyOwaspRuleTypeStatusResponse",
|
|
666
|
+
"status": "online"
|
|
667
|
+
},
|
|
668
|
+
"ModifyOwaspWhiteRule": {
|
|
669
|
+
"document": "This API is used to edit the allowlist for the rule engine.",
|
|
670
|
+
"input": "ModifyOwaspWhiteRuleRequest",
|
|
671
|
+
"name": "Edit a rule engine allowlist",
|
|
672
|
+
"output": "ModifyOwaspWhiteRuleResponse",
|
|
673
|
+
"status": "online"
|
|
674
|
+
},
|
|
598
675
|
"ModifyProtectionStatus": {
|
|
599
676
|
"document": "This API is used to obtain the enabling status of the basic security protection module of WAF.",
|
|
600
677
|
"input": "ModifyProtectionStatusRequest",
|
|
@@ -3413,12 +3490,121 @@
|
|
|
3413
3490
|
],
|
|
3414
3491
|
"type": "object"
|
|
3415
3492
|
},
|
|
3493
|
+
"CreateOwaspWhiteRuleRequest": {
|
|
3494
|
+
"document": "CreateOwaspWhiteRule request structure.",
|
|
3495
|
+
"members": [
|
|
3496
|
+
{
|
|
3497
|
+
"disabled": false,
|
|
3498
|
+
"document": "Rule name",
|
|
3499
|
+
"example": "rulename",
|
|
3500
|
+
"member": "string",
|
|
3501
|
+
"name": "Name",
|
|
3502
|
+
"required": true,
|
|
3503
|
+
"type": "string"
|
|
3504
|
+
},
|
|
3505
|
+
{
|
|
3506
|
+
"disabled": false,
|
|
3507
|
+
"document": "Domain name",
|
|
3508
|
+
"example": "www.test.com",
|
|
3509
|
+
"member": "string",
|
|
3510
|
+
"name": "Domain",
|
|
3511
|
+
"required": true,
|
|
3512
|
+
"type": "string"
|
|
3513
|
+
},
|
|
3514
|
+
{
|
|
3515
|
+
"disabled": false,
|
|
3516
|
+
"document": "Rule-Based matching policy list.",
|
|
3517
|
+
"example": "[{\"Field\": \"URL\",\"Arg\": \"\",\"CompareFunc\": \"eq\",\"Content\": \"/acl\"}]",
|
|
3518
|
+
"member": "Strategy",
|
|
3519
|
+
"name": "Strategies",
|
|
3520
|
+
"required": true,
|
|
3521
|
+
"type": "list"
|
|
3522
|
+
},
|
|
3523
|
+
{
|
|
3524
|
+
"disabled": false,
|
|
3525
|
+
"document": "ID list of allowlisted rules.",
|
|
3526
|
+
"example": "[90501998, 90501999]",
|
|
3527
|
+
"member": "uint64",
|
|
3528
|
+
"name": "Ids",
|
|
3529
|
+
"required": true,
|
|
3530
|
+
"type": "list"
|
|
3531
|
+
},
|
|
3532
|
+
{
|
|
3533
|
+
"disabled": false,
|
|
3534
|
+
"document": "Allowlist type. valid values: 0 (allowlisting by specific rule ID), 1 (allowlisting by rule type).",
|
|
3535
|
+
"example": "0",
|
|
3536
|
+
"member": "int64",
|
|
3537
|
+
"name": "Type",
|
|
3538
|
+
"required": true,
|
|
3539
|
+
"type": "int"
|
|
3540
|
+
},
|
|
3541
|
+
{
|
|
3542
|
+
"disabled": false,
|
|
3543
|
+
"document": "Rule execution mode: TimedJob indicates scheduled execution. CronJob indicates periodic execution.",
|
|
3544
|
+
"example": "TimedJob",
|
|
3545
|
+
"member": "string",
|
|
3546
|
+
"name": "JobType",
|
|
3547
|
+
"required": true,
|
|
3548
|
+
"type": "string"
|
|
3549
|
+
},
|
|
3550
|
+
{
|
|
3551
|
+
"disabled": false,
|
|
3552
|
+
"document": "Scheduled task configuration",
|
|
3553
|
+
"example": "{\"Timed\":[{\"StartDateTime\":1711618518,\"EndDateTime\":1711918518}],\"Cron\":[{\"Day\":12,\"WDay\":2,\"StartTime\":\"12:11\",\"EndTime\":\"21:00\"}],\"TimeTZone\":\"UTC+8\"}",
|
|
3554
|
+
"member": "JobDateTime",
|
|
3555
|
+
"name": "JobDateTime",
|
|
3556
|
+
"required": true,
|
|
3557
|
+
"type": "object"
|
|
3558
|
+
},
|
|
3559
|
+
{
|
|
3560
|
+
"disabled": false,
|
|
3561
|
+
"document": "If the JobDateTime field is not set, this field is used. 0 means permanent, other values indicate the cutoff time for scheduled effect (unit: seconds).",
|
|
3562
|
+
"example": "0",
|
|
3563
|
+
"member": "uint64",
|
|
3564
|
+
"name": "ExpireTime",
|
|
3565
|
+
"required": true,
|
|
3566
|
+
"type": "int"
|
|
3567
|
+
},
|
|
3568
|
+
{
|
|
3569
|
+
"disabled": false,
|
|
3570
|
+
"document": "Rule status. valid values: 0 (disabled), 1 (enabled). enabled by default.",
|
|
3571
|
+
"example": "1",
|
|
3572
|
+
"member": "uint64",
|
|
3573
|
+
"name": "Status",
|
|
3574
|
+
"required": false,
|
|
3575
|
+
"type": "int"
|
|
3576
|
+
}
|
|
3577
|
+
],
|
|
3578
|
+
"type": "object"
|
|
3579
|
+
},
|
|
3580
|
+
"CreateOwaspWhiteRuleResponse": {
|
|
3581
|
+
"document": "CreateOwaspWhiteRule response structure.",
|
|
3582
|
+
"members": [
|
|
3583
|
+
{
|
|
3584
|
+
"disabled": false,
|
|
3585
|
+
"document": "Rule ID",
|
|
3586
|
+
"example": "10011",
|
|
3587
|
+
"member": "uint64",
|
|
3588
|
+
"name": "RuleId",
|
|
3589
|
+
"output_required": true,
|
|
3590
|
+
"type": "int",
|
|
3591
|
+
"value_allowed_null": false
|
|
3592
|
+
},
|
|
3593
|
+
{
|
|
3594
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
3595
|
+
"member": "string",
|
|
3596
|
+
"name": "RequestId",
|
|
3597
|
+
"type": "string"
|
|
3598
|
+
}
|
|
3599
|
+
],
|
|
3600
|
+
"type": "object"
|
|
3601
|
+
},
|
|
3416
3602
|
"CronJob": {
|
|
3417
3603
|
"document": "Data structure of periodic rule execution",
|
|
3418
3604
|
"members": [
|
|
3419
3605
|
{
|
|
3420
3606
|
"disabled": false,
|
|
3421
|
-
"document": "
|
|
3607
|
+
"document": "Execution day of each month.",
|
|
3422
3608
|
"example": "[2, 13]",
|
|
3423
3609
|
"member": "uint64",
|
|
3424
3610
|
"name": "Days",
|
|
@@ -3429,7 +3615,7 @@
|
|
|
3429
3615
|
},
|
|
3430
3616
|
{
|
|
3431
3617
|
"disabled": false,
|
|
3432
|
-
"document": "
|
|
3618
|
+
"document": "Execution day of each week.",
|
|
3433
3619
|
"example": "[4, 0]",
|
|
3434
3620
|
"member": "uint64",
|
|
3435
3621
|
"name": "WDays",
|
|
@@ -3440,7 +3626,7 @@
|
|
|
3440
3626
|
},
|
|
3441
3627
|
{
|
|
3442
3628
|
"disabled": false,
|
|
3443
|
-
"document": "Start time
|
|
3629
|
+
"document": "Start time.",
|
|
3444
3630
|
"example": "19:21",
|
|
3445
3631
|
"member": "string",
|
|
3446
3632
|
"name": "StartTime",
|
|
@@ -3451,7 +3637,7 @@
|
|
|
3451
3637
|
},
|
|
3452
3638
|
{
|
|
3453
3639
|
"disabled": false,
|
|
3454
|
-
"document": "End time
|
|
3640
|
+
"document": "End time",
|
|
3455
3641
|
"example": "21:00",
|
|
3456
3642
|
"member": "string",
|
|
3457
3643
|
"name": "EndTime",
|
|
@@ -3855,6 +4041,78 @@
|
|
|
3855
4041
|
],
|
|
3856
4042
|
"type": "object"
|
|
3857
4043
|
},
|
|
4044
|
+
"DeleteOwaspRuleStatusRequest": {
|
|
4045
|
+
"document": "DeleteOwaspRuleStatus request structure.",
|
|
4046
|
+
"members": [
|
|
4047
|
+
{
|
|
4048
|
+
"disabled": false,
|
|
4049
|
+
"document": "Domain name",
|
|
4050
|
+
"example": "无",
|
|
4051
|
+
"member": "string",
|
|
4052
|
+
"name": "Domain",
|
|
4053
|
+
"required": true,
|
|
4054
|
+
"type": "string"
|
|
4055
|
+
},
|
|
4056
|
+
{
|
|
4057
|
+
"disabled": false,
|
|
4058
|
+
"document": "Rule ID list",
|
|
4059
|
+
"example": "[10000000,20000000]",
|
|
4060
|
+
"member": "string",
|
|
4061
|
+
"name": "RuleIDs",
|
|
4062
|
+
"required": true,
|
|
4063
|
+
"type": "list"
|
|
4064
|
+
}
|
|
4065
|
+
],
|
|
4066
|
+
"type": "object"
|
|
4067
|
+
},
|
|
4068
|
+
"DeleteOwaspRuleStatusResponse": {
|
|
4069
|
+
"document": "DeleteOwaspRuleStatus response structure.",
|
|
4070
|
+
"members": [
|
|
4071
|
+
{
|
|
4072
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
4073
|
+
"member": "string",
|
|
4074
|
+
"name": "RequestId",
|
|
4075
|
+
"type": "string"
|
|
4076
|
+
}
|
|
4077
|
+
],
|
|
4078
|
+
"type": "object"
|
|
4079
|
+
},
|
|
4080
|
+
"DeleteOwaspWhiteRuleRequest": {
|
|
4081
|
+
"document": "DeleteOwaspWhiteRule request structure.",
|
|
4082
|
+
"members": [
|
|
4083
|
+
{
|
|
4084
|
+
"disabled": false,
|
|
4085
|
+
"document": "ID list of allowlisted rules.",
|
|
4086
|
+
"example": "[100011,100023]",
|
|
4087
|
+
"member": "uint64",
|
|
4088
|
+
"name": "Ids",
|
|
4089
|
+
"required": true,
|
|
4090
|
+
"type": "list"
|
|
4091
|
+
},
|
|
4092
|
+
{
|
|
4093
|
+
"disabled": false,
|
|
4094
|
+
"document": "Domain name",
|
|
4095
|
+
"example": "www.waf.com",
|
|
4096
|
+
"member": "string",
|
|
4097
|
+
"name": "Domain",
|
|
4098
|
+
"required": true,
|
|
4099
|
+
"type": "string"
|
|
4100
|
+
}
|
|
4101
|
+
],
|
|
4102
|
+
"type": "object"
|
|
4103
|
+
},
|
|
4104
|
+
"DeleteOwaspWhiteRuleResponse": {
|
|
4105
|
+
"document": "DeleteOwaspWhiteRule response structure.",
|
|
4106
|
+
"members": [
|
|
4107
|
+
{
|
|
4108
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
4109
|
+
"member": "string",
|
|
4110
|
+
"name": "RequestId",
|
|
4111
|
+
"type": "string"
|
|
4112
|
+
}
|
|
4113
|
+
],
|
|
4114
|
+
"type": "object"
|
|
4115
|
+
},
|
|
3858
4116
|
"DeleteSessionRequest": {
|
|
3859
4117
|
"document": "DeleteSession request structure.",
|
|
3860
4118
|
"members": [
|
|
@@ -6409,75 +6667,67 @@
|
|
|
6409
6667
|
],
|
|
6410
6668
|
"type": "object"
|
|
6411
6669
|
},
|
|
6412
|
-
"
|
|
6413
|
-
"document": "
|
|
6670
|
+
"DescribeOwaspRuleTypesRequest": {
|
|
6671
|
+
"document": "DescribeOwaspRuleTypes request structure.",
|
|
6414
6672
|
"members": [
|
|
6415
6673
|
{
|
|
6416
6674
|
"disabled": false,
|
|
6417
|
-
"document": "
|
|
6418
|
-
"example": "
|
|
6419
|
-
"member": "datetime",
|
|
6420
|
-
"name": "FromTime",
|
|
6421
|
-
"required": true,
|
|
6422
|
-
"type": "string"
|
|
6423
|
-
},
|
|
6424
|
-
{
|
|
6425
|
-
"disabled": false,
|
|
6426
|
-
"document": "Query End Time",
|
|
6427
|
-
"example": "2019-12-30 23:59:59",
|
|
6428
|
-
"member": "datetime",
|
|
6429
|
-
"name": "ToTime",
|
|
6430
|
-
"required": true,
|
|
6431
|
-
"type": "string"
|
|
6432
|
-
},
|
|
6433
|
-
{
|
|
6434
|
-
"disabled": false,
|
|
6435
|
-
"document": "The domain to query, leave this parameter blank if querying data for all domains",
|
|
6436
|
-
"example": "abc.qcloudwaf.com",
|
|
6675
|
+
"document": "Domain names to be queried",
|
|
6676
|
+
"example": "www.test.com",
|
|
6437
6677
|
"member": "string",
|
|
6438
6678
|
"name": "Domain",
|
|
6439
|
-
"required":
|
|
6679
|
+
"required": true,
|
|
6440
6680
|
"type": "string"
|
|
6441
6681
|
},
|
|
6442
6682
|
{
|
|
6443
6683
|
"disabled": false,
|
|
6444
|
-
"document": "
|
|
6445
|
-
"example": "
|
|
6446
|
-
"member": "
|
|
6447
|
-
"name": "
|
|
6684
|
+
"document": "Page number, defaults to 0.",
|
|
6685
|
+
"example": "0",
|
|
6686
|
+
"member": "uint64",
|
|
6687
|
+
"name": "Offset",
|
|
6448
6688
|
"required": false,
|
|
6449
|
-
"type": "
|
|
6689
|
+
"type": "int"
|
|
6450
6690
|
},
|
|
6451
6691
|
{
|
|
6452
6692
|
"disabled": false,
|
|
6453
|
-
"document": "
|
|
6454
|
-
"example": "
|
|
6455
|
-
"member": "
|
|
6456
|
-
"name": "
|
|
6693
|
+
"document": "Capacity per page. defaults to 10.",
|
|
6694
|
+
"example": "10",
|
|
6695
|
+
"member": "uint64",
|
|
6696
|
+
"name": "Limit",
|
|
6457
6697
|
"required": false,
|
|
6458
|
-
"type": "
|
|
6698
|
+
"type": "int"
|
|
6459
6699
|
},
|
|
6460
6700
|
{
|
|
6461
6701
|
"disabled": false,
|
|
6462
|
-
"document": "
|
|
6463
|
-
"example": "
|
|
6464
|
-
"member": "
|
|
6465
|
-
"name": "
|
|
6702
|
+
"document": "Filter conditions. supports rule ID, CVE ID, and description.",
|
|
6703
|
+
"example": "{\"ExactMatch\": true,\"Name\": \"RuleId\", \"Values\": [\"10000001\"]}",
|
|
6704
|
+
"member": "FiltersItemNew",
|
|
6705
|
+
"name": "Filters",
|
|
6466
6706
|
"required": false,
|
|
6467
|
-
"type": "
|
|
6707
|
+
"type": "list"
|
|
6468
6708
|
}
|
|
6469
6709
|
],
|
|
6470
6710
|
"type": "object"
|
|
6471
6711
|
},
|
|
6472
|
-
"
|
|
6473
|
-
"document": "
|
|
6712
|
+
"DescribeOwaspRuleTypesResponse": {
|
|
6713
|
+
"document": "DescribeOwaspRuleTypes response structure.",
|
|
6474
6714
|
"members": [
|
|
6475
6715
|
{
|
|
6476
6716
|
"disabled": false,
|
|
6477
|
-
"document": "
|
|
6478
|
-
"example": "
|
|
6479
|
-
"member": "
|
|
6480
|
-
"name": "
|
|
6717
|
+
"document": "Number of rule types.",
|
|
6718
|
+
"example": "0",
|
|
6719
|
+
"member": "int64",
|
|
6720
|
+
"name": "Total",
|
|
6721
|
+
"output_required": true,
|
|
6722
|
+
"type": "int",
|
|
6723
|
+
"value_allowed_null": false
|
|
6724
|
+
},
|
|
6725
|
+
{
|
|
6726
|
+
"disabled": false,
|
|
6727
|
+
"document": "Rule type list and information.",
|
|
6728
|
+
"example": "[{\"Name\": \"rulename\",\"Desc\": \"description\",\"RuleTypeStatus\": 0,\"ActiveRuleCount\": 10,\"TotalRuleCount\": 12}]",
|
|
6729
|
+
"member": "OwaspRuleType",
|
|
6730
|
+
"name": "List",
|
|
6481
6731
|
"output_required": true,
|
|
6482
6732
|
"type": "list",
|
|
6483
6733
|
"value_allowed_null": false
|
|
@@ -6491,13 +6741,13 @@
|
|
|
6491
6741
|
],
|
|
6492
6742
|
"type": "object"
|
|
6493
6743
|
},
|
|
6494
|
-
"
|
|
6495
|
-
"document": "
|
|
6744
|
+
"DescribeOwaspRulesRequest": {
|
|
6745
|
+
"document": "DescribeOwaspRules request structure.",
|
|
6496
6746
|
"members": [
|
|
6497
6747
|
{
|
|
6498
6748
|
"disabled": false,
|
|
6499
|
-
"document": "Domain
|
|
6500
|
-
"example": "
|
|
6749
|
+
"document": "Domain to be queried",
|
|
6750
|
+
"example": "www.waf.com",
|
|
6501
6751
|
"member": "string",
|
|
6502
6752
|
"name": "Domain",
|
|
6503
6753
|
"required": true,
|
|
@@ -6505,13 +6755,279 @@
|
|
|
6505
6755
|
},
|
|
6506
6756
|
{
|
|
6507
6757
|
"disabled": false,
|
|
6508
|
-
"document": "
|
|
6509
|
-
"example": "
|
|
6510
|
-
"member": "
|
|
6511
|
-
"name": "
|
|
6512
|
-
"required":
|
|
6513
|
-
"type": "
|
|
6514
|
-
}
|
|
6758
|
+
"document": "Page number, defaults to 0.",
|
|
6759
|
+
"example": "0",
|
|
6760
|
+
"member": "uint64",
|
|
6761
|
+
"name": "Offset",
|
|
6762
|
+
"required": false,
|
|
6763
|
+
"type": "int"
|
|
6764
|
+
},
|
|
6765
|
+
{
|
|
6766
|
+
"disabled": false,
|
|
6767
|
+
"document": "Capacity per page. defaults to 10.",
|
|
6768
|
+
"example": "10",
|
|
6769
|
+
"member": "uint64",
|
|
6770
|
+
"name": "Limit",
|
|
6771
|
+
"required": false,
|
|
6772
|
+
"type": "int"
|
|
6773
|
+
},
|
|
6774
|
+
{
|
|
6775
|
+
"disabled": false,
|
|
6776
|
+
"document": "Specifies the field used to sort. valid values: RuleId, UpdateTime.",
|
|
6777
|
+
"example": "RuleId",
|
|
6778
|
+
"member": "string",
|
|
6779
|
+
"name": "By",
|
|
6780
|
+
"required": false,
|
|
6781
|
+
"type": "string"
|
|
6782
|
+
},
|
|
6783
|
+
{
|
|
6784
|
+
"disabled": false,
|
|
6785
|
+
"document": "Sorting method. supports asc, desc.",
|
|
6786
|
+
"example": "asc",
|
|
6787
|
+
"member": "string",
|
|
6788
|
+
"name": "Order",
|
|
6789
|
+
"required": false,
|
|
6790
|
+
"type": "string"
|
|
6791
|
+
},
|
|
6792
|
+
{
|
|
6793
|
+
"disabled": false,
|
|
6794
|
+
"document": "Specifies the criteria, support rule ID, rule type, rule description, CVE ID, rule Status, and threat level.",
|
|
6795
|
+
"example": "{\"ExactMatch\": true,\"Name\": \"RuleId\", \"Values\": [\"10000001\"]}",
|
|
6796
|
+
"member": "FiltersItemNew",
|
|
6797
|
+
"name": "Filters",
|
|
6798
|
+
"required": false,
|
|
6799
|
+
"type": "list"
|
|
6800
|
+
}
|
|
6801
|
+
],
|
|
6802
|
+
"type": "object"
|
|
6803
|
+
},
|
|
6804
|
+
"DescribeOwaspRulesResponse": {
|
|
6805
|
+
"document": "DescribeOwaspRules response structure.",
|
|
6806
|
+
"members": [
|
|
6807
|
+
{
|
|
6808
|
+
"disabled": false,
|
|
6809
|
+
"document": "Total number of rules.",
|
|
6810
|
+
"example": "1",
|
|
6811
|
+
"member": "uint64",
|
|
6812
|
+
"name": "Total",
|
|
6813
|
+
"output_required": true,
|
|
6814
|
+
"type": "int",
|
|
6815
|
+
"value_allowed_null": false
|
|
6816
|
+
},
|
|
6817
|
+
{
|
|
6818
|
+
"disabled": false,
|
|
6819
|
+
"document": "List of rules",
|
|
6820
|
+
"example": "[{\"CveID\": \"\",\"Description\": \"这\", \"ID\": \"10000041\",\"MainClassID\": \"010000000\",\"MainClassName\": \"XSS攻击\",\"Reason\": 0}]",
|
|
6821
|
+
"member": "OwaspRule",
|
|
6822
|
+
"name": "List",
|
|
6823
|
+
"output_required": true,
|
|
6824
|
+
"type": "list",
|
|
6825
|
+
"value_allowed_null": false
|
|
6826
|
+
},
|
|
6827
|
+
{
|
|
6828
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
6829
|
+
"member": "string",
|
|
6830
|
+
"name": "RequestId",
|
|
6831
|
+
"type": "string"
|
|
6832
|
+
}
|
|
6833
|
+
],
|
|
6834
|
+
"type": "object"
|
|
6835
|
+
},
|
|
6836
|
+
"DescribeOwaspWhiteRulesRequest": {
|
|
6837
|
+
"document": "DescribeOwaspWhiteRules request structure.",
|
|
6838
|
+
"members": [
|
|
6839
|
+
{
|
|
6840
|
+
"disabled": false,
|
|
6841
|
+
"document": "Domain to be queried",
|
|
6842
|
+
"example": "www.waf.com",
|
|
6843
|
+
"member": "string",
|
|
6844
|
+
"name": "Domain",
|
|
6845
|
+
"required": true,
|
|
6846
|
+
"type": "string"
|
|
6847
|
+
},
|
|
6848
|
+
{
|
|
6849
|
+
"disabled": false,
|
|
6850
|
+
"document": "Paginate, defaults to 0.",
|
|
6851
|
+
"example": "0",
|
|
6852
|
+
"member": "uint64",
|
|
6853
|
+
"name": "Offset",
|
|
6854
|
+
"required": false,
|
|
6855
|
+
"type": "int"
|
|
6856
|
+
},
|
|
6857
|
+
{
|
|
6858
|
+
"disabled": false,
|
|
6859
|
+
"document": "Capacity per page. defaults to 10.",
|
|
6860
|
+
"example": "10",
|
|
6861
|
+
"member": "uint64",
|
|
6862
|
+
"name": "Limit",
|
|
6863
|
+
"required": false,
|
|
6864
|
+
"type": "int"
|
|
6865
|
+
},
|
|
6866
|
+
{
|
|
6867
|
+
"disabled": false,
|
|
6868
|
+
"document": "Specifies the field used to sort. valid values: CreateTime (creation time), UpdateTime (update time).",
|
|
6869
|
+
"example": "CreateTime",
|
|
6870
|
+
"member": "string",
|
|
6871
|
+
"name": "By",
|
|
6872
|
+
"required": false,
|
|
6873
|
+
"type": "string"
|
|
6874
|
+
},
|
|
6875
|
+
{
|
|
6876
|
+
"disabled": false,
|
|
6877
|
+
"document": "Sorting method. supports asc, desc.",
|
|
6878
|
+
"example": "asc",
|
|
6879
|
+
"member": "string",
|
|
6880
|
+
"name": "Order",
|
|
6881
|
+
"required": false,
|
|
6882
|
+
"type": "string"
|
|
6883
|
+
},
|
|
6884
|
+
{
|
|
6885
|
+
"disabled": false,
|
|
6886
|
+
"document": "Filter conditions, support RuleId: whitelist rule ID, Name: rule Name, RuleType: whitelist rule type, Status: rule enabling Status, ValidStatus: rule effective Status, TimerType: effective method, ID: specific whitelist ID, determine whether it is a rule ID or type ID based on RuleType.",
|
|
6887
|
+
"example": " [{\"Name\": \"Name\", Values: [\"testname\"], \"ExactMatch\": true}]",
|
|
6888
|
+
"member": "FiltersItemNew",
|
|
6889
|
+
"name": "Filters",
|
|
6890
|
+
"required": false,
|
|
6891
|
+
"type": "list"
|
|
6892
|
+
}
|
|
6893
|
+
],
|
|
6894
|
+
"type": "object"
|
|
6895
|
+
},
|
|
6896
|
+
"DescribeOwaspWhiteRulesResponse": {
|
|
6897
|
+
"document": "DescribeOwaspWhiteRules response structure.",
|
|
6898
|
+
"members": [
|
|
6899
|
+
{
|
|
6900
|
+
"disabled": false,
|
|
6901
|
+
"document": "Total number of rules.",
|
|
6902
|
+
"example": "1",
|
|
6903
|
+
"member": "uint64",
|
|
6904
|
+
"name": "Total",
|
|
6905
|
+
"output_required": true,
|
|
6906
|
+
"type": "int",
|
|
6907
|
+
"value_allowed_null": false
|
|
6908
|
+
},
|
|
6909
|
+
{
|
|
6910
|
+
"disabled": false,
|
|
6911
|
+
"document": "Rule allowlist list",
|
|
6912
|
+
"example": "[{}]",
|
|
6913
|
+
"member": "OwaspWhiteRule",
|
|
6914
|
+
"name": "List",
|
|
6915
|
+
"output_required": true,
|
|
6916
|
+
"type": "list",
|
|
6917
|
+
"value_allowed_null": false
|
|
6918
|
+
},
|
|
6919
|
+
{
|
|
6920
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
6921
|
+
"member": "string",
|
|
6922
|
+
"name": "RequestId",
|
|
6923
|
+
"type": "string"
|
|
6924
|
+
}
|
|
6925
|
+
],
|
|
6926
|
+
"type": "object"
|
|
6927
|
+
},
|
|
6928
|
+
"DescribePeakPointsRequest": {
|
|
6929
|
+
"document": "DescribePeakPoints request structure.",
|
|
6930
|
+
"members": [
|
|
6931
|
+
{
|
|
6932
|
+
"disabled": false,
|
|
6933
|
+
"document": "Query start time",
|
|
6934
|
+
"example": "2019-12-30 00:00:00",
|
|
6935
|
+
"member": "datetime",
|
|
6936
|
+
"name": "FromTime",
|
|
6937
|
+
"required": true,
|
|
6938
|
+
"type": "string"
|
|
6939
|
+
},
|
|
6940
|
+
{
|
|
6941
|
+
"disabled": false,
|
|
6942
|
+
"document": "Query End Time",
|
|
6943
|
+
"example": "2019-12-30 23:59:59",
|
|
6944
|
+
"member": "datetime",
|
|
6945
|
+
"name": "ToTime",
|
|
6946
|
+
"required": true,
|
|
6947
|
+
"type": "string"
|
|
6948
|
+
},
|
|
6949
|
+
{
|
|
6950
|
+
"disabled": false,
|
|
6951
|
+
"document": "The domain to query, leave this parameter blank if querying data for all domains",
|
|
6952
|
+
"example": "abc.qcloudwaf.com",
|
|
6953
|
+
"member": "string",
|
|
6954
|
+
"name": "Domain",
|
|
6955
|
+
"required": false,
|
|
6956
|
+
"type": "string"
|
|
6957
|
+
},
|
|
6958
|
+
{
|
|
6959
|
+
"disabled": false,
|
|
6960
|
+
"document": "Only two values are valid: sparta-waf, clb-waf. No filtering if not input.",
|
|
6961
|
+
"example": "sparta-waf",
|
|
6962
|
+
"member": "string",
|
|
6963
|
+
"name": "Edition",
|
|
6964
|
+
"required": false,
|
|
6965
|
+
"type": "string"
|
|
6966
|
+
},
|
|
6967
|
+
{
|
|
6968
|
+
"disabled": false,
|
|
6969
|
+
"document": "WAF instance ID. No filter will be carried out if it is not input.",
|
|
6970
|
+
"example": "waf_000q3t12p",
|
|
6971
|
+
"member": "string",
|
|
6972
|
+
"name": "InstanceID",
|
|
6973
|
+
"required": false,
|
|
6974
|
+
"type": "string"
|
|
6975
|
+
},
|
|
6976
|
+
{
|
|
6977
|
+
"disabled": false,
|
|
6978
|
+
"document": "Twelve available values:\naccess: peak QPS trend chart\nbotAccess: peak bot QPS trend chart\ndown: downstream peak bandwidth trend chart\nup: upstream peak bandwidth trend chart\nattack: trend chart of total web attacks\ncc: trend chart of total CC attacks\nbw: trend chart of total attacks from blocklisted IP addresses\ntamper: trend chart of total tampering attacks\nleak: total leakage trend chart\nacl: trend chart of total access control attacks\nhttp_status: status code trend chart\nwx_access: trend chart of peak WeChat mini program QPS",
|
|
6979
|
+
"example": "access",
|
|
6980
|
+
"member": "string",
|
|
6981
|
+
"name": "MetricName",
|
|
6982
|
+
"required": false,
|
|
6983
|
+
"type": "string"
|
|
6984
|
+
}
|
|
6985
|
+
],
|
|
6986
|
+
"type": "object"
|
|
6987
|
+
},
|
|
6988
|
+
"DescribePeakPointsResponse": {
|
|
6989
|
+
"document": "DescribePeakPoints response structure.",
|
|
6990
|
+
"members": [
|
|
6991
|
+
{
|
|
6992
|
+
"disabled": false,
|
|
6993
|
+
"document": "Data points",
|
|
6994
|
+
"example": "[{\"Access\":10}]",
|
|
6995
|
+
"member": "PeakPointsItem",
|
|
6996
|
+
"name": "Points",
|
|
6997
|
+
"output_required": true,
|
|
6998
|
+
"type": "list",
|
|
6999
|
+
"value_allowed_null": false
|
|
7000
|
+
},
|
|
7001
|
+
{
|
|
7002
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
7003
|
+
"member": "string",
|
|
7004
|
+
"name": "RequestId",
|
|
7005
|
+
"type": "string"
|
|
7006
|
+
}
|
|
7007
|
+
],
|
|
7008
|
+
"type": "object"
|
|
7009
|
+
},
|
|
7010
|
+
"DescribePolicyStatusRequest": {
|
|
7011
|
+
"document": "DescribePolicyStatus request structure.",
|
|
7012
|
+
"members": [
|
|
7013
|
+
{
|
|
7014
|
+
"disabled": false,
|
|
7015
|
+
"document": "Domain name",
|
|
7016
|
+
"example": "test.com",
|
|
7017
|
+
"member": "string",
|
|
7018
|
+
"name": "Domain",
|
|
7019
|
+
"required": true,
|
|
7020
|
+
"type": "string"
|
|
7021
|
+
},
|
|
7022
|
+
{
|
|
7023
|
+
"disabled": false,
|
|
7024
|
+
"document": "clb-waf or saas-waf",
|
|
7025
|
+
"example": "clb-waf",
|
|
7026
|
+
"member": "string",
|
|
7027
|
+
"name": "Edition",
|
|
7028
|
+
"required": true,
|
|
7029
|
+
"type": "string"
|
|
7030
|
+
}
|
|
6515
7031
|
],
|
|
6516
7032
|
"type": "object"
|
|
6517
7033
|
},
|
|
@@ -10195,7 +10711,7 @@
|
|
|
10195
10711
|
"members": [
|
|
10196
10712
|
{
|
|
10197
10713
|
"disabled": false,
|
|
10198
|
-
"document": "Time
|
|
10714
|
+
"document": "Time parameter for scheduled execution.",
|
|
10199
10715
|
"example": "[{\"StartDateTime\":1711618518\t,\"EndDateTime\":1711918518}]",
|
|
10200
10716
|
"member": "TimedJob",
|
|
10201
10717
|
"name": "Timed",
|
|
@@ -10206,7 +10722,7 @@
|
|
|
10206
10722
|
},
|
|
10207
10723
|
{
|
|
10208
10724
|
"disabled": false,
|
|
10209
|
-
"document": "Time
|
|
10725
|
+
"document": "Time parameter for periodic execution.",
|
|
10210
10726
|
"example": "[{\"Day\":12,\"WDay\":2,\"StartTime\":\"12:11\",\"EndTime\":\"21:00\"}]",
|
|
10211
10727
|
"member": "CronJob",
|
|
10212
10728
|
"name": "Cron",
|
|
@@ -10217,7 +10733,7 @@
|
|
|
10217
10733
|
},
|
|
10218
10734
|
{
|
|
10219
10735
|
"disabled": false,
|
|
10220
|
-
"document": "
|
|
10736
|
+
"document": "Specifies the time zone.",
|
|
10221
10737
|
"example": "UTC+8\t",
|
|
10222
10738
|
"member": "string",
|
|
10223
10739
|
"name": "TimeTZone",
|
|
@@ -12499,13 +13015,13 @@
|
|
|
12499
13015
|
],
|
|
12500
13016
|
"type": "object"
|
|
12501
13017
|
},
|
|
12502
|
-
"
|
|
12503
|
-
"document": "
|
|
13018
|
+
"ModifyOwaspRuleStatusRequest": {
|
|
13019
|
+
"document": "ModifyOwaspRuleStatus request structure.",
|
|
12504
13020
|
"members": [
|
|
12505
13021
|
{
|
|
12506
13022
|
"disabled": false,
|
|
12507
13023
|
"document": "Domain name",
|
|
12508
|
-
"example": "
|
|
13024
|
+
"example": "无",
|
|
12509
13025
|
"member": "string",
|
|
12510
13026
|
"name": "Domain",
|
|
12511
13027
|
"required": true,
|
|
@@ -12513,27 +13029,54 @@
|
|
|
12513
13029
|
},
|
|
12514
13030
|
{
|
|
12515
13031
|
"disabled": false,
|
|
12516
|
-
"document": "
|
|
13032
|
+
"document": "Rule switch. valid values: 0 (disabled), 1 (enabled), 2 (observation only).",
|
|
12517
13033
|
"example": "0",
|
|
12518
|
-
"member": "
|
|
12519
|
-
"name": "
|
|
13034
|
+
"member": "int64",
|
|
13035
|
+
"name": "RuleStatus",
|
|
12520
13036
|
"required": true,
|
|
12521
13037
|
"type": "int"
|
|
12522
13038
|
},
|
|
12523
13039
|
{
|
|
12524
13040
|
"disabled": false,
|
|
12525
|
-
"document": "
|
|
12526
|
-
"example": "
|
|
12527
|
-
"member": "
|
|
12528
|
-
"name": "
|
|
12529
|
-
"required":
|
|
12530
|
-
"type": "
|
|
13041
|
+
"document": "Specifies whether to select all.",
|
|
13042
|
+
"example": "true",
|
|
13043
|
+
"member": "bool",
|
|
13044
|
+
"name": "SelectAll",
|
|
13045
|
+
"required": true,
|
|
13046
|
+
"type": "bool"
|
|
13047
|
+
},
|
|
13048
|
+
{
|
|
13049
|
+
"disabled": false,
|
|
13050
|
+
"document": "Rule ID list",
|
|
13051
|
+
"example": "[10000000,20000000]",
|
|
13052
|
+
"member": "string",
|
|
13053
|
+
"name": "RuleIDs",
|
|
13054
|
+
"required": false,
|
|
13055
|
+
"type": "list"
|
|
13056
|
+
},
|
|
13057
|
+
{
|
|
13058
|
+
"disabled": false,
|
|
13059
|
+
"document": "If reverse requires the input of data type.",
|
|
13060
|
+
"example": "10000",
|
|
13061
|
+
"member": "uint64",
|
|
13062
|
+
"name": "TypeId",
|
|
13063
|
+
"required": false,
|
|
13064
|
+
"type": "int"
|
|
13065
|
+
},
|
|
13066
|
+
{
|
|
13067
|
+
"disabled": false,
|
|
13068
|
+
"document": "Reason for modification. valid values: 0: none (compatibility record is empty). 1: avoid false positives due to business characteristics. 2: reporting of rule-based false positives. 3: gray release of core business rules. 4: others.",
|
|
13069
|
+
"example": "0",
|
|
13070
|
+
"member": "int64",
|
|
13071
|
+
"name": "Reason",
|
|
13072
|
+
"required": false,
|
|
13073
|
+
"type": "int"
|
|
12531
13074
|
}
|
|
12532
13075
|
],
|
|
12533
13076
|
"type": "object"
|
|
12534
13077
|
},
|
|
12535
|
-
"
|
|
12536
|
-
"document": "
|
|
13078
|
+
"ModifyOwaspRuleStatusResponse": {
|
|
13079
|
+
"document": "ModifyOwaspRuleStatus response structure.",
|
|
12537
13080
|
"members": [
|
|
12538
13081
|
{
|
|
12539
13082
|
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
@@ -12544,13 +13087,13 @@
|
|
|
12544
13087
|
],
|
|
12545
13088
|
"type": "object"
|
|
12546
13089
|
},
|
|
12547
|
-
"
|
|
12548
|
-
"document": "
|
|
13090
|
+
"ModifyOwaspRuleTypeActionRequest": {
|
|
13091
|
+
"document": "ModifyOwaspRuleTypeAction request structure.",
|
|
12549
13092
|
"members": [
|
|
12550
13093
|
{
|
|
12551
13094
|
"disabled": false,
|
|
12552
13095
|
"document": "Domain name",
|
|
12553
|
-
"example": "
|
|
13096
|
+
"example": "无",
|
|
12554
13097
|
"member": "string",
|
|
12555
13098
|
"name": "Domain",
|
|
12556
13099
|
"required": true,
|
|
@@ -12558,36 +13101,27 @@
|
|
|
12558
13101
|
},
|
|
12559
13102
|
{
|
|
12560
13103
|
"disabled": false,
|
|
12561
|
-
"document": "
|
|
12562
|
-
"example": "
|
|
12563
|
-
"member": "uint64",
|
|
12564
|
-
"name": "Mode",
|
|
12565
|
-
"required": true,
|
|
12566
|
-
"type": "int"
|
|
12567
|
-
},
|
|
12568
|
-
{
|
|
12569
|
-
"disabled": false,
|
|
12570
|
-
"document": "Version of WAF. clb-waf indicates CLB WAF; sparta-waf indicates SaaS WAF. sparta-waf by default.",
|
|
12571
|
-
"example": "sparta-waf",
|
|
13104
|
+
"document": "Rule type ID list.",
|
|
13105
|
+
"example": "[10000000,20000000]",
|
|
12572
13106
|
"member": "string",
|
|
12573
|
-
"name": "
|
|
12574
|
-
"required":
|
|
12575
|
-
"type": "
|
|
13107
|
+
"name": "TypeIDs",
|
|
13108
|
+
"required": true,
|
|
13109
|
+
"type": "list"
|
|
12576
13110
|
},
|
|
12577
13111
|
{
|
|
12578
13112
|
"disabled": false,
|
|
12579
|
-
"document": "
|
|
13113
|
+
"document": "Protection mode of the rule type. valid values: 0 (observation), 1 (intercept).",
|
|
12580
13114
|
"example": "0",
|
|
12581
|
-
"member": "
|
|
12582
|
-
"name": "
|
|
12583
|
-
"required":
|
|
13115
|
+
"member": "int64",
|
|
13116
|
+
"name": "RuleTypeAction",
|
|
13117
|
+
"required": true,
|
|
12584
13118
|
"type": "int"
|
|
12585
13119
|
}
|
|
12586
13120
|
],
|
|
12587
13121
|
"type": "object"
|
|
12588
13122
|
},
|
|
12589
|
-
"
|
|
12590
|
-
"document": "
|
|
13123
|
+
"ModifyOwaspRuleTypeActionResponse": {
|
|
13124
|
+
"document": "ModifyOwaspRuleTypeAction response structure.",
|
|
12591
13125
|
"members": [
|
|
12592
13126
|
{
|
|
12593
13127
|
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
@@ -12598,13 +13132,13 @@
|
|
|
12598
13132
|
],
|
|
12599
13133
|
"type": "object"
|
|
12600
13134
|
},
|
|
12601
|
-
"
|
|
12602
|
-
"document": "
|
|
13135
|
+
"ModifyOwaspRuleTypeLevelRequest": {
|
|
13136
|
+
"document": "ModifyOwaspRuleTypeLevel request structure.",
|
|
12603
13137
|
"members": [
|
|
12604
13138
|
{
|
|
12605
13139
|
"disabled": false,
|
|
12606
13140
|
"document": "Domain name",
|
|
12607
|
-
"example": "
|
|
13141
|
+
"example": "无",
|
|
12608
13142
|
"member": "string",
|
|
12609
13143
|
"name": "Domain",
|
|
12610
13144
|
"required": true,
|
|
@@ -12612,166 +13146,463 @@
|
|
|
12612
13146
|
},
|
|
12613
13147
|
{
|
|
12614
13148
|
"disabled": false,
|
|
12615
|
-
"document": "
|
|
12616
|
-
"example": "
|
|
12617
|
-
"member": "string",
|
|
12618
|
-
"name": "DomainId",
|
|
12619
|
-
"required": true,
|
|
12620
|
-
"type": "string"
|
|
12621
|
-
},
|
|
12622
|
-
{
|
|
12623
|
-
"disabled": false,
|
|
12624
|
-
"document": "Required. Instance ID of the domain name",
|
|
12625
|
-
"example": "waf_2kw60jg00908e8j3",
|
|
13149
|
+
"document": "Rule type ID list.",
|
|
13150
|
+
"example": "[10000000,20000000]",
|
|
12626
13151
|
"member": "string",
|
|
12627
|
-
"name": "
|
|
13152
|
+
"name": "TypeIDs",
|
|
12628
13153
|
"required": true,
|
|
12629
|
-
"type": "
|
|
13154
|
+
"type": "list"
|
|
12630
13155
|
},
|
|
12631
13156
|
{
|
|
12632
13157
|
"disabled": false,
|
|
12633
|
-
"document": "
|
|
12634
|
-
"example": "
|
|
13158
|
+
"document": "Protection level of the rule. valid values: 100 (loose), 200 (normal), 300 (strict), 400 (ultra-strict).",
|
|
13159
|
+
"example": "100",
|
|
12635
13160
|
"member": "int64",
|
|
12636
|
-
"name": "
|
|
12637
|
-
"required":
|
|
13161
|
+
"name": "RuleTypeLevel",
|
|
13162
|
+
"required": true,
|
|
12638
13163
|
"type": "int"
|
|
12639
|
-
}
|
|
13164
|
+
}
|
|
13165
|
+
],
|
|
13166
|
+
"type": "object"
|
|
13167
|
+
},
|
|
13168
|
+
"ModifyOwaspRuleTypeLevelResponse": {
|
|
13169
|
+
"document": "ModifyOwaspRuleTypeLevel response structure.",
|
|
13170
|
+
"members": [
|
|
12640
13171
|
{
|
|
12641
|
-
"
|
|
12642
|
-
"document": "When CertType is 1, this parameter is required, indicating the self-owned certificate chain",
|
|
12643
|
-
"example": "-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----",
|
|
13172
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
12644
13173
|
"member": "string",
|
|
12645
|
-
"name": "
|
|
12646
|
-
"required": false,
|
|
13174
|
+
"name": "RequestId",
|
|
12647
13175
|
"type": "string"
|
|
12648
|
-
}
|
|
13176
|
+
}
|
|
13177
|
+
],
|
|
13178
|
+
"type": "object"
|
|
13179
|
+
},
|
|
13180
|
+
"ModifyOwaspRuleTypeStatusRequest": {
|
|
13181
|
+
"document": "ModifyOwaspRuleTypeStatus request structure.",
|
|
13182
|
+
"members": [
|
|
12649
13183
|
{
|
|
12650
13184
|
"disabled": false,
|
|
12651
|
-
"document": "
|
|
12652
|
-
"example": "
|
|
13185
|
+
"document": "Domain name",
|
|
13186
|
+
"example": "无",
|
|
12653
13187
|
"member": "string",
|
|
12654
|
-
"name": "
|
|
12655
|
-
"required":
|
|
13188
|
+
"name": "Domain",
|
|
13189
|
+
"required": true,
|
|
12656
13190
|
"type": "string"
|
|
12657
13191
|
},
|
|
12658
13192
|
{
|
|
12659
13193
|
"disabled": false,
|
|
12660
|
-
"document": "
|
|
12661
|
-
"example": "
|
|
13194
|
+
"document": "Rule type ID list.",
|
|
13195
|
+
"example": "[10000000,20000000]",
|
|
12662
13196
|
"member": "string",
|
|
12663
|
-
"name": "
|
|
12664
|
-
"required":
|
|
12665
|
-
"type": "
|
|
13197
|
+
"name": "TypeIDs",
|
|
13198
|
+
"required": true,
|
|
13199
|
+
"type": "list"
|
|
12666
13200
|
},
|
|
12667
13201
|
{
|
|
12668
13202
|
"disabled": false,
|
|
12669
|
-
"document": "
|
|
13203
|
+
"document": "The switch status of the rule type. valid values: 0 (disabled), 1 (enabled).",
|
|
12670
13204
|
"example": "0",
|
|
12671
13205
|
"member": "int64",
|
|
12672
|
-
"name": "
|
|
12673
|
-
"required":
|
|
13206
|
+
"name": "RuleTypeStatus",
|
|
13207
|
+
"required": true,
|
|
13208
|
+
"type": "int"
|
|
13209
|
+
}
|
|
13210
|
+
],
|
|
13211
|
+
"type": "object"
|
|
13212
|
+
},
|
|
13213
|
+
"ModifyOwaspRuleTypeStatusResponse": {
|
|
13214
|
+
"document": "ModifyOwaspRuleTypeStatus response structure.",
|
|
13215
|
+
"members": [
|
|
13216
|
+
{
|
|
13217
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
13218
|
+
"member": "string",
|
|
13219
|
+
"name": "RequestId",
|
|
13220
|
+
"type": "string"
|
|
13221
|
+
}
|
|
13222
|
+
],
|
|
13223
|
+
"type": "object"
|
|
13224
|
+
},
|
|
13225
|
+
"ModifyOwaspWhiteRuleRequest": {
|
|
13226
|
+
"document": "ModifyOwaspWhiteRule request structure.",
|
|
13227
|
+
"members": [
|
|
13228
|
+
{
|
|
13229
|
+
"disabled": false,
|
|
13230
|
+
"document": "Rule ID",
|
|
13231
|
+
"example": "10011",
|
|
13232
|
+
"member": "uint64",
|
|
13233
|
+
"name": "RuleId",
|
|
13234
|
+
"required": true,
|
|
12674
13235
|
"type": "int"
|
|
12675
13236
|
},
|
|
12676
13237
|
{
|
|
12677
13238
|
"disabled": false,
|
|
12678
|
-
"document": "
|
|
12679
|
-
"example": "
|
|
13239
|
+
"document": "Rule name",
|
|
13240
|
+
"example": "rulename",
|
|
12680
13241
|
"member": "string",
|
|
12681
|
-
"name": "
|
|
12682
|
-
"required":
|
|
13242
|
+
"name": "Name",
|
|
13243
|
+
"required": true,
|
|
12683
13244
|
"type": "string"
|
|
12684
13245
|
},
|
|
12685
13246
|
{
|
|
12686
13247
|
"disabled": false,
|
|
12687
|
-
"document": "
|
|
12688
|
-
"example": "
|
|
13248
|
+
"document": "Domain name",
|
|
13249
|
+
"example": "www.test.com",
|
|
12689
13250
|
"member": "string",
|
|
12690
|
-
"name": "
|
|
12691
|
-
"required":
|
|
13251
|
+
"name": "Domain",
|
|
13252
|
+
"required": true,
|
|
12692
13253
|
"type": "string"
|
|
12693
13254
|
},
|
|
12694
13255
|
{
|
|
12695
13256
|
"disabled": false,
|
|
12696
|
-
"document": "
|
|
12697
|
-
"example": "
|
|
13257
|
+
"document": "Rule-Based matching policy list.",
|
|
13258
|
+
"example": "[{\"Field\": \"URL\",\"Arg\": \"\",\"CompareFunc\": \"eq\",\"Content\": \"/acl\"}]",
|
|
13259
|
+
"member": "Strategy",
|
|
13260
|
+
"name": "Strategies",
|
|
13261
|
+
"required": true,
|
|
13262
|
+
"type": "list"
|
|
13263
|
+
},
|
|
13264
|
+
{
|
|
13265
|
+
"disabled": false,
|
|
13266
|
+
"document": "ID list of allowlisted rules.",
|
|
13267
|
+
"example": "[90501998, 90501999]",
|
|
12698
13268
|
"member": "uint64",
|
|
12699
|
-
"name": "
|
|
12700
|
-
"required":
|
|
12701
|
-
"type": "
|
|
13269
|
+
"name": "Ids",
|
|
13270
|
+
"required": true,
|
|
13271
|
+
"type": "list"
|
|
12702
13272
|
},
|
|
12703
13273
|
{
|
|
12704
13274
|
"disabled": false,
|
|
12705
|
-
"document": "
|
|
13275
|
+
"document": "Allowlist type. valid values: 0 (allowlisting by specific rule ID), 1 (allowlisting by rule type).",
|
|
12706
13276
|
"example": "0",
|
|
12707
13277
|
"member": "int64",
|
|
12708
|
-
"name": "
|
|
12709
|
-
"required":
|
|
13278
|
+
"name": "Type",
|
|
13279
|
+
"required": true,
|
|
12710
13280
|
"type": "int"
|
|
12711
13281
|
},
|
|
12712
13282
|
{
|
|
12713
13283
|
"disabled": false,
|
|
12714
|
-
"document": "
|
|
12715
|
-
"example": "
|
|
13284
|
+
"document": "Rule execution mode: TimedJob indicates scheduled execution. CronJob indicates periodic execution.",
|
|
13285
|
+
"example": "TimedJob",
|
|
12716
13286
|
"member": "string",
|
|
12717
|
-
"name": "
|
|
12718
|
-
"required":
|
|
13287
|
+
"name": "JobType",
|
|
13288
|
+
"required": true,
|
|
12719
13289
|
"type": "string"
|
|
12720
13290
|
},
|
|
12721
13291
|
{
|
|
12722
13292
|
"disabled": false,
|
|
12723
|
-
"document": "
|
|
12724
|
-
"example": "[\"
|
|
12725
|
-
"member": "
|
|
12726
|
-
"name": "
|
|
12727
|
-
"required":
|
|
12728
|
-
"type": "
|
|
13293
|
+
"document": "Scheduled task configuration",
|
|
13294
|
+
"example": "{\"Timed\":[{\"StartDateTime\":1711618518,\"EndDateTime\":1711918518}],\"Cron\":[{\"Day\":12,\"WDay\":2,\"StartTime\":\"12:11\",\"EndTime\":\"21:00\"}],\"TimeTZone\":\"UTC+8\"}",
|
|
13295
|
+
"member": "JobDateTime",
|
|
13296
|
+
"name": "JobDateTime",
|
|
13297
|
+
"required": true,
|
|
13298
|
+
"type": "object"
|
|
12729
13299
|
},
|
|
12730
13300
|
{
|
|
12731
13301
|
"disabled": false,
|
|
12732
|
-
"document": "
|
|
13302
|
+
"document": "If the JobDateTime field is not set, this field is used. 0 means permanent, other values indicate the cutoff time for scheduled effect (unit: seconds).",
|
|
12733
13303
|
"example": "0",
|
|
12734
|
-
"member": "
|
|
12735
|
-
"name": "
|
|
12736
|
-
"required":
|
|
13304
|
+
"member": "uint64",
|
|
13305
|
+
"name": "ExpireTime",
|
|
13306
|
+
"required": true,
|
|
12737
13307
|
"type": "int"
|
|
12738
13308
|
},
|
|
12739
13309
|
{
|
|
12740
13310
|
"disabled": false,
|
|
12741
|
-
"document": "
|
|
12742
|
-
"example": "
|
|
12743
|
-
"member": "
|
|
12744
|
-
"name": "
|
|
13311
|
+
"document": "Rule status. valid values: 0 (disabled), 1 (enabled). enabled by default.",
|
|
13312
|
+
"example": "1",
|
|
13313
|
+
"member": "uint64",
|
|
13314
|
+
"name": "Status",
|
|
12745
13315
|
"required": false,
|
|
12746
13316
|
"type": "int"
|
|
12747
|
-
}
|
|
13317
|
+
}
|
|
13318
|
+
],
|
|
13319
|
+
"type": "object"
|
|
13320
|
+
},
|
|
13321
|
+
"ModifyOwaspWhiteRuleResponse": {
|
|
13322
|
+
"document": "ModifyOwaspWhiteRule response structure.",
|
|
13323
|
+
"members": [
|
|
13324
|
+
{
|
|
13325
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
13326
|
+
"member": "string",
|
|
13327
|
+
"name": "RequestId",
|
|
13328
|
+
"type": "string"
|
|
13329
|
+
}
|
|
13330
|
+
],
|
|
13331
|
+
"type": "object"
|
|
13332
|
+
},
|
|
13333
|
+
"ModifyProtectionStatusRequest": {
|
|
13334
|
+
"document": "ModifyProtectionStatus request structure.",
|
|
13335
|
+
"members": [
|
|
12748
13336
|
{
|
|
12749
13337
|
"disabled": false,
|
|
12750
|
-
"document": "
|
|
12751
|
-
"example": "
|
|
12752
|
-
"member": "
|
|
12753
|
-
"name": "
|
|
12754
|
-
"required":
|
|
12755
|
-
"type": "
|
|
13338
|
+
"document": "Domain name",
|
|
13339
|
+
"example": "www.qcloudwaf.com",
|
|
13340
|
+
"member": "string",
|
|
13341
|
+
"name": "Domain",
|
|
13342
|
+
"required": true,
|
|
13343
|
+
"type": "string"
|
|
12756
13344
|
},
|
|
12757
13345
|
{
|
|
12758
13346
|
"disabled": false,
|
|
12759
|
-
"document": "
|
|
13347
|
+
"document": "Status",
|
|
12760
13348
|
"example": "0",
|
|
12761
|
-
"member": "
|
|
12762
|
-
"name": "
|
|
12763
|
-
"required":
|
|
13349
|
+
"member": "uint64",
|
|
13350
|
+
"name": "Status",
|
|
13351
|
+
"required": true,
|
|
12764
13352
|
"type": "int"
|
|
12765
13353
|
},
|
|
12766
13354
|
{
|
|
12767
13355
|
"disabled": false,
|
|
12768
|
-
"document": "
|
|
12769
|
-
"example": "
|
|
13356
|
+
"document": "Version of WAF. clb-waf indicates CLB WAF; sparta-waf indicates SaaS WAF. sparta-waf by default.",
|
|
13357
|
+
"example": "clb-waf",
|
|
12770
13358
|
"member": "string",
|
|
12771
13359
|
"name": "Edition",
|
|
12772
13360
|
"required": false,
|
|
12773
13361
|
"type": "string"
|
|
12774
|
-
}
|
|
13362
|
+
}
|
|
13363
|
+
],
|
|
13364
|
+
"type": "object"
|
|
13365
|
+
},
|
|
13366
|
+
"ModifyProtectionStatusResponse": {
|
|
13367
|
+
"document": "ModifyProtectionStatus response structure.",
|
|
13368
|
+
"members": [
|
|
13369
|
+
{
|
|
13370
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
13371
|
+
"member": "string",
|
|
13372
|
+
"name": "RequestId",
|
|
13373
|
+
"type": "string"
|
|
13374
|
+
}
|
|
13375
|
+
],
|
|
13376
|
+
"type": "object"
|
|
13377
|
+
},
|
|
13378
|
+
"ModifySpartaProtectionModeRequest": {
|
|
13379
|
+
"document": "ModifySpartaProtectionMode request structure.",
|
|
13380
|
+
"members": [
|
|
13381
|
+
{
|
|
13382
|
+
"disabled": false,
|
|
13383
|
+
"document": "Domain name",
|
|
13384
|
+
"example": "www.test.com",
|
|
13385
|
+
"member": "string",
|
|
13386
|
+
"name": "Domain",
|
|
13387
|
+
"required": true,
|
|
13388
|
+
"type": "string"
|
|
13389
|
+
},
|
|
13390
|
+
{
|
|
13391
|
+
"disabled": false,
|
|
13392
|
+
"document": "Protection status:\n10: rule-based observation and AI disabling; 11: rule- and AI-based observation; 12: rule-based observation and AI-based interception\n20: rule-based interception and AI disabling; 21: rule-based interception and AI-based observation; 22: rule- and AI-based interception",
|
|
13393
|
+
"example": "22",
|
|
13394
|
+
"member": "uint64",
|
|
13395
|
+
"name": "Mode",
|
|
13396
|
+
"required": true,
|
|
13397
|
+
"type": "int"
|
|
13398
|
+
},
|
|
13399
|
+
{
|
|
13400
|
+
"disabled": false,
|
|
13401
|
+
"document": "Version of WAF. clb-waf indicates CLB WAF; sparta-waf indicates SaaS WAF. sparta-waf by default.",
|
|
13402
|
+
"example": "sparta-waf",
|
|
13403
|
+
"member": "string",
|
|
13404
|
+
"name": "Edition",
|
|
13405
|
+
"required": false,
|
|
13406
|
+
"type": "string"
|
|
13407
|
+
},
|
|
13408
|
+
{
|
|
13409
|
+
"disabled": false,
|
|
13410
|
+
"document": "0 is for modifying the Rule Engine Status; 1 is for modifying the AI Status",
|
|
13411
|
+
"example": "0",
|
|
13412
|
+
"member": "uint64",
|
|
13413
|
+
"name": "Type",
|
|
13414
|
+
"required": false,
|
|
13415
|
+
"type": "int"
|
|
13416
|
+
}
|
|
13417
|
+
],
|
|
13418
|
+
"type": "object"
|
|
13419
|
+
},
|
|
13420
|
+
"ModifySpartaProtectionModeResponse": {
|
|
13421
|
+
"document": "ModifySpartaProtectionMode response structure.",
|
|
13422
|
+
"members": [
|
|
13423
|
+
{
|
|
13424
|
+
"document": "The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.",
|
|
13425
|
+
"member": "string",
|
|
13426
|
+
"name": "RequestId",
|
|
13427
|
+
"type": "string"
|
|
13428
|
+
}
|
|
13429
|
+
],
|
|
13430
|
+
"type": "object"
|
|
13431
|
+
},
|
|
13432
|
+
"ModifySpartaProtectionRequest": {
|
|
13433
|
+
"document": "ModifySpartaProtection request structure.",
|
|
13434
|
+
"members": [
|
|
13435
|
+
{
|
|
13436
|
+
"disabled": false,
|
|
13437
|
+
"document": "Domain name",
|
|
13438
|
+
"example": "randy.qcloudwaf.com",
|
|
13439
|
+
"member": "string",
|
|
13440
|
+
"name": "Domain",
|
|
13441
|
+
"required": true,
|
|
13442
|
+
"type": "string"
|
|
13443
|
+
},
|
|
13444
|
+
{
|
|
13445
|
+
"disabled": false,
|
|
13446
|
+
"document": "Required. Unique domain name ID",
|
|
13447
|
+
"example": "42059f9a9905519d8f9e72a823891544",
|
|
13448
|
+
"member": "string",
|
|
13449
|
+
"name": "DomainId",
|
|
13450
|
+
"required": true,
|
|
13451
|
+
"type": "string"
|
|
13452
|
+
},
|
|
13453
|
+
{
|
|
13454
|
+
"disabled": false,
|
|
13455
|
+
"document": "Required. Instance ID of the domain name",
|
|
13456
|
+
"example": "waf_2kw60jg00908e8j3",
|
|
13457
|
+
"member": "string",
|
|
13458
|
+
"name": "InstanceID",
|
|
13459
|
+
"required": true,
|
|
13460
|
+
"type": "string"
|
|
13461
|
+
},
|
|
13462
|
+
{
|
|
13463
|
+
"disabled": false,
|
|
13464
|
+
"document": "Certificate type. 0: no certificate, with only the HTTP listening port configured; 1: self-owned certificate; 2: managed certificate.",
|
|
13465
|
+
"example": "0",
|
|
13466
|
+
"member": "int64",
|
|
13467
|
+
"name": "CertType",
|
|
13468
|
+
"required": false,
|
|
13469
|
+
"type": "int"
|
|
13470
|
+
},
|
|
13471
|
+
{
|
|
13472
|
+
"disabled": false,
|
|
13473
|
+
"document": "When CertType is 1, this parameter is required, indicating the self-owned certificate chain",
|
|
13474
|
+
"example": "-----BEGIN CERTIFICATE----- xxx -----END CERTIFICATE-----",
|
|
13475
|
+
"member": "string",
|
|
13476
|
+
"name": "Cert",
|
|
13477
|
+
"required": false,
|
|
13478
|
+
"type": "string"
|
|
13479
|
+
},
|
|
13480
|
+
{
|
|
13481
|
+
"disabled": false,
|
|
13482
|
+
"document": "When CertType=1, this parameter is required, indicating the private key of the self-owned certificate.",
|
|
13483
|
+
"example": "-----BEGIN RSA PRIVATE KEY----- xxx -----END RSA PRIVATE KEY-----",
|
|
13484
|
+
"member": "string",
|
|
13485
|
+
"name": "PrivateKey",
|
|
13486
|
+
"required": false,
|
|
13487
|
+
"type": "string"
|
|
13488
|
+
},
|
|
13489
|
+
{
|
|
13490
|
+
"disabled": false,
|
|
13491
|
+
"document": "When CertType is 2, this parameter must be filled, indicating the certificate ID hosted on Tencent Cloud's SSL platform",
|
|
13492
|
+
"example": "cKnKQLJ",
|
|
13493
|
+
"member": "string",
|
|
13494
|
+
"name": "SSLId",
|
|
13495
|
+
"required": false,
|
|
13496
|
+
"type": "string"
|
|
13497
|
+
},
|
|
13498
|
+
{
|
|
13499
|
+
"disabled": false,
|
|
13500
|
+
"document": "Whether a layer-7 proxy service is deployed before the WAF. 0: No proxy service is deployed; 1: The proxy service is deployed. The WAF will use XFF to obtain the client IP address; 2: The proxy service is deployed. The WAF will use remote_addr to obtain the client IP address; 3: The proxy service is deployed. The WAF will use a custom header in ip_headers to obtain the client IP address.",
|
|
13501
|
+
"example": "0",
|
|
13502
|
+
"member": "int64",
|
|
13503
|
+
"name": "IsCdn",
|
|
13504
|
+
"required": false,
|
|
13505
|
+
"type": "int"
|
|
13506
|
+
},
|
|
13507
|
+
{
|
|
13508
|
+
"disabled": false,
|
|
13509
|
+
"document": "Origin-pull protocol for HTTPS when the service is configured with an HTTPS port.\nhttp: Use the HTTP protocol for origin-pull. It is used with HttpsUpstreamPort.\nhttps: Use the HTTPS protocol for origin-pull.",
|
|
13510
|
+
"example": "https",
|
|
13511
|
+
"member": "string",
|
|
13512
|
+
"name": "UpstreamScheme",
|
|
13513
|
+
"required": false,
|
|
13514
|
+
"type": "string"
|
|
13515
|
+
},
|
|
13516
|
+
{
|
|
13517
|
+
"disabled": false,
|
|
13518
|
+
"document": "HTTPS upstream port, required only when UpstreamScheme is http",
|
|
13519
|
+
"example": "\"80,443\"",
|
|
13520
|
+
"member": "string",
|
|
13521
|
+
"name": "HttpsUpstreamPort",
|
|
13522
|
+
"required": false,
|
|
13523
|
+
"type": "string"
|
|
13524
|
+
},
|
|
13525
|
+
{
|
|
13526
|
+
"disabled": false,
|
|
13527
|
+
"document": "Whether to enable forced redirection from HTTP to HTTPS. 0: disable; 1: enable",
|
|
13528
|
+
"example": "1",
|
|
13529
|
+
"member": "uint64",
|
|
13530
|
+
"name": "HttpsRewrite",
|
|
13531
|
+
"required": false,
|
|
13532
|
+
"type": "int"
|
|
13533
|
+
},
|
|
13534
|
+
{
|
|
13535
|
+
"disabled": false,
|
|
13536
|
+
"document": "upstream type. 0: proxy to upstream by IP; 1: proxy to upstream by domain name",
|
|
13537
|
+
"example": "0",
|
|
13538
|
+
"member": "int64",
|
|
13539
|
+
"name": "UpstreamType",
|
|
13540
|
+
"required": false,
|
|
13541
|
+
"type": "int"
|
|
13542
|
+
},
|
|
13543
|
+
{
|
|
13544
|
+
"disabled": false,
|
|
13545
|
+
"document": "Upstream domain when proxy to upstream by domain. When UpstreamType=1, this field needs to be filled",
|
|
13546
|
+
"example": "randy.upstream.com",
|
|
13547
|
+
"member": "string",
|
|
13548
|
+
"name": "UpstreamDomain",
|
|
13549
|
+
"required": false,
|
|
13550
|
+
"type": "string"
|
|
13551
|
+
},
|
|
13552
|
+
{
|
|
13553
|
+
"disabled": false,
|
|
13554
|
+
"document": "Upstream IP list when proxy to upstream by IP. When UpstreamType=0, this field is required",
|
|
13555
|
+
"example": "[\"36.2.56.3\",\"28.36.245.23\"]",
|
|
13556
|
+
"member": "string",
|
|
13557
|
+
"name": "SrcList",
|
|
13558
|
+
"required": false,
|
|
13559
|
+
"type": "list"
|
|
13560
|
+
},
|
|
13561
|
+
{
|
|
13562
|
+
"disabled": false,
|
|
13563
|
+
"document": "Whether to enable HTTP2. You should enable HTTPS as well. 0: disable; 1: enable",
|
|
13564
|
+
"example": "0",
|
|
13565
|
+
"member": "int64",
|
|
13566
|
+
"name": "IsHttp2",
|
|
13567
|
+
"required": false,
|
|
13568
|
+
"type": "int"
|
|
13569
|
+
},
|
|
13570
|
+
{
|
|
13571
|
+
"disabled": false,
|
|
13572
|
+
"document": "Whether to enable WebSocket. 0: disable; 1: enable",
|
|
13573
|
+
"example": "0",
|
|
13574
|
+
"member": "int64",
|
|
13575
|
+
"name": "IsWebsocket",
|
|
13576
|
+
"required": false,
|
|
13577
|
+
"type": "int"
|
|
13578
|
+
},
|
|
13579
|
+
{
|
|
13580
|
+
"disabled": false,
|
|
13581
|
+
"document": "Load balancing policy for upstream. 0: round-robin scheduling; 1: IP hash; 2: weighted round-robin scheduling",
|
|
13582
|
+
"example": "0",
|
|
13583
|
+
"member": "int64",
|
|
13584
|
+
"name": "LoadBalance",
|
|
13585
|
+
"required": false,
|
|
13586
|
+
"type": "int"
|
|
13587
|
+
},
|
|
13588
|
+
{
|
|
13589
|
+
"disabled": false,
|
|
13590
|
+
"document": "To be deprecated, can be left blank. Whether to enable grayscale: 0 indicates not to enable grayscale.",
|
|
13591
|
+
"example": "0",
|
|
13592
|
+
"member": "int64",
|
|
13593
|
+
"name": "IsGray",
|
|
13594
|
+
"required": false,
|
|
13595
|
+
"type": "int"
|
|
13596
|
+
},
|
|
13597
|
+
{
|
|
13598
|
+
"disabled": false,
|
|
13599
|
+
"document": "Instance type of the domain name",
|
|
13600
|
+
"example": "sparta-waf",
|
|
13601
|
+
"member": "string",
|
|
13602
|
+
"name": "Edition",
|
|
13603
|
+
"required": false,
|
|
13604
|
+
"type": "string"
|
|
13605
|
+
},
|
|
12775
13606
|
{
|
|
12776
13607
|
"disabled": false,
|
|
12777
13608
|
"document": "Port information, which can be obtained through the DescribeDomains API",
|
|
@@ -13139,6 +13970,353 @@
|
|
|
13139
13970
|
],
|
|
13140
13971
|
"type": "object"
|
|
13141
13972
|
},
|
|
13973
|
+
"OwaspRule": {
|
|
13974
|
+
"document": "Owasp rule.",
|
|
13975
|
+
"members": [
|
|
13976
|
+
{
|
|
13977
|
+
"disabled": false,
|
|
13978
|
+
"document": "Rule ID",
|
|
13979
|
+
"example": "10000001",
|
|
13980
|
+
"member": "uint64",
|
|
13981
|
+
"name": "RuleId",
|
|
13982
|
+
"output_required": true,
|
|
13983
|
+
"type": "int",
|
|
13984
|
+
"value_allowed_null": false
|
|
13985
|
+
},
|
|
13986
|
+
{
|
|
13987
|
+
"disabled": false,
|
|
13988
|
+
"document": "Rule description",
|
|
13989
|
+
"example": "rule description",
|
|
13990
|
+
"member": "string",
|
|
13991
|
+
"name": "Description",
|
|
13992
|
+
"output_required": true,
|
|
13993
|
+
"type": "string",
|
|
13994
|
+
"value_allowed_null": false
|
|
13995
|
+
},
|
|
13996
|
+
{
|
|
13997
|
+
"disabled": false,
|
|
13998
|
+
"document": "Rule switch. valid values: 0 (disabled), 1 (enabled), 2 (observation only).",
|
|
13999
|
+
"example": "1",
|
|
14000
|
+
"member": "int64",
|
|
14001
|
+
"name": "Status",
|
|
14002
|
+
"output_required": true,
|
|
14003
|
+
"type": "int",
|
|
14004
|
+
"value_allowed_null": false
|
|
14005
|
+
},
|
|
14006
|
+
{
|
|
14007
|
+
"disabled": false,
|
|
14008
|
+
"document": "Protection level of the rule. valid values: 100 (loose), 200 (normal), 300 (strict), 400 (ultra-strict).",
|
|
14009
|
+
"example": "100",
|
|
14010
|
+
"member": "int64",
|
|
14011
|
+
"name": "Level",
|
|
14012
|
+
"output_required": true,
|
|
14013
|
+
"type": "int",
|
|
14014
|
+
"value_allowed_null": false
|
|
14015
|
+
},
|
|
14016
|
+
{
|
|
14017
|
+
"disabled": false,
|
|
14018
|
+
"document": "Threat level. valid values: 0 (unknown), 100 (low risk), 200 (medium risk), 300 (high risk), 400 (critical).",
|
|
14019
|
+
"example": "1",
|
|
14020
|
+
"member": "int64",
|
|
14021
|
+
"name": "VulLevel",
|
|
14022
|
+
"output_required": false,
|
|
14023
|
+
"type": "int",
|
|
14024
|
+
"value_allowed_null": false
|
|
14025
|
+
},
|
|
14026
|
+
{
|
|
14027
|
+
"disabled": false,
|
|
14028
|
+
"document": "CVE ID",
|
|
14029
|
+
"example": "CVE-2022-39195",
|
|
14030
|
+
"member": "string",
|
|
14031
|
+
"name": "CveID",
|
|
14032
|
+
"output_required": false,
|
|
14033
|
+
"type": "string",
|
|
14034
|
+
"value_allowed_null": false
|
|
14035
|
+
},
|
|
14036
|
+
{
|
|
14037
|
+
"disabled": false,
|
|
14038
|
+
"document": "Specifies the rule type ID.",
|
|
14039
|
+
"example": "10000001",
|
|
14040
|
+
"member": "uint64",
|
|
14041
|
+
"name": "TypeId",
|
|
14042
|
+
"output_required": true,
|
|
14043
|
+
"type": "int",
|
|
14044
|
+
"value_allowed_null": false
|
|
14045
|
+
},
|
|
14046
|
+
{
|
|
14047
|
+
"disabled": false,
|
|
14048
|
+
"document": "Creation time",
|
|
14049
|
+
"example": "2021-11-24 19:55:55",
|
|
14050
|
+
"member": "datetime_iso",
|
|
14051
|
+
"name": "CreateTime",
|
|
14052
|
+
"output_required": true,
|
|
14053
|
+
"type": "string",
|
|
14054
|
+
"value_allowed_null": false
|
|
14055
|
+
},
|
|
14056
|
+
{
|
|
14057
|
+
"disabled": false,
|
|
14058
|
+
"document": "Update time.",
|
|
14059
|
+
"example": "2021-11-24 19:55:55",
|
|
14060
|
+
"member": "datetime_iso",
|
|
14061
|
+
"name": "ModifyTime",
|
|
14062
|
+
"output_required": false,
|
|
14063
|
+
"type": "string",
|
|
14064
|
+
"value_allowed_null": false
|
|
14065
|
+
},
|
|
14066
|
+
{
|
|
14067
|
+
"disabled": false,
|
|
14068
|
+
"document": "Whether the user is locked.",
|
|
14069
|
+
"example": "0 1",
|
|
14070
|
+
"member": "int64",
|
|
14071
|
+
"name": "Locked",
|
|
14072
|
+
"output_required": true,
|
|
14073
|
+
"type": "int",
|
|
14074
|
+
"value_allowed_null": false
|
|
14075
|
+
},
|
|
14076
|
+
{
|
|
14077
|
+
"disabled": false,
|
|
14078
|
+
"document": "Reason for modification\n\n0: none (compatibility records are empty).\n1: avoid false positives due to business characteristics.\n2: reporting of rule-based false positives.\n3: gray release of core business rules.\n4: others",
|
|
14079
|
+
"example": "0",
|
|
14080
|
+
"member": "int64",
|
|
14081
|
+
"name": "Reason",
|
|
14082
|
+
"output_required": false,
|
|
14083
|
+
"type": "int",
|
|
14084
|
+
"value_allowed_null": false
|
|
14085
|
+
}
|
|
14086
|
+
],
|
|
14087
|
+
"usage": "out"
|
|
14088
|
+
},
|
|
14089
|
+
"OwaspRuleType": {
|
|
14090
|
+
"document": "Owasp rule type.",
|
|
14091
|
+
"members": [
|
|
14092
|
+
{
|
|
14093
|
+
"disabled": false,
|
|
14094
|
+
"document": "Type ID",
|
|
14095
|
+
"example": "10000001",
|
|
14096
|
+
"member": "uint64",
|
|
14097
|
+
"name": "TypeId",
|
|
14098
|
+
"output_required": true,
|
|
14099
|
+
"required": true,
|
|
14100
|
+
"type": "int",
|
|
14101
|
+
"value_allowed_null": false
|
|
14102
|
+
},
|
|
14103
|
+
{
|
|
14104
|
+
"disabled": false,
|
|
14105
|
+
"document": "Type name",
|
|
14106
|
+
"example": "ruleName",
|
|
14107
|
+
"member": "string",
|
|
14108
|
+
"name": "TypeName",
|
|
14109
|
+
"output_required": true,
|
|
14110
|
+
"required": true,
|
|
14111
|
+
"type": "string",
|
|
14112
|
+
"value_allowed_null": false
|
|
14113
|
+
},
|
|
14114
|
+
{
|
|
14115
|
+
"disabled": false,
|
|
14116
|
+
"document": "Type description.\n\n",
|
|
14117
|
+
"example": "ruleDescription",
|
|
14118
|
+
"member": "string",
|
|
14119
|
+
"name": "Description",
|
|
14120
|
+
"output_required": false,
|
|
14121
|
+
"required": false,
|
|
14122
|
+
"type": "string",
|
|
14123
|
+
"value_allowed_null": false
|
|
14124
|
+
},
|
|
14125
|
+
{
|
|
14126
|
+
"disabled": false,
|
|
14127
|
+
"document": "Data type category.",
|
|
14128
|
+
"example": "XSS",
|
|
14129
|
+
"member": "string",
|
|
14130
|
+
"name": "Classification",
|
|
14131
|
+
"output_required": false,
|
|
14132
|
+
"required": false,
|
|
14133
|
+
"type": "string",
|
|
14134
|
+
"value_allowed_null": false
|
|
14135
|
+
},
|
|
14136
|
+
{
|
|
14137
|
+
"disabled": false,
|
|
14138
|
+
"document": "Protection mode of the rule type. valid values: 0 (observation), 1 (intercept).",
|
|
14139
|
+
"example": "0",
|
|
14140
|
+
"member": "int64",
|
|
14141
|
+
"name": "Action",
|
|
14142
|
+
"output_required": false,
|
|
14143
|
+
"required": false,
|
|
14144
|
+
"type": "int",
|
|
14145
|
+
"value_allowed_null": false
|
|
14146
|
+
},
|
|
14147
|
+
{
|
|
14148
|
+
"disabled": false,
|
|
14149
|
+
"document": "Protection level of the rule type. valid values: 100 (loose), 200 (normal), 300 (strict), 400 (ultra-strict).",
|
|
14150
|
+
"example": "100",
|
|
14151
|
+
"member": "int64",
|
|
14152
|
+
"name": "Level",
|
|
14153
|
+
"output_required": false,
|
|
14154
|
+
"required": false,
|
|
14155
|
+
"type": "int",
|
|
14156
|
+
"value_allowed_null": false
|
|
14157
|
+
},
|
|
14158
|
+
{
|
|
14159
|
+
"disabled": false,
|
|
14160
|
+
"document": "The switch status of the rule type. valid values: 0 (disabled), 1 (enabled).",
|
|
14161
|
+
"example": "0",
|
|
14162
|
+
"member": "int64",
|
|
14163
|
+
"name": "Status",
|
|
14164
|
+
"output_required": false,
|
|
14165
|
+
"required": false,
|
|
14166
|
+
"type": "int",
|
|
14167
|
+
"value_allowed_null": false
|
|
14168
|
+
},
|
|
14169
|
+
{
|
|
14170
|
+
"disabled": false,
|
|
14171
|
+
"document": "Specifies all rules under the rule type. always.",
|
|
14172
|
+
"example": "100",
|
|
14173
|
+
"member": "uint64",
|
|
14174
|
+
"name": "TotalRule",
|
|
14175
|
+
"output_required": false,
|
|
14176
|
+
"required": false,
|
|
14177
|
+
"type": "int",
|
|
14178
|
+
"value_allowed_null": false
|
|
14179
|
+
},
|
|
14180
|
+
{
|
|
14181
|
+
"disabled": false,
|
|
14182
|
+
"document": "Indicates the total number of rules enabled under the rule type.",
|
|
14183
|
+
"example": "50",
|
|
14184
|
+
"member": "uint64",
|
|
14185
|
+
"name": "ActiveRule",
|
|
14186
|
+
"output_required": false,
|
|
14187
|
+
"required": false,
|
|
14188
|
+
"type": "int",
|
|
14189
|
+
"value_allowed_null": false
|
|
14190
|
+
}
|
|
14191
|
+
],
|
|
14192
|
+
"usage": "both"
|
|
14193
|
+
},
|
|
14194
|
+
"OwaspWhiteRule": {
|
|
14195
|
+
"document": "Rule engine allowlist.",
|
|
14196
|
+
"members": [
|
|
14197
|
+
{
|
|
14198
|
+
"disabled": false,
|
|
14199
|
+
"document": "Rule ID of the allowlist.",
|
|
14200
|
+
"example": "10011",
|
|
14201
|
+
"member": "uint64",
|
|
14202
|
+
"name": "RuleId",
|
|
14203
|
+
"output_required": true,
|
|
14204
|
+
"type": "int",
|
|
14205
|
+
"value_allowed_null": false
|
|
14206
|
+
},
|
|
14207
|
+
{
|
|
14208
|
+
"disabled": false,
|
|
14209
|
+
"document": "Rule Name",
|
|
14210
|
+
"example": "testRule",
|
|
14211
|
+
"member": "string",
|
|
14212
|
+
"name": "Name",
|
|
14213
|
+
"output_required": true,
|
|
14214
|
+
"type": "string",
|
|
14215
|
+
"value_allowed_null": false
|
|
14216
|
+
},
|
|
14217
|
+
{
|
|
14218
|
+
"disabled": false,
|
|
14219
|
+
"document": "ID list of allowlisted rules.",
|
|
14220
|
+
"example": "[10000030,10000032]",
|
|
14221
|
+
"member": "uint64",
|
|
14222
|
+
"name": "Ids",
|
|
14223
|
+
"output_required": true,
|
|
14224
|
+
"type": "list",
|
|
14225
|
+
"value_allowed_null": false
|
|
14226
|
+
},
|
|
14227
|
+
{
|
|
14228
|
+
"disabled": false,
|
|
14229
|
+
"document": "Allowlist rule state. valid values: 0 (disabled), 1 (enabled).",
|
|
14230
|
+
"example": "1",
|
|
14231
|
+
"member": "int64",
|
|
14232
|
+
"name": "Status",
|
|
14233
|
+
"output_required": true,
|
|
14234
|
+
"type": "int",
|
|
14235
|
+
"value_allowed_null": false
|
|
14236
|
+
},
|
|
14237
|
+
{
|
|
14238
|
+
"disabled": false,
|
|
14239
|
+
"document": "Allowlist type. valid values: 0 (allowlisting by specific rule ID), 1 (allowlisting by rule type).",
|
|
14240
|
+
"example": "1",
|
|
14241
|
+
"member": "int64",
|
|
14242
|
+
"name": "Type",
|
|
14243
|
+
"output_required": true,
|
|
14244
|
+
"type": "int",
|
|
14245
|
+
"value_allowed_null": false
|
|
14246
|
+
},
|
|
14247
|
+
{
|
|
14248
|
+
"disabled": false,
|
|
14249
|
+
"document": "Rule-Based matching policy list.",
|
|
14250
|
+
"example": "[{\"Field\": \"URL\",\"Arg\": \"\",\"CompareFunc\": \"eq\",\"Content\": \"/acl\"}]",
|
|
14251
|
+
"member": "Strategy",
|
|
14252
|
+
"name": "Strategies",
|
|
14253
|
+
"output_required": true,
|
|
14254
|
+
"type": "list",
|
|
14255
|
+
"value_allowed_null": false
|
|
14256
|
+
},
|
|
14257
|
+
{
|
|
14258
|
+
"disabled": false,
|
|
14259
|
+
"document": "Creation time",
|
|
14260
|
+
"example": "2021-11-19T19:53:53+08:00",
|
|
14261
|
+
"member": "datetime_iso",
|
|
14262
|
+
"name": "CreateTime",
|
|
14263
|
+
"output_required": true,
|
|
14264
|
+
"type": "string",
|
|
14265
|
+
"value_allowed_null": false
|
|
14266
|
+
},
|
|
14267
|
+
{
|
|
14268
|
+
"disabled": false,
|
|
14269
|
+
"document": "Modification time",
|
|
14270
|
+
"example": "2021-11-19T19:53:53+08:00",
|
|
14271
|
+
"member": "datetime_iso",
|
|
14272
|
+
"name": "UpdateTime",
|
|
14273
|
+
"output_required": true,
|
|
14274
|
+
"type": "string",
|
|
14275
|
+
"value_allowed_null": false
|
|
14276
|
+
},
|
|
14277
|
+
{
|
|
14278
|
+
"disabled": false,
|
|
14279
|
+
"document": "Scheduled task type",
|
|
14280
|
+
"example": "TimedJob",
|
|
14281
|
+
"member": "string",
|
|
14282
|
+
"name": "JobType",
|
|
14283
|
+
"output_required": false,
|
|
14284
|
+
"type": "string",
|
|
14285
|
+
"value_allowed_null": false
|
|
14286
|
+
},
|
|
14287
|
+
{
|
|
14288
|
+
"disabled": false,
|
|
14289
|
+
"document": "Scheduled task configuration",
|
|
14290
|
+
"example": "{\"Timed\":[{\"StartDateTime\":1711618518,\"EndDateTime\":1711918518}],\"Cron\":[{\"Day\":12,\"WDay\":2,\"StartTime\":\"12:11\",\"EndTime\":\"21:00\"}],\"TimeTZone\":\"UTC+8\"}",
|
|
14291
|
+
"member": "JobDateTime",
|
|
14292
|
+
"name": "JobDateTime",
|
|
14293
|
+
"output_required": false,
|
|
14294
|
+
"type": "object",
|
|
14295
|
+
"value_allowed_null": false
|
|
14296
|
+
},
|
|
14297
|
+
{
|
|
14298
|
+
"disabled": false,
|
|
14299
|
+
"document": "Periodic task granularity.",
|
|
14300
|
+
"example": "week",
|
|
14301
|
+
"member": "string",
|
|
14302
|
+
"name": "CronType",
|
|
14303
|
+
"output_required": false,
|
|
14304
|
+
"type": "string",
|
|
14305
|
+
"value_allowed_null": false
|
|
14306
|
+
},
|
|
14307
|
+
{
|
|
14308
|
+
"disabled": false,
|
|
14309
|
+
"document": "Whether there is currently valid.",
|
|
14310
|
+
"example": "true",
|
|
14311
|
+
"member": "bool",
|
|
14312
|
+
"name": "ValidStatus",
|
|
14313
|
+
"output_required": false,
|
|
14314
|
+
"type": "bool",
|
|
14315
|
+
"value_allowed_null": false
|
|
14316
|
+
}
|
|
14317
|
+
],
|
|
14318
|
+
"usage": "out"
|
|
14319
|
+
},
|
|
13142
14320
|
"PeakPointsItem": {
|
|
13143
14321
|
"document": "PeakPoints array item",
|
|
13144
14322
|
"members": [
|
|
@@ -14087,11 +15265,11 @@
|
|
|
14087
15265
|
"usage": "in"
|
|
14088
15266
|
},
|
|
14089
15267
|
"Strategy": {
|
|
14090
|
-
"document": "
|
|
15268
|
+
"document": "Rule matching criteria structure.",
|
|
14091
15269
|
"members": [
|
|
14092
15270
|
{
|
|
14093
15271
|
"disabled": false,
|
|
14094
|
-
"document": "
|
|
15272
|
+
"document": "Specifies the matching field.\n\nDifferent matching fields result in different matching parameters, logical operators, and matching contents. the details are as follows:.\n<table><thead><tr><th>Matching Field</th> <th>Matching Parameter</th> <th>Logical Symbol</th> <th>Matching Content</th></tr></thead> <tbody><tr><td>IP (source IP)</td> <td>Parameters are not supported.</td> <td>ipmatch (match)<br/>ipnmatch (mismatch)</td> <td>Multiple IP addresses are separated by commas. A maximum of 20 IP addresses are allowed.</td></tr> <tr><td>IPv6 (source IPv6)</td> <td>Parameters are not supported.</td> <td>ipmatch (match)<br/>ipnmatch (mismatch)</td> <td>A single IPv6 address is supported.</td></tr> <tr><td>Referer (referer)</td> <td>Parameters are not supported.</td> <td>empty (Content is empty.)<br/>null (do not exist)<br/>eq (equal to)<br/>neq (not equal to)<br/>contains (contain)<br/>ncontains (do not contain)<br/>len_eq (length equals to)<br/>len_gt (length is greater than)<br/>len_lt (length is less than)<br/>strprefix (prefix matching)<br/>strsuffix (suffix matching)<br/>rematch (regular expression matching)</td> <td>Enter the content, with a maximum of 512 characters.</td></tr> <tr><td>URL (request path)</td> <td>Parameters are not supported.</td> <td>eq (equal to)<br/>neq (not equal to)<br/>contains (contain)<br/>ncontains (do not contain)<br/>len_eq (length equals to)<br/>len_gt (length is greater than)<br/>len_lt (length is \n less than)<br/>strprefix (prefix matching)<br/>strsuffix (suffix matching)<br/>rematch (regular expression matching)</td> <td>Enter the content starting with /, with a maximum of 512 characters.</td></tr> <tr><td>UserAgent (UserAgent)</td> <td>Parameters are not supported.</td><td>Same logical symbols as the matching field <font color=\"Red\">Referer</font></td> <td>Enter the content with a maximum of 512 characters.</td></tr> <tr><td>HTTP_METHOD (HTTP request method)</td> <td>Parameters are not supported.</td> <td>eq (equal to)<br/>neq (not equal to)</td> <td>Enter the method name. The uppercase is recommended.</td></tr> <tr><td>QUERY_STRING (request string)</td> <td>Parameters are not supported.</td> <td>Same logical symbol as the matching field <font color=\"Red\">Request Path</font></td><td>Enter the content with a maximum of 512 characters.</td></tr> <tr><td>GET (GET parameter value)</td> <td>Parameter entry is supported.</td> <td>contains (contain)<br/>ncontains (do not contain)<br/>len_eq (length equals to)<br/>len_gt (length is greater than)<br/>len_lt (length is less than)<br/>strprefix (prefix matching)<br/>strsuffix (suffix matching)</td> <td>Enter the content with a maximum of 512 characters.</td></tr> <tr><td>GET_PARAMS_NAMES (GET parameter name)</td> <td>Parameters are not supported.</td> <td>exist (Parameter exists.)<br/>nexist (Parameter does not exist.)<br/>len_eq (length equals to)<br/>len_gt (length is greater than)<br/>len_lt (length is less than)<br/>strprefix (prefix matching)<br/>strsuffix (suffix matching)</td><td>Enter the content with a maximum of 512 characters.</td></tr> <tr><td>POST (POST parameter value)</td> <td>Parameter entry is supported.</td> <td>Same logical symbol as the matching field <font color=\"Red\">GET Parameter Value</font></td> <td>Enter the content with a maximum of 512 characters.</td></tr> <tr><td>GET_POST_NAMES (POST parameter name)</td> <td>Parameters are not supported.</td> <td>Same logical symbol as the matching field <font color=\"Red\">GET Parameter Name</font></td> <td>Enter the content with a maximum of 512 characters.</td></tr> <tr><td>POST_BODY (complete body)</td> <td>Parameters are not supported.</td> <td>Same logical symbol as the matching field <font color=\"Red\">Request Path</font></td><td>Enter the body content with a maximum of 512 characters.</td></tr> <tr><td>COOKIE (cookie)</td> <td>Parameters are not supported.</td> <td>empty (Content is empty.)<br/>null (do not exist)<br/>rematch (regular expression matching)</td> <td><font color=\"Red\">Unsupported currently</font></td></tr> <tr><td>GET_COOKIES_NAMES (cookie parameter name)</td> <td>Parameters are not supported.</td> <td>Same logical symbol as the matching field <font color=\"Red\">GET Parameter Name</font></td> <td>Enter the content with a maximum of 512 characters.</td></tr> <tr><td>ARGS_COOKIE (cookie parameter value)</td> <td>Parameter entry is supported.</td> <td>Same logical symbol as the matching field <font color=\"Red\">GET Parameter Value</font></td> <td>Enter the content512 characters limit</td></tr><tr><td>GET_HEADERS_NAMES (Header parameter name)</td><td>parameter not supported</td><td>exsit (parameter exists)<br/>nexsit (parameter does not exist)<br/>len_eq (LENGTH equal)<br/>len_gt (LENGTH greater than)<br/>len_lt (LENGTH less than)<br/>strprefix (prefix match)<br/>strsuffix (suffix matching)<br/>rematch (regular expression matching)</td><td>enter CONTENT, lowercase is recommended, up to 512 characters</td></tr><tr><td>ARGS_Header (Header parameter value)</td><td>support parameter entry</td><td>contains (include)<br/>ncontains (does not include)<br/>len_eq (LENGTH equal)<br/>len_gt (LENGTH greater than)<br/>len_lt (LENGTH less than)<br/>strprefix (prefix match)<br/>strsuffix (suffix matching)<br/>rematch (regular expression matching)</td><td>enter CONTENT, up to 512 characters</td></tr><tr><td>CONTENT_LENGTH (CONTENT-LENGTH)</td><td>support parameter entry</td><td>numgt (value greater than)<br/>numlt (value smaller than)<br/>numeq (value equal to)<br/></td><td>enter an integer between 0-9999999999999</td></tr><tr><td>IP_GEO (source IP geolocation)</td><td>support parameter entry</td><td>GEO_in (belong)<br/>GEO_not_in (not_in)<br/></td><td>enter CONTENT, up to 10240 characters, format: serialized JSON, format: [{\"Country\":\"china\",\"Region\":\"guangdong\",\"City\":\"shenzhen\"}]</td></tr><tr><td>CAPTCHA_RISK (CAPTCHA RISK)</td><td>parameter not supported</td><td>eq (equal)<br/>neq (not equal to)<br/>belong (belong)<br/>not_belong (not belong to)<br/>null (nonexistent)<br/>exist (exist)</td><td>enter RISK level value, value range 0-255</td></tr><tr><td>CAPTCHA_DEVICE_RISK (CAPTCHA DEVICE RISK)</td><td>parameter not supported</td><td>eq (equal)<br/>neq (not equal to)<br/>belong (belong)<br/>not_belong (not belong to)<br/>null (nonexistent)<br/>exist (exist)</td><td>enter DEVICE RISK code, valid values: 101, 201, 301, 401, 501, 601, 701</td></tr><tr><td>CAPTCHAR_SCORE (CAPTCHA RISK assessment SCORE)</td><td>parameter not supported</td><td>numeq (value equal to)<br/>numgt (value greater than)<br/>numlt (value smaller than)<br/>numle (less than or equal to)<br/>numge (value is greater than or equal to)<br/>null (nonexistent)<br/>exist (exist)</td><td>enter assessment SCORE, value range 0-100</td></tr>.\n</tbody></table>",
|
|
14095
15273
|
"example": "IP-来源IP",
|
|
14096
15274
|
"member": "string",
|
|
14097
15275
|
"name": "Field",
|
|
@@ -14102,7 +15280,7 @@
|
|
|
14102
15280
|
},
|
|
14103
15281
|
{
|
|
14104
15282
|
"disabled": false,
|
|
14105
|
-
"document": "
|
|
15283
|
+
"document": "Specifies the logic symbol. \n\nLogical symbols are divided into the following types:.\nEmpty (content is empty).\nnull (not found).\nEq (equal to).\nneq (not equal to).\ncontains (contain).\nncontains (do not contain).\nstrprefix (prefix matching).\nstrsuffix (suffix matching).\nLen_eq (length equals to).\nLen_gt (length greater than).\nLen_lt (length less than).\nipmatch (belong).\nipnmatch (not_in).\nnumgt (value greater than).\nNumValue smaller than].\nValue equal to.\nnumneq (value not equal to).\nnumle (less than or equal to).\nnumge (value is greater than or equal to).\ngeo_in (IP geographic belong).\ngeo_not_in (IP geographic not_in).\nSpecifies different logical operators for matching fields. for details, see the matching field table above.",
|
|
14106
15284
|
"example": "contains - 包含",
|
|
14107
15285
|
"member": "string",
|
|
14108
15286
|
"name": "CompareFunc",
|
|
@@ -14113,7 +15291,7 @@
|
|
|
14113
15291
|
},
|
|
14114
15292
|
{
|
|
14115
15293
|
"disabled": false,
|
|
14116
|
-
"document": "
|
|
15294
|
+
"document": "Specifies the match content.\n\nCurrently, when the match field is COOKIE (COOKIE), match content is not required. all others are needed.\n",
|
|
14117
15295
|
"example": "/url",
|
|
14118
15296
|
"member": "string",
|
|
14119
15297
|
"name": "Content",
|
|
@@ -14124,7 +15302,7 @@
|
|
|
14124
15302
|
},
|
|
14125
15303
|
{
|
|
14126
15304
|
"disabled": false,
|
|
14127
|
-
"document": "
|
|
15305
|
+
"document": "Specifies the matching parameter.\n\nConfiguration parameters are divided into two data types: parameter not supported and support parameters.\nWhen the match field is one of the following four, the matching parameter can be entered, otherwise not supported.\nGET (get parameter value).\u000b\t\t\nPOST (post parameter value).\u000b\t\t\nARGS_COOKIE (COOKIE parameter value).\u000b\t\t\nARGS_HEADER (HEADER parameter value).\n",
|
|
14128
15306
|
"example": "argvalue",
|
|
14129
15307
|
"member": "string",
|
|
14130
15308
|
"name": "Arg",
|
|
@@ -14135,7 +15313,7 @@
|
|
|
14135
15313
|
},
|
|
14136
15314
|
{
|
|
14137
15315
|
"disabled": false,
|
|
14138
|
-
"document": "
|
|
15316
|
+
"document": "Case-Sensitive.\nCase-Insensitive.",
|
|
14139
15317
|
"example": "0",
|
|
14140
15318
|
"member": "uint64",
|
|
14141
15319
|
"name": "CaseNotSensitive",
|
|
@@ -14316,7 +15494,7 @@
|
|
|
14316
15494
|
"members": [
|
|
14317
15495
|
{
|
|
14318
15496
|
"disabled": false,
|
|
14319
|
-
"document": "Start timestamp, in seconds
|
|
15497
|
+
"document": "Start timestamp, in seconds.",
|
|
14320
15498
|
"example": "1711618518",
|
|
14321
15499
|
"member": "uint64",
|
|
14322
15500
|
"name": "StartDateTime",
|
|
@@ -14327,7 +15505,7 @@
|
|
|
14327
15505
|
},
|
|
14328
15506
|
{
|
|
14329
15507
|
"disabled": false,
|
|
14330
|
-
"document": "End timestamp, in seconds
|
|
15508
|
+
"document": "End timestamp, in seconds.",
|
|
14331
15509
|
"example": "1711618518",
|
|
14332
15510
|
"member": "uint64",
|
|
14333
15511
|
"name": "EndDateTime",
|