From c6f8dcefb620cdcd9dcaa6224e6df6731de47fab Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Wed, 3 Jul 2024 08:09:51 +0000 Subject: [PATCH] Update content --- .../creating_an_acl_rule.rst | 9 + .../acl_rule_management/delete_acl_rule.rst | 2 +- .../list_acl_rule_tags.rst | 10 +- .../querying_a_protection_rule.rst | 11 +- .../updating_an_acl_rule.rst | 6 + .../adding_an_address_set.rst | 34 ++-- .../batch_delete_address_items.rst | 10 +- .../querying_ip_address_sets.rst | 38 ++-- .../updating_address_set_information.rst | 28 +-- ...creating_a_blacklist_or_whitelist_rule.rst | 2 +- .../querying_a_blacklist_or_whitelist.rst | 6 +- .../updating_the_blacklist_or_whitelist.rst | 4 +- .../add_domain_set.rst | 8 +- .../add_domains.rst | 2 +- .../list_domain_sets.rst | 2 +- .../list_domains.rst | 2 +- .../querying_the_dns_server_list.rst | 2 +- .../update_domain_set.rst | 25 ++- .../updating_the_dns_server_list.rst | 2 +- .../querying_the_number_of_eips.rst | 2 +- .../firewall_management/create_firewall.rst | 12 +- .../querying_the_number_of_protected_vpcs.rst | 2 - .../enabling_or_disabling_ips.rst | 2 - .../switching_the_protection_mode.rst | 23 ++- .../querying_access_control_logs.rst | 6 +- .../log_management/querying_attack_logs.rst | 170 +++++++++--------- .../api/log_management/querying_flow_logs.rst | 8 +- .../creating_a_service_member.rst | 19 +- .../creating_a_service_set.rst | 57 +++--- .../modifying_a_service_set.rst | 23 ++- .../obtaining_the_service_set_list.rst | 2 - .../querying_the_service_set_member_list.rst | 4 +- api-ref/source/appendix/index.rst | 4 +- api-ref/source/change_history.rst | 28 +-- 34 files changed, 284 insertions(+), 281 deletions(-) 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 6e39396..68d37ad 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,7 +56,9 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | + | | | | | | | | | - **2** | +-----------------+-----------------+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | rules | Yes | Array of :ref:`rules ` objects | rules | @@ -78,7 +80,9 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | + | | | | | | | | | - **2** | +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | action_type | Yes | Integer | Action. 0: allow; 1: deny | @@ -88,6 +92,7 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | applications | No | Array of strings | applications | @@ -107,6 +112,7 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | description | No | String | Description | @@ -116,6 +122,7 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | source | Yes | :ref:`RuleAddressDtoForRequest ` object | Source address transmission object | @@ -174,6 +181,8 @@ Request Parameters +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | predefined_group | No | Array of strings | predefined group | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_group | No | Array of strings | address group | + +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_ipregiondto: diff --git a/api-ref/source/api/acl_rule_management/delete_acl_rule.rst b/api-ref/source/api/acl_rule_management/delete_acl_rule.rst index 9ed1206..dfa087a 100644 --- a/api-ref/source/api/acl_rule_management/delete_acl_rule.rst +++ b/api-ref/source/api/acl_rule_management/delete_acl_rule.rst @@ -55,7 +55,7 @@ Response Parameters +-----------+-------------------------------------------------------+-------------+ | Parameter | Type | Description | +===========+=======================================================+=============+ - | data | :ref:`RuleId ` object | | + | data | :ref:`RuleId ` object | Rule Id | +-----------+-------------------------------------------------------+-------------+ .. _deleteaclrule__response_ruleid: diff --git a/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst b/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst index ca369aa..be8a336 100644 --- a/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst +++ b/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst @@ -103,6 +103,8 @@ Example Responses **Status code: 200** +Get acl tag response + .. code-block:: { @@ -129,11 +131,11 @@ Example Responses Status Codes ------------ -=========== =========== +=========== ==================== Status Code Description -=========== =========== -200 -=========== =========== +=========== ==================== +200 Get acl tag response +=========== ==================== Error Codes ----------- 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 04b3520..a061024 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,7 +35,9 @@ GET /v1/{project_id}/acl-rules | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | + | | | | | | | | | - **2** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip | No | String | IP address | @@ -49,6 +51,7 @@ GET /v1/{project_id}/acl-rules | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | action_type | No | Integer | Action. 0: allow; 1: deny | @@ -56,6 +59,7 @@ GET /v1/{project_id}/acl-rules | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | address_type | No | Integer | Address type. The value can be 0 (IPv4). | @@ -63,7 +67,9 @@ GET /v1/{project_id}/acl-rules | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | + | | | | | | | | | - **2** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | @@ -145,7 +151,8 @@ Response Parameters | | | Enumeration values: | | | | | | | | - **0** | - | | | - **1end_time** | + | | | | + | | | - **1** | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | action_type | Integer | Action. 0: allow; 1: deny | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ @@ -174,7 +181,9 @@ Response Parameters | | | Enumeration values: | | | | | | | | - **0** | + | | | | | | | - **1** | + | | | | | | | - **2** | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | created_date | String | Created time | 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 28aad5a..97414c1 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,6 +55,7 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | name | No | String | Rule name | @@ -66,6 +67,7 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | action_type | No | Integer | Action. 0: allow; 1: deny | @@ -73,6 +75,7 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | status | No | Integer | Rule delivery status. 0: disabled; 1: enabled. | @@ -96,6 +99,7 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | source | No | :ref:`RuleAddressDto ` object | rule address dto | @@ -109,7 +113,9 @@ Request Parameters | | | | Enumeration values: | | | | | | | | | | - **0** | + | | | | | | | | | - **1** | + | | | | | | | | | - **2** | +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | tag | No | :ref:`TagsVO ` object | tag | diff --git a/api-ref/source/api/address_set_management/adding_an_address_set.rst b/api-ref/source/api/address_set_management/adding_an_address_set.rst index 933bc7a..d04eb5d 100644 --- a/api-ref/source/api/address_set_management/adding_an_address_set.rst +++ b/api-ref/source/api/address_set_management/adding_an_address_set.rst @@ -46,23 +46,23 @@ Request Parameters .. table:: **Table 4** Request body 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. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | IP address group name | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Address group description | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Internet border Protected object ID, 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. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | Yes | String | IP address group name | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Address group description | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | | + | | | | - **1** | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- diff --git a/api-ref/source/api/address_set_management/batch_delete_address_items.rst b/api-ref/source/api/address_set_management/batch_delete_address_items.rst index 06711f5..0dc9516 100644 --- a/api-ref/source/api/address_set_management/batch_delete_address_items.rst +++ b/api-ref/source/api/address_set_management/batch_delete_address_items.rst @@ -85,6 +85,8 @@ Example Responses **Status code: 200** +Batch delete address items response + .. code-block:: { @@ -94,11 +96,11 @@ Example Responses Status Codes ------------ -=========== =========== +=========== =================================== Status Code Description -=========== =========== -200 -=========== =========== +=========== =================================== +200 Batch delete address items response +=========== =================================== Error Codes ----------- 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 e693d1f..3e02ab8 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 @@ -28,7 +28,7 @@ GET /v1/{project_id}/address-sets +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | object_id | Yes | String | Internet border Protected object ID, 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. | +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | key_word | No | String | Keyword | +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -52,6 +52,8 @@ GET /v1/{project_id}/address-sets +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 ------------------ @@ -97,23 +99,23 @@ Response Parameters .. table:: **Table 6** records - +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | set_id | String | ID of the IP address group | - +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ref_count | Integer | Reference count | - +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description | - +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | IP address group name | - +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | - +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 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. | - +------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +==================+=========+=====================================================================================================================================================================================================================================================================================+ + | set_id | String | ID of the IP address group | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ref_count | Integer | Reference count | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Description | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | IP address group name | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | address_type | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | object_id | String | Internet border Protected object ID, 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. | + +------------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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/address_set_management/updating_address_set_information.rst b/api-ref/source/api/address_set_management/updating_address_set_information.rst index 28c2875..faad909 100644 --- a/api-ref/source/api/address_set_management/updating_address_set_information.rst +++ b/api-ref/source/api/address_set_management/updating_address_set_information.rst @@ -47,23 +47,12 @@ Request Parameters .. table:: **Table 4** Request body parameters - +-----------------+-----------------+-----------------+-------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===================================================================+ - | name | No | String | IP address group name | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------+ - | description | No | String | Address group description | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------+ - | address_type | No | Integer | Address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - | | | | | - | | | | - **2** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------+ + =========== ========= ====== ========================= + Parameter Mandatory Type Description + =========== ========= ====== ========================= + name No String IP address group name + description No String Address group description + =========== ========= ====== ========================= Response Parameters ------------------- @@ -111,7 +100,7 @@ Response Parameters Example Requests ---------------- -In the project 9d80d070b6d44942af73c9c3d38e0429, change the name of the address set whose ID is cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 to ABCD. Change its address set type to IPV4. +In the project 9d80d070b6d44942af73c9c3d38e0429, change the name of the address set whose ID is cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 to ABCD. .. code-block:: @@ -119,8 +108,7 @@ In the project 9d80d070b6d44942af73c9c3d38e0429, change the name of the address { "name" : "ABCD", - "description" : "", - "address_type" : 0 + "description" : "" } Example Responses diff --git a/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst b/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst index 60b5df5..f0da7fe 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst +++ b/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst @@ -55,7 +55,7 @@ Request Parameters +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | direction | Yes | Integer | Indicates the address direction. 0: source address 1: destination address | +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Yes | Integer | IP address type. 0: ipv4; 1: ipv6; 2: domain | + | address_type | Yes | Integer | IP address type. 0: ipv4; 1: ipv6 | +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | address | Yes | String | Address type | +--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 cb73f8a..3dd7274 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 @@ -28,7 +28,7 @@ GET /v1/{project_id}/black-white-lists +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | object_id | Yes | String | Internet border Protected object ID, 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. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | list_type | Yes | Integer | Blacklist/Whitelist type. The options are 4 (blacklist) and 5 (whitelist). | | | | | | @@ -38,7 +38,7 @@ GET /v1/{project_id}/black-white-lists | | | | | | | | | - **5** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | Specifies the IP address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain). | + | address_type | No | Integer | Specifies the IP address type. The value can be 0 (IPv4), 1 (IPv6). | | | | | | | | | | Enumeration values: | | | | | | @@ -112,7 +112,7 @@ Response Parameters +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | direction | Integer | Direction of a black or white address. 0: source address; 1: destination address. | +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | IP address type. 0: ipv4; 1: ipv6; 2: domain | + | address_type | Integer | IP address type. 0: ipv4; 1: ipv6 | +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | address | String | IP address | +--------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 7cbe3a3..0addfe4 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 @@ -52,9 +52,9 @@ Request Parameters +==============+===========+=========+========================================================================================================+ | 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_type | No | Integer | Address type. 0: ipv4; 1: ipv6 | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ - | address | No | String | IP address | + | address | Yes | 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. | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+ 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 0618ba7..9b19a6f 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 @@ -51,13 +51,13 @@ Request Parameters +=================+===========+===================================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | 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. | +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | + | object_id | Yes | String | Internet border Protected object ID, 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. | +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | Yes | String | name | +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | No | String | description | +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_names | No | Array of :ref:`DomainSetInfoDto ` objects | domain names | + | domain_names | Yes | Array of :ref:`DomainSetInfoDto ` objects | domain names | +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | domain_set_type | Yes | Integer | Domain name group type. 0 means Application type and 1 means Network type. | +-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,7 +69,7 @@ Request Parameters =========== ========= ====== =========== Parameter Mandatory Type Description =========== ========= ====== =========== - domain_name No String domain name + domain_name Yes String domain name description No String description =========== ========= ====== =========== @@ -100,7 +100,7 @@ Response Parameters Example Requests ---------------- -Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2. +Add a domain set whose project ID is 9d80d070b6d44942af73c9c3d38e0429, firewall ID is 546af3f8-88e9-47f2-a205-2346d7090925, domain set name is test, domain name is www.aaa.com, and protected object ID is fde07429-2e02-45c0-a85f-4f1cacea24d2 and domain set type is application type. .. code-block:: diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst b/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst index 0a8ddee..0cb7307 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst @@ -64,7 +64,7 @@ Request Parameters =========== ========= ====== =========== Parameter Mandatory Type Description =========== ========= ====== =========== - domain_name No String domain name + domain_name Yes String domain name description No String description =========== ========= ====== =========== 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 c3cedc5..4141ba5 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 @@ -36,7 +36,7 @@ GET /v1/{project_id}/domain-sets +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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**. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | + | object_id | Yes | String | Internet border Protected object ID, 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. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | key_word | No | String | key | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 627ba30..6141365 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,7 +39,7 @@ GET /v1/{project_id}/domain-set/domains/{domain_set_id} +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | domain_name | No | String | domain name | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | + | object_Id | No | String | Internet border Protected object ID, 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. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request 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 325b9f3..0731f8b 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://console.xxxxxx.com/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers + https://console.example.com/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers Example Responses ----------------- 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 2784f8f..6e90d4b 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 @@ -17,12 +17,12 @@ PUT /v1/{project_id}/domain-set/{set_id} .. table:: **Table 1** Path Parameters - ========== ========= ====== =========== + ========== ========= ====== ============= Parameter Mandatory Type Description - ========== ========= ====== =========== + ========== ========= ====== ============= project_id Yes String project ID - set_id Yes String set id - ========== ========= ====== =========== + set_id Yes String domain set id + ========== ========= ====== ============= .. table:: **Table 2** Query Parameters @@ -47,17 +47,12 @@ 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 name group type. 0 means Application type and 1 means Network type. | - +-----------------+-----------+---------+----------------------------------------------------------------------------+ + =========== ========= ====== =========== + Parameter Mandatory Type Description + =========== ========= ====== =========== + name Yes String name + description No String description + =========== ========= ====== =========== Response Parameters ------------------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst b/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst index 07784cf..c6cecd3 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst @@ -49,7 +49,7 @@ Request Parameters +--------------------------+-----------+---------------------------------------------------------------------------+--------------------------+ | Parameter | Mandatory | Type | Description | +==========================+===========+===========================================================================+==========================+ - | dns_server | No | Array of :ref:`dns_server ` objects | DNS server | + | dns_server | Yes | Array of :ref:`dns_server ` objects | DNS server | +--------------------------+-----------+---------------------------------------------------------------------------+--------------------------+ | health_check_domain_name | No | String | Health check domain name | +--------------------------+-----------+---------------------------------------------------------------------------+--------------------------+ diff --git a/api-ref/source/api/eip_management/querying_the_number_of_eips.rst b/api-ref/source/api/eip_management/querying_the_number_of_eips.rst index 6b2ce57..e8fa795 100644 --- a/api-ref/source/api/eip_management/querying_the_number_of_eips.rst +++ b/api-ref/source/api/eip_management/querying_the_number_of_eips.rst @@ -138,7 +138,7 @@ OK "eip_protected" : 1, "eip_protected_self" : 4, "eip_total" : 5, - "object_id" : "6d3db4fd-fd58-4d8e-914b-ef91aa268f62" + "object_id" : "" } } diff --git a/api-ref/source/api/firewall_management/create_firewall.rst b/api-ref/source/api/firewall_management/create_firewall.rst index 55073d8..ce52d5e 100644 --- a/api-ref/source/api/firewall_management/create_firewall.rst +++ b/api-ref/source/api/firewall_management/create_firewall.rst @@ -51,7 +51,7 @@ Request Parameters +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | tags | No | Array of :ref:`tags ` objects | Resource Tag | +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | flavor | No | :ref:`flavor ` object | flavor | + | flavor | Yes | :ref:`flavor ` object | flavor | +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ | charge_info | Yes | :ref:`charge_info ` object | Billing type information, prepaid and postpaid, the default is postpaid. | +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ @@ -63,8 +63,8 @@ Request Parameters ========= ========= ====== =========== Parameter Mandatory Type Description ========= ========= ====== =========== - key Yes String Tag Key - value Yes String Tag Value + key No String Tag Key + value No String Tag Value ========= ========= ====== =========== .. _createfirewall__request_flavor: @@ -74,7 +74,7 @@ Request Parameters +------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==================+=================+=================+================================================================================================================================================================================================+ - | version | No | String | Firewall version: If charge_mode is set to prePaid, only the Professional Edition is supported, and when charge_mode is set to postPaid, the Standard and Professional Editions are supported. | + | version | Yes | String | Firewall version: If charge_mode is set to postPaid, only the Professional Edition is supported, and when charge_mode is set to prePaid, the Standard and Professional Editions are supported. | | | | | | | | | | Enumeration values: | | | | | | @@ -180,7 +180,7 @@ Response Parameters +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================+================================================================================================================================================================================================+ - | version | String | Firewall version: If charge_mode is set to prePaid, only the Professional Edition is supported, and when charge_mode is set to postPaid, the Standard and Professional Editions are supported. | + | version | String | Firewall version: If charge_mode is set to postPaid, only the Professional Edition is supported, and when charge_mode is set to prePaid, the Standard and Professional Editions are supported. | | | | | | | | Enumeration values: | | | | | @@ -268,7 +268,7 @@ Enable a standard firewall with 2000 extended EIP, 5,000 Mbps extended protectio "value" : "TagVal" } ], "flavor" : { - "version" : "standard", + "version" : "Standard", "extend_eip_count" : 2000, "extend_bandwidth" : 5000, "extend_vpc_count" : 100 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 45180fb..d681614 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 @@ -56,8 +56,6 @@ Response Parameters +-----------+-------------------------------------------------------------------------+--------------------------------+ | Parameter | Type | Description | +===========+=========================================================================+================================+ - | trace_id | String | Call chain ID | - +-----------+-------------------------------------------------------------------------+--------------------------------+ | data | :ref:`VPCProtectsVo ` object | Return value of VPC protection | +-----------+-------------------------------------------------------------------------+--------------------------------+ diff --git a/api-ref/source/api/ips_management/enabling_or_disabling_ips.rst b/api-ref/source/api/ips_management/enabling_or_disabling_ips.rst index d4b496f..d06eaa6 100644 --- a/api-ref/source/api/ips_management/enabling_or_disabling_ips.rst +++ b/api-ref/source/api/ips_management/enabling_or_disabling_ips.rst @@ -74,8 +74,6 @@ Response Parameters +-----------+-----------------------------------------------------------+-------------+ | Parameter | Type | Description | +===========+===========================================================+=============+ - | trace_id | String | trace_id | - +-----------+-----------------------------------------------------------+-------------+ | data | :ref:`data ` object | object | +-----------+-----------------------------------------------------------+-------------+ diff --git a/api-ref/source/api/ips_management/switching_the_protection_mode.rst b/api-ref/source/api/ips_management/switching_the_protection_mode.rst index 39f4a44..4f04380 100644 --- a/api-ref/source/api/ips_management/switching_the_protection_mode.rst +++ b/api-ref/source/api/ips_management/switching_the_protection_mode.rst @@ -61,22 +61,21 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+------------------------------------------------------------------+--------------------------------+ - | Parameter | Type | Description | - +===========+==================================================================+================================+ - | data | :ref:`IdObject ` object | Update the IPS protection mode | - +-----------+------------------------------------------------------------------+--------------------------------+ + +-----------+----------------------------------------------------------+-------------+ + | Parameter | Type | Description | + +===========+==========================================================+=============+ + | data | :ref:`data ` object | object | + +-----------+----------------------------------------------------------+-------------+ -.. _changeipsprotectmode__response_idobject: +.. _changeipsprotectmode__response_data: -.. table:: **Table 6** IdObject +.. table:: **Table 6** data - ========= ====== =========== + ========= ====== =================== Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== + ========= ====== =================== + id String Protected object ID + ========= ====== =================== **Status code: 400** 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 379612f..92c6288 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 @@ -32,9 +32,9 @@ GET /v1/{project_id}/cfw/logs/access-control +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | rule_id | No | String | Rule ID | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Yes | Long | Start time | + | start_time | Yes | Long | Start time, a timestamp in milliseconds, such as 1718936272648 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | Yes | Long | End time | + | end_time | Yes | Long | End time, a timestamp in milliseconds, such as 1718936272648 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | src_ip | No | String | Source IP address | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -138,7 +138,7 @@ Response Parameters +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | rule_id | String | Rule ID | +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hit_time | Long | Hit time | + | hit_time | Long | Hit time, a timestamp in milliseconds, such as 1718936272648 | +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | src_region_id | String | source region id | +-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 a2efc9c..667fe0e 100644 --- a/api-ref/source/api/log_management/querying_attack_logs.rst +++ b/api-ref/source/api/log_management/querying_attack_logs.rst @@ -28,9 +28,9 @@ GET /v1/{project_id}/cfw/logs/attack +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=======================+=================+=================+================================================================================================================================================================================================================================+ - | start_time | Yes | Long | Start time | + | start_time | Yes | Long | Start time, a timestamp in milliseconds, such as 1718936272648 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | Yes | Long | End time | + | end_time | Yes | Long | End time, a timestamp in milliseconds, such as 1718936272648 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | src_ip | No | String | Source IP address | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -68,14 +68,9 @@ GET /v1/{project_id}/cfw/logs/attack +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | attack_type | No | String | Intrusion event type | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | attack_rule | No | String | Intrusion event rule | + | attack_rule | No | String | Intrusion event rule, Including CRITICAL,HIGH,MEDIUM,LOW. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | level | No | String | Threat level | - | | | | | - | | | | - **CRITICAL** | - | | | | - **HIGH** | - | | | | - **MEDIUM** | - | | | | - **LOW** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | source | No | String | Source | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -88,7 +83,9 @@ GET /v1/{project_id}/cfw/logs/attack | | | | Enumeration values: | | | | | | | | | | - **internet** | + | | | | | | | | | - **nat** | + | | | | | | | | | - **vpc** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | attack_rule_id | No | String | attack rule id | @@ -148,84 +145,85 @@ Response Parameters .. table:: **Table 6** records - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================+=============================================+ - | direction | String | Direction, which can be inbound or outbound | - | | | | - | | | Enumeration values: | - | | | | - | | | - **out2in** | - | | | - **in2out** | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | action | String | Action | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | event_time | Long | Event time | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | attack_type | String | Attack type | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | attack_rule | String | Attack rule | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | level | String | Threat level | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | source | String | Source | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | packet_length | Long | Packet length | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | attack_rule_id | String | Attack rule ID | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | hit_time | Integer | Hit time | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | log_id | String | Log ID | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | src_ip | String | Source IP address | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | src_port | Integer | Source port | - | | | | - | | | Minimum: **0** | - | | | | - | | | Maximum: **65535** | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | dst_ip | String | Destination IP address | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | dst_port | Integer | Destination port | - | | | | - | | | Minimum: **0** | - | | | | - | | | Maximum: **65535** | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | protocol | String | Protocol | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | packet | String | Attack log packet | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | app | String | Application protocol | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | packetMessages | Array of :ref:`PacketMessage ` objects | packet message | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | 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 | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ - | 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 | - +-----------------------+--------------------------------------------------------------------------------+---------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================================================+================================================================+ + | direction | String | Direction, which can be inbound or outbound | + | | | | + | | | Enumeration values: | + | | | | + | | | - **out2in** | + | | | | + | | | - **in2out** | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | action | String | Action | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | event_time | Long | Event time, a timestamp in milliseconds, such as 1718936272648 | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | attack_type | String | Attack type | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | attack_rule | String | Attack rule | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | level | String | Threat level | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | source | String | Source | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | packet_length | Long | Packet length | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | attack_rule_id | String | Attack rule ID | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | hit_time | Integer | Hit time, a timestamp in milliseconds, such as 1718936272648 | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | log_id | String | Log ID | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | src_ip | String | Source IP address | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | src_port | Integer | Source port | + | | | | + | | | Minimum: **0** | + | | | | + | | | Maximum: **65535** | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | dst_ip | String | Destination IP address | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | dst_port | Integer | Destination port | + | | | | + | | | Minimum: **0** | + | | | | + | | | Maximum: **65535** | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | protocol | String | Protocol | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | packet | String | Attack log packet | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | app | String | Application protocol | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | packetMessages | Array of :ref:`PacketMessage ` objects | packet message | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | 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 | + +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+ + | 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: 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 9eceded..e89492b 100644 --- a/api-ref/source/api/log_management/querying_flow_logs.rst +++ b/api-ref/source/api/log_management/querying_flow_logs.rst @@ -42,9 +42,9 @@ GET /v1/{project_id}/cfw/logs/flow | | | | | | | | | - **nat** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Yes | Long | Start time | + | start_time | Yes | Long | Start time, a timestamp in milliseconds, such as 1718936272648 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | Yes | Long | End time | + | end_time | Yes | Long | End time, a timestamp in milliseconds, such as 1718936272648 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | src_ip | No | String | Source IP address | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -152,9 +152,9 @@ Response Parameters +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | packets | Integer | Packet | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Long | Start time | + | start_time | Long | Start time, a timestamp in milliseconds, such as 1718936272648 | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | Long | End time | + | end_time | Long | End time, a timestamp in milliseconds, such as 1718936272648 | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | log_id | String | Document ID | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 16abd87..35aa72c 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 @@ -67,8 +67,6 @@ Request Parameters +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dest_port | Yes | String | Destination port | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Service member name | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | No | String | Service member description | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -89,21 +87,20 @@ Response Parameters .. table:: **Table 7** ServiceItemIds - +-----------+-----------------------------------------------------------------------+------------------------------+ - | Parameter | Type | Description | - +===========+=======================================================================+==============================+ - | items | Array of :ref:`IdObject ` objects | Service group member ID list | - +-----------+-----------------------------------------------------------------------+------------------------------+ + +-----------+-----------------------------------------------------------------+----------------------+ + | Parameter | Type | Description | + +===========+=================================================================+======================+ + | items | Array of :ref:`items ` objects | service item id list | + +-----------+-----------------------------------------------------------------+----------------------+ -.. _addserviceitems__response_idobject: +.. _addserviceitems__response_items: -.. table:: **Table 8** IdObject +.. table:: **Table 8** items ========= ====== =========== Parameter Type Description ========= ====== =========== - id String ID - name String name + id String id ========= ====== =========== **Status code: 400** diff --git a/api-ref/source/api/service_set_management/creating_a_service_set.rst b/api-ref/source/api/service_set_management/creating_a_service_set.rst index 116c0ff..06764b5 100644 --- a/api-ref/source/api/service_set_management/creating_a_service_set.rst +++ b/api-ref/source/api/service_set_management/creating_a_service_set.rst @@ -46,23 +46,23 @@ Request Parameters .. table:: **Table 4** Request body 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. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | Service group name | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **255** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Service group description | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Maximum: **255** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+=====================================================================================================================================================================================================================================================================================+ + | object_id | Yes | String | Internet border Protected object ID, 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. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | Yes | String | Service group name | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **255** | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Service group description | + | | | | | + | | | | Minimum: **1** | + | | | | | + | | | | Maximum: **255** | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters ------------------- @@ -71,22 +71,21 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+-----------------------------------------------------------+-----------------------------------------------+ - | Parameter | Type | Description | - +===========+===========================================================+===============================================+ - | data | :ref:`IdObject ` object | Data returned when a service group is created | - +-----------+-----------------------------------------------------------+-----------------------------------------------+ + ========= ================================================= =========== + Parameter Type Description + ========= ================================================= =========== + data :ref:`data ` object object + ========= ================================================= =========== -.. _addserviceset__response_idobject: +.. _addserviceset__response_data: -.. table:: **Table 6** IdObject +.. table:: **Table 6** data - ========= ====== =========== + ========= ====== =================== Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== + ========= ====== =================== + id String Protected object ID + ========= ====== =================== **Status code: 400** diff --git a/api-ref/source/api/service_set_management/modifying_a_service_set.rst b/api-ref/source/api/service_set_management/modifying_a_service_set.rst index ddc66a5..dc353cb 100644 --- a/api-ref/source/api/service_set_management/modifying_a_service_set.rst +++ b/api-ref/source/api/service_set_management/modifying_a_service_set.rst @@ -70,22 +70,21 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------+--------------------------------------------------------------+-----------------------------------------------+ - | Parameter | Type | Description | - +===========+==============================================================+===============================================+ - | data | :ref:`IdObject ` object | Data returned when a service group is updated | - +-----------+--------------------------------------------------------------+-----------------------------------------------+ + +-----------+------------------------------------------------------+-------------+ + | Parameter | Type | Description | + +===========+======================================================+=============+ + | data | :ref:`data ` object | object | + +-----------+------------------------------------------------------+-------------+ -.. _updateserviceset__response_idobject: +.. _updateserviceset__response_data: -.. table:: **Table 6** IdObject +.. table:: **Table 6** data - ========= ====== =========== + ========= ====== =================== Parameter Type Description - ========= ====== =========== - id String ID - name String name - ========= ====== =========== + ========= ====== =================== + id String Protected object ID + ========= ====== =================== **Status code: 400** 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 364e75f..b3ed8ac 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 @@ -106,8 +106,6 @@ Response Parameters +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ref_count | Integer | Reference count | +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Status | - +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | project_id | String | Project ID | +------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocols | Array of integers | Protocols | 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 f149108..b0cdc1c 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 @@ -40,7 +40,7 @@ GET /v1/{project_id}/service-items +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | query_service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set, Takes effect only if the set_id is a predefined service set ID | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -100,8 +100,6 @@ Response Parameters +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dest_port | String | Destination port | +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Service member name | - +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | String | Service member description | +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/appendix/index.rst b/api-ref/source/appendix/index.rst index 23f3319..b2dd1a1 100644 --- a/api-ref/source/appendix/index.rst +++ b/api-ref/source/appendix/index.rst @@ -1,6 +1,6 @@ -:original_name: cfw_02_0011.html +:original_name: cfw_02_0023.html -.. _cfw_02_0011: +.. _cfw_02_0023: Appendix ======== diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 66d279e..9992aee 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -1,16 +1,22 @@ -:original_name: cfw_02_0016.html +:original_name: cfw_02_0017.html -.. _cfw_02_0016: +.. _cfw_02_0017: Change History ============== -+-----------------------------------+-----------------------------------------------------------------------+ -| 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. | -+-----------------------------------+-----------------------------------------------------------------------+ ++-----------------------------------+----------------------------------------------------------------------------------+ +| Release Date | Description | ++===================================+==================================================================================+ +| 2024-07-02 | This issue is the third official release. | +| | | +| | Deleted: | +| | | +| | - The **address_type** parameter in the "Updating Address Set Information" API. | ++-----------------------------------+----------------------------------------------------------------------------------+ +| 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. | ++-----------------------------------+----------------------------------------------------------------------------------+