lbelejka/cloud-firewall
1
0
Fork 0
forked from docs/cloud-firewall
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2024-06-03 09:20:28 +00:00 committed by Lukas Belejkanic
parent 35a6ebc9d7
commit 6546da69b1
33 changed files with 987 additions and 798 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

216
api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst
View File

@ -41,7 +41,7 @@ Request Parameters
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+====================================================================================================================================================+
| X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 4** Request body parameters

254
api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst
View File

@ -54,6 +54,8 @@ Request Parameters
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| top | No | Integer | Whether to pin on top. The options are as follows: 0: no; 1: yes. |
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0: no; 1: yes. |
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------

135
api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst
View File

File diff suppressed because it is too large Load Diff

40
api-ref/source/api/address_set_management/querying_address_set_details.rst
View File

@ -35,6 +35,8 @@ GET /v1/{project_id}/address-sets/{set_id}
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| query_address_set_type | No | Integer | Query address set type, 0 indicates a custom address set and 1 indicates a predefined address set |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -64,25 +66,25 @@ Response Parameters
.. table:: **Table 5** data
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=============================================================================================+
| id | String | ID of the IP address group |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| name | String | IP address group name |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| description | String | Address group description |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| address_set_type | Integer | Address set type, 0 indicates a custom address set and 1 indicates a predefined address set |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| address_type | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). |
| | | |
| | | Enumeration values: |
| | | |
| | | - **0** |
| | | |
| | | - **1** |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+====================================================================================================================================================================================================================+
| id | String | ID of the IP address group |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | IP address group name |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Address group description |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_type | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). |
| | | |
| | | Enumeration values: |
| | | |
| | | - **0** |
| | | |
| | | - **1** |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**

36
api-ref/source/api/address_set_management/querying_address_set_members.rst
View File

@ -25,23 +25,25 @@ GET /v1/{project_id}/address-items
.. table:: **Table 2** Query Parameters
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| set_id | Yes | String | ID of the IP address group |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| key_word | No | String | Keyword |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address | No | String | IP address |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| set_id | Yes | String | ID of the IP address group |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| key_word | No | String | Keyword |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address | No | String | IP address |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| query_address_set_type | No | Integer | Query address set type, 0 means custom define address set, 1 means predefined address set |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------

2
api-ref/source/api/address_set_management/querying_ip_address_sets.rst
View File

@ -112,7 +112,7 @@ Response Parameters
+------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. |
+------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_set_type | Integer | Address set type, 0 indicates a custom address set and 1 indicates a predefined address set |
| address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. |
+------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**

24
api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst
View File

@ -89,19 +89,17 @@ Response Parameters
.. table:: **Table 5** data
+-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+=========================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| object_id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. |
+-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. |
+-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | Integer | Number of records displayed on each page, in the range 1-1024 |
+-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| total | Integer | Total number of queried records |
+-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| records | Array of :ref:`records <listblackwhitelists__response_records>` objects | Blacklist and whitelist records |
+-----------+-------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+=========================================================================+=================================================================================================================================================+
| offset | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. |
+-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | Integer | Number of records displayed on each page, in the range 1-1024 |
+-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| total | Integer | Total number of queried records |
+-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| records | Array of :ref:`records <listblackwhitelists__response_records>` objects | Blacklist and whitelist records |
+-----------+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
.. _listblackwhitelists__response_records:

40
api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst
View File

@ -47,31 +47,21 @@ Request Parameters
.. table:: **Table 4** Request body parameters
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| direction | No | Integer | Indicates the address direction. 0: source address 1: destination address |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_type | No | Integer | Address type. 0: ipv4; 1: ipv6; 2: domain |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address | No | String | IP address |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | No | Integer | Protocol type. The value is 6 for TCP, 17 for UDP, 1 for ICMP, 58 for ICMPv6, and -1 for any protocol. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port | No | String | Port |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| list_type | No | Integer | Blacklist/Whitelist type. The options are 4 (blacklist) and 5 (whitelist). |
| | | | |
| | | | Enumeration values: |
| | | | |
| | | | - **4** |
| | | | |
| | | | - **5** |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| object_id | No | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | description |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+=========+========================================================================================================+
| direction | No | Integer | Indicates the address direction. 0: source address 1: destination address |
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+
| address_type | No | Integer | Address type. 0: ipv4; 1: ipv6; 2: domain |
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+
| address | No | String | IP address |
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+
| protocol | No | Integer | Protocol type. The value is 6 for TCP, 17 for UDP, 1 for ICMP, 58 for ICMPv6, and -1 for any protocol. |
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+
| port | No | String | Port |
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+
| description | No | String | description |
+--------------+-----------+---------+--------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------

2
api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst
View File

@ -59,7 +59,7 @@ Request Parameters
+-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| domain_names | No | Array of :ref:`DomainSetInfoDto <adddomainset__request_domainsetinfodto>` objects | domain names |
+-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| domain_set_type | Yes | Integer | Domain set type, 0 means URL filtering, 1 means domain parse |
| domain_set_type | Yes | Integer | Domain name group type. 0 means Application type and 1 means Network type. |
+-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _adddomainset__request_domainsetinfodto:

43
api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst
View File

@ -40,7 +40,7 @@ GET /v1/{project_id}/domain-sets
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| key_word | No | String | key |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| domain_set_type | No | Integer | Domain set type, 0 means URL filtering, 1 means domain parse |
| domain_set_type | No | Integer | Domain name group type. 0 means Application type and 1 means Network type. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| config_status | No | Integer | config status |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -89,17 +89,36 @@ Response Parameters
.. table:: **Table 6** DomainSetVo
=============== ======= ===============
Parameter Type Description
=============== ======= ===============
set_id String set id
name String domain set name
description String description
ref_count Integer reference count
domain_set_type Integer domain set type
config_status Integer config status
message String message
=============== ======= ===============
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========================================================================+============================================================================+
| set_id | String | set id |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| name | String | domain set name |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| description | String | description |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| ref_count | Integer | reference count |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| domain_set_type | Integer | Domain name group type. 0 means Application type and 1 means Network type. |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| config_status | Integer | config status |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| message | String | message |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| rules | Array of :ref:`UseRuleVO <listdomainsets__response_userulevo>` objects | used rule list |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
.. _listdomainsets__response_userulevo:
.. table:: **Table 7** UseRuleVO
========= ====== ===========
Parameter Type Description
========= ====== ===========
id String rule id
name String rule name
========= ====== ===========
Example Requests
----------------

6
api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst
View File

@ -39,10 +39,6 @@ GET /v1/{project_id}/domain-set/domains/{domain_set_id}
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| domain_name | No | String | domain name |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | description |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| set_id | No | String | domain_set_id |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| object_Id | No | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -54,7 +50,7 @@ Request Parameters
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+====================================================================================================================================================+
| X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters

2
api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst
View File

@ -88,7 +88,7 @@ Obtain the DNS server list of the project whose ID is 2349ba469daf4b7daf268bb026
.. code-block::
https://endpoint/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers
https://console.xxxxxx.com/cfw/v1/2349ba469daf4b7daf268bb0261d18b0/dns/servers
Example Responses
-----------------

18
api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst
View File

@ -26,15 +26,15 @@ GET /v1/{project_id}/domain/parse/{domain_name}
.. table:: **Table 2** Query Parameters
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_type | No | String | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_type | No | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------

21
api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst
View File

@ -31,7 +31,7 @@ PUT /v1/{project_id}/domain-set/{set_id}
+=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
| fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
@ -47,14 +47,17 @@ Request Parameters
.. table:: **Table 4** Request body parameters
=============== ========= ======= ===============
Parameter Mandatory Type Description
=============== ========= ======= ===============
name Yes String name
description No String description
set_id No String domain set id
domain_set_type No Integer domain set type
=============== ========= ======= ===============
+-----------------+-----------+---------+----------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+===========+=========+============================================================================+
| name | Yes | String | name |
+-----------------+-----------+---------+----------------------------------------------------------------------------+
| description | No | String | description |
+-----------------+-----------+---------+----------------------------------------------------------------------------+
| set_id | No | String | domain set id |
+-----------------+-----------+---------+----------------------------------------------------------------------------+
| domain_set_type | No | Integer | Domain name group type. 0 means Application type and 1 means Network type. |
+-----------------+-----------+---------+----------------------------------------------------------------------------+
Response Parameters
-------------------

6
api-ref/source/api/eip_management/querying_the_eip_list.rst
View File

@ -49,7 +49,9 @@ GET /v1/{project_id}/eips/protect
| | | | Enumeration values: |
| | | | |
| | | | - **null** |
| | | | |
| | | | - **0** |
| | | | |
| | | | - **1** |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| sync | No | Integer | Specifies whether to synchronize tenant EIP data. The options are as follows: 0: no; 1: yes |
@ -57,6 +59,7 @@ GET /v1/{project_id}/eips/protect
| | | | Enumeration values: |
| | | | |
| | | | - **0** |
| | | | |
| | | | - **1** |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 |
@ -138,6 +141,7 @@ Response Parameters
| | | Enumeration values: |
| | | |
| | | - **0** |
| | | |
| | | - **1** |
+--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| public_ipv6 | String | EIP IPv6 |
@ -215,7 +219,7 @@ Return value of EIP data query
"associate_instance_type" : "PORT",
"device_id" : "c87579ab-c76a-4afd-83ce-62e0f531f13e",
"device_name" : "test",
"device_owner" : "compute:endpoint",
"device_owner" : "compute:test",
"domain_id" : "7d07807209524a4280266db9df63c4fa",
"enterprise_project_id" : "0",
"fw_domain_id" : "7d07807209524a4280266db9df63c4fa",

61
api-ref/source/api/firewall_management/create_east_west_firewall.rst
View File

@ -63,22 +63,47 @@ Response Parameters
.. table:: **Table 5** Response body parameters
+-----------+--------------------------------------------------------------------+------------------------------------+
| Parameter | Type | Description |
+===========+====================================================================+====================================+
| data | :ref:`IdObject <createeastwestfirewall__response_idobject>` object | create east west firewall response |
+-----------+--------------------------------------------------------------------+------------------------------------+
+-----------+--------------------------------------------------------------------------------------------+------------------------------------+
| Parameter | Type | Description |
+===========+============================================================================================+====================================+
| data | :ref:`CreateEWFirewallResp <createeastwestfirewall__response_createewfirewallresp>` object | create east west firewall response |
+-----------+--------------------------------------------------------------------------------------------+------------------------------------+
.. _createeastwestfirewall__response_idobject:
.. _createeastwestfirewall__response_createewfirewallresp:
.. table:: **Table 6** IdObject
.. table:: **Table 6** CreateEWFirewallResp
========= ====== ===========
Parameter Type Description
========= ====== ===========
id String ID
name String name
========= ====== ===========
+----------------+----------------------------------------------------------------------------------------------------------------+----------------+
| Parameter | Type | Description |
+================+================================================================================================================+================+
| id | String | Id |
+----------------+----------------------------------------------------------------------------------------------------------------+----------------+
| er | :ref:`ER <createeastwestfirewall__response_er>` object | ER data |
+----------------+----------------------------------------------------------------------------------------------------------------+----------------+
| inspertion_vpc | :ref:`CreateEWFirewallInspectVpcResp <createeastwestfirewall__response_createewfirewallinspectvpcresp>` object | inspection vpc |
+----------------+----------------------------------------------------------------------------------------------------------------+----------------+
.. _createeastwestfirewall__response_er:
.. table:: **Table 7** ER
============ ====== ============
Parameter Type Description
============ ====== ============
er_id String ER ID
er_attach_id String ER attach ID
============ ====== ============
.. _createeastwestfirewall__response_createewfirewallinspectvpcresp:
.. table:: **Table 8** CreateEWFirewallInspectVpcResp
========== ================ ===========
Parameter Type Description
========== ================ ===========
vpc_id String vpc id
subnet_ids Array of strings subnet ids
========== ================ ===========
Example Requests
----------------
@ -106,7 +131,15 @@ Create East West Firewall Response Body
{
"data" : {
"id" : "b6d4a7d5-388e-4594-b696-fb4bba1d2b9e"
"id" : "acc86ca7-818b-4c3d-8a9a-3915a2b21651",
"er" : {
"er_id" : "f0f5275a-40aa-4d1e-ac78-2550f7818d43",
"er_attach_id" : "bd62ddd3-5e20-482b-aefa-9e2940e2b1a9"
},
"inspertion_vpc" : {
"vpc_id" : "00672633-0466-4c35-99ef-5e3f5c813a4b",
"subnet_ids" : [ "294682a0-1e85-45f5-92c8-e52bee09c204", "a86277bb-35d5-4442-bc0b-2e9d4e6a9080", "95829240-14e0-47e6-b9e7-2ac228e7b00f" ]
}
}
}

25
api-ref/source/api/firewall_management/create_firewall.rst
View File

@ -31,7 +31,7 @@ Request Parameters
+----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+================+===========+========+========================================================================================================================================================================+
| X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
+----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| X-Client-Token | No | String | An identity that guarantees the idempotency of client requests. The identifier is in 32-bit UUID format, generated by the client, and must be unique between requests. |
+----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -292,7 +292,28 @@ Create Firewall Response
.. code-block::
{
"data" : "6ed72853-34cb-4b97-9b87-cfc47087c96e"
"data" : {
"charge_info" : {
"charge_mode" : "prePaid",
"is_auto_pay" : true,
"is_auto_renew" : true,
"period_num" : 1,
"period_type" : "month"
},
"enterprise_project_id" : "0",
"flavor" : {
"extend_bandwidth" : 5000,
"extend_eip_count" : 2000,
"extend_vpc_count" : 100,
"version" : "Standard"
},
"name" : "CFW-TEST",
"tags" : [ {
"key" : "TagKey",
"value" : "TagVal"
} ]
},
"order_id" : "CS2403271050ZEM0L"
}
**Status code: 400**

2
api-ref/source/api/firewall_management/delete_firewall_instance.rst
View File

@ -32,7 +32,7 @@ Request Parameters
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+====================================================================================================================================================+
| X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters

85
api-ref/source/api/firewall_management/list_firewall_detail.rst
View File

File diff suppressed because it is too large Load Diff

131
api-ref/source/api/firewall_management/list_firewall_list.rst
View File

File diff suppressed because it is too large Load Diff

38
api-ref/source/api/firewall_management/list_job_status.rst
View File

@ -32,7 +32,7 @@ Request Parameters
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+====================================================================================================================================================+
| X-Auth-Token | No | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
@ -64,23 +64,25 @@ Response Parameters
.. table:: **Table 4** data
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=========================================================================================================================================+
| id | String | Job Id |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| status | String | Job execution status. Running means the job is being executed, Success means the job is successful, Failed means the job is failed. |
| | | |
| | | Enumeration values: |
| | | |
| | | - **Running** |
| | | - **Success** |
| | | - **Failed** |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| begin_time | String | Creation time, in the format yyyy-mm-ddThh:mm:ssZ. where T refers to the beginning of a certain time; Z refers to the time zone offset. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| end_time | String | End time, in the format "yyyy-mm-ddThh:mm:ssZ". where T refers to the beginning of a certain time; Z refers to the time zone offset. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=====================================================================================================================================================================================================+
| id | String | Job Id |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | String | Job execution status. Running means the job is being executed, Success means the job is successful, Failed means the job is failed. |
| | | |
| | | Enumeration values: |
| | | |
| | | - **Running** |
| | | |
| | | - **Success** |
| | | |
| | | - **Failed** |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| begin_time | String | Creation time, in the format yyyy-mm-ddThh:mm:ssZ. where T refers to the beginning of a certain time; Z refers to the time zone offset, for example, the Beijing time offset is displayed as +0800. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| end_time | String | End time, in the format "yyyy-mm-ddThh:mm:ssZ". where T refers to the beginning of a certain time; Z refers to the time zone offset, for example, the Beijing time offset is displayed as +0800. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Requests
----------------

101
api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst
View File

File diff suppressed because it is too large Load Diff

37
api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst
View File

@ -87,48 +87,15 @@ Response Parameters
.. table:: **Table 6** VpcAttachmentDetail
+-----------------------+---------------------------------------------------------------+-----------------------+
| Parameter | Type | Description |
+=======================+===============================================================+=======================+
| id | String | id |
+-----------------------+---------------------------------------------------------------+-----------------------+
| name | String | name |
+-----------------------+---------------------------------------------------------------+-----------------------+
| vpc_id | String | vpc id |
+-----------------------+---------------------------------------------------------------+-----------------------+
| virsubnet_id | String | subnet id |
+-----------------------+---------------------------------------------------------------+-----------------------+
| state | String | state |
+-----------------------+---------------------------------------------------------------+-----------------------+
| created_at | String | create time |
+-----------------------+---------------------------------------------------------------+-----------------------+
| updated_at | String | update time |
+-----------------------+---------------------------------------------------------------+-----------------------+
| tags | Array of :ref:`Tag <listprotectedvpcs__response_tag>` objects | tag |
+-----------------------+---------------------------------------------------------------+-----------------------+
| description | String | description |
+-----------------------+---------------------------------------------------------------+-----------------------+
| project_id | String | project id |
+-----------------------+---------------------------------------------------------------+-----------------------+
| vpc_project_id | String | vpc project id |
+-----------------------+---------------------------------------------------------------+-----------------------+
| enterprise_project_id | String | enterprise project id |
+-----------------------+---------------------------------------------------------------+-----------------------+
.. _listprotectedvpcs__response_tag:
.. table:: **Table 7** Tag
========= ====== ===========
Parameter Type Description
========= ====== ===========
key String key
value String value
vpc_id String vpc id
========= ====== ===========
**Status code: 500**
.. table:: **Table 8** Response body parameters
.. table:: **Table 7** Response body parameters
+-----------------------+-----------------------+-----------------------+
| Parameter | Type | Description |

118
api-ref/source/api/log_management/querying_access_control_logs.rst
View File

File diff suppressed because it is too large Load Diff

84
api-ref/source/api/log_management/querying_attack_logs.rst
View File

File diff suppressed because it is too large Load Diff

68
api-ref/source/api/log_management/querying_flow_logs.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/api/service_set_management/creating_a_service_member.rst
View File

@ -61,8 +61,6 @@ Request Parameters
+-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=============+===========+=========+==================================================================================================================================================================================================================+
| item_id | No | String | Service member ID |
+-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | Yes | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. |
+-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| source_port | Yes | String | Source port |

84
api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst
View File

File diff suppressed because it is too large Load Diff

54
api-ref/source/api/service_set_management/querying_service_set_details.rst
View File

@ -26,13 +26,15 @@ GET /v1/{project_id}/service-sets/{set_id}
.. table:: **Table 2** Query Parameters
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| query_service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
@ -62,25 +64,25 @@ Response Parameters
.. table:: **Table 5** ServiceSetDetailResponseDto
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=============================================================================================+
| id | String | Service group ID |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| name | String | Service group name |
| | | |
| | | Minimum: **1** |
| | | |
| | | Maximum: **255** |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| description | String | Service group description |
| | | |
| | | Minimum: **1** |
| | | |
| | | Maximum: **255** |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| service_set_type | Integer | Service set type, 0 indicates a custom service set and 1 indicates a predefined service set |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+================================================================================================================================================================================+
| id | String | Service group ID |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | Service group name |
| | | |
| | | Minimum: **1** |
| | | |
| | | Maximum: **255** |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Service group description |
| | | |
| | | Minimum: **1** |
| | | |
| | | Maximum: **255** |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service_set_type | Integer | Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**

32
api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst
View File

@ -25,21 +25,23 @@ GET /v1/{project_id}/service-items
.. table:: **Table 2** Query Parameters
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=======================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| set_id | Yes | String | Service group ID |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| key_word | No | String | Query field |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+========================+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| set_id | Yes | String | Service group ID |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| key_word | No | String | Query field |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | No | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| query_service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. |
+------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------

14
api-ref/source/change_history.rst
View File

@ -5,8 +5,12 @@
Change History
==============
============ =========================================
Release Date Description
============ =========================================
2024-04-30 This issue is the first official release.
============ =========================================
+-----------------------------------+-----------------------------------------------------------------------+
| Release Date | Description |
+===================================+=======================================================================+
| 2024-05-28 | This issue is the second official release. |
| | |
| | Modified the description about whether **X-Auth-Token** is mandatory. |
+-----------------------------------+-----------------------------------------------------------------------+
| 2024-04-30 | This issue is the first official release. |
+-----------------------------------+-----------------------------------------------------------------------+