vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

re-introducing changes before wafd version 20230423

Browse Source 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
This commit is contained in:
Hasko, Vladimir 2023-06-02 12:41:58 +00:00 committed by zuul
parent d7579655e9
commit f083e18983
96 changed files with 16483 additions and 2968 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/wafd/api-ref/.placeholder
View File

578
docs/wafd/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

1028
docs/wafd/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

386
docs/wafd/api-ref/CreateAnticrawlerRule.html Normal file
View File

File diff suppressed because it is too large Load Diff

355
docs/wafd/api-ref/CreateAntileakageRules.html Normal file
View File

File diff suppressed because it is too large Load Diff

6
docs/wafd/api-ref/CreateAntitamperRule.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Creating a Web Tamper Protection Rule</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a web tamper protection rule.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/policy/{policy_id}/antitamper</p>
<div class="section" id="CreateAntitamperRule__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/policy/{policy_id}/antitamper</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID. It can be obtained by calling the <strong>ListPolicy</strong> API.</p>
</td>
</tr>
</tbody>
@ -164,7 +164,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Domain name protected by the web tamper protection rule</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>The domain name of the website protected with the web tamper protection rule. The domain name is in the format of xxx.xxx.com, such as www.example.com.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>url</p>

707
docs/wafd/api-ref/CreateCcRule.html
View File

File diff suppressed because it is too large Load Diff

6
docs/wafd/api-ref/CreateCertificate.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Creating a Certificate</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a certificate.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/certificate</p>
<div class="section" id="CreateCertificate__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/certificate</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -230,8 +230,8 @@
{
"name" : "demo",
"content" : "-----BEGIN CERTIFICATE----- MIIDyzCCArOgAwIBAgIJAN5U0Z4Bh5ccMA0GCSqGSIb3DQEBCwUAMHwxCzAJBgNV BAYTAlpIMRIwEAYDVQQIDAlHVUFOR0RPTkcxETAPBgNVBAcMCERPTkdHVUFOMQ0w CwYDVQQKDARERUtFMQswCQYDVQQLDAJESzELMAkGA1UEAwwCT0QxHTAbBgkqhkiG 9w0BCQEWDk8IZC5odWF3ZWkuY29tMB4XDTIxMTExNTA4MTk0MVoXDTIyMTExNTA4 MTk0MVowfDELMAkGA1UEBhMCWkgxEjAQBgNVBAgMCUdVQU5HRE9ORzERMA8GA1UE BwwIRE9OR0dVQU4xDTALBgNVBAoMBERFS0UxCzAJBgNVBAsMAkRLMQswCQYDVQQD DAJPRDEdMBsGCSqGSIb3DQEJARYOTwhkLmh1YXdlaS5jb20wggEiMA0GCSqGSIb3 DQEBAQUAA4IBDwAwggEKAoIBAQDcoLFK62//r0RHFyweYBj97S4NsJ8Qj0RG+Y02 OgwhQmRiNNjubJwP8Nqqyd86zr+fsSQxKBaBCosn1PcN2Pj2vPJD6NEk4I6VdOWr /kFYMlOcimhSfW4wt6VakniOKIYGrCxxvQe1X2OyBxT+ocTLRgEIB8ZbvJyPNseg feLEUuPYRpQ5kXLgJH2/3NwZFOgBHVv/b07l4fR+sWJMnIA2yIjSBQ0DEAOSusXo FQ/WRbBRH7DrQmxGiXsq4VELEr9Nnc/Kywq+9pYi8L+mKeRL+lcMMbXC/3k6OfMB tVTiwcmS1Mkr3iG03i8u6H7RSvRwyBz9G9sE+tmJZTPH6lYtAgMBAAGjUDBOMB0G A1UdDgQWBBQprUUFXW+gIkpzXdrYlsWjfSahWjAfBgNVHSMEGDAWgBQprUUFXW+g IkpzXdrYlsWjfSahWjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBCwUAA4IBAQA2 603KozsQoIKeLvqDJlcAXwWRfNW8SvlaSJAulhHgneMt9bQgIL+3PJWA/iMniOhU o/kVwkiUIcxw4t7RwP0hVms0OZw59MuqKd3oCSWkYO4vEHs3t40JDWnGDnmQ4sol RkOWJwL4w8tnPe3qY9JSupjlsu6Y1hlvKtEfN2vEKFnsuMhidkUpUAJWodHhWBQH wgIDo4/6yTnWZNGK8JDal86Dm5IchXea1EoYBJsHxiJb7HeWQlkre+MCYi1RHOin 4mIXTr0oT4/jWlgklSz6/ZhGRq+7W7tIl7cvzCe+4XsVZIenAcYoNd/WLfo91PD4 yAsRXrOjW1so1Bj0BkDz -----END CERTIFICATE-----",
"key" : "-----BEGIN PRIVATE KEY----- MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDcoLFK62//r0RH FyweYBj97S4NsJ8Qj0RG+Y02OgwhQmRiNNjubJwP8Nqqyd86zr+fsSQxKBaBCosn 1PcN2Pj2vPJD6NEk4I6VdOWr/kFYMlOcimhSfW4wt6VakniOKIYGrCxxvQe1X2Oy BxT+ocTLRgEIB8ZbvJyPNsegfeLEUuPYRpQ5kXLgJH2/3NwZFOgBHVv/b07l4fR+ sWJMnIA2yIjSBQ0DEAOSusXoFQ/WRbBRH7DrQmxGiXsq4VELEr9Nnc/Kywq+9pYi 8L+mKeRL+lcMMbXC/3k6OfMBtVTiwcmS1Mkr3iG03i8u6H7RSvRwyBz9G9sE+tmJ ZTPH6lYtAgMBAAECggEBAL+xZxm/QoqXT+2stoqV2GEYaMFASpRqxlocjZMmEE/9 jZa+cBWIjHhVPsjRqYFBDcHEebu0JwlrjcjIAvgnIvnO5XgXm1A9Q+WbscokmcX1 xCvpHgc+MDVn+uWdCd4KW5kEk4EnSsFN5iNSf+1VxNURN+gwSSp/0E+muwA5IISO G6HQ+p6qs52JAitX5t/7ruKoHYXJxBnf7TUs7768qrh++KPKpPlq044qoYlcGO1n 4urPBHuNLy04GgGw+vkaqjqOvZrNLVOMMaFWBxsDWBehgSSBQTj+f3NCxneGYtt8 3SCTZQI5nIkb+r/M455EwKTSXuEsNHoIwx7L6GEPbQECgYEA8IxgK2fYykloICoh TFJaRAvyjyKa2+Aza4qT9SGY9Y30VPClPjBB1vUu5M9KrFufzlv06nGEcHmpEwOe 8vbRu7nLAQTGYFi8VK63q8w6FlFdAyCG6Sx+BWCfWxJzXsZLAJTfklwi8HsOSlqh 6QNv0xbE2fLjXKf8MHvtrufip40CgYEA6sy87eDrkVgtq4ythAik3i1C5Z3v0fvx mTblG52Z21OyocNq3Tf/b1ZwoIc1ik6cyBzY6z1bIrbSzArCqm0sb2iD+kJL81O0 /qqdXjBxZUkKiVAMNNp7xJGZHHFKWUxT2+UX/tlyx4tT4dzrFIkdDXkcMmqfsRxd 1NEVaAaT8SECgYAoU7BPtpIun43YTpfUfr3pSIN6oZeKoxSbw9i4MNC+4fSDRPC+ 80ImcmZRL7taF+Y7p0jxAOTuIkdJC8NbAiv5J9WzrwQ+5MF2BPB/2bYnRa6tNofH kZDy/9bXYsl6qw2p5Ety8wVcgZTMvFMGiG/32IpZ65FYWEU8L5qSRwfFhQKBgQC9 ihjZTj/bTHtRiHZppzCvyYm/Igd+Uwtsy0uXR1n0G1SQENgrTBD/J6AzdfJae6tE P0U8YIM5Oqxf2i/as9ay+IPRecMl4eSxz7jJWAGx6Yx/3AZ+hAB1ZbNbqniCLYNk d0MvjwmA25ATO+ro4OZ7AdEpQbk3l9aG/WFyYBz9AQKBgQCucFPA1l5eslL8196V WMr2Qo0tqzl7CGSoWQk2Sa2HZtZdfofXAaaqo+zvJ6RPHtJh0jgJtx536DVV3egI 37YrdQyJbCPZXQ3SPgqWCorUnXBwq/nxS06uwu6JBxUFc57ijmMU4fWYNrvkkmWb 7keAg/r5Uy1joMAvBN1I6lB8pg== -----END PRIVATE KEY-----"
"content" : "-----BEGIN CERTIFICATE-----\nMIICUjCCAbugAwIBAgIJANxRp4YpWj66MA0GCSqGSIb3DQEBCwUAMEIxCzAJBgNV BAYTAlhYMRUwEwYDVQQHDAxEZWZhdWx0IENpdHkxHDAaBgNVBAoME0RlZmF1bHQg Q29tcGFueSBMdGQwHhcNMjMwMzA2MTMwNDI2WhcNMjQwMzA1MTMwNDI2WjBCMQsw CQYDVQQGEwJYWDEVMBMGA1UEBwwMRGVmYXVsdCBDaXR5MRwwGgYDVQQKDBNEZWZh dWx0IENvbXBhbnkgTHRkMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC4KoXA HK8ZcmOMl+FDDnzBKhD/RcSdjqtie47YZYX9T9XNtfuvmJf78JQC3X18xAJdutyP tvX6RwqITLItD6DsI/x6vkMJDLGOfuMpxjHwm6VOILIVIMUVWsZqTk4NdaFRpBCN VpzQdy/j3WUg0l86dYna0GdkOHuk6l1pgk52RwIDAQABo1AwTjAdBgNVHQ4EFgQU 9/usGS95WL1qUuq5F8XiDXA8Fq4wHwYDVR0jBBgwFoAU9/usGS95WL1qUuq5F8Xi DXA8Fq4wDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOBgQCXIvTibia/fGlf IaraBMH313Z+xBlkBX5X8y2wYRa+RRVR4OB8zTY2Rm0OXOHMgPPEs5xpYXPBK/CH i+kodHIq+0AxYzMlDs3j+V7FzUrZQbItPYXtgQStZjdOvtM129ecuKWRRtmNNSBZ sj9VBsvsMrI1S2bZo5wJMPuR/TGGOQ==\n-----END CERTIFICATE-----",
"key" : "-----BEGIN PRIVATE KEY-----\nMIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBALgqhcAcrxlyY4yX 4UMOfMEqEP9FxJ2Oq2J7jthlhf1P1c21+6+Yl/vwlALdfXzEAl263I+29fpHCohM si0PoOwj/Hq+QwkMsY5+4ynGMfCbpU4gshUgxRVaxmpOTg11oVGkEI1WnNB3L+Pd ZSDSXzp1idrQZ2Q4e6TqXWmCTnZHAgMBAAECgYEAh/YknirO/ktbwQzTqczFP1oO CFd6ixMr5d3wHEP/Qn6xCliCwiU2dzIqI19faD/Qu1/bu2HIgQf3d56fn/K8yrgq tmd7BZvXcZuK/LXOLfpAXAdMl5bgOW+ejJvf9LsA6xYWsxmki6+VYbJ+XVr4w2yH nBiimwp7v4eoBlMqVQECQQDeJw6o15p30MEzj5t3oVLL86rY20HZfqnpS6S10CHx l0W/0ah7S4QnvXi6NhvS0o3mj+VNzeYvoHII9DP28IyBAkEA1DnSyH7D5W4GUmsr NfDOBYuKUaahDtdN/Qx2JF1jEvLluLC7Nr1ETzrKodN/+lOYwfIOWx5tkXPpLFMu rko+xwJAWV7DEf+yn7L2loSWWbknsu7y80y5oALJ3hXVTGNP1H4zzChPLFLD9qzN rbPo25ZjCbcn23YSvWRBnAKKCTTagQJBAKWvgxVOimfrLvpXesPA/Ucs+s7mNSVe CCAAA5g+ZGPdyGUZbP++Yb8tWhdfBLINY9w+uuB+b/I3uRoG0xH1Gu8CQQCpEIYC DUNO98ylm4QOAkyC0nv6x33gQqcu6ExtK7ptbdFZT1QdOAwm5SBaE50rWjyTO4gL Cpsd6f0baeGAxNAw\n-----END PRIVATE KEY-----"
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>

229
docs/wafd/api-ref/CreateCustomRules.html
View File

File diff suppressed because it is too large Load Diff

33
docs/wafd/api-ref/CreateGeoipRule.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Creating a Geolocation Access Control Rule</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a geolocation access control rule.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/policy/{policy_id}/geoip</p>
<div class="section" id="CreateGeoipRule__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/policy/{policy_id}/geoip</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID. It can be obtained by calling the <strong>ListPolicy</strong> API.</p>
</td>
</tr>
</tbody>
@ -109,6 +109,7 @@
</li><li><p>South Africa: South Africa</p>
</li><li><p>Mexico: Mexico</p>
</li><li><p>Peru: Peru</p>
</li><li><p>For more geographical location codes, see "Appendix - Geographic Location Codes."</p>
</li></ul>
</td>
</tr>
@ -125,6 +126,15 @@
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Rule name. Currently, the console does not support configuring names for geolocation access control rule. Ignore this parameter.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p>description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p>No</p>
@ -162,6 +172,20 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Policy ID</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Rule name. Currently, the console does not support configuring names for geolocation access control rule. Ignore this parameter.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>geoTagList</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>List of geographical locations hit the geolocation access control rule.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>geoip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
@ -188,6 +212,7 @@
</li><li><p>South Africa: South Africa</p>
</li><li><p>Mexico: Mexico</p>
</li><li><p>Peru: Peru</p>
</li><li><p>For more geographical location codes, see "Appendix - Geographic Location Codes."</p>
</li></ul>
</td>
</tr>
@ -327,9 +352,9 @@
"timestamp" : 1650534513775,
"description" : "demo",
"status" : 1,
"geoTagList" : [ "BR" ],
"geoip" : "BR",
"white" : 0,
"geoTagList" : [ "SH", "Afghanistan" ]
"white" : 0
}</pre>
</div>
<div class="section"><h4 class="sectiontitle">Status Codes</h4>

389
docs/wafd/api-ref/CreateIgnoreRule.html
View File

File diff suppressed because it is too large Load Diff

46
docs/wafd/api-ref/CreateInstance.html
View File

File diff suppressed because it is too large Load Diff

358
docs/wafd/api-ref/CreatePolicy.html
View File

File diff suppressed because it is too large Load Diff

182
docs/wafd/api-ref/CreatePremiumHost.html
View File

File diff suppressed because it is too large Load Diff

6
docs/wafd/api-ref/CreatePrivacyRules.html
View File

@ -1,9 +1,9 @@
<a name="CreatePrivacyRules"></a><a name="CreatePrivacyRules"></a>
<h1 class="topictitle1">Creating a Data Masking Rule</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>Creating a Data Masking Rule</p>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a data masking rule.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/policy/{policy_id}/privacy</p>
<div class="section" id="CreatePrivacyRules__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/policy/{policy_id}/privacy</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID. It can be obtained by calling the <strong>ListPolicy</strong> API.</p>
</td>
</tr>
</tbody>

318
docs/wafd/api-ref/CreatePunishmentRules.html Normal file
View File

File diff suppressed because it is too large Load Diff

25
docs/wafd/api-ref/CreateValueList.html
View File

@ -1,9 +1,9 @@
<a name="CreateValueList"></a><a name="CreateValueList"></a>
<h1 class="topictitle1">Adding a Reference Table</h1>
<h1 class="topictitle1">Creating a Reference Table</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to create a reference table. A reference table can be referenced by CC attack protection rules and precise protection rules. For details about how to use reference tables, see "Adding a Reference Table" under "Rule Configurations" in Web Application Firewall User Guide.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/valuelist</p>
<div class="section" id="CreateValueList__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>POST /v1/{project_id}/waf/valuelist</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -87,7 +87,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Reference table type. For details, see the enumeration list</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p>Reference table type. For details, see the enumeration values as followed.</p>
<p>Enumeration values:</p>
<ul><li><p><strong>url</strong></p>
</li><li><p><strong>params</strong></p>
@ -98,7 +98,7 @@
</li><li><p><strong>header</strong></p>
</li><li><p><strong>response_code</strong></p>
</li><li><p><strong>response_header</strong></p>
</li><li><p><strong>resopnse_body</strong></p>
</li><li><p><strong>response_body</strong></p>
</li></ul>
</td>
</tr>
@ -171,6 +171,23 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Value of the reference table</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Reference table description</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>producer</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>This parameter is reserved and can be ignored currently.</p>
<p>Enumeration values:</p>
<ul><li><p><strong>1</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>

49
docs/wafd/api-ref/CreateWhiteblackipRule.html
View File

File diff suppressed because it is too large Load Diff

326
docs/wafd/api-ref/DeleteAnticrawlerRule.html Normal file
View File

File diff suppressed because it is too large Load Diff

298
docs/wafd/api-ref/DeleteAntileakageRule.html Normal file
View File

File diff suppressed because it is too large Load Diff

8
docs/wafd/api-ref/DeleteAntitamperRule.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Deleting a Web Tamper Protection Rule</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a web tamper protection rule.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}</p>
<div class="section" id="DeleteAntitamperRule__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID. It can be obtained by calling the <strong>ListPolicy</strong> API.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>rule_id</p>
@ -39,7 +39,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Rule ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>ID of the web tamper protection rule. It can be obtained by calling the <strong>ListAntitamperRules</strong> API.</p>
</td>
</tr>
</tbody>
@ -132,7 +132,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Domain name protected by the web tamper protection rule</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>The domain name of the website protected with the web tamper protection rule. The domain name is in the format of xxx.xxx.com, such as www.example.com.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>url</p>

365
docs/wafd/api-ref/DeleteCcRule.html
View File

File diff suppressed because it is too large Load Diff

2
docs/wafd/api-ref/DeleteCertificate.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Deleting a Certificate</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a certificate.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/certificate/{certificate_id}</p>
<div class="section" id="DeleteCertificate__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/certificate/{certificate_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>

124
docs/wafd/api-ref/DeleteCustomRule.html
View File

File diff suppressed because it is too large Load Diff

22
docs/wafd/api-ref/DeleteGeoipRule.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Deleting a Geolocation Access Control Rule</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a geolocation access control rule.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}</p>
<div class="section" id="DeleteGeoipRule__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID. It can be obtained by calling the <strong>ListPolicy</strong> API.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>rule_id</p>
@ -39,7 +39,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Rule ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>ID of the geolocation access control rule. It can be obtained by calling the <strong>ListGeoipRules</strong> API.</p>
</td>
</tr>
</tbody>
@ -104,6 +104,20 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Policy ID</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Rule name. Currently, the console does not support configuring names for geolocation access control rule. Ignore this parameter.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>geoTagList</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>List of geographical locations hit the geolocation access control rule.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>geoip</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
@ -130,6 +144,7 @@
</li><li><p>South Africa: South Africa</p>
</li><li><p>Mexico: Mexico</p>
</li><li><p>Peru: Peru</p>
</li><li><p>For more geographical location codes, see "Appendix - Geographic Location Codes."</p>
</li></ul>
</td>
</tr>
@ -264,6 +279,7 @@
"timestamp" : 1650534513775,
"description" : "demo",
"status" : 1,
"geoTagList" : [ "BR" ],
"geoip" : "BR",
"white" : 0
}</pre>

224
docs/wafd/api-ref/DeleteIgnoreRule.html
View File

File diff suppressed because it is too large Load Diff

111
docs/wafd/api-ref/DeleteInstance.html
View File

File diff suppressed because it is too large Load Diff

338
docs/wafd/api-ref/DeletePolicy.html
View File

File diff suppressed because it is too large Load Diff

144
docs/wafd/api-ref/DeletePremiumHost.html
View File

File diff suppressed because it is too large Load Diff

106
docs/wafd/api-ref/DeletePrivacyRule.html
View File

File diff suppressed because it is too large Load Diff

280
docs/wafd/api-ref/DeletePunishmentRule.html Normal file
View File

File diff suppressed because it is too large Load Diff

8
docs/wafd/api-ref/DeleteValueList.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Deleting a Reference Table</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete a reference table.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/valuelist/{valuelistid}</p>
<div class="section" id="DeleteValueList__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/valuelist/{table_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -24,7 +24,7 @@
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>valuelistid</p>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>table_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p>Yes</p>
</td>
@ -205,7 +205,7 @@
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">DELETE https://{Endpoint}/v1/{project_id}/waf/valuelist/{valuelistid}?</pre>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">DELETE https://{Endpoint}/v1/{project_id}/waf/valuelist/{table_id}?</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Request succeeded.</p>
@ -214,6 +214,8 @@
"name" : "demo2",
"type" : "url",
"values" : [ "/demo" ],
"description" : "",
"producer" : 1,
"timestamp" : 1656495488880
}</pre>
</div>

24
docs/wafd/api-ref/DeleteWhiteBlackIpRule.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Deleting a Blacklist or Whitelist Rule</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to delete an IP address blacklist or whitelist rule.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}</p>
<div class="section" id="DeleteWhiteBlackIpRule__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>DELETE /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID. It can be obtained by calling the <strong>ListPolicy</strong> API.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>rule_id</p>
@ -39,7 +39,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Rule ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>ID of the blacklist or whitelist rule. It can be obtained by calling the <strong>ListWhiteblackipRules</strong> API.</p>
</td>
</tr>
</tbody>
@ -68,7 +68,7 @@
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
@ -97,6 +97,13 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Rule ID</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Rule name.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>policyid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
@ -132,7 +139,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>lacklisted or whitelisted IP addresses</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Blacklisted or whitelisted IP addresses</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>white</p>
@ -146,6 +153,13 @@
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p>followed_action_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>ID of the known attack source rule.</p>
</td>
</tr>
</tbody>
</table>
</div>

2
docs/wafd/api-ref/ErrorCode.html
View File

@ -209,7 +209,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.1.6.1.4 "><p>Inconsistency between project_id and token</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.1.6.1.5 "><p>Check Consistency of project_id and token</p>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.1.1.6.1.5 "><p>Check consistency of project_id and token</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.1.1.6.1.1 "><p>400</p>

376
docs/wafd/api-ref/ListAnticrawlerRules.html Normal file
View File

File diff suppressed because it is too large Load Diff

112
docs/wafd/api-ref/ListWhiteblackipRule.html → docs/wafd/api-ref/ListAntileakageRules.html
View File

File diff suppressed because it is too large Load Diff

12
docs/wafd/api-ref/ListAntitamperRules.html
View File

@ -1,9 +1,9 @@
<a name="ListAntitamperRules"></a><a name="ListAntitamperRules"></a>
<h1 class="topictitle1">Querying the List of Web Tamper Protection Rules</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This api is used to query the list of web tamper protection rules.</p>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the list of web tamper protection rules.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/policy/{policy_id}/antitamper</p>
<div class="section" id="ListAntitamperRules__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/policy/{policy_id}/antitamper</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -21,7 +21,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Prroject ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Project ID</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p>policy_id</p>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID. It can be obtained by calling the <strong>ListPolicy</strong> API.</p>
</td>
</tr>
</tbody>
@ -63,7 +63,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Number of records on each page. The maximum value is 100.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Number of records on each page. The maximum value is 2147483647.</p>
<p>Default: <strong>10</strong></p>
</td>
</tr>
@ -183,7 +183,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Domain name protected by the web tamper protection rule</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>The domain name of the website protected with the web tamper protection rule. The domain name is in the format of xxx.xxx.com, such as www.example.com.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>url</p>

11
docs/wafd/api-ref/ListBandwidthTimeline.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying Bandwidth Usage Statistics</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query bandwidth usage statistics.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/overviews/bandwidth/timeline</p>
<div class="section" id="ListBandwidthTimeline__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/overviews/bandwidth/timeline</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -71,7 +71,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>List of instance to query (only for the instantiation mode).</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>This parameter is used to query the bandwidth of the protected domain name protected by a specific dedicated WAF engine instance.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p>group_by</p>
@ -80,7 +80,12 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Display dimension. For example, the value is DAY if data is displayed by the day.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Data aggregation interval. If this parameter is not specified, data is displayed by a time range calculated based on parameters <strong>from</strong> and <strong>to</strong>.</p>
<ul><li><p>If the time range between <strong>from</strong> and <strong>to</strong> is fewer than or equal to 1 day, the interval is one minute.</p>
</li><li><p>If the time range between <strong>from</strong> and <strong>to</strong> is greater than 1 day but fewer than or equal to 3 days, the interval is 5 minutes.</p>
</li><li><p>If the time range between <strong>from</strong> and <strong>to</strong> is greater than 3 days but fewer than or equal 7 days, the interval is 10 minutes.</p>
</li><li><p>If the time range between <strong>from</strong> and <strong>to</strong> is greater than 7 days but fewer than or equal to 30 days, the interval is 1 hour.</p>
</li></ul>
</td>
</tr>
</tbody>

378
docs/wafd/api-ref/ListCcRules.html
View File

File diff suppressed because it is too large Load Diff

24
docs/wafd/api-ref/ListCertificates.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying the Certificate List</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the certificate list.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/certificate</p>
<div class="section" id="ListCertificates__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/certificate</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -181,18 +181,32 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Certificate name</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>certificateid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Certificate ID, which is a redundant parameter. Please ignore it.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>certificatename</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Certificate name, which is a redundant parameter. Please ignore it.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>expire_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Timestamp when the certificate expire</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Timestamp when the certificate expire. This parameter is returned in the response body only when the value of host in the URL request is true.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>exp_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Certificate expiration status. The value can be:</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Certificate expiration status. This parameter is returned in the response body only when the value of host in the URL request is true. The value can be:</p>
<ul><li><p>0: The certificate is valid.</p>
</li><li><p>1: The certificate has expired.</p>
</li><li><p>2: The certificate is about to expire.</p>
@ -210,7 +224,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Array of <a href="#ListCertificates__response_BindHost">BindHost</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Domain name associated with the certificate</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Domain name associated with the certificate. This parameter is returned in the response body only when the value of host in the URL request is true.</p>
</td>
</tr>
</tbody>
@ -331,7 +345,7 @@
</table>
</div>
</div>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">GET https://{Endpoint}/v1/{project_id}/waf/certificate?</pre>
<div class="section"><h4 class="sectiontitle">Example Requests</h4><pre class="screen">GET https://{Endpoint}/v1/{project_id}/waf/certificate?page=1&amp;pagesize=10&amp;host=true&amp;enterprise_project_id=0</pre>
</div>
<div class="section"><h4 class="sectiontitle">Example Responses</h4><p><strong>Status code: 200</strong></p>
<p>Request succeeded.</p>

102
docs/wafd/api-ref/ListCustomRules.html
View File

File diff suppressed because it is too large Load Diff

23
docs/wafd/api-ref/ListEvent.html
View File

@ -1,9 +1,9 @@
<a name="ListEvent"></a><a name="ListEvent"></a>
<h1 class="topictitle1">Querying the List of Attack Events</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the list of attack events for a specific period. It cannot be used to query all attack events. The pagesize parameter cannot be set to -1.</p>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the list of attack events for a specific period.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/event</p>
<div class="section" id="ListEvent__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/event</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -227,12 +227,12 @@
</li><li><p>rfi: Remote file inclusion</p>
</li><li><p>webshell: Website Trojans</p>
</li><li><p>cc: CC attacks</p>
</li><li><p>custom_custom: Precise protection</p>
</li><li><p>custom_whiteblackip: IP address blacklist and whitelist</p>
</li><li><p>custom_geoip: Geolocation access control</p>
</li><li><p>antitamper: Web tamper protection</p>
</li><li><p>anticrawler: Anti-crawler protection</p>
</li><li><p>leakage: Data leakage prevention</p>
</li><li><p>custom_custom: attack protected by the precise protection rules</p>
</li><li><p>custom_whiteblackip: attack protected by the blacklist and whitelist protection rule</p>
</li><li><p>custom_geoip: attack protected by the geolocation access control protection rule</p>
</li><li><p>antitamper: attack protected by the web tamper protection rules</p>
</li><li><p>anticrawler: attack protected by the anti-crawler protection rules</p>
</li><li><p>leakage: attack protected by the information leakage protection rule</p>
</li><li><p>illegal: Illegal requests</p>
</li><li><p>vuln: Other attack types</p>
</li></ul>
@ -336,6 +336,13 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Response body content.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>request_body</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Request body</p>
</td>
</tr>
</tbody>
</table>
</div>

40
docs/wafd/api-ref/ListGeoipRule.html → docs/wafd/api-ref/ListGeoipRules.html
View File

File diff suppressed because it is too large Load Diff

215
docs/wafd/api-ref/ListIgnoreRules.html
View File

File diff suppressed because it is too large Load Diff

39
docs/wafd/api-ref/ListInstance.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying the List of Dedicated WAF Engines</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the list of dedicated WAF engines.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/premium-waf/instance</p>
<div class="section" id="ListInstance__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/premium-waf/instance</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -82,7 +82,7 @@
</thead>
<tbody><tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p>X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>No</p>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p>Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p>String</p>
</td>
@ -124,7 +124,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p>Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Whether any dedicated engine has been created. The value can be false or true.</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p>Whether any dedicated engine has been created. This parameter is reserved and can be ignored currently. The value can be false or true.</p>
<ul><li><p>false: No dedicated WAF engine has been created.</p>
</li><li><p>true: At least one dedicated WAF engine has been created.</p>
</li></ul>
@ -241,7 +241,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>unning status of the dedicated engine. The value can be 0 (creating), 1 (running), 2 (deleting), 3 (deleted), 4 (creation failed), 5 (frozen), 6 (abnormal), 7 (updating), or 8 (update failed).</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Running status of the dedicated engine. The value can be 0 (creating), 1 (running), 2 (deleting), 3 (deleted), 4 (creation failed), 5 (frozen), 6 (abnormal), 7 (updating), or 8 (update failed).</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>access_status</p>
@ -258,7 +258,10 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Whether the dedicated engine can be upgraded. The value can be 0 for no or 1 for yes.</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Whether the dedicated engine can be upgraded.</p>
<ul><li><p>0: the dedicated engine is non-upgradable</p>
</li><li><p>1: the dedicated engine is upgradable</p>
</li></ul>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>cloudServiceType</p>
@ -286,7 +289,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Dedicated engine ECS specifications, for example, 8 vCPUs | 16 GB.</p>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Dedicated engine ECS specifications, for example, 8 vCPUs | 16 GB. 8vCPUs | 16GB maps to waf.instance.enterprise, and 2vCPUs | 4GB to waf.instance. professional.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>hosts</p>
@ -310,6 +313,27 @@
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>ID of the ECS hosting the dedicated engine. This parameter is the same as server_id, and will be deleted.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>create_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Timestamp when the dedicated WAF engine was created.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>data_volume_size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Size of the data disk, in GB.</p>
</td>
</tr>
<tr><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p>res_tenant_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p>Type of the dedicated WAF instance. Its value is always <strong>1</strong>, which means the type of the dedicated WAF instance is <strong>Network Interface</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
@ -453,7 +477,8 @@
"hostname" : "demo.www.com"
} ],
"instancename" : "0412elb",
"instance_name" : "0412elb"
"instance_name" : "0412elb",
"create_time" : 1649217360674
} ]
}</pre>
</div>

340
docs/wafd/api-ref/ListPolicy.html
View File

File diff suppressed because it is too large Load Diff

120
docs/wafd/api-ref/ListPremiumHost.html
View File

File diff suppressed because it is too large Load Diff

6
docs/wafd/api-ref/ListPrivacyRules.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying the Data Masking Rule List</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the data masking rule list.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/policy/{policy_id}/privacy</p>
<div class="section" id="ListPrivacyRules__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/policy/{policy_id}/privacy</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>
@ -30,7 +30,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p>String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p>Policy ID. It can be obtained by calling the <strong>ListPolicy</strong> API.</p>
</td>
</tr>
</tbody>
@ -62,7 +62,7 @@
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p>Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Number of records on each page. The maximum value is 100.</p>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p>Number of records on each page. The maximum value is 2147483647.</p>
</td>
</tr>
</tbody>

324
docs/wafd/api-ref/ListPunishmentRules.html Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/wafd/api-ref/ListQpsTimeline.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying the QPS Statistics</h1>
<div><div class="section"><h4 class="sectiontitle">Function</h4><p>This API is used to query the website QPS statistics.</p>
</div>
<div class="section"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/overviews/qps/timeline</p>
<div class="section" id="ListQpsTimeline__atuogenerate_1"><h4 class="sectiontitle">URI</h4><p>GET /v1/{project_id}/waf/overviews/qps/timeline</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p>Parameter</p>
</th>

Some files were not shown because too many files have changed in this diff Show More