Update content

This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-01-12 15:57:42 +00:00
parent 9bfe4c5594
commit 6096dbcb9a
6 changed files with 247 additions and 247 deletions

View File

@ -141,39 +141,39 @@ Response Parameters
.. table:: **Table 7** Response body parameters .. table:: **Table 7** 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. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. | | url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. |
| | | | | | | |
| | | - Prefix match: A path ending with ``*`` indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin\ ``*``. | | | | - Prefix match: A path ending with \* indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin*. |
| | | | | | | |
| | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. | | | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. | | prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mode | Integer | Mode. | | mode | Integer | Mode. |
| | | | | | | |
| | | - **0**: Standard. | | | | - **0**: Standard. |
| | | | | | | |
| | | - **1**: Advanced | | | | - **1**: Advanced |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | Integer | Rule status. The value can be **0** or **1**. | | status | Integer | Rule status. The value can be **0** or **1**. |
| | | | | | | |
| | | - **0**: The rule is disabled. | | | | - **0**: The rule is disabled. |
| | | | | | | |
| | | - **1**: The rule is enabled. | | | | - **1**: The rule is enabled. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_num | String | Number of requests allowed from a web visitor in a rate limiting period | | limit_num | String | Number of requests allowed from a web visitor in a rate limiting period |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_period | String | Rate limiting period | | limit_period | String | Rate limiting period |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. | | lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tag_type | String | Protection mode. | | tag_type | String | Protection mode. |
| | | | | | | |
| | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. | | | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. |
@ -181,15 +181,15 @@ Response Parameters
| | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. | | | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. |
| | | | | | | |
| | | - other: A website visitor is identified by the Referer field (user-defined request source). | | | | - other: A website visitor is identified by the Referer field (user-defined request source). |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Rule description | | description | String | Rule description |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| action | :ref:`action <createccrule__response_action>` object | Action to take if the number of requests reaches the upper limit. | | action | :ref:`action <createccrule__response_action>` object | Action to take if the number of requests reaches the upper limit. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| conditions | Array of :ref:`conditions <createccrule__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. | | conditions | Array of :ref:`conditions <createccrule__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| timestamp | Long | Timestamp the rule is created. | | timestamp | Long | Timestamp the rule is created. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _createccrule__response_action: .. _createccrule__response_action:

View File

@ -49,33 +49,33 @@ 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. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. | | url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. |
| | | | | | | |
| | | - Prefix match: A path ending with ``*`` indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin\ ``*``. | | | | - Prefix match: A path ending with \* indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin*. |
| | | | | | | |
| | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. | | | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. | | prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mode | Integer | Mode. | | mode | Integer | Mode. |
| | | | | | | |
| | | - **0**: Standard. | | | | - **0**: Standard. |
| | | | | | | |
| | | - **1**: Advanced | | | | - **1**: Advanced |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_num | String | Number of requests allowed from a web visitor in a rate limiting period | | limit_num | String | Number of requests allowed from a web visitor in a rate limiting period |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_period | String | Rate limiting period | | limit_period | String | Rate limiting period |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. | | lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tag_type | String | Protection mode. | | tag_type | String | Protection mode. |
| | | | | | | |
| | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. | | | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. |
@ -83,21 +83,21 @@ Response Parameters
| | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. | | | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. |
| | | | | | | |
| | | - other: A website visitor is identified by the Referer field (user-defined request source). | | | | - other: A website visitor is identified by the Referer field (user-defined request source). |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | Integer | Rule status. The value can be **0** or **1**. | | status | Integer | Rule status. The value can be **0** or **1**. |
| | | | | | | |
| | | - **0**: The rule is disabled. | | | | - **0**: The rule is disabled. |
| | | | | | | |
| | | - **1**: The rule is enabled. | | | | - **1**: The rule is enabled. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Rule description | | description | String | Rule description |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| action | :ref:`action <deleteccrule__response_action>` object | Action to take if the number of requests reaches the upper limit. | | action | :ref:`action <deleteccrule__response_action>` object | Action to take if the number of requests reaches the upper limit. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| conditions | Array of :ref:`conditions <deleteccrule__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. | | conditions | Array of :ref:`conditions <deleteccrule__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| timestamp | Long | Time the rule is created. | | timestamp | Long | Time the rule is created. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _deleteccrule__response_action: .. _deleteccrule__response_action:

View File

@ -49,33 +49,33 @@ 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. |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. | | url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. |
| | | | | | | |
| | | - Prefix match: A path ending with ``*`` indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin\ ``*``. | | | | - Prefix match: A path ending with \* indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin*. |
| | | | | | | |
| | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. | | | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. | | prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mode | Integer | Mode. | | mode | Integer | Mode. |
| | | | | | | |
| | | - **0**: Standard | | | | - **0**: Standard |
| | | | | | | |
| | | - **1**: Advanced | | | | - **1**: Advanced |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_num | String | Number of requests allowed from a web visitor in a rate limiting period | | limit_num | String | Number of requests allowed from a web visitor in a rate limiting period |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_period | String | Rate limiting period | | limit_period | String | Rate limiting period |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. | | lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tag_type | String | Protection mode. | | tag_type | String | Protection mode. |
| | | | | | | |
| | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. | | | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. |
@ -83,21 +83,21 @@ Response Parameters
| | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. | | | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. |
| | | | | | | |
| | | - other: A website visitor is identified by the Referer field (user-defined request source). | | | | - other: A website visitor is identified by the Referer field (user-defined request source). |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | Integer | Rule status. The value can be **0** or **1**. | | status | Integer | Rule status. The value can be **0** or **1**. |
| | | | | | | |
| | | - **0**: The rule is disabled. | | | | - **0**: The rule is disabled. |
| | | | | | | |
| | | - **1**: The rule is enabled. | | | | - **1**: The rule is enabled. |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Rule description | | description | String | Rule description |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| action | :ref:`action <showccrule__response_action>` object | Action to take if the number of requests reaches the upper limit. | | action | :ref:`action <showccrule__response_action>` object | Action to take if the number of requests reaches the upper limit. |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| conditions | Array of :ref:`conditions <showccrule__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. | | conditions | Array of :ref:`conditions <showccrule__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| timestamp | Long | Time the rule is created. | | timestamp | Long | Time the rule is created. |
+-----------------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _showccrule__response_action: .. _showccrule__response_action:

View File

@ -73,33 +73,33 @@ Response Parameters
.. table:: **Table 5** CcrulesListInfo .. table:: **Table 5** CcrulesListInfo
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================================================================+=================================================================================================================================================================================+ +=======================+=======================================================================+========================================================================================================================================================================+
| id | String | Rule ID. | | id | String | Rule ID. |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| policyid | String | Policy ID. | | policyid | String | Policy ID. |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. | | url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. |
| | | | | | | |
| | | - Prefix match: A path ending with ``*`` indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin\ ``*``. | | | | - Prefix match: A path ending with \* indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin*. |
| | | | | | | |
| | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. | | | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. | | prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mode | Integer | Mode. | | mode | Integer | Mode. |
| | | | | | | |
| | | - **0**: Standard. | | | | - **0**: Standard. |
| | | | | | | |
| | | - **1**: Advanced | | | | - **1**: Advanced |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_num | String | Number of requests allowed from a web visitor in a rate limiting period | | limit_num | String | Number of requests allowed from a web visitor in a rate limiting period |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_period | String | Rate limiting period | | limit_period | String | Rate limiting period |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. | | lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tag_type | String | Protection mode. | | tag_type | String | Protection mode. |
| | | | | | | |
| | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. | | | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. |
@ -107,21 +107,21 @@ Response Parameters
| | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. | | | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. |
| | | | | | | |
| | | - **other**: Website visitors are identified by the **Referer** field (user-defined request source). | | | | - **other**: Website visitors are identified by the **Referer** field (user-defined request source). |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | Integer | Rule status. The value can be **0** or **1**. | | status | Integer | Rule status. The value can be **0** or **1**. |
| | | | | | | |
| | | - **0**: The rule is disabled. | | | | - **0**: The rule is disabled. |
| | | | | | | |
| | | - **1**: The rule is enabled. | | | | - **1**: The rule is enabled. |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Rule description | | description | String | Rule description |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| action | :ref:`action <listccrules__response_action>` object | Action to take if the number of requests reaches the upper limit. | | action | :ref:`action <listccrules__response_action>` object | Action to take if the number of requests reaches the upper limit. |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| conditions | Array of :ref:`conditions <listccrules__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. | | conditions | Array of :ref:`conditions <listccrules__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| timestamp | Long | Time the rule is created. | | timestamp | Long | Time the rule is created. |
+-----------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _listccrules__response_action: .. _listccrules__response_action:

View File

@ -141,33 +141,33 @@ Response Parameters
.. table:: **Table 7** Response body parameters .. table:: **Table 7** 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. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. | | url | String | When the value of mode is 0, this parameter has a return value. URL to which the rule applies, excluding a domain name. |
| | | | | | | |
| | | - Prefix match: A path ending with ``*`` indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin\ ``*``. | | | | - Prefix match: A path ending with \* indicates that the path is used as a prefix. For example, to protect /admin/test.php or /adminabc, you can set Path to /admin*. |
| | | | | | | |
| | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. | | | | - Exact match: The path you enter must exactly match the path you want to protect. If the path you want to protect is /admin, set url to /admin. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. | | prefix | Boolean | Whether a prefix is used for the path. If the protected URL ends with an asterisk (``*``), a path prefix is used. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mode | Integer | Mode. | | mode | Integer | Mode. |
| | | | | | | |
| | | - **0**: Standard. | | | | - **0**: Standard. |
| | | | | | | |
| | | - **1**: Advanced | | | | - **1**: Advanced |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_num | String | Number of requests allowed from a web visitor in a rate limiting period | | limit_num | String | Number of requests allowed from a web visitor in a rate limiting period |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit_period | String | Rate limiting period | | limit_period | String | Rate limiting period |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. | | lock_time | String | How long a web visitor will be locked The value range is [0 to 2^32), in seconds. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tag_type | String | Protection mode. | | tag_type | String | Protection mode. |
| | | | | | | |
| | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. | | | | - **ip**: IP-based rate limiting. Website visitors are identified by IP address. |
@ -175,21 +175,21 @@ Response Parameters
| | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. | | | | - **cookie**: User-based rate limiting. Website visitors are identified by the cookie key value. |
| | | | | | | |
| | | - other: A website visitor is identified by the Referer field (user-defined request source). | | | | - other: A website visitor is identified by the Referer field (user-defined request source). |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | Integer | Rule status. The value can be **0** or **1**. | | status | Integer | Rule status. The value can be **0** or **1**. |
| | | | | | | |
| | | - **0**: The rule is disabled. | | | | - **0**: The rule is disabled. |
| | | | | | | |
| | | - **1**: The rule is enabled. | | | | - **1**: The rule is enabled. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Rule description | | description | String | Rule description |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| action | :ref:`action <updateccrule__response_action>` object | Action to take if the number of requests reaches the upper limit. | | action | :ref:`action <updateccrule__response_action>` object | Action to take if the number of requests reaches the upper limit. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| conditions | Array of :ref:`conditions <updateccrule__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. | | conditions | Array of :ref:`conditions <updateccrule__response_conditions>` objects | Condition list. This parameter is returned when mode is set to **1**. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| timestamp | Long | Time the rule is created. | | timestamp | Long | Time the rule is created. |
+-----------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _updateccrule__response_action: .. _updateccrule__response_action:

View File

@ -10,11 +10,11 @@ Character Set Specifications
The key cannot be left blank or be an empty string. The key cannot be left blank or be an empty string.
- In Deutsche Telekom, a tag key can contain uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and sign @. - In Deutsche Telekom, a tag key can contain uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and sign @.
- In other environments, a tag key cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (``*``), left angle brackets (<), right angle brackets (>), backslashes (\\), commas (,), vertical bars (|), and slashes (/). - In other environments, a tag key cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\\), commas (,), vertical bars (|), and slashes (/).
- Character Set Specifications for Value - Character Set Specifications for Value
The value cannot be left blank but can be an empty string. The value cannot be left blank but can be an empty string.
- In Deutsche Telekom, a tag value can contain uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). - In Deutsche Telekom, a tag value can contain uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_).
- In other environments, a tag value cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (``*``), left angle brackets (<), right angle brackets (>), backslashes (\\), commas (,), vertical bars (|), and slashes (/). - In other environments, a tag value cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\\), commas (,), vertical bars (|), and slashes (/).