diff --git a/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst b/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst index eecfeda..6e39396 100644 --- a/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst +++ b/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst @@ -56,9 +56,7 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | - | | | | | | | | | - **2** | +-----------------+-----------------+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | rules | Yes | Array of :ref:`rules ` objects | rules | @@ -68,67 +66,66 @@ Request Parameters .. table:: **Table 5** rules - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=====================================================================+=================================================================================================================================+ - | name | Yes | String | Rule name | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | sequence | Yes | :ref:`OrderRuleAclDto ` object | Rule sequence | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Yes | Integer | Address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - | | | | | - | | | | - **2** | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | action_type | Yes | Integer | Action. 0: allow; 1: deny | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | status | Yes | Integer | Rule delivery status. 0: disabled; 1: enabled. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time | No | Long | Persistent connection duration | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_hour | No | Long | Persistent connection duration (hour) | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_minute | No | Long | Persistent connection duration (minute) | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_second | No | Long | Persistent Connection Duration (second) | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_enable | Yes | Integer | Whether to support persistent connections. 0: not supported; 1: supported. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | Integer | Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | source | Yes | :ref:`RuleAddressDto ` object | Source address transmission object | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | destination | Yes | :ref:`RuleAddressDto ` object | Destination address transmission object | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service | Yes | :ref:`RuleServiceDto ` object | Service object | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | tag | No | :ref:`TagsVO ` object | Tag value | - +--------------------------+-----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==========================+=================+=======================================================================================+=================================================================================================================================+ + | name | Yes | String | Rule name | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | sequence | Yes | :ref:`OrderRuleAclDto ` object | Rule sequence | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Yes | Integer | Address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain). | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | - **1** | + | | | | - **2** | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | action_type | Yes | Integer | Action. 0: allow; 1: deny | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | status | Yes | Integer | Rule delivery status. 0: disabled; 1: enabled. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | - **1** | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | applications | No | Array of strings | applications | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | applicationsJsonString | No | String | applications json string | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time | No | Long | Persistent connection duration | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_hour | No | Long | Persistent connection duration (hour) | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_minute | No | Long | Persistent connection duration (minute) | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_second | No | Long | Persistent Connection Duration (second) | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_enable | Yes | Integer | Whether to support persistent connections. 0: not supported; 1: supported. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | - **1** | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Description | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | direction | No | Integer | Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | - **1** | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | source | Yes | :ref:`RuleAddressDtoForRequest ` object | Source address transmission object | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | destination | Yes | :ref:`RuleAddressDtoForRequest ` object | Destination address transmission object | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | service | Yes | :ref:`RuleServiceDto ` object | Service object | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | tag | No | :ref:`TagsVO ` object | Tag value | + +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_orderruleacldto: @@ -141,40 +138,42 @@ Request Parameters +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | top | No | Integer | Whether to pin on top. The options are as follows: 0: no; 1: yes. | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0: no; 1: yes. | + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _addaclrule__request_ruleaddressdto: +.. _addaclrule__request_ruleaddressdtoforrequest: -.. table:: **Table 7** RuleAddressDto +.. table:: **Table 7** RuleAddressDtoForRequest - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+=============================================================================+===============================================================================================================================================+ - | type | Yes | Integer | Source type. 0: manual input; 1: associated IP address group; 2: domain name | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Source type. 0: IPv4; 1: IPv6 | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address | No | String | Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_id | No | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_name | No | String | IP address group name | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_address_name | No | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list_json | No | String | JSON value of the rule region list. | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list | No | Array of :ref:`IpRegionDto ` objects | Region list of a rule | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_id | No | String | domain set id | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_name | No | String | domain set name | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | Array of strings | IP address list | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group | No | Array of strings | address group | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group_names | No | Array of :ref:`AddressGroupVO ` objects | Address set list | - +---------------------+-----------+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=====================+===========+=======================================================================+====================================================================================================================================================================================================================+ + | type | Yes | Integer | Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Source type. 0: IPv4; 1: IPv6 | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | No | String | Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_id | No | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_name | No | String | IP address group name | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_address_name | No | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list_json | No | String | JSON value of the rule region list. | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list | No | Array of :ref:`IpRegionDto ` objects | Region list of a rule | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_id | No | String | domain set id | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_name | No | String | domain set name | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | No | Array of strings | IP address list | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | predefined_group | No | Array of strings | predefined group | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_ipregiondto: @@ -203,6 +202,8 @@ Request Parameters +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | No | Array of integers | Protocols | + +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | source_port | No | String | Source port | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dest_port | No | String | Destination port | @@ -213,9 +214,13 @@ Request Parameters +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | custom_service | No | Array of :ref:`ServiceItem ` objects | custom service | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | predefined_group | No | Array of strings | predefined group | + +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | service_group | No | Array of strings | Service group list | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group_names | No | Array of :ref:`AddressGroupVO ` objects | Service group name list | + | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | Service group name list | + +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | No | Integer | Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_serviceitem: @@ -236,16 +241,21 @@ Request Parameters | name | No | String | name | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _addaclrule__request_addressgroupvo: +.. _addaclrule__request_servicegroupvo: -.. table:: **Table 11** AddressGroupVO +.. table:: **Table 11** ServiceGroupVO - ========= ========= ====== =========== - Parameter Mandatory Type Description - ========= ========= ====== =========== - set_id No String set id - name No String name - ========= ========= ====== =========== + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+===================+===========================================================================================+ + | name | No | String | service group name | + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + | protocols | No | Array of integers | protocols | + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + | service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + | set_id | No | String | service set id | + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ .. _addaclrule__request_tagsvo: diff --git a/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst b/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst index 7b4130b..dcd749e 100644 --- a/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst +++ b/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst @@ -41,7 +41,7 @@ Request Parameters +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | + | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 4** Request body parameters diff --git a/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst b/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst index 612242b..04b3520 100644 --- a/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst +++ b/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst @@ -35,23 +35,9 @@ GET /v1/{project_id}/acl-rules | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | - | | | | | | | | | - **2** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | Integer | Protocol type. The value is 6 for TCP, 17 for UDP, 1 for ICMP, 58 for ICMPv6, and -1 for any protocol. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **6** | - | | | | | - | | | | - **17** | - | | | | | - | | | | - **1** | - | | | | | - | | | | - **58** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip | No | String | IP address | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | No | String | Name | @@ -63,7 +49,6 @@ GET /v1/{project_id}/acl-rules | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | action_type | No | Integer | Action. 0: allow; 1: deny | @@ -71,17 +56,14 @@ GET /v1/{project_id}/acl-rules | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain). | + | address_type | No | Integer | Address type. The value can be 0 (IPv4). | | | | | | | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | - | | | | | | | | | - **2** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | @@ -100,6 +82,8 @@ GET /v1/{project_id}/acl-rules +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | service | No | String | service port | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | application | No | String | application | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -147,113 +131,98 @@ Response Parameters .. table:: **Table 6** records - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+========================================================================+=================================================================================================================================+ - | rule_id | String | Rule ID | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Rule name | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | sequence | :ref:`OrderRuleAclDto ` object | UpdateRuleAclDto | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | direction | Integer | Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat. | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1end_time** | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | action_type | Integer | Action. 0: allow; 1: deny | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Rule delivery status. 0: disabled; 1: enabled. | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_hour | Long | Persistent connection duration (hour) | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_minute | Long | Persistent connection duration (hour) | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_second | Long | Persistent connection duration (hour) | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time | Long | Persistent connection duration | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_enable | Integer | Persistent connection support | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | source | :ref:`RuleAddressDto ` object | Source address transmission object | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | destination | :ref:`RuleAddressDto ` object | destination | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service | :ref:`RuleServiceDto ` object | service | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule). | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - | | | | - | | | - **2** | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | created_date | String | Created time | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | last_open_time | String | Last open time | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | tag | :ref:`TagsVO ` object | tag | - +--------------------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==========================+============================================================================================+=================================================================================================================================+ + | rule_id | String | Rule ID | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Rule name | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | direction | Integer | Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **0** | + | | | - **1end_time** | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | action_type | Integer | Action. 0: allow; 1: deny | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | status | Integer | Rule delivery status. 0: disabled; 1: enabled. | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Description | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time | Long | Persistent connection duration | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_enable | Integer | Persistent connection support | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_hour | Long | Persistent connection duration (hour) | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_minute | Long | Persistent connection duration (hour) | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_second | Long | Persistent connection duration (hour) | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | source | :ref:`RuleAddressDtoForResponse ` object | Source address transmission object | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | destination | :ref:`RuleAddressDtoForResponse ` object | destination | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | service | :ref:`RuleServiceDtoForResponse ` object | service | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | type | Integer | Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule). | + | | | | + | | | Enumeration values: | + | | | | + | | | - **0** | + | | | - **1** | + | | | - **2** | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | created_date | String | Created time | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | last_open_time | String | Last open time | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | tag | :ref:`TagsVO ` object | tag | + +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ -.. _listaclrules__response_orderruleacldto: +.. _listaclrules__response_ruleaddressdtoforresponse: -.. table:: **Table 7** OrderRuleAclDto +.. table:: **Table 7** RuleAddressDtoForResponse - +--------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+=========+==========================================================================================================================================================================+ - | dest_rule_id | String | ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top. | - +--------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | top | Integer | Whether to pin on top. The options are as follows: 0: no; 1: yes. | - +--------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listaclrules__response_ruleaddressdto: - -.. table:: **Table 8** RuleAddressDto - - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+================================================================================+===============================================================================================================================================+ - | type | Integer | Source type. 0: manual input; 1: associated IP address group; 2: domain name | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | Source type. 0: IPv4; 1: IPv6 | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address | String | Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_id | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_name | String | IP address group name | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_address_name | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list_json | String | JSON value of the rule region list. | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list | Array of :ref:`IpRegionDto ` objects | Region list of a rule | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_id | String | domain set id | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_name | String | domain set name | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | Array of strings | IP address list | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group | Array of strings | address group | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group_names | Array of :ref:`AddressGroupVO ` objects | Address set list | - +---------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+================================================================================+====================================================================================================================================================================================================================+ + | type | Integer | Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Integer | Source type. 0: IPv4; 1: IPv6 | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | String | Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_id | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_name | String | IP address group name | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_address_name | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list_json | String | JSON value of the rule region list. | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list | Array of :ref:`IpRegionDto ` objects | Region list of a rule | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_id | String | domain set id | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_name | String | domain set name | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | Array of strings | IP address list | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group | Array of strings | address group | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group_names | Array of :ref:`AddressGroupVO ` objects | Address set list | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | + +---------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_ipregiondto: -.. table:: **Table 9** IpRegionDto +.. table:: **Table 8** IpRegionDto +----------------+---------+-------------------------------------------------------------------+ | Parameter | Type | Description | @@ -267,9 +236,23 @@ Response Parameters | region_type | Integer | Region type, 0 means country, 1 means province, 2 means continent | +----------------+---------+-------------------------------------------------------------------+ -.. _listaclrules__response_ruleservicedto: +.. _listaclrules__response_addressgroupvo: -.. table:: **Table 10** RuleServiceDto +.. table:: **Table 9** AddressGroupVO + + +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+=========+====================================================================================================================================================================================================================+ + | address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | + +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | name | + +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | String | address set id | + +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _listaclrules__response_ruleservicedtoforresponse: + +.. table:: **Table 10** RuleServiceDtoForResponse +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | @@ -278,6 +261,8 @@ Response Parameters +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocol | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | Array of integers | Protocols | + +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | source_port | String | Source port | +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dest_port | String | Destination port | @@ -290,7 +275,9 @@ Response Parameters +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | service_group | Array of strings | Service group list | +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group_names | Array of :ref:`AddressGroupVO ` objects | Service group name list | + | service_group_names | Array of :ref:`ServiceGroupVO ` objects | Service group name list | + +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | Integer | Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases | +---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_serviceitem: @@ -311,16 +298,21 @@ Response Parameters | name | String | name | +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _listaclrules__response_addressgroupvo: +.. _listaclrules__response_servicegroupvo: -.. table:: **Table 12** AddressGroupVO +.. table:: **Table 12** ServiceGroupVO - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - set_id String set id - name String name - ========= ====== =========== + +------------------+-------------------+-------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================+===========================================================================================+ + | name | String | service group name | + +------------------+-------------------+-------------------------------------------------------------------------------------------+ + | protocols | Array of integers | protocols | + +------------------+-------------------+-------------------------------------------------------------------------------------------+ + | service_set_type | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | + +------------------+-------------------+-------------------------------------------------------------------------------------------+ + | set_id | String | service set id | + +------------------+-------------------+-------------------------------------------------------------------------------------------+ .. _listaclrules__response_tagsvo: diff --git a/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst b/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst index 991e5d2..e3b5b80 100644 --- a/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst +++ b/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst @@ -54,6 +54,8 @@ Request Parameters +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | top | No | Integer | Whether to pin on top. The options are as follows: 0: no; 1: yes. | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0: no; 1: yes. | + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- diff --git a/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst b/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst index c9ccc7d..28aad5a 100644 --- a/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst +++ b/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst @@ -55,7 +55,6 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | name | No | String | Rule name | @@ -67,7 +66,6 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | action_type | No | Integer | Action. 0: allow; 1: deny | @@ -75,11 +73,14 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | status | No | Integer | Rule delivery status. 0: disabled; 1: enabled. | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | applications | No | Array of strings | applications | + +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + | applicationsJsonString | No | String | applications json string | + +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | description | No | String | Description | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | long_connect_time_hour | No | Long | Persistent connection duration (hour) | @@ -95,23 +96,20 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | source | No | :ref:`RuleAddressDto ` object | Rule address DTO | + | source | No | :ref:`RuleAddressDto ` object | rule address dto | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | destination | No | :ref:`RuleAddressDto ` object | Rule address DTO | + | destination | No | :ref:`RuleAddressDto ` object | rule address dto | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service | No | :ref:`RuleServiceDto ` object | RuleServiceDto | + | service | No | :ref:`RuleServiceDto ` object | rule service dto | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | type | No | Integer | Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule). | | | | | | | | | | Enumeration values: | | | | | | | | | | - **0** | - | | | | | | | | | - **1** | - | | | | | | | | | - **2** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | tag | No | :ref:`TagsVO ` object | tag | @@ -128,40 +126,46 @@ Request Parameters +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | top | No | Integer | Whether to pin on top. The options are as follows: 0: no; 1: yes. | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0: no; 1: yes. | + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_ruleaddressdto: .. table:: **Table 6** RuleAddressDto - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+================================================================================+===============================================================================================================================================+ - | type | Yes | Integer | Source type. 0: manual input; 1: associated IP address group; 2: domain name | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Source type. 0: IPv4; 1: IPv6 | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address | No | String | Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_id | No | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_name | No | String | IP address group name | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_address_name | No | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list_json | No | String | JSON value of the rule region list. | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list | No | Array of :ref:`IpRegionDto ` objects | Region list of a rule | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_id | No | String | domain set id | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_name | No | String | domain set name | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | Array of strings | IP address list | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group | No | Array of strings | address group | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group_names | No | Array of :ref:`AddressGroupVO ` objects | Address set list | - +---------------------+-----------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=====================+===========+================================================================================+====================================================================================================================================================================================================================+ + | type | Yes | Integer | Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Source type. 0: IPv4; 1: IPv6 | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | No | String | Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_id | No | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_name | No | String | IP address group name | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_address_name | No | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list_json | No | String | JSON value of the rule region list. | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | region_list | No | Array of :ref:`IpRegionDto ` objects | Region list of a rule | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_id | No | String | domain set id | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | domain_set_name | No | String | domain set name | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | No | Array of strings | IP address list | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group | No | Array of strings | address group | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group_names | No | Array of :ref:`AddressGroupVO ` objects | Address set list | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | predefined_group | No | Array of strings | predefined group | + +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_ipregiondto: @@ -179,9 +183,23 @@ Request Parameters | region_type | No | Integer | Region type, 0 means country, 1 means province, 2 means continent | +----------------+-----------+---------+-------------------------------------------------------------------+ +.. _updateaclrule__request_addressgroupvo: + +.. table:: **Table 8** AddressGroupVO + + +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+=========+====================================================================================================================================================================================================================+ + | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | + +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | name | + +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | set_id | No | String | address set id | + +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _updateaclrule__request_ruleservicedto: -.. table:: **Table 8** RuleServiceDto +.. table:: **Table 9** RuleServiceDto +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -190,6 +208,8 @@ Request Parameters +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | No | Array of integers | Protocols | + +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | source_port | No | String | Source port | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dest_port | No | String | Destination port | @@ -200,14 +220,18 @@ Request Parameters +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | custom_service | No | Array of :ref:`ServiceItem ` objects | custom service | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | predefined_group | No | Array of strings | predefined group | + +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | service_group | No | Array of strings | Service group list | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group_names | No | Array of :ref:`AddressGroupVO ` objects | Service group name list | + | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | Service group name list | + +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | No | Integer | Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_serviceitem: -.. table:: **Table 9** ServiceItem +.. table:: **Table 10** ServiceItem +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -223,20 +247,25 @@ Request Parameters | name | No | String | name | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -.. _updateaclrule__request_addressgroupvo: +.. _updateaclrule__request_servicegroupvo: -.. table:: **Table 10** AddressGroupVO +.. table:: **Table 11** ServiceGroupVO - ========= ========= ====== =========== - Parameter Mandatory Type Description - ========= ========= ====== =========== - set_id No String set id - name No String name - ========= ========= ====== =========== + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==================+===========+===================+===========================================================================================+ + | name | No | String | service group name | + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + | protocols | No | Array of integers | protocols | + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + | service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ + | set_id | No | String | service set id | + +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ .. _updateaclrule__request_tagsvo: -.. table:: **Table 11** TagsVO +.. table:: **Table 12** TagsVO ========= ========= ====== =========== Parameter Mandatory Type Description @@ -251,7 +280,7 @@ Response Parameters **Status code: 200** -.. table:: **Table 12** Response body parameters +.. table:: **Table 13** Response body parameters +-----------+-------------------------------------------------------+-------------+ | Parameter | Type | Description | @@ -261,7 +290,7 @@ Response Parameters .. _updateaclrule__response_ruleid: -.. table:: **Table 13** RuleId +.. table:: **Table 14** RuleId ========= ====== =========== Parameter Type Description @@ -272,7 +301,7 @@ Response Parameters **Status code: 400** -.. table:: **Table 14** Response body parameters +.. table:: **Table 15** Response body parameters +-----------------------+-----------------------+-----------------------+ | Parameter | Type | Description | diff --git a/api-ref/source/api/address_set_management/querying_address_set_details.rst b/api-ref/source/api/address_set_management/querying_address_set_details.rst index 9c84824..b8afd7e 100644 --- a/api-ref/source/api/address_set_management/querying_address_set_details.rst +++ b/api-ref/source/api/address_set_management/querying_address_set_details.rst @@ -35,6 +35,8 @@ GET /v1/{project_id}/address-sets/{set_id} +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | query_address_set_type | No | Integer | Query address set type, 0 indicates a custom address set and 1 indicates a predefined address set | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -64,25 +66,25 @@ Response Parameters .. table:: **Table 5** data - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=============================================================================================+ - | id | String | ID of the IP address group | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | name | String | IP address group name | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | description | String | Address group description | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | address_set_type | Integer | Address set type, 0 indicates a custom address set and 1 indicates a predefined address set | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | address_type | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+====================================================================================================================================================================================================================+ + | id | String | ID of the IP address group | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | IP address group name | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Address group description | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). | + | | | | + | | | Enumeration values: | + | | | | + | | | - **0** | + | | | | + | | | - **1** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** diff --git a/api-ref/source/api/address_set_management/querying_address_set_members.rst b/api-ref/source/api/address_set_management/querying_address_set_members.rst index 1aee4ab..61c6313 100644 --- a/api-ref/source/api/address_set_management/querying_address_set_members.rst +++ b/api-ref/source/api/address_set_management/querying_address_set_members.rst @@ -25,23 +25,25 @@ GET /v1/{project_id}/address-items .. table:: **Table 2** Query Parameters - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | set_id | Yes | String | ID of the IP address group | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | Keyword | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | No | String | IP address | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | set_id | Yes | String | ID of the IP address group | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Keyword | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address | No | String | IP address | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_address_set_type | No | Integer | Query address set type, 0 means custom define address set, 1 means predefined address set | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/api/address_set_management/querying_ip_address_sets.rst b/api-ref/source/api/address_set_management/querying_ip_address_sets.rst index 5fb0a7f..e693d1f 100644 --- a/api-ref/source/api/address_set_management/querying_ip_address_sets.rst +++ b/api-ref/source/api/address_set_management/querying_ip_address_sets.rst @@ -112,7 +112,7 @@ Response Parameters +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_type | Integer | Address set type, 0 indicates a custom address set and 1 indicates a predefined address set | + | address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** diff --git a/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst b/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst index 3850e78..cb73f8a 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst +++ b/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst @@ -89,19 +89,17 @@ Response Parameters .. table:: **Table 5** data - +-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total number of queried records | - +-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | Blacklist and whitelist records | - +-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================+=================================================================================================================================================+ + | offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Integer | Number of records displayed on each page, in the range 1-1024 | + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | total | Integer | Total number of queried records | + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + | records | Array of :ref:`records ` objects | Blacklist and whitelist records | + +-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listblackwhitelists__response_records: diff --git a/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst b/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst index cdd8469..7cbe3a3 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst +++ b/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst @@ -47,31 +47,21 @@ Request Parameters .. table:: **Table 4** Request body parameters - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | direction | No | Integer | Indicates the address direction. 0: source address 1: destination address | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Address type. 0: ipv4; 1: ipv6; 2: domain | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address | No | String | IP address | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | Integer | Protocol type. The value is 6 for TCP, 17 for UDP, 1 for ICMP, 58 for ICMPv6, and -1 for any protocol. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port | No | String | Port | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | list_type | No | Integer | Blacklist/Whitelist type. The options are 4 (blacklist) and 5 (whitelist). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **4** | - | | | | | - | | | | - **5** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object_id | No | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | description | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==============+===========+=========+========================================================================================================+ + | direction | No | Integer | Indicates the address direction. 0: source address 1: destination address | + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type. 0: ipv4; 1: ipv6; 2: domain | + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ + | address | No | String | IP address | + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ + | protocol | No | Integer | Protocol type. The value is 6 for TCP, 17 for UDP, 1 for ICMP, 58 for ICMPv6, and -1 for any protocol. | + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ + | port | No | String | Port | + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ + | description | No | String | description | + +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst b/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst index f3c80c0..0618ba7 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst @@ -59,7 +59,7 @@ Request Parameters +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | domain_names | No | Array of :ref:`DomainSetInfoDto ` objects | domain names | +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_type | Yes | Integer | Domain set type, 0 means URL filtering, 1 means domain parse | + | domain_set_type | Yes | Integer | Domain name group type. 0 means Application type and 1 means Network type. | +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _adddomainset__request_domainsetinfodto: diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst b/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst index dff96ba..c3cedc5 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst @@ -40,7 +40,7 @@ GET /v1/{project_id}/domain-sets +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | key_word | No | String | key | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_type | No | Integer | Domain set type, 0 means URL filtering, 1 means domain parse | + | domain_set_type | No | Integer | Domain name group type. 0 means Application type and 1 means Network type. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | config_status | No | Integer | config status | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -89,17 +89,36 @@ Response Parameters .. table:: **Table 6** DomainSetVo - =============== ======= =============== - Parameter Type Description - =============== ======= =============== - set_id String set id - name String domain set name - description String description - ref_count Integer reference count - domain_set_type Integer domain set type - config_status Integer config status - message String message - =============== ======= =============== + +-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========================================================================+============================================================================+ + | set_id | String | set id | + +-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | name | String | domain set name | + +-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | description | String | description | + +-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | ref_count | Integer | reference count | + +-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | domain_set_type | Integer | Domain name group type. 0 means Application type and 1 means Network type. | + +-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | config_status | Integer | config status | + +-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | message | String | message | + +-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+ + | rules | Array of :ref:`UseRuleVO ` objects | used rule list | + +-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+ + +.. _listdomainsets__response_userulevo: + +.. table:: **Table 7** UseRuleVO + + ========= ====== =========== + Parameter Type Description + ========= ====== =========== + id String rule id + name String rule name + ========= ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst b/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst index 85cbf9e..627ba30 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst @@ -39,10 +39,6 @@ GET /v1/{project_id}/domain-set/domains/{domain_set_id} +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | domain_name | No | String | domain name | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | description | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | set_id | No | String | domain_set_id | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | object_Id | No | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,7 +50,7 @@ Request Parameters +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | + | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst b/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst index 31a2422..325b9f3 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst @@ -88,7 +88,7 @@ Obtain the DNS server list of the project whose ID is 2349ba469daf4b7daf268bb026 .. code-block:: - https://endpoint/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers + https://console.xxxxxx.com/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers Example Responses ----------------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst b/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst index 19789d4..66a5128 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst @@ -26,15 +26,15 @@ GET /v1/{project_id}/domain/parse/{domain_name} .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | String | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | + +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). | + +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst b/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst index 94c1472..2784f8f 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst @@ -31,7 +31,7 @@ PUT /v1/{project_id}/domain-set/{set_id} +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | + | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -47,14 +47,17 @@ Request Parameters .. table:: **Table 4** Request body parameters - =============== ========= ======= =============== - Parameter Mandatory Type Description - =============== ========= ======= =============== - name Yes String name - description No String description - set_id No String domain set id - domain_set_type No Integer domain set type - =============== ========= ======= =============== + +-----------------+-----------+---------+----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+===========+=========+============================================================================+ + | name | Yes | String | name | + +-----------------+-----------+---------+----------------------------------------------------------------------------+ + | description | No | String | description | + +-----------------+-----------+---------+----------------------------------------------------------------------------+ + | set_id | No | String | domain set id | + +-----------------+-----------+---------+----------------------------------------------------------------------------+ + | domain_set_type | No | Integer | Domain name group type. 0 means Application type and 1 means Network type. | + +-----------------+-----------+---------+----------------------------------------------------------------------------+ Response Parameters ------------------- diff --git a/api-ref/source/api/eip_management/querying_the_eip_list.rst b/api-ref/source/api/eip_management/querying_the_eip_list.rst index ded2e87..af7407a 100644 --- a/api-ref/source/api/eip_management/querying_the_eip_list.rst +++ b/api-ref/source/api/eip_management/querying_the_eip_list.rst @@ -49,7 +49,9 @@ GET /v1/{project_id}/eips/protect | | | | Enumeration values: | | | | | | | | | | - **null** | + | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | sync | No | Integer | Specifies whether to synchronize tenant EIP data. The options are as follows: 0: no; 1: yes | @@ -57,6 +59,7 @@ GET /v1/{project_id}/eips/protect | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | @@ -138,6 +141,7 @@ Response Parameters | | | Enumeration values: | | | | | | | | - **0** | + | | | | | | | - **1** | +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | public_ipv6 | String | EIP IPv6 | @@ -215,7 +219,7 @@ Return value of EIP data query "associate_instance_type" : "PORT", "device_id" : "c87579ab-c76a-4afd-83ce-62e0f531f13e", "device_name" : "test", - "device_owner" : "compute:endpoint", + "device_owner" : "compute:test", "domain_id" : "7d07807209524a4280266db9df63c4fa", "enterprise_project_id" : "0", "fw_domain_id" : "7d07807209524a4280266db9df63c4fa", diff --git a/api-ref/source/api/firewall_management/create_east_west_firewall.rst b/api-ref/source/api/firewall_management/create_east_west_firewall.rst index f2563e6..1791468 100644 --- a/api-ref/source/api/firewall_management/create_east_west_firewall.rst +++ b/api-ref/source/api/firewall_management/create_east_west_firewall.rst @@ -63,22 +63,47 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+--------------------------------------------------------------------+------------------------------------+ - | Parameter | Type | Description | - +===========+====================================================================+====================================+ - | data | :ref:`IdObject ` object | create east west firewall response | - +-----------+--------------------------------------------------------------------+------------------------------------+ + +-----------+--------------------------------------------------------------------------------------------+------------------------------------+ + | Parameter | Type | Description | + +===========+============================================================================================+====================================+ + | data | :ref:`CreateEWFirewallResp ` object | create east west firewall response | + +-----------+--------------------------------------------------------------------------------------------+------------------------------------+ -.. _createeastwestfirewall__response_idobject: +.. _createeastwestfirewall__response_createewfirewallresp: -.. table:: **Table 6** IdObject +.. table:: **Table 6** CreateEWFirewallResp - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== + +----------------+----------------------------------------------------------------------------------------------------------------+----------------+ + | Parameter | Type | Description | + +================+================================================================================================================+================+ + | id | String | Id | + +----------------+----------------------------------------------------------------------------------------------------------------+----------------+ + | er | :ref:`ER ` object | ER data | + +----------------+----------------------------------------------------------------------------------------------------------------+----------------+ + | inspertion_vpc | :ref:`CreateEWFirewallInspectVpcResp ` object | inspection vpc | + +----------------+----------------------------------------------------------------------------------------------------------------+----------------+ + +.. _createeastwestfirewall__response_er: + +.. table:: **Table 7** ER + + ============ ====== ============ + Parameter Type Description + ============ ====== ============ + er_id String ER ID + er_attach_id String ER attach ID + ============ ====== ============ + +.. _createeastwestfirewall__response_createewfirewallinspectvpcresp: + +.. table:: **Table 8** CreateEWFirewallInspectVpcResp + + ========== ================ =========== + Parameter Type Description + ========== ================ =========== + vpc_id String vpc id + subnet_ids Array of strings subnet ids + ========== ================ =========== Example Requests ---------------- @@ -106,7 +131,15 @@ Create East West Firewall Response Body { "data" : { - "id" : "b6d4a7d5-388e-4594-b696-fb4bba1d2b9e" + "id" : "acc86ca7-818b-4c3d-8a9a-3915a2b21651", + "er" : { + "er_id" : "f0f5275a-40aa-4d1e-ac78-2550f7818d43", + "er_attach_id" : "bd62ddd3-5e20-482b-aefa-9e2940e2b1a9" + }, + "inspertion_vpc" : { + "vpc_id" : "00672633-0466-4c35-99ef-5e3f5c813a4b", + "subnet_ids" : [ "294682a0-1e85-45f5-92c8-e52bee09c204", "a86277bb-35d5-4442-bc0b-2e9d4e6a9080", "95829240-14e0-47e6-b9e7-2ac228e7b00f" ] + } } } diff --git a/api-ref/source/api/firewall_management/create_firewall.rst b/api-ref/source/api/firewall_management/create_firewall.rst index 63aa3cc..55073d8 100644 --- a/api-ref/source/api/firewall_management/create_firewall.rst +++ b/api-ref/source/api/firewall_management/create_firewall.rst @@ -31,7 +31,7 @@ Request Parameters +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +================+===========+========+========================================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | + | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | X-Client-Token | No | String | An identity that guarantees the idempotency of client requests. The identifier is in 32-bit UUID format, generated by the client, and must be unique between requests. | +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -292,7 +292,28 @@ Create Firewall Response .. code-block:: { - "data" : "6ed72853-34cb-4b97-9b87-cfc47087c96e" + "data" : { + "charge_info" : { + "charge_mode" : "prePaid", + "is_auto_pay" : true, + "is_auto_renew" : true, + "period_num" : 1, + "period_type" : "month" + }, + "enterprise_project_id" : "0", + "flavor" : { + "extend_bandwidth" : 5000, + "extend_eip_count" : 2000, + "extend_vpc_count" : 100, + "version" : "Standard" + }, + "name" : "CFW-TEST", + "tags" : [ { + "key" : "TagKey", + "value" : "TagVal" + } ] + }, + "order_id" : "CS2403271050ZEM0L" } **Status code: 400** diff --git a/api-ref/source/api/firewall_management/delete_firewall_instance.rst b/api-ref/source/api/firewall_management/delete_firewall_instance.rst index 46b3bda..bf5e23f 100644 --- a/api-ref/source/api/firewall_management/delete_firewall_instance.rst +++ b/api-ref/source/api/firewall_management/delete_firewall_instance.rst @@ -32,7 +32,7 @@ Request Parameters +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | + | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters diff --git a/api-ref/source/api/firewall_management/list_firewall_detail.rst b/api-ref/source/api/firewall_management/list_firewall_detail.rst index 91a439b..65c5bd3 100644 --- a/api-ref/source/api/firewall_management/list_firewall_detail.rst +++ b/api-ref/source/api/firewall_management/list_firewall_detail.rst @@ -50,6 +50,8 @@ GET /v1/{project_id}/firewall/exist +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | firewall instance name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -170,48 +172,50 @@ Response Parameters +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | support_url_filtering | Boolean | whether to enable url filtering. The options are true (yes) and false (no). | +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | String | tags | + +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listfirewalldetail__response_flavor: .. table:: **Table 7** Flavor - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================+ - | version | Integer | Firewall version. The value can be 0 (standard edition), 1 (professional edition), or 3 (basic edition). | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - | | | | - | | | - **3** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | eip_count | Integer | Number of EIPs | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | vpc_count | Integer | Number of VPCs | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | bandwidth | Integer | Bandwidth | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | log_storage | Integer | Log storage | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | session_concurrent | Integer | concurrent session | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | session_create | Integer | created session | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | total_rule_count | Integer | total rule count | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | used_rule_count | Integer | used rule count | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | vpc_bandwith | Integer | vpc bandwith | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================================================================================================+ + | version | Integer | Firewall version. The value can be 0 (standard edition), 1 (professional edition), 2 (platinum edition), or 3 (basic edition). | + | | | | + | | | Enumeration values: | + | | | | + | | | - **0** | + | | | | + | | | - **1** | + | | | | + | | | - **2** | + | | | | + | | | - **3** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | eip_count | Integer | Number of EIPs | + | | | | + | | | Minimum: **1** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | vpc_count | Integer | Number of VPCs | + | | | | + | | | Minimum: **1** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Integer | Bandwidth | + | | | | + | | | Minimum: **1** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_storage | Integer | Log storage | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | default_bandwidth | Integer | default bandwidth | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | default_eip_count | Integer | default eip count | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | default_log_storage | Integer | default log storage | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | default_vpc_count | Integer | default vpc count | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ .. _listfirewalldetail__response_protectobjectvo: @@ -312,8 +316,13 @@ Response to the request for obtaining a firewall instance "used_rule_count" : 2136, "version" : 1, "vpc_bandwith" : 1400, - "vpc_count" : 8 + "vpc_count" : 8, + "default_eip_count" : 20, + "default_vpc_count" : 0, + "default_bandwidth" : 10, + "default_log_storage" : 0 }, + "tags" : "{\"key1234\":\"1234\",\"key122\":\"2222\"}", "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925", "fw_instance_name" : "test", "ha_type" : 1, diff --git a/api-ref/source/api/firewall_management/list_firewall_list.rst b/api-ref/source/api/firewall_management/list_firewall_list.rst index 965e3f3..58a32d4 100644 --- a/api-ref/source/api/firewall_management/list_firewall_list.rst +++ b/api-ref/source/api/firewall_management/list_firewall_list.rst @@ -139,48 +139,50 @@ Response Parameters +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | Integer | Firewall status list. The options are as follows: -1: waiting for payment; 0: creating; 1: deleting; 2: running; 3: upgrading; 4: deletion completed; 5: freezing; 6: creation failed; 7: deletion failed; 8: freezing failed; 9: storage in progress; 10: storage failed; 11: upgrade failed | +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | String | tags | + +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listfirewalllist__response_flavor: .. table:: **Table 9** Flavor - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================+ - | version | Integer | Firewall version. The value can be 0 (standard edition), 1 (professional edition), or 3 (basic edition). | - | | | | - | | | Enumeration values: | - | | | | - | | | - **0** | - | | | | - | | | - **1** | - | | | | - | | | - **3** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | eip_count | Integer | Number of EIPs | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | vpc_count | Integer | Number of VPCs | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | bandwidth | Integer | Bandwidth | - | | | | - | | | Minimum: **1** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | log_storage | Integer | Log storage | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | session_concurrent | Integer | concurrent session | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | session_create | Integer | created session | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | total_rule_count | Integer | total rule count | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | used_rule_count | Integer | used rule count | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | vpc_bandwith | Integer | vpc bandwith | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================================================================================================+ + | version | Integer | Firewall version. The value can be 0 (standard edition), 1 (professional edition), 2 (platinum edition), or 3 (basic edition). | + | | | | + | | | Enumeration values: | + | | | | + | | | - **0** | + | | | | + | | | - **1** | + | | | | + | | | - **2** | + | | | | + | | | - **3** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | eip_count | Integer | Number of EIPs | + | | | | + | | | Minimum: **1** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | vpc_count | Integer | Number of VPCs | + | | | | + | | | Minimum: **1** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Integer | Bandwidth | + | | | | + | | | Minimum: **1** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_storage | Integer | Log storage | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | default_bandwidth | Integer | default bandwidth | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | default_eip_count | Integer | default eip count | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | default_log_storage | Integer | default log storage | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | default_vpc_count | Integer | default vpc count | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- @@ -201,51 +203,56 @@ Example Responses **Status code: 200** -list firewall list response +Get Firewall Instance Response .. code-block:: { "data" : { - "limit" : 10, + "limit" : 1, "offset" : 0, "project_id" : "14181c1245cf4fd786824efe1e2b9388", "records" : [ { - "charge_mode" : 0, - "engine_type" : 1, - "enterprise_project_id" : "default", - "flavor" : { - "bandwidth" : 60, - "eip_count" : 51, - "log_storage" : 0, - "version" : 1, - "vpc_count" : 8 - }, - "fw_instance_id" : "546af3f8-88e9-47f2-a205-2346d7090925", + "fw_instance_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", + "resource_id" : "ebf891cd-2163-48a0-9963-6309f99dd3c4", + "name" : "1709176078374", "fw_instance_name" : "test", - "ha_type" : 1, - "name" : "1680054140516", - "resource_id" : "546af3f8-88e9-47f2-a205-2346d7090925", + "enterprise_project_id" : "default", + "tags" : "{\"key_test3\":\"value_test3\"}", + "ha_type" : 0, + "charge_mode" : 0, "service_type" : 0, + "engine_type" : 1, + "flavor" : { + "version" : 1, + "eip_count" : 50, + "vpc_count" : 6, + "bandwidth" : 50, + "log_storage" : 0, + "default_eip_count" : 50, + "default_vpc_count" : 2, + "default_bandwidth" : 50, + "default_log_storage" : 0 + }, "status" : 2 } ], - "total" : 1 + "total" : 18 }, - "user_support_eps" : false, "has_ndr" : false, - "is_support_postpaid" : false, - "is_support_basic_version" : false, - "is_support_buy_professional" : false + "is_support_basic_version" : true, + "is_support_buy_professional" : false, + "is_support_postpaid" : true, + "user_support_eps" : false } Status Codes ------------ -=========== =========================== +=========== ============================== Status Code Description -=========== =========================== -200 list firewall list response -=========== =========================== +=========== ============================== +200 Get Firewall Instance Response +=========== ============================== Error Codes ----------- diff --git a/api-ref/source/api/firewall_management/list_job_status.rst b/api-ref/source/api/firewall_management/list_job_status.rst index ed58589..3b38946 100644 --- a/api-ref/source/api/firewall_management/list_job_status.rst +++ b/api-ref/source/api/firewall_management/list_job_status.rst @@ -32,7 +32,7 @@ Request Parameters +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | + | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters @@ -64,23 +64,25 @@ Response Parameters .. table:: **Table 4** data - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=========================================================================================================================================+ - | id | String | Job Id | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Job execution status. Running means the job is being executed, Success means the job is successful, Failed means the job is failed. | - | | | | - | | | Enumeration values: | - | | | | - | | | - **Running** | - | | | - **Success** | - | | | - **Failed** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | begin_time | String | Creation time, in the format yyyy-mm-ddThh:mm:ssZ. where T refers to the beginning of a certain time; Z refers to the time zone offset. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | String | End time, in the format "yyyy-mm-ddThh:mm:ssZ". where T refers to the beginning of a certain time; Z refers to the time zone offset. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=====================================================================================================================================================================================================+ + | id | String | Job Id | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Job execution status. Running means the job is being executed, Success means the job is successful, Failed means the job is failed. | + | | | | + | | | Enumeration values: | + | | | | + | | | - **Running** | + | | | | + | | | - **Success** | + | | | | + | | | - **Failed** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | begin_time | String | Creation time, in the format yyyy-mm-ddThh:mm:ssZ. where T refers to the beginning of a certain time; Z refers to the time zone offset, for example, the Beijing time offset is displayed as +0800. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | String | End time, in the format "yyyy-mm-ddThh:mm:ssZ". where T refers to the beginning of a certain time; Z refers to the time zone offset, for example, the Beijing time offset is displayed as +0800. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Requests ---------------- diff --git a/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst b/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst index 29ee633..32b466c 100644 --- a/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst +++ b/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst @@ -132,6 +132,7 @@ Response Parameters enterprise_project_id String Enterprise user ID project_id String User ID enable_ipv6 String Whether to enable IPv6 + attachment_id String ER attachment id ===================== ====== ====================== .. _listeastwestfirewall__response_vpcdetail: @@ -194,7 +195,7 @@ Response Parameters Example Requests ---------------- -Obtain the east-west firewall information of the project whose ID is 09bb24e6f280d23d0f9fc0104b901480. +Get EastWest Firewall Response .. code-block:: @@ -205,82 +206,90 @@ Example Responses **Status code: 200** -Response to the request for querying east-west firewall information +Get EastWest Firewall Response .. code-block:: { "data" : { - "ew_vpc_route_limit" : 5, + "er" : { + "id" : "f0f5275a-40aa-4d1e-ac78-2550f7818d43", + "name" : "er", + "project_id" : "5c69cf330cda42369cbd726ee1bc5e76", + "attachment_id" : "e978c028-0ccf-4168-a015-0094ac631e88" + }, "inspection_vpc" : { - "cidr" : "10.90.90.0/24", - "id" : "4471b50f-811a-4f9b-9575-a491e6c81dd0", + "cidr" : "10.13.13.0/24", + "id" : "3baa2248-03d4-47ac-aefa-ec6f9a30ed80", "name" : "inspection-vpc" }, "limit" : 50, - "mode" : "peer", - "object_id" : "5681ed03-ff3f-4dab-9bb1-daf388121ad1", + "mode" : "er", + "object_id" : "6cc31075-0b03-461d-aa3a-73c4765bf9ac", "offset" : 0, - "project_id" : "28f403ddd3f141daa6e046e85cb15519", + "project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protect_infos" : [ { - "protected_resource_id" : "4c51e814-03b5-4754-87cb-243701f5b4ff", - "protected_resource_mode" : "peer", - "protected_resource_name" : "vpc-c247", - "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", + "protected_resource_id" : "09b26b83-4b7c-499f-805b-50820900cd9f", + "protected_resource_mode" : "er", + "protected_resource_name" : "vpc-4", + "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { - "protected_resource_id" : "af44c693-a13c-46a7-a6d2-eb2cb2570e57", - "protected_resource_mode" : "peer", - "protected_resource_name" : "vpc-10.1", - "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", + "protected_resource_id" : "2956f917-af18-44a2-a0f2-f592633d4431", + "protected_resource_mode" : "er", + "protected_resource_name" : "vpc-t3", + "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 0 }, { - "protected_resource_id" : "2ae53845-64b8-4cd5-bcbe-efb93a7c9207", - "protected_resource_mode" : "peer", - "protected_resource_name" : "vpc-test", - "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", + "protected_resource_id" : "69d4c81f-80bd-4c28-9074-f26b400b3a34", + "protected_resource_mode" : "er", + "protected_resource_name" : "vpc-t2", + "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, - "status" : 1 + "status" : 0 }, { - "protected_resource_id" : "8a51174b-376b-40e5-8ccf-89d33703842b", - "protected_resource_mode" : "peer", - "protected_resource_name" : "vpc-a0c1", - "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", + "protected_resource_id" : "e1b18d3e-8f7d-4c4e-a326-37db7bd89a3a", + "protected_resource_mode" : "er", + "protected_resource_name" : "vpc-t1", + "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, - "status" : 1 + "status" : 0 }, { - "protected_resource_id" : "9cccb096-31be-4d68-a7ee-156f0c947f0b", - "protected_resource_mode" : "peer", - "protected_resource_name" : "vpc-192.168", - "protected_resource_project_id" : "28f403ddd3f141daa6e046e85cb15519", + "protected_resource_id" : "f91c1747-1325-4b39-9d58-7fac0bd2786f", + "protected_resource_mode" : "er", + "protected_resource_name" : "vpc-5", + "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", + "protected_resource_type" : 0, + "status" : 0 + }, { + "protected_resource_id" : "bd556a7d-447e-49eb-be17-f93af09769f5", + "protected_resource_mode" : "er", + "protected_resource_name" : "inspct-a", + "protected_resource_project_id" : "5c69cf330cda42369cbd726ee1bc5e76", "protected_resource_type" : 0, "status" : 1 } ], "status" : 0, - "total" : 5 + "total" : 6, + "special_vpc" : [ ] } } Status Codes ------------ -+-------------+---------------------------------------------------------------------+ -| Status Code | Description | -+=============+=====================================================================+ -| 200 | Response to the request for querying east-west firewall information | -+-------------+---------------------------------------------------------------------+ -| 400 | Bad Request | -+-------------+---------------------------------------------------------------------+ -| 401 | Unauthorized | -+-------------+---------------------------------------------------------------------+ -| 403 | Forbidden | -+-------------+---------------------------------------------------------------------+ -| 404 | Not Found | -+-------------+---------------------------------------------------------------------+ -| 500 | Internal Server Error | -+-------------+---------------------------------------------------------------------+ +=========== ============================== +Status Code Description +=========== ============================== +200 Get EastWest Firewall Response +400 Bad Request +401 Unauthorized +403 Forbidden +404 Not Found +500 Internal Server Error +=========== ============================== Error Codes ----------- diff --git a/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst b/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst index b4bfde6..45180fb 100644 --- a/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst +++ b/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst @@ -87,48 +87,15 @@ Response Parameters .. table:: **Table 6** VpcAttachmentDetail - +-----------------------+---------------------------------------------------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+===============================================================+=======================+ - | id | String | id | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | name | String | name | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | vpc_id | String | vpc id | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | virsubnet_id | String | subnet id | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | state | String | state | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | created_at | String | create time | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | updated_at | String | update time | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | tags | Array of :ref:`Tag ` objects | tag | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | description | String | description | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | project_id | String | project id | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | vpc_project_id | String | vpc project id | - +-----------------------+---------------------------------------------------------------+-----------------------+ - | enterprise_project_id | String | enterprise project id | - +-----------------------+---------------------------------------------------------------+-----------------------+ - -.. _listprotectedvpcs__response_tag: - -.. table:: **Table 7** Tag - ========= ====== =========== Parameter Type Description ========= ====== =========== - key String key - value String value + vpc_id String vpc id ========= ====== =========== **Status code: 500** -.. table:: **Table 8** Response body parameters +.. table:: **Table 7** Response body parameters +-----------------------+-----------------------+-----------------------+ | Parameter | Type | Description | diff --git a/api-ref/source/api/log_management/querying_access_control_logs.rst b/api-ref/source/api/log_management/querying_access_control_logs.rst index 3d1d59b..379612f 100644 --- a/api-ref/source/api/log_management/querying_access_control_logs.rst +++ b/api-ref/source/api/log_management/querying_access_control_logs.rst @@ -44,15 +44,15 @@ GET /v1/{project_id}/cfw/logs/access-control +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dst_port | No | Integer | Destination port | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Protocol | + | protocol | No | String | Protocol types, including TCP, UDP, ICMP, ICMPV6, etc. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | app | No | String | Application protocol | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_id | No | String | Document ID. The value is null for the first page and not null for the rest of the pages. | + | log_id | No | String | Document ID, the first page is empty, the other pages are not empty, and the other pages can take the log_id of the last query record. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | next_date | No | Integer | Date. The value is null for the first page and not null for the rest of the pages. | + | next_date | No | Integer | The next date is empty when it is the first page, not empty when it is not the first page, and the other pages can take the start_time of the last query record. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The first page is empty, and the non-first page is not empty. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,19 @@ GET /v1/{project_id}/cfw/logs/access-control +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | rule_name | No | String | rule name | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | action | No | String | Action. 0: allow; 1: deny | + | action | No | String | Action. including allow and deny | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | No | String | source region name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | No | String | destination region name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | No | String | source province name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | No | String | dst province name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | No | String | source city name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | No | String | dst city name | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -117,41 +129,57 @@ Response Parameters .. table:: **Table 6** records - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+=========+==================================================================================================================================================================================================================+ - | action | String | Action. 0: allow; 1: deny | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_name | String | Rule name | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_id | String | Rule ID | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hit_time | Long | Hit time | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_region_id | String | source region id | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_region_name | String | source region name | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_region_id | String | destination region id | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_region_name | String | destination region name | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_id | String | Document ID | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_ip | String | Source IP address | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_port | Integer | Source port | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_ip | String | Destination IP address | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_port | Integer | Destination port | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app | String | Application protocol | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dst_host | String | destination host | - +-----------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===================+=========+==================================================================================================================================================================================================================+ + | action | String | Action. 0: allow; 1: deny | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rule_name | String | Rule name | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rule_id | String | Rule ID | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | hit_time | Long | Hit time | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_id | String | source region id | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | String | source region name | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_id | String | destination region id | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | String | destination region name | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | log_id | String | Document ID | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_ip | String | Source IP address | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_port | Integer | Source port | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_ip | String | Destination IP address | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_port | Integer | Destination port | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app | String | Application protocol | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_host | String | destination host | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_id | String | source province id | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | String | source province name | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_id | String | source city id | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | String | source city name | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_id | String | dst province id | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | String | dst province name | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_id | String | dst city id | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | String | dst city name | + +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** @@ -205,7 +233,15 @@ OK "rule_id" : "c755be1c-4b92-4ae7-a15e-c2d02b152538", "rule_name" : "eip_ipv4_w_n_default_deny", "src_ip" : "100.95.148.49", - "src_port" : 24954 + "src_port" : 24954, + "src_province_id" : "source province id", + "src_province_name" : "source province name", + "src_city_id" : "source city id", + "src_city_name" : "source city name", + "dst_province_id" : "dst province id", + "dst_province_name" : "dst province name", + "dst_city_id" : "dst city id", + "dst_city_name" : "dst city name" } ], "total" : 1 } diff --git a/api-ref/source/api/log_management/querying_attack_logs.rst b/api-ref/source/api/log_management/querying_attack_logs.rst index 8915b59..a2efc9c 100644 --- a/api-ref/source/api/log_management/querying_attack_logs.rst +++ b/api-ref/source/api/log_management/querying_attack_logs.rst @@ -48,51 +48,34 @@ GET /v1/{project_id}/cfw/logs/attack | | | | | | | | | Maximum: **65535** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **6** | - | | | | | - | | | | - **17** | - | | | | | - | | | | - **1** | - | | | | | - | | | | - **58** | + | protocol | No | String | Protocol types, including TCP, UDP, ICMP, ICMPV6, etc. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | app | No | String | Application protocol | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_id | No | String | Log ID. The value is null for the first page and not null for the rest of the pages. | + | log_id | No | String | Document ID, the first page is empty, the other pages are not empty, and the other pages can take the log_id of the last query record. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | next_date | No | Long | Next date. The value is null for the first page and not null for the rest of the pages. | + | next_date | No | Long | The next date is empty when it is the first page, not empty when it is not the first page, and the other pages can take the start_time of the last query record. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The first page is empty, and the non-first page is not empty. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | action | No | String | Action. 0: allow; 1: deny | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | + | action | No | String | Action. including allow and deny | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | String | Direction. 0: inbound; 1: outbound | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | + | direction | No | String | Direction. including in2out and out2in | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | attack_type | No | String | Intrusion event type | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | attack_rule | No | String | Intrusion event rule | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | level | No | String | Threat level | + | | | | | + | | | | - **CRITICAL** | + | | | | - **HIGH** | + | | | | - **MEDIUM** | + | | | | - **LOW** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | source | No | String | Source | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -105,11 +88,23 @@ GET /v1/{project_id}/cfw/logs/attack | | | | Enumeration values: | | | | | | | | | | - **internet** | - | | | | | | | | | - **nat** | - | | | | | | | | | - **vpc** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | attack_rule_id | No | String | attack rule id | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | No | String | source region name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | No | String | destination region name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | No | String | source province name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | No | String | dst province name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | No | String | source city name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | No | String | dst city name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -161,7 +156,6 @@ Response Parameters | | | Enumeration values: | | | | | | | | - **out2in** | - | | | | | | | - **in2out** | +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ | action | String | Action | @@ -208,8 +202,6 @@ Response Parameters +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ | packetMessages | Array of :ref:`PacketMessage ` objects | packet message | +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | dst_host | String | destination host | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ | src_region_id | String | source region id | +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ | src_region_name | String | source region name | @@ -218,6 +210,22 @@ Response Parameters +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ | dst_region_name | String | destination region name | +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ + | src_province_id | String | source province id | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ + | src_province_name | String | source province name | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ + | src_city_id | String | source city id | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ + | src_city_name | String | source city name | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ + | dst_province_id | String | dst province id | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ + | dst_province_name | String | dst province name | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ + | dst_city_id | String | dst city id | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ + | dst_city_name | String | dst city name | + +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ .. _listattacklogs__response_packetmessage: @@ -322,7 +330,15 @@ OK "protocol" : "TCP", "source" : "0", "src_ip" : "100.85.238.144", - "src_port" : 50384 + "src_port" : 50384, + "src_province_id" : "source province id", + "src_province_name" : "source province name", + "src_city_id" : "source city id", + "src_city_name" : "source city name", + "dst_province_id" : "dst province id", + "dst_province_name" : "dst province name", + "dst_city_id" : "dst city id", + "dst_city_name" : "dst city name" } ], "total" : 1 } diff --git a/api-ref/source/api/log_management/querying_flow_logs.rst b/api-ref/source/api/log_management/querying_flow_logs.rst index 390eafd..9eceded 100644 --- a/api-ref/source/api/log_management/querying_flow_logs.rst +++ b/api-ref/source/api/log_management/querying_flow_logs.rst @@ -30,7 +30,7 @@ GET /v1/{project_id}/cfw/logs/flow +=======================+=================+=================+================================================================================================================================================================================================================================+ | fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | String | Direction | + | direction | No | String | direction, including in2out and out2in | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | log_type | No | String | Log type | | | | | | @@ -62,25 +62,15 @@ GET /v1/{project_id}/cfw/logs/flow | | | | | | | | | Maximum: **65535** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **6** | - | | | | | - | | | | - **17** | - | | | | | - | | | | - **1** | - | | | | | - | | | | - **58** | + | protocol | No | String | Protocol types, including TCP, UDP, ICMP, ICMPV6, etc. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | app | No | String | Application protocol | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_id | No | String | Document ID. The value is null for the first page and not null for the rest of the pages. | + | log_id | No | String | Document ID, the first page is empty, the other pages are not empty, and the other pages can take the log_id of the last query record. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | next_date | No | Long | Date. The value is null for the first page and not null for the rest of the pages. | + | next_date | No | Long | The next date is empty when it is the first page, not empty when it is not the first page, and the other pages can take the start_time of the last query record. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + | offset | No | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The first page is empty, and the non-first page is not empty. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | | | | | | @@ -92,6 +82,18 @@ GET /v1/{project_id}/cfw/logs/flow +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dst_host | No | String | destination host | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | No | String | source region name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | No | String | dst region name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | No | String | source province name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | No | String | dst province name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | No | String | source city name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | No | String | dst city name | + +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -138,7 +140,7 @@ Response Parameters +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+==================================================================================================================================================================================================================+ - | bytes | Integer | Byte | + | bytes | Double | Byte | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | direction | String | Direction, which can be inbound or outbound | | | | | @@ -170,6 +172,30 @@ Response Parameters +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dst_host | String | destination host | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_id | String | destination region id | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_region_name | String | destination region name | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_id | String | source region id | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_region_name | String | source region name | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_id | String | source province id | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_province_name | String | source province name | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_id | String | source city id | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | src_city_name | String | source city name | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_id | String | dst province id | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_province_name | String | dst province name | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_id | String | dst city id | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dst_city_name | String | dst city name | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** @@ -224,7 +250,15 @@ OK "protocol" : "TCP", "src_ip" : "100.93.27.17", "src_port" : 49634, - "start_time" : 1664155428000 + "start_time" : 1664155428000, + "src_province_id" : "source province id", + "src_province_name" : "source province name", + "src_city_id" : "source city id", + "src_city_name" : "source city name", + "dst_province_id" : "dst province id", + "dst_province_name" : "dst province name", + "dst_city_id" : "dst city id", + "dst_city_name" : "dst city name" } ], "total" : 1 } diff --git a/api-ref/source/api/service_set_management/creating_a_service_member.rst b/api-ref/source/api/service_set_management/creating_a_service_member.rst index e3b8fee..16abd87 100644 --- a/api-ref/source/api/service_set_management/creating_a_service_member.rst +++ b/api-ref/source/api/service_set_management/creating_a_service_member.rst @@ -61,8 +61,6 @@ Request Parameters +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=============+===========+=========+==================================================================================================================================================================================================================+ - | item_id | No | String | Service member ID | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocol | Yes | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | source_port | Yes | String | Source port | diff --git a/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst b/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst index 3b952e2..364e75f 100644 --- a/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst +++ b/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst @@ -25,27 +25,29 @@ GET /v1/{project_id}/service-sets .. table:: **Table 2** Query Parameters - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | Keyword | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of queries on each page, in the range 1-1024 | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **1024** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - | | | | | - | | | | Minimum: **0** | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Keyword | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of queries on each page, in the range 1-1024 | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **1024** | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + | | | | | + | | | | Minimum: **0** | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | + +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -55,7 +57,7 @@ Request Parameters +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==============+===========+========+====================================================================================================================================================+ - | X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | + | X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. | +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters @@ -91,25 +93,25 @@ Response Parameters .. table:: **Table 6** ServiceSet - +------------------+-------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+===================+=============================================================================================+ - | set_id | String | Service group ID | - +------------------+-------------------+---------------------------------------------------------------------------------------------+ - | name | String | Name | - +------------------+-------------------+---------------------------------------------------------------------------------------------+ - | description | String | Description | - +------------------+-------------------+---------------------------------------------------------------------------------------------+ - | service_set_type | Integer | Service set type, 0 indicates a custom service set and 1 indicates a predefined service set | - +------------------+-------------------+---------------------------------------------------------------------------------------------+ - | ref_count | Integer | Reference count | - +------------------+-------------------+---------------------------------------------------------------------------------------------+ - | status | String | Status | - +------------------+-------------------+---------------------------------------------------------------------------------------------+ - | project_id | String | Project ID | - +------------------+-------------------+---------------------------------------------------------------------------------------------+ - | protocols | Array of integers | Protocols | - +------------------+-------------------+---------------------------------------------------------------------------------------------+ + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+===================+================================================================================================================================================================================+ + | set_id | String | Service group ID | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Name | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Description | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | Integer | Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ref_count | Integer | Reference count | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Status | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Project ID | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocols | Array of integers | Protocols | + +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** diff --git a/api-ref/source/api/service_set_management/querying_service_set_details.rst b/api-ref/source/api/service_set_management/querying_service_set_details.rst index 8ed7e1f..5a42e33 100644 --- a/api-ref/source/api/service_set_management/querying_service_set_details.rst +++ b/api-ref/source/api/service_set_management/querying_service_set_details.rst @@ -26,13 +26,15 @@ GET /v1/{project_id}/service-sets/{set_id} .. table:: **Table 2** Query Parameters - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -62,25 +64,25 @@ Response Parameters .. table:: **Table 5** ServiceSetDetailResponseDto - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=============================================================================================+ - | id | String | Service group ID | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | name | String | Service group name | - | | | | - | | | Minimum: **1** | - | | | | - | | | Maximum: **255** | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | description | String | Service group description | - | | | | - | | | Minimum: **1** | - | | | | - | | | Maximum: **255** | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | service_set_type | Integer | Service set type, 0 indicates a custom service set and 1 indicates a predefined service set | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================================================================================================================================================+ + | id | String | Service group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Service group name | + | | | | + | | | Minimum: **1** | + | | | | + | | | Maximum: **255** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Service group description | + | | | | + | | | Minimum: **1** | + | | | | + | | | Maximum: **255** | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | service_set_type | Integer | Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ **Status code: 400** diff --git a/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst b/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst index 3c504bd..f149108 100644 --- a/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst +++ b/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst @@ -25,21 +25,23 @@ GET /v1/{project_id}/service-items .. table:: **Table 2** Query Parameters - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | set_id | Yes | String | Service group ID | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | Query field | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | - +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | set_id | Yes | String | Service group ID | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | Query field | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | query_service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | + +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index a7fbd55..66d279e 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -5,8 +5,12 @@ Change History ============== -============ ========================================= -Release Date Description -============ ========================================= -2024-04-30 This issue is the first official release. -============ ========================================= ++-----------------------------------+-----------------------------------------------------------------------+ +| Release Date | Description | ++===================================+=======================================================================+ +| 2024-05-28 | This issue is the second official release. | +| | | +| | Modified the description about whether **X-Auth-Token** is mandatory. | ++-----------------------------------+-----------------------------------------------------------------------+ +| 2024-04-30 | This issue is the first official release. | ++-----------------------------------+-----------------------------------------------------------------------+