akyriako/web-application-firewall-dedicated
1
0
Fork 0
forked from docs/web-application-firewall-dedicated
Code Pull Requests Activity

Compare commits

base: akyriako:main
Branches Tags
akyriako:main
akyriako:propose-wafd_best-practice-809
akyriako:sbv_update
akyriako:confpy
akyriako:propose-wafd_api-ref-778
akyriako:propose-wafd_umn-769
akyriako:propose-wafd_api-ref-769
akyriako:propose-wafd_api-ref-776
akyriako:propose-wafd_api-ref-588
akyriako:propose-wafd_umn-773
akyriako:service_based_view
akyriako:propose-wafd_umn-694
akyriako:propose-wafd_umn-569
akyriako:propose-wafd_api-ref-569
akyriako:tox4-cleanup
akyriako:tox4
akyriako:x4
akyriako:propose-wafd_api-ref-471
akyriako:propose-wafd_umn-472
akyriako:propose-wafd_umn-451
akyriako:propose-wafd_api-ref-451
akyriako:propose-wafd_umn-449
akyriako:propose-wafd_api-ref-449
akyriako:x2
akyriako:propose-wafd_umn-412
akyriako:propose-wafd_api-ref-412
akyriako:confpy-2
..
compare: akyriako:tox4
Branches Tags
akyriako:propose-wafd_best-practice-809
akyriako:main
akyriako:sbv_update
akyriako:confpy
akyriako:propose-wafd_api-ref-778
akyriako:propose-wafd_umn-769
akyriako:propose-wafd_api-ref-769
akyriako:propose-wafd_api-ref-776
akyriako:propose-wafd_api-ref-588
akyriako:propose-wafd_umn-773
akyriako:service_based_view
akyriako:propose-wafd_umn-694
akyriako:propose-wafd_umn-569
akyriako:propose-wafd_api-ref-569
akyriako:tox4-cleanup
akyriako:tox4
akyriako:x4
akyriako:propose-wafd_api-ref-471
akyriako:propose-wafd_umn-472
akyriako:propose-wafd_umn-451
akyriako:propose-wafd_api-ref-451
akyriako:propose-wafd_umn-449
akyriako:propose-wafd_api-ref-449
akyriako:x2
akyriako:propose-wafd_umn-412
akyriako:propose-wafd_api-ref-412
akyriako:confpy-2

1 Commits
main ... tox4

Author SHA1 Message Date
Artem Goncharov
9dda428b6e Update tox.ini && conf.py file 
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
 2023-01-05 19:11:15 +01:00
318 changed files with 5050 additions and 14324 deletions
Show Stats Expand all files Collapse all files

4
api-ref/source/apis/certificate_management/creating_a_certificate.rst
View File

@ -108,8 +108,8 @@ Example Requests
{ {
"name" : "demo", "name" : "demo",
"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-----", "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-----\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-----" "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-----"
} }
Example Responses Example Responses

48
api-ref/source/apis/certificate_management/querying_the_certificate_list.rst
View File

@ -89,31 +89,27 @@ Response Parameters
.. table:: **Table 5** ListCertificateBody .. table:: **Table 5** ListCertificateBody
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+========================================================================+==========================================================================================================================================================+ +=======================+========================================================================+==================================================+
| id | String | Certificate ID | | id | String | Certificate ID |
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
| name | String | Certificate name | | name | String | Certificate name |
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
| certificateid | String | Certificate ID, which is a redundant parameter. Please ignore it. | | expire_time | Long | Timestamp when the certificate expire |
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
| certificatename | String | Certificate name, which is a redundant parameter. Please ignore it. | | exp_status | Integer | Certificate expiration status. The value can be: |
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | |
| expire_time | Long | 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. | | | | - 0: The certificate is valid. |
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | | | |
| exp_status | Integer | 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: | | | | - 1: The certificate has expired. |
| | | | | | | |
| | | - 0: The certificate is valid. | | | | - 2: The certificate is about to expire. |
| | | | +-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
| | | - 1: The certificate has expired. | | timestamp | Long | Timestamp when the certificate is uploaded |
| | | | +-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
| | | - 2: The certificate is about to expire. | | bind_host | Array of :ref:`BindHost <listcertificates__response_bindhost>` objects | Domain name associated with the certificate |
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+--------------------------------------------------+
| timestamp | Long | Timestamp when the certificate is uploaded |
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| bind_host | Array of :ref:`BindHost <listcertificates__response_bindhost>` objects | 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. |
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _listcertificates__response_bindhost: .. _listcertificates__response_bindhost:
@ -167,7 +163,7 @@ Example Requests
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/waf/certificate?page=1&pagesize=10&host=true&enterprise_project_id=0 GET https://{Endpoint}/v1/{project_id}/waf/certificate?
Example Responses Example Responses
----------------- -----------------

34
api-ref/source/apis/dashboard/querying_bandwidth_usage_statistics.rst
View File

@ -25,27 +25,19 @@ GET /v1/{project_id}/waf/overviews/bandwidth/timeline
.. table:: **Table 2** Query Parameters .. table:: **Table 2** Query Parameters
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================================================+ +===========+===========+========+===============================================================================================+
| from | Yes | Long | Start time (13-digit timestamp in millisecond). This parameter must be used together with to. | | from | Yes | Long | Start time (13-digit timestamp in millisecond). This parameter must be used together with to. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
| to | Yes | Long | End time (13-digit timestamp in millisecond). This parameter must be used together with from. | | to | Yes | Long | End time (13-digit timestamp in millisecond). This parameter must be used together with from. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
| hosts | No | String | List of domain names to query, which can be obtained by calling the ListHost API | | hosts | No | String | List of domain names to query, which can be obtained by calling the ListHost API |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
| instances | No | String | This parameter is used to query the bandwidth of the protected domain name protected by a specific dedicated WAF engine instance. | | instances | No | String | List of instance to query (only for the instantiation mode). |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
| group_by | No | String | Data aggregation interval. If this parameter is not specified, data is displayed by a time range calculated based on parameters **from** and **to**. | | group_by | No | String | Display dimension. For example, the value is DAY if data is displayed by the day. |
| | | | | +-----------+-----------+--------+-----------------------------------------------------------------------------------------------+
| | | | - If the time range between **from** and **to** is fewer than or equal to 1 day, the interval is one minute. |
| | | | |
| | | | - If the time range between **from** and **to** is greater than 1 day but fewer than or equal to 3 days, the interval is 5 minutes. |
| | | | |
| | | | - If the time range between **from** and **to** is greater than 3 days but fewer than or equal 7 days, the interval is 10 minutes. |
| | | | |
| | | | - If the time range between **from** and **to** is greater than 7 days but fewer than or equal to 30 days, the interval is 1 hour. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

72
api-ref/source/apis/dedicated_instance_management/creating_a_dedicated_waf_engine.rst
View File

@ -31,7 +31,7 @@ Request Parameters
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+=================+=================+=================+==========================================================================================================+ +=================+=================+=================+==========================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). | | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+
| Content-Type | Yes | String | Content type. | | Content-Type | Yes | String | Content type. |
| | | | | | | | | |
@ -40,47 +40,31 @@ Request Parameters
.. table:: **Table 3** Request body parameters .. table:: **Table 3** Request body parameters
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+=================+=================+==================+==============================================================================================================================================================================================================+ +================+===========+==================+=========================================================================================================================================================================================================================================================================================================+
| region | Yes | String | Region where a dedicated engine is to be created. Its value is EU-DE. | | chargemode | No | Integer | Billing mode. Currently, only pay-per-use billing (30) is supported. Make sure your account balance is enough, or the dedicated WAF engine will forward requests directly to the origin server without inspection. |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| available_zone | Yes | String | AZ where the dedicated engine is to be created. | | region | Yes | String | Region where a dedicated engine is to be created. Its value is EU-DE. |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| arch | Yes | String | Dedicated engine CPU architecture. Its value has to be x86. | | available_zone | Yes | String | AZ where the dedicated engine is to be created. |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| instancename | Yes | String | Prefix of the dedicated WAF engine name, which is user-defined. | | arch | Yes | String | Dedicated engine CPU architecture. Its value can be x86 . |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| specification | Yes | String | Specifications of the dedicated engine version. The value can be **waf.instance.enterprise** or **waf.instance.professional**. | | instancename | Yes | String | Prefix of the dedicated WAF engine name, which is user-defined. |
| | | | | +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | - **waf.instance.professional**: WI-100. Performance: 100 Mbit/s of throughput and 2,000 QPS. | | specification | Yes | String | Specifications of the dedicated engine version. The value can be waf.instance.enterprise or waf.instance.professional. An enterprise edition dedicated engine has more functions than a professional edition one. For more details, see the Web Application Firewall (WAF) User Guide. |
| | | | | +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | - **waf.instance.enterprise**: WI-100. Performance: 500 Mbit/s of throughput and 10,000 QPS. | | cpu_flavor | Yes | String | ID of the specifications of the ECS hosting the dedicated engine. It can be obtained by calling the ECS ListFlavors API. For the enterprise edition, ECS specifications with 8 vCPUs and 16 GB memory are used. For the professional edition, ECS specifications with 2 vCPUs and 4 GB memory are used. |
| | | | | +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | Enumeration values: | | vpc_id | Yes | String | ID of the VPC where the dedicated engine is located. It can be obtained by calling the ListVpcs API. |
| | | | | +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | - **waf.instance.professional** | | subnet_id | Yes | String | ID of the VPC subnet where the dedicated engine is located. It can be obtained by calling the **ListSubnets API**. **subnet_id** has the same value as **network_id** obtained by calling the OpenStack APIs |
| | | | | +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | - **waf.instance.enterprise** | | security_group | Yes | Array of strings | ID of the security group where the dedicated engine is located. It can be obtained by calling the ListSecurityGroups API. |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cpu_flavor | Yes | String | ID of the specifications of the ECS hosting the dedicated engine. You can go to the management console and confirm supported specifications. | | count | Yes | Integer | Number of dedicated engines to be provisioned |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +----------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | Yes | String | ID of the VPC where the dedicated engine is located. It can be obtained by calling the ListVpcs API. |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| subnet_id | Yes | String | ID of the VPC subnet where the dedicated engine is located. It can be obtained by calling the **ListSubnets API**. **subnet_id** has the same value as **network_id** obtained by calling the OpenStack APIs |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group | Yes | Array of strings | ID of the security group where the dedicated engine is located. It can be obtained by calling the ListSecurityGroups API. |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| count | Yes | Integer | Number of dedicated engines to be provisioned |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| res_tenant | Yes | Boolean | Whether to create a dedicated engine instance of the network interface type. Its value has to be true. |
| | | | |
| | | | - **Network Interface**: Your WAF instance will be connected to your network via a VPC. (If ELB is used, only dedicated load balancers can be used.) |
| | | | |
| | | | Enumeration values: |
| | | | |
| | | | - **true** |
+-----------------+-----------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters Response Parameters
------------------- -------------------
@ -147,6 +131,7 @@ Example Requests
POST https://{endpoint}/v1/{project_id}/premium-waf/instance POST https://{endpoint}/v1/{project_id}/premium-waf/instance
{ {
"chargemode" : 30,
"region" : "region-01-4", "region" : "region-01-4",
"available_zone" : "region-01-4a", "available_zone" : "region-01-4a",
"arch" : "x86", "arch" : "x86",
@ -156,8 +141,7 @@ Example Requests
"vpc_id" : "d7b6a5ff-6c53-4cd4-9d57-f20ee8753056", "vpc_id" : "d7b6a5ff-6c53-4cd4-9d57-f20ee8753056",
"subnet_id" : "e59ccd18-7e15-4588-b689-04b856f4e78b", "subnet_id" : "e59ccd18-7e15-4588-b689-04b856f4e78b",
"security_group" : [ "09b156a2-f0f0-41fd-9891-60e594601cfd" ], "security_group" : [ "09b156a2-f0f0-41fd-9891-60e594601cfd" ],
"count" : 1, "count" : 1
"res_tenant" : true
} }
Example Responses Example Responses

170
api-ref/source/apis/dedicated_instance_management/deleting_a_dedicated_waf_engine.rst
View File

File diff suppressed because it is too large Load Diff

168
api-ref/source/apis/dedicated_instance_management/operations_on_a_dedicated_waf_instance.rst
View File

File diff suppressed because it is too large Load Diff

170
api-ref/source/apis/dedicated_instance_management/querying_details_about_a_dedicated_waf_engine.rst
View File

File diff suppressed because it is too large Load Diff

155
api-ref/source/apis/dedicated_instance_management/querying_the_list_of_dedicated_waf_engines.rst
View File

File diff suppressed because it is too large Load Diff

168
api-ref/source/apis/dedicated_instance_management/renaming_a_dedicated_waf_engine.rst
View File

File diff suppressed because it is too large Load Diff

152
api-ref/source/apis/event_management/querying_attack_event_details.rst
View File

File diff suppressed because it is too large Load Diff

154
api-ref/source/apis/event_management/querying_the_list_of_attack_events.rst
View File

File diff suppressed because it is too large Load Diff

119
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/adding_a_protected_domain_name.rst
View File

File diff suppressed because it is too large Load Diff

125
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/deleting_a_domain_name_from_a_dedicated_waf_instance.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/index.rst
View File

@ -10,7 +10,6 @@ Managing Websites Protected in Dedicated Mode
- :ref:`Querying Domain Name Settings in Dedicated Mode <showpremiumhost>` - :ref:`Querying Domain Name Settings in Dedicated Mode <showpremiumhost>`
- :ref:`Modifying a Domain Name Protected by a Dedicated WAF Instance <updatepremiumhost>` - :ref:`Modifying a Domain Name Protected by a Dedicated WAF Instance <updatepremiumhost>`
- :ref:`Deleting a Domain Name from a Dedicated WAF Instance <deletepremiumhost>` - :ref:`Deleting a Domain Name from a Dedicated WAF Instance <deletepremiumhost>`
- :ref:`Modifying the Protection Status of a Domain Name in Dedicated Mode <updatepremiumhostprotectstatus>`
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -21,4 +20,3 @@ Managing Websites Protected in Dedicated Mode
querying_domain_name_settings_in_dedicated_mode querying_domain_name_settings_in_dedicated_mode
modifying_a_domain_name_protected_by_a_dedicated_waf_instance modifying_a_domain_name_protected_by_a_dedicated_waf_instance
deleting_a_domain_name_from_a_dedicated_waf_instance deleting_a_domain_name_from_a_dedicated_waf_instance
modifying_the_protection_status_of_a_domain_name_in_dedicated_mode

519
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/modifying_a_domain_name_protected_by_a_dedicated_waf_instance.rst
View File

File diff suppressed because it is too large Load Diff

152
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/modifying_the_protection_status_of_a_domain_name_in_dedicated_mode.rst
View File

File diff suppressed because it is too large Load Diff

328
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/querying_domain_name_settings_in_dedicated_mode.rst
View File

File diff suppressed because it is too large Load Diff

127
api-ref/source/apis/managing_websites_protected_in_dedicated_mode/querying_domain_names_protected_by_dedicated_waf_engines.rst
View File

File diff suppressed because it is too large Load Diff

448
api-ref/source/apis/policy_management/creating_a_policy.rst
View File

File diff suppressed because it is too large Load Diff

450
api-ref/source/apis/policy_management/deleting_a_policy.rst
View File

File diff suppressed because it is too large Load Diff

468
api-ref/source/apis/policy_management/querying_a_policy_by_id.rst
View File

File diff suppressed because it is too large Load Diff

446
api-ref/source/apis/policy_management/querying_protection_policies.rst
View File

File diff suppressed because it is too large Load Diff

730
api-ref/source/apis/policy_management/updating_a_policy.rst
View File

File diff suppressed because it is too large Load Diff

82
api-ref/source/apis/rule_management/creating_a_reference_table.rst → api-ref/source/apis/rule_management/adding_a_reference_table.rst
View File

File diff suppressed because it is too large Load Diff

76
api-ref/source/apis/rule_management/changing_the_status_of_a_policy_rule.rst
View File

File diff suppressed because it is too large Load Diff

60
api-ref/source/apis/rule_management/creating_a_blacklist_or_whitelist_rule.rst
View File

File diff suppressed because it is too large Load Diff

629
api-ref/source/apis/rule_management/creating_a_cc_attack_protection_rule.rst
View File

File diff suppressed because it is too large Load Diff

15
api-ref/source/apis/rule_management/creating_a_data_masking_rule.rst
View File

@ -8,7 +8,7 @@ Creating a Data Masking Rule
Function Function
-------- --------
This API is used to create a data masking rule. Creating a Data Masking Rule
URI URI
--- ---
@ -17,13 +17,12 @@ POST /v1/{project_id}/waf/policy/{policy_id}/privacy
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+------------+-----------+--------+------------------------------------------------------------------+ ========== ========= ====== ===========
| Parameter | Mandatory | Type | Description | Parameter Mandatory Type Description
+============+===========+========+==================================================================+ ========== ========= ====== ===========
| project_id | Yes | String | Project ID | project_id Yes String Project ID
+------------+-----------+--------+------------------------------------------------------------------+ policy_id Yes String Policy ID
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. | ========== ========= ====== ===========
+------------+-----------+--------+------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

279
api-ref/source/apis/rule_management/creating_a_false_alarm_masking_rule.rst Normal file
View File

File diff suppressed because it is too large Load Diff

279
api-ref/source/apis/rule_management/creating_a_geolocation_access_control_rule.rst
View File

File diff suppressed because it is too large Load Diff

218
api-ref/source/apis/rule_management/creating_a_javascript_anti-crawler_rule.rst
View File

File diff suppressed because it is too large Load Diff

166
api-ref/source/apis/rule_management/creating_a_known_attack_source_rule.rst
View File

File diff suppressed because it is too large Load Diff

372
api-ref/source/apis/rule_management/creating_a_precise_protection_rule.rst
View File

File diff suppressed because it is too large Load Diff

55
api-ref/source/apis/rule_management/creating_a_web_tamper_protection_rule.rst
View File

@ -17,13 +17,12 @@ POST /v1/{project_id}/waf/policy/{policy_id}/antitamper
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+------------+-----------+--------+------------------------------------------------------------------+ ========== ========= ====== ===========
| Parameter | Mandatory | Type | Description | Parameter Mandatory Type Description
+============+===========+========+==================================================================+ ========== ========= ====== ===========
| project_id | Yes | String | Project ID | project_id Yes String Project ID
+------------+-----------+--------+------------------------------------------------------------------+ policy_id Yes String Policy ID
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. | ========== ========= ====== ===========
+------------+-----------+--------+------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------
@ -59,27 +58,27 @@ Response Parameters
.. table:: **Table 4** Response body parameters .. table:: **Table 4** Response body parameters
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+=========================================================================================================================================================+ +=======================+=======================+=========================================================+
| id | String | Rule ID. | | id | String | Rule ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| policyid | String | Policy ID | | policyid | String | Policy ID |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| timestamp | Long | Timestamp | | timestamp | Long | Timestamp |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| description | String | Rule description. | | description | String | Rule description. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| status | Integer | Rule status. The value can be: | | status | Integer | Rule status. The value can be: |
| | | | | | | |
| | | - 0: The rule is disabled. | | | | - 0: The rule is disabled. |
| | | | | | | |
| | | - 1: The rule is enabled. | | | | - 1: The rule is enabled. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| hostname | String | 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. | | hostname | String | Domain name protected by the web tamper protection rule |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| url | String | URL for the web tamper protection rule. | | url | String | URL for the web tamper protection rule. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
**Status code: 400** **Status code: 400**

201
api-ref/source/apis/rule_management/creating_an_information_leakage_protection_rule.rst
View File

File diff suppressed because it is too large Load Diff

24
api-ref/source/apis/rule_management/deleting_a_blacklist_or_whitelist_rule.rst
View File

@ -17,15 +17,13 @@ DELETE /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+ ========== ========= ====== ===========
| Parameter | Mandatory | Type | Description | Parameter Mandatory Type Description
+============+===========+========+=========================================================================================================+ ========== ========= ====== ===========
| project_id | Yes | String | Project ID | project_id Yes String Project ID
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+ policy_id Yes String Policy ID
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. | rule_id Yes String Rule ID
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+ ========== ========= ====== ===========
| rule_id | Yes | String | ID of the blacklist or whitelist rule. It can be obtained by calling the **ListWhiteblackipRules** API. |
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------
@ -37,7 +35,7 @@ Request Parameters
+=================+=================+=================+============================================+ +=================+=================+=================+============================================+
| X-Auth-Token | Yes | String | User Token. | | X-Auth-Token | Yes | String | User Token. |
+-----------------+-----------------+-----------------+--------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------+
| Content-Type | No | String | Content type | | Content-Type | Yes | String | Content type |
| | | | | | | | | |
| | | | Default: **application/json;charset=utf8** | | | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------+
@ -54,8 +52,6 @@ Response Parameters
+=======================+=======================+=====================================================+ +=======================+=======================+=====================================================+
| id | String | Rule ID | | id | String | Rule ID |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| name | String | Rule name. |
+-----------------------+-----------------------+-----------------------------------------------------+
| policyid | String | Policy ID. | | policyid | String | Policy ID. |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| timestamp | Long | Rule creation time | | timestamp | Long | Rule creation time |
@ -68,7 +64,7 @@ Response Parameters
| | | | | | | |
| | | - 1: The rule is enabled. | | | | - 1: The rule is enabled. |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| addr | String | Blacklisted or whitelisted IP addresses | | addr | String | lacklisted or whitelisted IP addresses |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| white | Integer | Protective action. The value can be: | | white | Integer | Protective action. The value can be: |
| | | | | | | |
@ -78,8 +74,6 @@ Response Parameters
| | | | | | | |
| | | - 2: WAF only logs the requests that hit the rule. | | | | - 2: WAF only logs the requests that hit the rule. |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| followed_action_id | String | ID of the known attack source rule. |
+-----------------------+-----------------------+-----------------------------------------------------+
**Status code: 400** **Status code: 400**

354
api-ref/source/apis/rule_management/deleting_a_cc_attack_protection_rule.rst
View File

File diff suppressed because it is too large Load Diff

62
api-ref/source/apis/rule_management/deleting_a_data_masking_rule.rst
View File

@ -17,15 +17,13 @@ DELETE /v1/{project_id}/waf/policy/{policy_id}/privacy/{rule_id}
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------+ ========== ========= ====== ===========
| Parameter | Mandatory | Type | Description | Parameter Mandatory Type Description
+============+===========+========+==========================================================================================+ ========== ========= ====== ===========
| project_id | Yes | String | Project ID | project_id Yes String Project ID
+------------+-----------+--------+------------------------------------------------------------------------------------------+ policy_id Yes String Policy ID
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. | rule_id Yes String Rule ID
+------------+-----------+--------+------------------------------------------------------------------------------------------+ ========== ========= ====== ===========
| rule_id | Yes | String | ID of the data masking rule. It can be obtained by calling the **ListPrivacyRules** API. |
+------------+-----------+--------+------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------
@ -37,7 +35,7 @@ Request Parameters
+=================+=================+=================+============================================+ +=================+=================+=================+============================================+
| X-Auth-Token | Yes | String | auth token | | X-Auth-Token | Yes | String | auth token |
+-----------------+-----------------+-----------------+--------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------+
| Content-Type | No | String | Content type | | Content-Type | Yes | String | Content type |
| | | | | | | | | |
| | | | Default: **application/json;charset=utf8** | | | | | Default: **application/json;charset=utf8** |
+-----------------+-----------------+-----------------+--------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------+
@ -45,47 +43,9 @@ Request Parameters
Response Parameters Response Parameters
------------------- -------------------
**Status code: 200**
.. table:: **Table 3** Response body parameters
+-----------------------+-----------------------+--------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+====================================================================+
| id | String | Rule ID |
+-----------------------+-----------------------+--------------------------------------------------------------------+
| policyid | String | Policy ID |
+-----------------------+-----------------------+--------------------------------------------------------------------+
| timestamp | Long | Time the rule is created. The value is a 13-digit timestamp in ms. |
+-----------------------+-----------------------+--------------------------------------------------------------------+
| status | Integer | Rule status. The value can be: |
| | | |
| | | - 0: The rule is disabled. |
| | | |
| | | - 1: The rule is enabled. |
+-----------------------+-----------------------+--------------------------------------------------------------------+
| url | String | URL protected by the data masking rule |
+-----------------------+-----------------------+--------------------------------------------------------------------+
| category | String | Masked field |
| | | |
| | | Enumeration values: |
| | | |
| | | - **params** |
| | | |
| | | - **cookie** |
| | | |
| | | - **header** |
| | | |
| | | - **form** |
+-----------------------+-----------------------+--------------------------------------------------------------------+
| index | String | Name of the masked field |
+-----------------------+-----------------------+--------------------------------------------------------------------+
| description | String | Rule description |
+-----------------------+-----------------------+--------------------------------------------------------------------+
**Status code: 400** **Status code: 400**
.. table:: **Table 4** Response body parameters .. table:: **Table 3** Response body parameters
========== ====== ============= ========== ====== =============
Parameter Type Description Parameter Type Description
@ -96,7 +56,7 @@ Response Parameters
**Status code: 401** **Status code: 401**
.. table:: **Table 5** Response body parameters .. table:: **Table 4** Response body parameters
========== ====== ============= ========== ====== =============
Parameter Type Description Parameter Type Description
@ -107,7 +67,7 @@ Response Parameters
**Status code: 500** **Status code: 500**
.. table:: **Table 6** Response body parameters .. table:: **Table 5** Response body parameters
========== ====== ============= ========== ====== =============
Parameter Type Description Parameter Type Description

281
api-ref/source/apis/rule_management/creating_a_global_protection_whitelist_formerly_false_alarm_masking_rule.rst → api-ref/source/apis/rule_management/deleting_a_false_alarm_masking_rule.rst
View File

File diff suppressed because it is too large Load Diff

161
api-ref/source/apis/rule_management/deleting_a_geolocation_access_control_rule.rst
View File

File diff suppressed because it is too large Load Diff

200
api-ref/source/apis/rule_management/deleting_a_global_protection_whitelist_false_alarm_masking_rule.rst
View File

File diff suppressed because it is too large Load Diff

179
api-ref/source/apis/rule_management/deleting_a_javascript_anti-crawler_rule.rst
View File

File diff suppressed because it is too large Load Diff

155
api-ref/source/apis/rule_management/deleting_a_known_attack_source_rule.rst
View File

File diff suppressed because it is too large Load Diff

172
api-ref/source/apis/rule_management/deleting_a_precise_protection_rule.rst
View File

File diff suppressed because it is too large Load Diff

20
api-ref/source/apis/rule_management/deleting_a_reference_table.rst
View File

@ -13,17 +13,17 @@ This API is used to delete a reference table.
URI URI
--- ---
DELETE /v1/{project_id}/waf/valuelist/{table_id} DELETE /v1/{project_id}/waf/valuelist/{valuelistid}
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+------------+-----------+--------+---------------------------------------------------------------------------------------------+ +-------------+-----------+--------+---------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description | | Parameter | Mandatory | Type | Description |
+============+===========+========+=============================================================================================+ +=============+===========+========+=============================================================================================+
| project_id | Yes | String | Project ID | | project_id | Yes | String | Project ID |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+ +-------------+-----------+--------+---------------------------------------------------------------------------------------------+
| table_id | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List | | valuelistid | Yes | String | Reference table ID. It can be obtained by calling the API Querying the Reference Table List |
+------------+-----------+--------+---------------------------------------------------------------------------------------------+ +-------------+-----------+--------+---------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------
@ -117,7 +117,7 @@ Example Requests
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/waf/valuelist/{table_id}? DELETE https://{Endpoint}/v1/{project_id}/waf/valuelist/{valuelistid}?
Example Responses Example Responses
----------------- -----------------
@ -133,8 +133,6 @@ Request succeeded.
"name" : "demo2", "name" : "demo2",
"type" : "url", "type" : "url",
"values" : [ "/demo" ], "values" : [ "/demo" ],
"description" : "",
"producer" : 1,
"timestamp" : 1656495488880 "timestamp" : 1656495488880
} }

58
api-ref/source/apis/rule_management/deleting_a_web_tamper_protection_rule.rst
View File

@ -17,15 +17,13 @@ DELETE /v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+------------+-----------+--------+------------------------------------------------------------------------------------------------------+ ========== ========= ====== ===========
| Parameter | Mandatory | Type | Description | Parameter Mandatory Type Description
+============+===========+========+======================================================================================================+ ========== ========= ====== ===========
| project_id | Yes | String | Project ID | project_id Yes String Project ID
+------------+-----------+--------+------------------------------------------------------------------------------------------------------+ policy_id Yes String Policy ID
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. | rule_id Yes String Rule ID
+------------+-----------+--------+------------------------------------------------------------------------------------------------------+ ========== ========= ====== ===========
| rule_id | Yes | String | ID of the web tamper protection rule. It can be obtained by calling the **ListAntitamperRules** API. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------
@ -49,27 +47,27 @@ Response Parameters
.. table:: **Table 3** Response body parameters .. table:: **Table 3** Response body parameters
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+=========================================================================================================================================================+ +=======================+=======================+=========================================================+
| id | String | Rule ID. | | id | String | Rule ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| policyid | String | Policy ID | | policyid | String | Policy ID |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| timestamp | Long | Timestamp | | timestamp | Long | Timestamp |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| description | String | Rule description. | | description | String | Rule description. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| status | Integer | Rule status. The value can be: | | status | Integer | Rule status. The value can be: |
| | | | | | | |
| | | - 0: The rule is disabled. | | | | - 0: The rule is disabled. |
| | | | | | | |
| | | - 1: The rule is enabled. | | | | - 1: The rule is enabled. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| hostname | String | 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. | | hostname | String | Domain name protected by the web tamper protection rule |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
| url | String | URL for the web tamper protection rule. | | url | String | URL for the web tamper protection rule. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------+
**Status code: 400** **Status code: 400**

169
api-ref/source/apis/rule_management/deleting_an_information_leakage_prevention_rule.rst
View File

File diff suppressed because it is too large Load Diff

66
api-ref/source/apis/rule_management/index.rst
View File

File diff suppressed because it is too large Load Diff

100
api-ref/source/apis/rule_management/modifying_a_reference_table.rst
View File

File diff suppressed because it is too large Load Diff

42
api-ref/source/apis/rule_management/querying_a_blacklist_or_whitelist_rule_by_id.rst → api-ref/source/apis/rule_management/querying_a_blacklist_or_whitelist_rule.rst
View File

@ -2,8 +2,8 @@
.. _ShowWhiteblackipRule: .. _ShowWhiteblackipRule:
Querying a Blacklist Or Whitelist Rule by ID Querying a Blacklist or Whitelist Rule
============================================ ======================================
Function Function
-------- --------
@ -17,15 +17,13 @@ GET /v1/{project_id}/waf/policy/{policy_id}/whiteblackip/{rule_id}
.. table:: **Table 1** Path Parameters .. table:: **Table 1** Path Parameters
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+ ========== ========= ====== ===========
| Parameter | Mandatory | Type | Description | Parameter Mandatory Type Description
+============+===========+========+=========================================================================================================+ ========== ========= ====== ===========
| project_id | Yes | String | Project ID | project_id Yes String Project ID
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+ policy_id Yes String Policy ID
| policy_id | Yes | String | Policy ID. It can be obtained by calling the **ListPolicy** API. | rule_id Yes String Rule ID
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+ ========== ========= ====== ===========
| rule_id | Yes | String | ID of the blacklist or whitelist rule. It can be obtained by calling the **ListWhiteblackipRules** API. |
+------------+-----------+--------+---------------------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------
@ -54,8 +52,6 @@ Response Parameters
+=======================+=======================+=====================================================+ +=======================+=======================+=====================================================+
| id | String | Rule ID | | id | String | Rule ID |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| name | String | Rule name. |
+-----------------------+-----------------------+-----------------------------------------------------+
| policyid | String | Policy ID. | | policyid | String | Policy ID. |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| timestamp | Long | Rule creation time | | timestamp | Long | Rule creation time |
@ -68,7 +64,7 @@ Response Parameters
| | | | | | | |
| | | - 1: The rule is enabled. | | | | - 1: The rule is enabled. |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| addr | String | Blacklisted or whitelisted IP addresses | | addr | String | lacklisted or whitelisted IP addresses |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| white | Integer | Protective action. The value can be: | | white | Integer | Protective action. The value can be: |
| | | | | | | |
@ -78,8 +74,6 @@ Response Parameters
| | | | | | | |
| | | - 2: WAF only logs the requests that hit the rule. | | | | - 2: WAF only logs the requests that hit the rule. |
+-----------------------+-----------------------+-----------------------------------------------------+ +-----------------------+-----------------------+-----------------------------------------------------+
| followed_action_id | String | ID of the known attack source rule. |
+-----------------------+-----------------------+-----------------------------------------------------+
**Status code: 400** **Status code: 400**
@ -124,21 +118,7 @@ Example Requests
Example Responses Example Responses
----------------- -----------------
**Status code: 200** None
Request succeeded.
.. code-block::
{
"id" : "5d43af25404341058d5ab17b7ba78b56",
"policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
"timestamp" : 1650531872900,
"description" : "demo",
"status" : 1,
"addr" : "x.x.x.x",
"white" : 0
}
Status Codes Status Codes
------------ ------------

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