From a4b8e93e031f4fe7f5a2ec6f8f86bc8a12f4c751 Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Mon, 5 Jun 2023 09:01:30 +0000 Subject: [PATCH] Update content --- .../adding_a_protected_domain_name.rst | 4 +- ...ain_name_from_a_dedicated_waf_instance.rst | 2 - ..._protected_by_a_dedicated_waf_instance.rst | 180 +++++++++++------- ...mes_protected_by_dedicated_waf_engines.rst | 2 - ...creating_a_blacklist_or_whitelist_rule.rst | 2 +- ...ting_a_geolocation_access_control_rule.rst | 8 +- ...ting_a_geolocation_access_control_rule.rst | 6 +- ...eleting_a_javascript_anti-crawler_rule.rst | 2 +- .../deleting_a_reference_table.rst | 16 +- api-ref/source/apis/rule_management/index.rst | 4 +- .../modifying_a_reference_table.rst | 16 +- ..._geolocation_access_control_rule_by_id.rst | 6 +- ...uerying_a_javascript_anti-crawler_rule.rst | 2 +- ..._id.rst => querying_a_reference_table.rst} | 22 +-- ..._the_javascript_anti-crawler_rule_list.rst | 2 +- ...st_of_geolocation_access_control_rules.rst | 4 +- ...ting_a_geolocation_access_control_rule.rst | 8 +- api-ref/source/change_history.rst | 2 + 18 files changed, 171 insertions(+), 117 deletions(-) rename api-ref/source/apis/rule_management/{querying_a_reference_table_by_id.rst => querying_a_reference_table.rst} (87%) diff --git a/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/adding_a_protected_domain_name.rst b/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/adding_a_protected_domain_name.rst index 4850311..d03c417 100644 --- a/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/adding_a_protected_domain_name.rst +++ b/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/adding_a_protected_domain_name.rst @@ -134,8 +134,6 @@ Response Parameters +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protect_status | Integer | WAF status of the protected domain name. | | | | | - | | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. | - | | | | | | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. -1: Enabled. WAF detects attacks based on the configured policy. | +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | access_status | Integer | Whether a domain name is connected to WAF. | @@ -326,7 +324,7 @@ Example Requests .. code-block:: text - POST https://{Endpoint}/v1/{project_id}/premium-waf/host?enterprise_project_id=0 + POST https://{Endpoint}/v1/{project_id}/premium-waf/host? { "hostname" : "www.demo.com", diff --git a/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/deleting_a_domain_name_from_a_dedicated_waf_instance.rst b/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/deleting_a_domain_name_from_a_dedicated_waf_instance.rst index 6cc2e49..df5f426 100644 --- a/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/deleting_a_domain_name_from_a_dedicated_waf_instance.rst +++ b/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/deleting_a_domain_name_from_a_dedicated_waf_instance.rst @@ -68,8 +68,6 @@ Response Parameters +-----------------------+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ | protect_status | Integer | WAF status of the protected domain name. The value can be: | | | | | - | | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. | - | | | | | | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. | | | | | | | | - 1: Enabled. WAF detects attacks based on the configured policy. | diff --git a/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/modifying_a_domain_name_protected_by_a_dedicated_waf_instance.rst b/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/modifying_a_domain_name_protected_by_a_dedicated_waf_instance.rst index c6330b3..076fd5a 100644 --- a/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/modifying_a_domain_name_protected_by_a_dedicated_waf_instance.rst +++ b/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/modifying_a_domain_name_protected_by_a_dedicated_waf_instance.rst @@ -42,57 +42,103 @@ Request Parameters .. table:: **Table 3** Request body parameters - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==========================================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================+ - | proxy | No | Boolean | Whether a proxy is used for the domain name. If your website has no layer-7 proxy server such as CDN and cloud acceleration service deployed in front of WAF and uses only layer-4 load balancers (or NAT), set Proxy Configured to No. Otherwise, Proxy Configured must be set to Yes. This ensures that WAF obtains real IP addresses of website visitors and takes protective actions configured in protection policies. | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | certificateid | No | String | HTTPS certificate ID. It can be obtained by calling the ListCertificates API. | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | certificatename | No | String | HTTPS certificate name. It can be obtained by calling the ListCertificates API. Certifacteid and certificatename are required at the same. If certificateid does not match certificatename, an error is reported. | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tls | No | String | Minimum TLS version supported. | - | | | | | - | | | | - TLS v1.0 is used by default. | - | | | | | - | | | | - The value can be:TLS v1.0TLS v1.1TLS v1.2TLS v1.3 | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cipher | No | String | Cipher suite. The value can be: | - | | | | | - | | | | - cipher_1: ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH | - | | | | | - | | | | - cipher_2: EECDH+AESGCM:EDH+AESGCM | - | | | | | - | | | | - cipher_3: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH | - | | | | | - | | | | - cipher_4. ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH | - | | | | | - | | | | - cipher_default: ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protect_status | No | Integer | WAF status of the protected domain name. | - | | | | | - | | | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. | - | | | | | - | | | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. -1: Enabled. WAF detects attacks based on the configured policy. | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | block_page | No | :ref:`BlockPage ` object | Alarm configuration page | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flag | No | :ref:`Flag ` object | Feature switch for configuring compliance certification checks for domain names protected with the dedicated WAF instance. | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | traffic_mark | No | :ref:`TrafficMark ` object | Traffic identifier | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | circuit_breaker | No | :ref:`CircuitBreaker ` object | Circuit breaker configuration | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | timeout_config | No | :ref:`TimeoutConfig ` object | Timeout settings | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | web_tag | No | String | website name | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | website remarks | - +-----------------+-----------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+========================================================================================+=============================================================================================================================================================================================================================================================================================================================================================================================================================+ + | proxy | No | Boolean | Whether a proxy is used for the domain name. If your website has no layer-7 proxy server such as CDN and cloud acceleration service deployed in front of WAF and uses only layer-4 load balancers (or NAT), set Proxy Configured to No. Otherwise, Proxy Configured must be set to Yes. This ensures that WAF obtains real IP addresses of website visitors and takes protective actions configured in protection policies. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | certificateid | No | String | HTTPS certificate ID. It can be obtained by calling the ListCertificates API. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | certificatename | No | String | HTTPS certificate name. It can be obtained by calling the ListCertificates API. Certifacteid and certificatename are required at the same. If certificateid does not match certificatename, an error is reported. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tls | No | String | Minimum TLS version supported. | + | | | | | + | | | | - TLS v1.0 is used by default. | + | | | | | + | | | | - The value can be:TLS v1.0TLS v1.1TLS v1.2TLS v1.3 | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cipher | No | String | Cipher suite. The value can be: | + | | | | | + | | | | - cipher_1: ECDHE-ECDSA-AES256-GCM-SHA384:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!DES:!MD5:!PSK:!RC4:!kRSA:!SRP:!3DES:!DSS:!EXP:!CAMELLIA:@STRENGTH | + | | | | | + | | | | - cipher_2: EECDH+AESGCM:EDH+AESGCM | + | | | | | + | | | | - cipher_3: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH | + | | | | | + | | | | - cipher_4. ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!EDH | + | | | | | + | | | | - cipher_default: ECDHE-RSA-AES256-SHA384:AES256-SHA256:RC4:HIGH:!MD5:!aNULL:!eNULL:!NULL:!DH:!EDH:!AESGCM | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protect_status | No | Integer | WAF status of the protected domain name. | + | | | | | + | | | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. | + | | | | | + | | | | - 1: Enabled. WAF detects attacks based on the configured policy. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | server | No | Array of :ref:`PremiumWafServer ` objects | Server configuration in dedicated mode | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | block_page | No | :ref:`BlockPage ` object | Alarm configuration page | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flag | No | :ref:`Flag ` object | Feature switch for configuring compliance certification checks for domain names protected with the dedicated WAF instance. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | traffic_mark | No | :ref:`TrafficMark ` object | Traffic identifier | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | circuit_breaker | No | :ref:`CircuitBreaker ` object | Circuit breaker configuration | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | timeout_config | No | :ref:`TimeoutConfig ` object | Timeout settings | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | web_tag | No | String | website name | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | website remarks | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _updatepremiumhost__request_premiumwafserver: + +.. table:: **Table 4** PremiumWafServer + + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+============================================================================================================================================================================================================+ + | front_protocol | Yes | String | Client protocol | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **HTTP** | + | | | | | + | | | | - **HTTPS** | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | back_protocol | Yes | String | Server protocol | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **HTTP** | + | | | | | + | | | | - **HTTPS** | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | Yes | String | IP address or domain name of the origin server that the client accesses. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port | Yes | Integer | Server port | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | Yes | String | The origin server address is an IPv4 or IPv6 address. Default value: ipv4 | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **ipv4** | + | | | | | + | | | | - **ipv6** | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | VPC ID. Perform the following steps to obtain the VPC ID: | + | | | | | + | | | | - 1.Find the name of the VPC where the dedicated engine is located. The VPC name is in the VPC\\Subnet column. Log in to the WAF console and choose Instance Management > Dedicated Engine > VPC\\Subnet. | + | | | | | + | | | | - Log in to the VPC console and click the VPC name. On the page displayed, copy the VPC ID in the VPC Information area. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | weight | No | Integer | This parameter is reserved and can be ignored currently. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updatepremiumhost__request_blockpage: -.. table:: **Table 4** BlockPage +.. table:: **Table 5** BlockPage +-----------------+-----------------+------------------------------------------------------------------+-------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -112,7 +158,7 @@ Request Parameters .. _updatepremiumhost__request_custompage: -.. table:: **Table 5** CustomPage +.. table:: **Table 6** CustomPage ============ ========= ====== ========================== Parameter Mandatory Type Description @@ -124,7 +170,7 @@ Request Parameters .. _updatepremiumhost__request_flag: -.. table:: **Table 6** Flag +.. table:: **Table 7** Flag +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -156,7 +202,7 @@ Request Parameters .. _updatepremiumhost__request_trafficmark: -.. table:: **Table 7** TrafficMark +.. table:: **Table 8** TrafficMark +-----------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -170,7 +216,7 @@ Request Parameters .. _updatepremiumhost__request_circuitbreaker: -.. table:: **Table 8** CircuitBreaker +.. table:: **Table 9** CircuitBreaker +-------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -196,7 +242,7 @@ Request Parameters .. _updatepremiumhost__request_timeoutconfig: -.. table:: **Table 9** TimeoutConfig +.. table:: **Table 10** TimeoutConfig +-----------------+-----------+---------+--------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -213,7 +259,7 @@ Response Parameters **Status code: 200** -.. table:: **Table 10** Response body parameters +.. table:: **Table 11** Response body parameters +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -276,8 +322,6 @@ Response Parameters +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+ | protect_status | Integer | WAF status of the protected domain name. The value can be: | | | | | - | | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. | - | | | | | | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. | | | | | | | | - 1: Enabled. WAF detects attacks based on the configured policy. | @@ -311,7 +355,7 @@ Response Parameters .. _updatepremiumhost__response_premiumwafserver: -.. table:: **Table 11** PremiumWafServer +.. table:: **Table 12** PremiumWafServer +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -355,7 +399,7 @@ Response Parameters .. _updatepremiumhost__response_access_progress: -.. table:: **Table 12** Access_progress +.. table:: **Table 13** Access_progress +-----------------------+-----------------------+-------------------------------------------+ | Parameter | Type | Description | @@ -377,7 +421,7 @@ Response Parameters .. _updatepremiumhost__response_flag: -.. table:: **Table 13** Flag +.. table:: **Table 14** Flag +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -409,7 +453,7 @@ Response Parameters .. _updatepremiumhost__response_blockpage: -.. table:: **Table 14** BlockPage +.. table:: **Table 15** BlockPage +-----------------------+-------------------------------------------------------------------+-------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -429,7 +473,7 @@ Response Parameters .. _updatepremiumhost__response_custompage: -.. table:: **Table 15** CustomPage +.. table:: **Table 16** CustomPage ============ ====== ========================== Parameter Type Description @@ -441,7 +485,7 @@ Response Parameters .. _updatepremiumhost__response_extend: -.. table:: **Table 16** Extend +.. table:: **Table 17** Extend ========= ====== =============================== Parameter Type Description @@ -452,7 +496,7 @@ Response Parameters .. _updatepremiumhost__response_trafficmark: -.. table:: **Table 17** TrafficMark +.. table:: **Table 18** TrafficMark +-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -466,7 +510,7 @@ Response Parameters .. _updatepremiumhost__response_circuitbreaker: -.. table:: **Table 18** CircuitBreaker +.. table:: **Table 19** CircuitBreaker +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -492,7 +536,7 @@ Response Parameters .. _updatepremiumhost__response_timeoutconfig: -.. table:: **Table 19** TimeoutConfig +.. table:: **Table 20** TimeoutConfig +-----------------+---------+--------------------------------------------------------------+ | Parameter | Type | Description | @@ -506,7 +550,7 @@ Response Parameters **Status code: 400** -.. table:: **Table 20** Response body parameters +.. table:: **Table 21** Response body parameters ========== ====== ============= Parameter Type Description @@ -517,7 +561,7 @@ Response Parameters **Status code: 401** -.. table:: **Table 21** Response body parameters +.. table:: **Table 22** Response body parameters ========== ====== ============= Parameter Type Description @@ -528,7 +572,7 @@ Response Parameters **Status code: 500** -.. table:: **Table 22** Response body parameters +.. table:: **Table 23** Response body parameters ========== ====== ============= Parameter Type Description diff --git a/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/querying_domain_names_protected_by_dedicated_waf_engines.rst b/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/querying_domain_names_protected_by_dedicated_waf_engines.rst index fb9a809..42e19cf 100644 --- a/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/querying_domain_names_protected_by_dedicated_waf_engines.rst +++ b/api-ref/source/apis/managing_websites_protected_in_dedicated_mode/querying_domain_names_protected_by_dedicated_waf_engines.rst @@ -94,8 +94,6 @@ Response Parameters +-----------------------+---------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protect_status | Integer | WAF status of the protected domain name. The value can be: | | | | | - | | | - -1: Bypassed. Requests are directly sent to the backend servers without passing through WAF. | - | | | | | | | - 0: Suspended. WAF only forwards requests for the domain name but does not detect attacks. | | | | | | | | - 1: Enabled. WAF detects attacks based on the configured policy. | diff --git a/api-ref/source/apis/rule_management/creating_a_blacklist_or_whitelist_rule.rst b/api-ref/source/apis/rule_management/creating_a_blacklist_or_whitelist_rule.rst index 63d5814..bcf2e54 100644 --- a/api-ref/source/apis/rule_management/creating_a_blacklist_or_whitelist_rule.rst +++ b/api-ref/source/apis/rule_management/creating_a_blacklist_or_whitelist_rule.rst @@ -45,7 +45,7 @@ Request Parameters +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +====================+=================+=================+============================================================================================================================================================================================================+ - | name | No | String | Rule name. | + | name | Yes | String | Rule name. | +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | No | String | Rule description. | +--------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/rule_management/creating_a_geolocation_access_control_rule.rst b/api-ref/source/apis/rule_management/creating_a_geolocation_access_control_rule.rst index 7c0d002..b69b687 100644 --- a/api-ref/source/apis/rule_management/creating_a_geolocation_access_control_rule.rst +++ b/api-ref/source/apis/rule_management/creating_a_geolocation_access_control_rule.rst @@ -73,7 +73,9 @@ Request Parameters | | | | | | | | | - Israel: Israel | | | | | | - | | | | - Iraq: Afghanistan | + | | | | - Iraq: Iraq | + | | | | | + | | | | - Afghanistan: Afghanistan | | | | | | | | | | - Libya: Libya | | | | | | @@ -150,7 +152,9 @@ Response Parameters | | | | | | | - Israel: Israel | | | | | - | | | - Iraq: Afghanistan | + | | | - Iraq: Iraq | + | | | | + | | | - Afghanistan: Afghanistan | | | | | | | | - Libya: Libya | | | | | diff --git a/api-ref/source/apis/rule_management/deleting_a_geolocation_access_control_rule.rst b/api-ref/source/apis/rule_management/deleting_a_geolocation_access_control_rule.rst index 1034e6e..859d6fc 100644 --- a/api-ref/source/apis/rule_management/deleting_a_geolocation_access_control_rule.rst +++ b/api-ref/source/apis/rule_management/deleting_a_geolocation_access_control_rule.rst @@ -88,7 +88,9 @@ Response Parameters | | | | | | | - Israel: Israel | | | | | - | | | - Iraq: Afghanistan | + | | | - Iraq: Iraq | + | | | | + | | | - Afghanistan: Afghanistan | | | | | | | | - Libya: Libya | | | | | @@ -163,7 +165,7 @@ Example Requests .. code-block:: text - DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?enterprise_project_id=0 + DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}? Example Responses ----------------- diff --git a/api-ref/source/apis/rule_management/deleting_a_javascript_anti-crawler_rule.rst b/api-ref/source/apis/rule_management/deleting_a_javascript_anti-crawler_rule.rst index 9734c6c..7034cbb 100644 --- a/api-ref/source/apis/rule_management/deleting_a_javascript_anti-crawler_rule.rst +++ b/api-ref/source/apis/rule_management/deleting_a_javascript_anti-crawler_rule.rst @@ -45,7 +45,7 @@ Request Parameters +=================+=================+=================+==============================================================================================================+ | 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). | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ - | Content-Type | Yes | String | Content type. | + | Content-Type | No | String | Content type. | | | | | | | | | | Default: **application/json;charset=utf8** | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/rule_management/deleting_a_reference_table.rst b/api-ref/source/apis/rule_management/deleting_a_reference_table.rst index 1313f07..1192eef 100644 --- a/api-ref/source/apis/rule_management/deleting_a_reference_table.rst +++ b/api-ref/source/apis/rule_management/deleting_a_reference_table.rst @@ -13,17 +13,17 @@ This API is used to delete a reference table. URI --- -DELETE /v1/{project_id}/waf/valuelist/{table_id} +DELETE /v1/{project_id}/waf/valuelist/{valuelist_id} .. table:: **Table 1** Path Parameters - +------------+-----------+--------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================+ - | 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 | - +------------+-----------+--------+---------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=======================================================================================+ + | project_id | Yes | String | Project ID | + +--------------+-----------+--------+---------------------------------------------------------------------------------------+ + | valuelist_id | Yes | String | Valuelist ID. It can be obtained by calling the API Querying the Reference Table List | + +--------------+-----------+--------+---------------------------------------------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/apis/rule_management/index.rst b/api-ref/source/apis/rule_management/index.rst index 3e4bffa..ce23401 100644 --- a/api-ref/source/apis/rule_management/index.rst +++ b/api-ref/source/apis/rule_management/index.rst @@ -58,7 +58,7 @@ Rule Management - :ref:`Deleting a Geolocation Access Control Rule ` - :ref:`Querying the Reference Table List ` - :ref:`Creating a Reference Table ` -- :ref:`Querying a Reference Table by ID ` +- :ref:`Querying a Reference Table ` - :ref:`Modifying a Reference Table ` - :ref:`Deleting a Reference Table ` @@ -119,6 +119,6 @@ Rule Management deleting_a_geolocation_access_control_rule querying_the_reference_table_list creating_a_reference_table - querying_a_reference_table_by_id + querying_a_reference_table modifying_a_reference_table deleting_a_reference_table diff --git a/api-ref/source/apis/rule_management/modifying_a_reference_table.rst b/api-ref/source/apis/rule_management/modifying_a_reference_table.rst index 6cecaa8..336f170 100644 --- a/api-ref/source/apis/rule_management/modifying_a_reference_table.rst +++ b/api-ref/source/apis/rule_management/modifying_a_reference_table.rst @@ -13,17 +13,17 @@ This API is used to modify a reference table. URI --- -PUT /v1/{project_id}/waf/valuelist/{table_id} +PUT /v1/{project_id}/waf/valuelist/{valuelist_id} .. table:: **Table 1** Path Parameters - +------------+-----------+--------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================+ - | 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 | - +------------+-----------+--------+---------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=======================================================================================+ + | project_id | Yes | String | Project ID | + +--------------+-----------+--------+---------------------------------------------------------------------------------------+ + | valuelist_id | Yes | String | Valuelist ID. It can be obtained by calling the API Querying the Reference Table List | + +--------------+-----------+--------+---------------------------------------------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/apis/rule_management/querying_a_geolocation_access_control_rule_by_id.rst b/api-ref/source/apis/rule_management/querying_a_geolocation_access_control_rule_by_id.rst index cf7a972..c67be72 100644 --- a/api-ref/source/apis/rule_management/querying_a_geolocation_access_control_rule_by_id.rst +++ b/api-ref/source/apis/rule_management/querying_a_geolocation_access_control_rule_by_id.rst @@ -37,7 +37,7 @@ Request Parameters +=================+=================+=================+============================================+ | X-Auth-Token | Yes | String | User token | +-----------------+-----------------+-----------------+--------------------------------------------+ - | Content-Type | Yes | String | Content type | + | Content-Type | No | String | Content type | | | | | | | | | | Default: **application/json;charset=utf8** | +-----------------+-----------------+-----------------+--------------------------------------------+ @@ -88,7 +88,9 @@ Response Parameters | | | | | | | - Israel: Israel | | | | | - | | | - Iraq: Afghanistan | + | | | - Iraq: Iraq | + | | | | + | | | - Afghanistan: Afghanistan | | | | | | | | - Libya: Libya | | | | | diff --git a/api-ref/source/apis/rule_management/querying_a_javascript_anti-crawler_rule.rst b/api-ref/source/apis/rule_management/querying_a_javascript_anti-crawler_rule.rst index 025832f..de1faa2 100644 --- a/api-ref/source/apis/rule_management/querying_a_javascript_anti-crawler_rule.rst +++ b/api-ref/source/apis/rule_management/querying_a_javascript_anti-crawler_rule.rst @@ -45,7 +45,7 @@ Request Parameters +=================+=================+=================+==============================================================================================================+ | 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). | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ - | Content-Type | Yes | String | Content type. | + | Content-Type | No | String | Content type. | | | | | | | | | | Default: **application/json;charset=utf8** | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/rule_management/querying_a_reference_table_by_id.rst b/api-ref/source/apis/rule_management/querying_a_reference_table.rst similarity index 87% rename from api-ref/source/apis/rule_management/querying_a_reference_table_by_id.rst rename to api-ref/source/apis/rule_management/querying_a_reference_table.rst index 6d0bad6..80a43f3 100644 --- a/api-ref/source/apis/rule_management/querying_a_reference_table_by_id.rst +++ b/api-ref/source/apis/rule_management/querying_a_reference_table.rst @@ -2,28 +2,28 @@ .. _ShowValueList: -Querying a Reference Table by ID -================================ +Querying a Reference Table +========================== Function -------- -This API is used to query a reference table by ID. +This API is used to query a reference table. URI --- -GET /v1/{project_id}/waf/valuelist/{table_id} +GET /v1/{project_id}/waf/valuelist/{valuelist_id} .. table:: **Table 1** Path Parameters - +------------+-----------+--------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================+ - | 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 | - +------------+-----------+--------+---------------------------------------------------------------------------------------------+ + +--------------+-----------+--------+---------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+========+=======================================================================================+ + | project_id | Yes | String | Project ID | + +--------------+-----------+--------+---------------------------------------------------------------------------------------+ + | valuelist_id | Yes | String | Valuelist ID. It can be obtained by calling the API Querying the Reference Table List | + +--------------+-----------+--------+---------------------------------------------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/apis/rule_management/querying_the_javascript_anti-crawler_rule_list.rst b/api-ref/source/apis/rule_management/querying_the_javascript_anti-crawler_rule_list.rst index 2a96f31..c8a0de8 100644 --- a/api-ref/source/apis/rule_management/querying_the_javascript_anti-crawler_rule_list.rst +++ b/api-ref/source/apis/rule_management/querying_the_javascript_anti-crawler_rule_list.rst @@ -53,7 +53,7 @@ Request Parameters +=================+=================+=================+==============================================================================================================+ | 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). | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ - | Content-Type | Yes | String | Content type. | + | Content-Type | No | String | Content type. | | | | | | | | | | Default: **application/json;charset=utf8** | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/rule_management/querying_the_list_of_geolocation_access_control_rules.rst b/api-ref/source/apis/rule_management/querying_the_list_of_geolocation_access_control_rules.rst index 2071608..6d04857 100644 --- a/api-ref/source/apis/rule_management/querying_the_list_of_geolocation_access_control_rules.rst +++ b/api-ref/source/apis/rule_management/querying_the_list_of_geolocation_access_control_rules.rst @@ -112,7 +112,9 @@ Response Parameters | | | | | | | - Israel: Israel | | | | | - | | | - Iraq: Afghanistan | + | | | - Iraq: Iraq | + | | | | + | | | - Afghanistan: Afghanistan | | | | | | | | - Libya: Libya | | | | | diff --git a/api-ref/source/apis/rule_management/updating_a_geolocation_access_control_rule.rst b/api-ref/source/apis/rule_management/updating_a_geolocation_access_control_rule.rst index fca3aff..f6feabb 100644 --- a/api-ref/source/apis/rule_management/updating_a_geolocation_access_control_rule.rst +++ b/api-ref/source/apis/rule_management/updating_a_geolocation_access_control_rule.rst @@ -75,7 +75,9 @@ Request Parameters | | | | | | | | | - Israel: Israel | | | | | | - | | | | - Iraq: Afghanistan | + | | | | - Iraq: Iraq | + | | | | | + | | | | - Afghanistan: Afghanistan | | | | | | | | | | - Libya: Libya | | | | | | @@ -152,7 +154,9 @@ Response Parameters | | | | | | | - Israel: Israel | | | | | - | | | - Iraq: Afghanistan | + | | | - Iraq: Iraq | + | | | | + | | | - Afghanistan: Afghanistan | | | | | | | | - Libya: Libya | | | | | diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 6e70577..7d69923 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,8 @@ Change History +-----------------------------------+----------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+====================================================================================================+ +| 2023-04-23 | Revised the document based on review comments. | ++-----------------------------------+----------------------------------------------------------------------------------------------------+ | 2023-03-30 | - Added "Geographical Location Codes." | | | - Revised the document based on review comments. | +-----------------------------------+----------------------------------------------------------------------------------------------------+