diff --git a/api-ref/source/api/acl_rule_management/batch_delete_acl_rules.rst b/api-ref/source/api/acl_rule_management/batch_delete_acl_rules.rst index 1096d00..c4d674b 100644 --- a/api-ref/source/api/acl_rule_management/batch_delete_acl_rules.rst +++ b/api-ref/source/api/acl_rule_management/batch_delete_acl_rules.rst @@ -8,7 +8,7 @@ Batch Delete Acl Rules Function -------- -Batch Delete Acl Rules +Batch Delete ACL Rules URI --- @@ -28,7 +28,7 @@ DELETE /v1/{project_id}/acl-rule +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -51,7 +51,7 @@ Request Parameters +===========+===========+==================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_ids | Yes | Array of strings | rule ids | + | rule_ids | Yes | Array of strings | Array of Rule IDs. | +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters diff --git a/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst b/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst index c9870a6..0a57040 100644 --- a/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst +++ b/api-ref/source/api/acl_rule_management/creating_an_acl_rule.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/acl-rule +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,7 +61,7 @@ Request Parameters | | | | | | | | | - **2** | +-----------------+-----------------+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rules | Yes | Array of :ref:`rules ` objects | rules | + | rules | Yes | Array of :ref:`rules ` objects | Rules | +-----------------+-----------------+-----------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_rules: @@ -83,9 +83,9 @@ Request Parameters | | | | | | | | | - **1** | +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | action_type | Yes | Integer | Action. 0: allow; 1: deny | + | action_type | Yes | Integer | Action type: 0 (allow), 1 (deny). Enumeration values: - 0 - 1 | +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | status | Yes | Integer | Rule delivery status. 0: disabled; 1: enabled. | + | status | Yes | Integer | Rule delivery status: 0 (disabled), 1 (enabled). | | | | | | | | | | Enumeration values: | | | | | | @@ -105,7 +105,7 @@ Request Parameters +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | long_connect_time_second | No | Long | Persistent Connection Duration (second) | +--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_enable | Yes | Integer | Whether to support persistent connections. 0: not supported; 1: supported. | + | long_connect_enable | Yes | Integer | Whether to support persistent connections: 0 (not supported), 1 (supported). | | | | | | | | | | Enumeration values: | | | | | | @@ -141,9 +141,9 @@ Request Parameters +==============+===========+=========+==========================================================================================================================================================================+ | dest_rule_id | No | String | ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top. | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | top | No | Integer | Whether to pin on top. The options are as follows: 0: no; 1: yes. | + | 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. | + | bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0 (no), 1 (yes). | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_ruleaddressdtoforrequest: @@ -153,50 +153,50 @@ Request Parameters +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=====================+===========+=======================================================================+====================================================================================================================================================================================================================+ - | type | Yes | Integer | Type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile | + | type | Yes | Integer | address source type: 0 (manual input), 1 (associated IP address group), 2 (domain name), 3 (region), 4 (domain set), 5 (multi object), 6 (domain set dns), 7 (domain url profile). | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_type | No | Integer | address type. 0: IPv4; 1: IPv6 | + | address_type | No | Integer | Address type: 0 (IPv4), 1 (IPv6). | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | address | No | String | IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | address_set_id | No | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_name | No | String | IP address group name | + | address_set_name | No | String | IP address group name. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | domain_address_name | No | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | region_list_json | No | String | JSON value of the rule region list. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | region_list | No | Array of :ref:`IpRegionDto ` objects | Region list of a rule | + | region_list | No | Array of :ref:`IpRegionDto ` objects | Region list of a rule. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_id | No | String | domain set id | + | domain_set_id | No | String | Domain set id. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_name | No | String | domain set name | + | domain_set_name | No | String | Domain set name. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | Array of strings | IP address list | + | ip_address | No | Array of strings | IP address list. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | predefined_group | No | Array of strings | predefined group | + | predefined_group | No | Array of strings | Predefined group. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group | No | Array of strings | address group | + | address_group | No | Array of strings | Address group. | +---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_ipregiondto: .. table:: **Table 8** IpRegionDto - +----------------+-----------+---------+-------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+=========+===================================================================+ - | region_id | No | String | region id | - +----------------+-----------+---------+-------------------------------------------------------------------+ - | description_cn | No | String | cn description | - +----------------+-----------+---------+-------------------------------------------------------------------+ - | description_en | No | String | en description | - +----------------+-----------+---------+-------------------------------------------------------------------+ - | region_type | No | Integer | Region type, 0 means country, 1 means province, 2 means continent | - +----------------+-----------+---------+-------------------------------------------------------------------+ + +----------------+-----------+---------+-----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================+===========+=========+=============================================================================+ + | region_id | No | String | Region id,it can be obtained from the Import and export template. | + +----------------+-----------+---------+-----------------------------------------------------------------------------+ + | description_cn | No | String | CN description of the region, it is only applied when the Country is China. | + +----------------+-----------+---------+-----------------------------------------------------------------------------+ + | description_en | No | String | EN description of the region. | + +----------------+-----------+---------+-----------------------------------------------------------------------------+ + | region_type | No | Integer | Region type, 0 means country, 1 means province, 2 means continent. | + +----------------+-----------+---------+-----------------------------------------------------------------------------+ .. _addaclrule__request_ruleservicedto: @@ -209,25 +209,25 @@ Request Parameters +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocols | No | Array of integers | Protocols | + | protocols | No | Array of integers | Array of protocol types. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | No | String | Source port | + | source_port | No | String | Source port. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | No | String | Destination port | + | dest_port | No | String | Destination port. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | service_set_id | No | String | Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_name | No | String | Service group name | + | service_set_name | No | String | Service group name. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_service | No | Array of :ref:`ServiceItem ` objects | custom service | + | custom_service | No | Array of :ref:`ServiceItem ` objects | Custom service. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | predefined_group | No | Array of strings | predefined group, Includes Web Service, Remote Login and Ping, Database | + | predefined_group | No | Array of strings | Predefined group includes following: Web Service, Remote Login and Ping, Database. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group | No | Array of strings | Service group list | + | service_group | No | Array of strings | List of service groups. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | Service group name list | + | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | List of service group names. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_type | No | Integer | predefined service set type, 1 indicates Web Service, 2 indicates Remote login and PING, 3 indicates Databases | + | service_set_type | No | Integer | Predefined service set type: 1 indicates Web Service, 2 indicates Remote login and Ping, 3 indicates Databases. | +---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_serviceitem: @@ -239,13 +239,13 @@ Request Parameters +=============+===========+=========+==================================================================================================================================================================================================================+ | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | No | String | source port | + | source_port | No | String | Source port. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | No | String | destination port | + | dest_port | No | String | Destination port. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | description | + | description | No | String | Description of service item. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | name | + | name | No | String | Name of service item. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _addaclrule__request_servicegroupvo: @@ -255,13 +255,13 @@ Request Parameters +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==================+===========+===================+===========================================================================================+ - | name | No | String | service group name | + | name | No | String | Service group name. | +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | protocols | No | Array of integers | protocols | + | protocols | No | Array of integers | Array of protocol types,the value can be 1(ICMP),6(TCP),17(UDP),58(ICMPV6). | +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ | service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | set_id | No | String | service set id | + | set_id | No | String | Service set id. | +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ .. _addaclrule__request_tagsvo: @@ -271,9 +271,9 @@ Request Parameters ========= ========= ====== =========== Parameter Mandatory Type Description ========= ========= ====== =========== - tag_id No String tag id - tag_key No String tag key - tag_value No String tag value + tag_id No String Tag id. + tag_key No String Tag key. + tag_value No String Tag value. ========= ========= ====== =========== Response Parameters @@ -306,29 +306,20 @@ Response Parameters ========= ====== =========== Parameter Type Description ========= ====== =========== - id String rule id - name String rule name + id String Rule ID. + name String Rule name. ========= ====== =========== **Status code: 400** .. table:: **Table 16** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/acl_rule_management/delete_acl_rule.rst b/api-ref/source/api/acl_rule_management/delete_acl_rule.rst index 22a60ed..8aae139 100644 --- a/api-ref/source/api/acl_rule_management/delete_acl_rule.rst +++ b/api-ref/source/api/acl_rule_management/delete_acl_rule.rst @@ -2,7 +2,7 @@ .. _DeleteAclRule: -Delete Acl Rule +Delete ACL Rule =============== Function @@ -29,7 +29,7 @@ DELETE /v1/{project_id}/acl-rule/{acl_rule_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -65,29 +65,20 @@ Response Parameters ========= ====== =========== Parameter Type Description ========= ====== =========== - id String rule id - name String rule name + id String Rule ID. + name String Rule name. ========= ====== =========== **Status code: 400** .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/acl_rule_management/deleting_the_rule_hit_count.rst b/api-ref/source/api/acl_rule_management/deleting_the_rule_hit_count.rst index 5f6578f..73d7e20 100644 --- a/api-ref/source/api/acl_rule_management/deleting_the_rule_hit_count.rst +++ b/api-ref/source/api/acl_rule_management/deleting_the_rule_hit_count.rst @@ -28,7 +28,7 @@ DELETE /v1/{project_id}/acl-rule/count +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -59,21 +59,12 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/acl_rule_management/index.rst b/api-ref/source/api/acl_rule_management/index.rst index 6a0cf9e..0ead640 100644 --- a/api-ref/source/api/acl_rule_management/index.rst +++ b/api-ref/source/api/acl_rule_management/index.rst @@ -12,7 +12,7 @@ ACL Rule Management - :ref:`List Acl Rule Tags ` - :ref:`Obtaining the Rule Hit Count ` - :ref:`Deleting the Rule Hit Count ` -- :ref:`Delete Acl Rule ` +- :ref:`Delete ACL Rule ` - :ref:`Querying a Protection Rule ` - :ref:`Setting the Priority of an ACL Protection Rule ` diff --git a/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst b/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst index be8a336..e4eb8d8 100644 --- a/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst +++ b/api-ref/source/api/acl_rule_management/list_acl_rule_tags.rst @@ -20,7 +20,7 @@ GET /v2/{project_id}/cfw-acl/tags ========== ========= ====== =========== Parameter Mandatory Type Description ========== ========= ====== =========== - project_id Yes String project ID + project_id Yes String Project ID. ========== ========= ====== =========== .. table:: **Table 2** Query Parameters @@ -28,13 +28,13 @@ GET /v2/{project_id}/cfw-acl/tags +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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**. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | + | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -55,11 +55,11 @@ Response Parameters .. table:: **Table 4** Response body parameters - +-----------+-----------------------------------------------------------------------------------------------+-------------+ - | Parameter | Type | Description | - +===========+===============================================================================================+=============+ - | data | :ref:`HttpGetAclTagResponseData ` object | | - +-----------+-----------------------------------------------------------------------------------------------+-------------+ + +-----------+-----------------------------------------------------------------------------------------------+-----------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================================================+===================================+ + | data | :ref:`HttpGetAclTagResponseData ` object | Result of querying rule acl tags. | + +-----------+-----------------------------------------------------------------------------------------------+-----------------------------------+ .. _listruleacltags__response_httpgetacltagresponsedata: @@ -70,11 +70,11 @@ Response Parameters +===========+===================================================================+=================================================================================================================================================+ | 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 | + | limit | Integer | Number of records displayed on each page, in the range 1-1024. | +-----------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | total | + | total | Integer | Total number of tags. | +-----------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`TagsVO ` objects | tag vos | + | records | Array of :ref:`TagsVO ` objects | Display list of tag. | +-----------+-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listruleacltags__response_tagsvo: @@ -84,9 +84,9 @@ Response Parameters ========= ====== =========== Parameter Type Description ========= ====== =========== - tag_id String tag id - tag_key String tag key - tag_value String tag value + tag_id String Tag id. + tag_key String Tag key. + tag_value String Tag value. ========= ====== =========== Example Requests @@ -103,7 +103,7 @@ Example Responses **Status code: 200** -Get acl tag response +Get successful acl tag response. .. code-block:: @@ -131,11 +131,11 @@ Get acl tag response Status Codes ------------ -=========== ==================== +=========== ================================ Status Code Description -=========== ==================== -200 Get acl tag response -=========== ==================== +=========== ================================ +200 Get successful acl tag response. +=========== ================================ Error Codes ----------- diff --git a/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst b/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst index 1e88f5c..ef2aed0 100644 --- a/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst +++ b/api-ref/source/api/acl_rule_management/obtaining_the_rule_hit_count.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/acl-rule/count +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -76,7 +76,7 @@ Response Parameters +-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | 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**. | +-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total | + | total | Integer | Total number of records. | +-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | records | Array of :ref:`RuleHitCountObject ` objects | Rule hit count list | +-----------+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst b/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst index 8effc1f..6748fbd 100644 --- a/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst +++ b/api-ref/source/api/acl_rule_management/querying_a_protection_rule.rst @@ -44,7 +44,7 @@ GET /v1/{project_id}/acl-rules +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | No | String | Name | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | Integer | Direction. 0: inbound; 1: outbound | + | direction | No | Integer | Direction parameter can have following values: 0 (inbound), 1 (outbound). | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | No | Integer | Indicates the rule delivery status. 0: disabled; 1: enabled. | | | | | | @@ -54,7 +54,7 @@ GET /v1/{project_id}/acl-rules | | | | | | | | | - **1** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | action_type | No | Integer | Action. 0: allow; 1: deny | + | action_type | No | Integer | Action type parameter can have following values: 0 (allow), 1 (deny). | | | | | | | | | | Enumeration values: | | | | | | @@ -70,21 +70,21 @@ GET /v1/{project_id}/acl-rules | | | | | | | | | - **1** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 | + | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags_id | No | String | tags id | + | tags_id | No | String | Tags ID. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | No | String | source address | + | source | No | String | Source address. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | destination | No | String | destination address | + | destination | No | String | Destination address. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service | No | String | service port | + | service | No | String | Service port. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | application | No | String | Application protocol, such as HTTP, TLS, etc. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -107,11 +107,11 @@ Response Parameters .. table:: **Table 4** Response body parameters - ========= ================================================ =========== - Parameter Type Description - ========= ================================================ =========== - data :ref:`data ` object data - ========= ================================================ =========== + +-----------+--------------------------------------------------+-----------------------------------+ + | Parameter | Type | Description | + +===========+==================================================+===================================+ + | data | :ref:`data ` object | Result of querying acl rule list. | + +-----------+--------------------------------------------------+-----------------------------------+ .. _listaclrules__response_data: @@ -122,13 +122,13 @@ Response Parameters +===========+==================================================================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | 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 | + | limit | Integer | Number of records displayed on each page, in the range 1-1024. | +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total | Integer | Total number of queried records | + | total | Integer | Total number of queried records. | +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | records | Array of :ref:`records ` objects | records | + | records | Array of :ref:`records ` objects | Records of acl rule. | +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_records: @@ -140,7 +140,7 @@ Response Parameters +==========================+============================================================================================+=================================================================================================================================+ | rule_id | String | Rule ID | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | address_type | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | + | address_type | Integer | Address type can have following values: 0 (IPv4), 1 (IPv6). | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | name | String | Rule name | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ @@ -152,11 +152,11 @@ Response Parameters | | | | | | | - **1** | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | action_type | Integer | Action. 0: allow; 1: deny | + | action_type | Integer | Action type parameter can have following values: 0 (allow), 1 (deny). | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Rule delivery status. 0: disabled; 1: enabled. | + | status | Integer | Rule delivery status can have the following values: 0 (disabled), 1 (enabled). | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description | + | description | String | Description of the acl rule. | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ | long_connect_time | Long | Persistent connection duration | +--------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ @@ -231,17 +231,17 @@ Response Parameters .. table:: **Table 8** IpRegionDto - +----------------+---------+-------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+===================================================================+ - | region_id | String | region id | - +----------------+---------+-------------------------------------------------------------------+ - | description_cn | String | cn description | - +----------------+---------+-------------------------------------------------------------------+ - | description_en | String | en description | - +----------------+---------+-------------------------------------------------------------------+ - | region_type | Integer | Region type, 0 means country, 1 means province, 2 means continent | - +----------------+---------+-------------------------------------------------------------------+ + +----------------+---------+-----------------------------------------------------------------------------+ + | Parameter | Type | Description | + +================+=========+=============================================================================+ + | region_id | String | Region id,it can be obtained from the Import and export template. | + +----------------+---------+-----------------------------------------------------------------------------+ + | description_cn | String | CN description of the region, it is only applied when the Country is China. | + +----------------+---------+-----------------------------------------------------------------------------+ + | description_en | String | EN description of the region. | + +----------------+---------+-----------------------------------------------------------------------------+ + | region_type | Integer | Region type, 0 means country, 1 means province, 2 means continent. | + +----------------+---------+-----------------------------------------------------------------------------+ .. _listaclrules__response_addressgroupvo: @@ -252,9 +252,9 @@ Response Parameters +==================+=========+====================================================================================================================================================================================================================+ | address_set_type | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | name | + | name | String | Address set name. | +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | set_id | String | address set id | + | set_id | String | Address set id, it can be obtained by calling the ListAddressSets API. | +------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_ruleservicedtoforresponse: @@ -296,13 +296,13 @@ Response Parameters +=============+=========+==================================================================================================================================================================================================================+ | protocol | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | String | source port | + | source_port | String | Source port. | +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | String | destination port | + | dest_port | String | Destination port. | +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | description | + | description | String | Description of service item. | +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | name | + | name | String | Name of service item. | +-------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listaclrules__response_servicegroupvo: @@ -312,13 +312,13 @@ Response Parameters +------------------+-------------------+-------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +==================+===================+===========================================================================================+ - | name | String | service group name | + | name | String | Service group name. | +------------------+-------------------+-------------------------------------------------------------------------------------------+ - | protocols | Array of integers | protocols | + | protocols | Array of integers | Array of protocol types,the value can be 1(ICMP),6(TCP),17(UDP),58(ICMPV6). | +------------------+-------------------+-------------------------------------------------------------------------------------------+ | service_set_type | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | +------------------+-------------------+-------------------------------------------------------------------------------------------+ - | set_id | String | service set id | + | set_id | String | Service set id. | +------------------+-------------------+-------------------------------------------------------------------------------------------+ .. _listaclrules__response_tagsvo: @@ -328,30 +328,21 @@ Response Parameters ========= ====== =========== Parameter Type Description ========= ====== =========== - tag_id String tag id - tag_key String tag key - tag_value String tag value + tag_id String Tag id. + tag_key String Tag key. + tag_value String Tag value. ========= ====== =========== **Status code: 400** .. table:: **Table 14** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- @@ -360,7 +351,7 @@ Query the data whose project ID is 9d80d070b6d44942af73c9c3d38e0429, project ID .. code-block:: - https://{Endpoint}/cfw/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0 + https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/acl-rules?object_id=e12bd2cd-ebfc-4af7-ad6f-ebe6da398029&limit=10&offset=0 Example Responses ----------------- diff --git a/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst b/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst index 3b1c714..0e83b47 100644 --- a/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst +++ b/api-ref/source/api/acl_rule_management/setting_the_priority_of_an_acl_protection_rule.rst @@ -17,19 +17,20 @@ PUT /v1/{project_id}/acl-rule/order/{acl_rule_id} .. table:: **Table 1** Path Parameters - =========== ========= ====== =========== - Parameter Mandatory Type Description - =========== ========= ====== =========== - project_id Yes String Project ID - acl_rule_id Yes String Rule ID - =========== ========= ====== =========== + +-------------+-----------+--------+--------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+==============================================================+ + | project_id | Yes | String | Project ID | + +-------------+-----------+--------+--------------------------------------------------------------+ + | acl_rule_id | Yes | String | Rule ID, it can be obtained by calling the API ListAclRules. | + +-------------+-----------+--------+--------------------------------------------------------------+ .. 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -52,9 +53,9 @@ Request Parameters +==============+===========+=========+==========================================================================================================================================================================+ | dest_rule_id | No | String | ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top. | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | top | No | Integer | Whether to pin on top. The options are as follows: 0: no; 1: yes. | + | 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. | + | bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0 (no), 1 (yes). | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters @@ -77,29 +78,20 @@ Response Parameters ========= ====== =========== Parameter Type Description ========= ====== =========== - id String rule id - name String rule name + id String Rule ID. + name String Rule name. ========= ====== =========== **Status code: 400** .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst b/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst index 998df83..87ef176 100644 --- a/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst +++ b/api-ref/source/api/acl_rule_management/updating_an_acl_rule.rst @@ -17,19 +17,20 @@ PUT /v1/{project_id}/acl-rule/{acl_rule_id} .. table:: **Table 1** Path Parameters - =========== ========= ====== =========== - Parameter Mandatory Type Description - =========== ========= ====== =========== - project_id Yes String Project ID - acl_rule_id Yes String Rule ID - =========== ========= ====== =========== + +-------------+-----------+--------+--------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+==============================================================+ + | project_id | Yes | String | Project ID | + +-------------+-----------+--------+--------------------------------------------------------------+ + | acl_rule_id | Yes | String | Rule ID, it can be obtained by calling the API ListAclRules. | + +-------------+-----------+--------+--------------------------------------------------------------+ .. 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -47,79 +48,79 @@ Request Parameters .. table:: **Table 4** Request body parameters - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+========================================================================+=================================================================================================================================+ - | address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Rule name | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | sequence | No | :ref:`OrderRuleAclDto ` object | UpdateRuleAclDto | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | direction | No | Integer | Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | action_type | No | Integer | Action. 0: allow; 1: deny | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | status | No | Integer | Rule delivery status. 0: disabled; 1: enabled. | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | applications | No | Array of strings | applications | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | applicationsJsonString | No | String | applications json string | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_hour | No | Long | Persistent connection duration (hour) | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_minute | No | Long | Persistent connection duration (hour) | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time_second | No | Long | Persistent connection duration (minute) | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_time | No | Long | Persistent connection duration | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | long_connect_enable | No | Integer | Whether to support persistent connections. 0: not supported; 1: supported. | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | source | No | :ref:`RuleAddressDto ` object | rule address dto | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | destination | No | :ref:`RuleAddressDto ` object | rule address dto | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service | No | :ref:`RuleServiceDto ` object | rule service dto | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule). | - | | | | | - | | | | Enumeration values: | - | | | | | - | | | | - **0** | - | | | | | - | | | | - **1** | - | | | | | - | | | | - **2** | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | tag | No | :ref:`TagsVO ` object | tag | - +--------------------------+-----------------+------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +==========================+=================+========================================================================+====================================================================================================================================================+ + | address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | | + | | | | - **1** | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Rule name | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | sequence | No | :ref:`OrderRuleAclDto ` object | UpdateRuleAclDto | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | No | Integer | Direction: 0 means outside to inside, 1 means inside to outside, direction value is required when rule type is internet or nat. | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | | + | | | | - **1** | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | action_type | No | Integer | Action type parameter accept the following values: 0 (allow), 1 (deny). | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | | + | | | | - **1** | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | No | Integer | Rule delivery status: 0 (disabled), 1 (enabled). | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | applications | No | Array of strings | Applications of the Acl rule, the value in the list can be 1.HTTP,2.SMTP,3.HTTPS,4.IMAP4,5.MYSQL,6.POP3,7.POP3S.8.SSH,9.TLS1,10.VNC,11.DNS,12.RDP. | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | applicationsJsonString | No | String | JSON String created by the array list of the applications. | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Description of the rule. | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_hour | No | Long | Persistent connection duration (hour) | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_minute | No | Long | Persistent connection duration (hour) | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time_second | No | Long | Persistent connection duration (minute) | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_time | No | Long | Persistent connection duration | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | long_connect_enable | No | Integer | Whether to support persistent connections: 0 (not supported), 1 (supported). | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | | + | | | | - **1** | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | source | No | :ref:`RuleAddressDto ` object | Source rule address info. | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | destination | No | :ref:`RuleAddressDto ` object | Destination rule address info. | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | service | No | :ref:`RuleServiceDto ` object | Rule Service Info description, includes protocols and port info. | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | type | No | Integer | Rule type. The value can be 0 (Internet rule), 1 (VPC rule), or 2 (NAT rule). | + | | | | | + | | | | Enumeration values: | + | | | | | + | | | | - **0** | + | | | | | + | | | | - **1** | + | | | | | + | | | | - **2** | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ + | tag | No | :ref:`TagsVO ` object | tag | + +--------------------------+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_orderruleacldto: @@ -130,9 +131,9 @@ Request Parameters +==============+===========+=========+==========================================================================================================================================================================+ | dest_rule_id | No | String | ID of the rule that the added rule will follow. This parameter cannot be left blank if the rule is not pinned on top, and is empty when the added rule is pinned on top. | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | top | No | Integer | Whether to pin on top. The options are as follows: 0: no; 1: yes. | + | 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. | + | bottom | No | Integer | Whether to pin on bottom. The options are as follows: 0 (no), 1 (yes). | +--------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_ruleaddressdto: @@ -150,7 +151,7 @@ Request Parameters +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | address_set_id | No | String | ID of the associated IP address group. The value cannot be empty for the automatic type or for the manual or domain type. | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_set_name | No | String | IP address group name | + | address_set_name | No | String | IP address group name,it can be obtained by calling the API ListAddressSets. | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | domain_address_name | No | String | Name of the domain name address. This parameter cannot be left empty for the domain name type, and is empty for the manual or automatic type. | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -158,36 +159,36 @@ Request Parameters +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | region_list | No | Array of :ref:`IpRegionDto ` objects | Region list of a rule | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_id | No | String | domain set id | + | domain_set_id | No | String | Domain set id,it can be obtained by calling the API ListDomainSets. | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | domain_set_name | No | String | domain set name | + | domain_set_name | No | String | Domain set name,it can be obtained by calling the API ListDomainSets. | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_address | No | Array of strings | IP address list | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group | No | Array of strings | address group | + | address_group | No | Array of strings | list of address set id, which can be obtained by calling the API ListAddressSets. | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | address_group_names | No | Array of :ref:`AddressGroupVO ` objects | Address set list | + | address_group_names | No | Array of :ref:`AddressGroupVO ` objects | List of address group names, which can be obtained by calling the API ListAddressSets, it is only used in the response. | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | predefined_group | No | Array of strings | predefined group | + | predefined_group | No | Array of strings | Predefined group id of the address group.which can be obtained by calling the API ListAddressSets,only applied when the RuleAddressDto is applied for source. | +---------------------+-----------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_ipregiondto: .. table:: **Table 7** IpRegionDto - +----------------+-----------+---------+-------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+=========+===================================================================+ - | region_id | No | String | region id | - +----------------+-----------+---------+-------------------------------------------------------------------+ - | description_cn | No | String | cn description | - +----------------+-----------+---------+-------------------------------------------------------------------+ - | description_en | No | String | en description | - +----------------+-----------+---------+-------------------------------------------------------------------+ - | region_type | No | Integer | Region type, 0 means country, 1 means province, 2 means continent | - +----------------+-----------+---------+-------------------------------------------------------------------+ + +----------------+-----------+---------+-----------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +================+===========+=========+=============================================================================+ + | region_id | No | String | Region id,it can be obtained from the Import and export template. | + +----------------+-----------+---------+-----------------------------------------------------------------------------+ + | description_cn | No | String | CN description of the region, it is only applied when the Country is China. | + +----------------+-----------+---------+-----------------------------------------------------------------------------+ + | description_en | No | String | EN description of the region. | + +----------------+-----------+---------+-----------------------------------------------------------------------------+ + | region_type | No | Integer | Region type, 0 means country, 1 means province, 2 means continent. | + +----------------+-----------+---------+-----------------------------------------------------------------------------+ .. _updateaclrule__request_addressgroupvo: @@ -198,9 +199,9 @@ Request Parameters +==================+===========+=========+====================================================================================================================================================================================================================+ | address_set_type | No | Integer | Address set type, 0 indicates a custom define address set, 1 indicates a WAF return-to-source IP address set, 2 indicates a DDoS return-to-source IP address set, and 3 indicates a NAT64 translation address set. | +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | name | + | name | No | String | Address set name. | +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | set_id | No | String | address set id | + | set_id | No | String | Address set id, it can be obtained by calling the ListAddressSets API. | +------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_ruleservicedto: @@ -214,25 +215,25 @@ Request Parameters +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocols | No | Array of integers | Protocols | + | protocols | No | Array of integers | Array of protocol types. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | No | String | Source port | + | source_port | No | String | Source port. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | No | String | Destination port | + | dest_port | No | String | Destination port. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | service_set_id | No | String | Service group ID. This parameter is left blank for the manual type and cannot be left blank for the automatic type. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_name | No | String | Service group name | + | service_set_name | No | String | Service group name. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_service | No | Array of :ref:`ServiceItem ` objects | custom service | + | custom_service | No | Array of :ref:`ServiceItem ` objects | Custom service. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | predefined_group | No | Array of strings | predefined group, Includes Web Service, Remote Login and Ping, Database | + | predefined_group | No | Array of strings | Predefined group includes following: Web Service, Remote Login and Ping, Database. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group | No | Array of strings | Service group list | + | service_group | No | Array of strings | List of service groups. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | Service group name list | + | service_group_names | No | Array of :ref:`ServiceGroupVO ` objects | List of service group names. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_set_type | No | Integer | predefined service set type, 1 indicates Web Service, 2 indicates Remote login and PING, 3 indicates Databases | + | service_set_type | No | Integer | Predefined service set type: 1 indicates Web Service, 2 indicates Remote login and Ping, 3 indicates Databases. | +---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_serviceitem: @@ -244,13 +245,13 @@ Request Parameters +=============+===========+=========+==================================================================================================================================================================================================================+ | protocol | No | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_port | No | String | source port | + | source_port | No | String | Source port. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_port | No | String | destination port | + | dest_port | No | String | Destination port. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | description | + | description | No | String | Description of service item. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | name | + | name | No | String | Name of service item. | +-------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _updateaclrule__request_servicegroupvo: @@ -260,13 +261,13 @@ Request Parameters +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +==================+===========+===================+===========================================================================================+ - | name | No | String | service group name | + | name | No | String | Service group name. | +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | protocols | No | Array of integers | protocols | + | protocols | No | Array of integers | Array of protocol types,the value can be 1(ICMP),6(TCP),17(UDP),58(ICMPV6). | +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ | service_set_type | No | Integer | Query service set type, 0 means custom define service set, 1 means predefine service set. | +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ - | set_id | No | String | service set id | + | set_id | No | String | Service set id. | +------------------+-----------+-------------------+-------------------------------------------------------------------------------------------+ .. _updateaclrule__request_tagsvo: @@ -276,9 +277,9 @@ Request Parameters ========= ========= ====== =========== Parameter Mandatory Type Description ========= ========= ====== =========== - tag_id No String tag id - tag_key No String tag key - tag_value No String tag value + tag_id No String Tag id. + tag_key No String Tag key. + tag_value No String Tag value. ========= ========= ====== =========== Response Parameters @@ -301,29 +302,20 @@ Response Parameters ========= ====== =========== Parameter Type Description ========= ====== =========== - id String rule id - name String rule name + id String Rule ID. + name String Rule name. ========= ====== =========== **Status code: 400** .. table:: **Table 15** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/acl_rule_management/updating_rule_actions_in_batches.rst b/api-ref/source/api/acl_rule_management/updating_rule_actions_in_batches.rst index 5d6b25b..e7f5226 100644 --- a/api-ref/source/api/acl_rule_management/updating_rule_actions_in_batches.rst +++ b/api-ref/source/api/acl_rule_management/updating_rule_actions_in_batches.rst @@ -25,11 +25,13 @@ PUT /v1/{project_id}/acl-rule/action .. 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. | - +-----------------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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, which can be obtained by calling the ListFirewallList. | + +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -49,9 +51,9 @@ Request Parameters +===========+===========+==================+================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | action | Yes | String | action | + | action | Yes | String | Action of updating ACL Rules. The value can be enable (enable the rules), or disable (disable the rules). | +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rule_ids | Yes | Array of strings | rule ids | + | rule_ids | Yes | Array of strings | Array of rule IDs. | +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Parameters diff --git a/api-ref/source/api/address_set_management/adding_an_address_set.rst b/api-ref/source/api/address_set_management/adding_an_address_set.rst index b6e4213..1a973a7 100644 --- a/api-ref/source/api/address_set_management/adding_an_address_set.rst +++ b/api-ref/source/api/address_set_management/adding_an_address_set.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/address-set +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -92,21 +92,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/address_set_management/adding_an_address_set_member.rst b/api-ref/source/api/address_set_management/adding_an_address_set_member.rst index 2daae44..a6a40e9 100644 --- a/api-ref/source/api/address_set_management/adding_an_address_set_member.rst +++ b/api-ref/source/api/address_set_management/adding_an_address_set_member.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/address-items +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -118,21 +118,12 @@ Response Parameters .. table:: **Table 10** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/address_set_management/batch_delete_address_items.rst b/api-ref/source/api/address_set_management/batch_delete_address_items.rst index b3e0a6d..20af244 100644 --- a/api-ref/source/api/address_set_management/batch_delete_address_items.rst +++ b/api-ref/source/api/address_set_management/batch_delete_address_items.rst @@ -28,7 +28,7 @@ DELETE /v1/{project_id}/address-items +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/address_set_management/deleting_an_address_set.rst b/api-ref/source/api/address_set_management/deleting_an_address_set.rst index bbfb5e5..741b3c8 100644 --- a/api-ref/source/api/address_set_management/deleting_an_address_set.rst +++ b/api-ref/source/api/address_set_management/deleting_an_address_set.rst @@ -29,7 +29,7 @@ DELETE /v1/{project_id}/address-sets/{set_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,21 +73,12 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/address_set_management/deleting_an_address_set_member.rst b/api-ref/source/api/address_set_management/deleting_an_address_set_member.rst index f28fef4..cd17ff4 100644 --- a/api-ref/source/api/address_set_management/deleting_an_address_set_member.rst +++ b/api-ref/source/api/address_set_management/deleting_an_address_set_member.rst @@ -29,7 +29,7 @@ DELETE /v1/{project_id}/address-items/{item_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,21 +73,12 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/address_set_management/querying_address_set_details.rst b/api-ref/source/api/address_set_management/querying_address_set_details.rst index b8afd7e..857c1ad 100644 --- a/api-ref/source/api/address_set_management/querying_address_set_details.rst +++ b/api-ref/source/api/address_set_management/querying_address_set_details.rst @@ -29,7 +29,7 @@ GET /v1/{project_id}/address-sets/{set_id} +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -90,21 +90,12 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/address_set_management/querying_address_set_members.rst b/api-ref/source/api/address_set_management/querying_address_set_members.rst index 61c6313..dee0e2c 100644 --- a/api-ref/source/api/address_set_management/querying_address_set_members.rst +++ b/api-ref/source/api/address_set_management/querying_address_set_members.rst @@ -38,7 +38,7 @@ GET /v1/{project_id}/address-items +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -109,21 +109,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/address_set_management/querying_ip_address_sets.rst b/api-ref/source/api/address_set_management/querying_ip_address_sets.rst index 3e02ab8..7823b3d 100644 --- a/api-ref/source/api/address_set_management/querying_ip_address_sets.rst +++ b/api-ref/source/api/address_set_management/querying_ip_address_sets.rst @@ -46,7 +46,7 @@ GET /v1/{project_id}/address-sets | | | | | | | | | - **1** | +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -121,21 +121,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/address_set_management/updating_address_set_information.rst b/api-ref/source/api/address_set_management/updating_address_set_information.rst index faad909..9940f61 100644 --- a/api-ref/source/api/address_set_management/updating_address_set_information.rst +++ b/api-ref/source/api/address_set_management/updating_address_set_information.rst @@ -29,7 +29,7 @@ PUT /v1/{project_id}/address-sets/{set_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,21 +81,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst b/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst index 59049fc..0e1261a 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst +++ b/api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/black-white-list +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -94,21 +94,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/blacklist_and_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst b/api-ref/source/api/blacklist_and_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst index 49cbc32..e90e982 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst +++ b/api-ref/source/api/blacklist_and_whitelist_management/deleting_a_blacklist_or_whitelist_rule.rst @@ -29,7 +29,7 @@ DELETE /v1/{project_id}/black-white-list/{list_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,21 +73,12 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst b/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst index bd8de4d..fbc8699 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst +++ b/api-ref/source/api/blacklist_and_whitelist_management/querying_a_blacklist_or_whitelist.rst @@ -54,7 +54,7 @@ GET /v1/{project_id}/black-white-lists +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -125,21 +125,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst b/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst index 0addfe4..7d9a6f0 100644 --- a/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst +++ b/api-ref/source/api/blacklist_and_whitelist_management/updating_the_blacklist_or_whitelist.rst @@ -29,7 +29,7 @@ PUT /v1/{project_id}/black-white-list/{list_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,21 +91,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/capture_management/cancel_capture_task.rst b/api-ref/source/api/capture_management/cancel_capture_task.rst index ddc622c..b8c909c 100644 --- a/api-ref/source/api/capture_management/cancel_capture_task.rst +++ b/api-ref/source/api/capture_management/cancel_capture_task.rst @@ -30,7 +30,7 @@ POST /v1/{project_id}/capture-task/stop +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/api/capture_management/create_capture_task.rst b/api-ref/source/api/capture_management/create_capture_task.rst index 5cec663..d51ad0c 100644 --- a/api-ref/source/api/capture_management/create_capture_task.rst +++ b/api-ref/source/api/capture_management/create_capture_task.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/capture-task +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/capture_management/delete_capture_task.rst b/api-ref/source/api/capture_management/delete_capture_task.rst index 288e5d5..a64cecb 100644 --- a/api-ref/source/api/capture_management/delete_capture_task.rst +++ b/api-ref/source/api/capture_management/delete_capture_task.rst @@ -30,7 +30,7 @@ POST /v1/{project_id}/capture-task/batch-delete +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/api/capture_management/list_capture_task.rst b/api-ref/source/api/capture_management/list_capture_task.rst index 47b3ae2..a585a30 100644 --- a/api-ref/source/api/capture_management/list_capture_task.rst +++ b/api-ref/source/api/capture_management/list_capture_task.rst @@ -28,7 +28,7 @@ GET /v1/{project_id}/capture-task +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/capture_management/list_capture_task_result.rst b/api-ref/source/api/capture_management/list_capture_task_result.rst index c433b17..64ef828 100644 --- a/api-ref/source/api/capture_management/list_capture_task_result.rst +++ b/api-ref/source/api/capture_management/list_capture_task_result.rst @@ -36,7 +36,7 @@ GET /v1/{project_id}/capture-task/capture-result +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip | No | Array | specified public ip address | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst b/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst index de1850a..fb89cc6 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/add_domain_set.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/domain-set +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst b/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst index 50044ae..0c29cfc 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst @@ -29,7 +29,7 @@ POST /v1/{project_id}/domain-set/domains/{set_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/delete_domain_set.rst b/api-ref/source/api/domain_parse_and_domain_set_management/delete_domain_set.rst index 24743d7..b48598d 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/delete_domain_set.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/delete_domain_set.rst @@ -29,7 +29,7 @@ DELETE /v1/{project_id}/domain-set/{set_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/delete_domains.rst b/api-ref/source/api/domain_parse_and_domain_set_management/delete_domains.rst index 222e737..d67992f 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/delete_domains.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/delete_domains.rst @@ -26,11 +26,11 @@ DELETE /v1/{project_id}/domain-set/domains/{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. | - +-----------------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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, which can be obtained by calling the ListFirewallList. | + +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst b/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst index 7c5ccc7..76675ef 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/list_domain_sets.rst @@ -28,7 +28,7 @@ GET /v1/{project_id}/domain-sets +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst b/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst index feb7822..8317178 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/list_domains.rst @@ -29,7 +29,7 @@ GET /v1/{project_id}/domain-set/domains/{set_id} +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst b/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst index 63fdfae..13082a8 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_dns_server_list.rst @@ -34,7 +34,7 @@ GET /v1/{project_id}/dns/servers +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst b/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst index 22e7b4f..4ecf3b0 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/querying_the_ip_address_for_domain_name_resolution.rst @@ -29,7 +29,7 @@ GET /v1/{project_id}/domain/parse/{domain_name} +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -64,21 +64,12 @@ Response Parameters .. table:: **Table 5** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst b/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst index e55ddd5..1ab4f1b 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/update_domain_set.rst @@ -29,7 +29,7 @@ PUT /v1/{project_id}/domain-set/{set_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst b/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst index c6cecd3..f592f99 100644 --- a/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst +++ b/api-ref/source/api/domain_parse_and_domain_set_management/updating_the_dns_server_list.rst @@ -30,7 +30,7 @@ PUT /v1/{project_id}/dns/servers +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -85,21 +85,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/eip_management/enabling_or_disabling_an_eip.rst b/api-ref/source/api/eip_management/enabling_or_disabling_an_eip.rst index df4a28b..96c180b 100644 --- a/api-ref/source/api/eip_management/enabling_or_disabling_an_eip.rst +++ b/api-ref/source/api/eip_management/enabling_or_disabling_an_eip.rst @@ -32,7 +32,7 @@ POST /v1/{project_id}/eip/protect +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -123,21 +123,12 @@ Response Parameters .. table:: **Table 8** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/eip_management/querying_the_eip_list.rst b/api-ref/source/api/eip_management/querying_the_eip_list.rst index af7407a..c848516 100644 --- a/api-ref/source/api/eip_management/querying_the_eip_list.rst +++ b/api-ref/source/api/eip_management/querying_the_eip_list.rst @@ -49,9 +49,7 @@ 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 | @@ -59,20 +57,17 @@ 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 | - | | | | | - | | | | Minimum: **0** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | offset | Yes | Integer | Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is **0**. | | | | | | | | | | Minimum: **0** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_key | No | String | Device key | + | device_key | No | String | Device key,It can be obtained by calling the EIP service API ListPublicips. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | address_type | No | Integer | Specifies the address type. The value can be 0 (IPv4) or 1 (IPv6). | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -141,7 +136,6 @@ Response Parameters | | | Enumeration values: | | | | | | | | - **0** | - | | | | | | | - **1** | +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | public_ipv6 | String | EIP IPv6 | @@ -168,7 +162,7 @@ Response Parameters +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | domain_id | String | domain id | +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | String | owner | + | owner | String | The username of the project, which is the owner of the EIPs | +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | fw_domain_id | String | firewall domain id | +--------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -177,21 +171,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/eip_management/querying_the_number_of_eips.rst b/api-ref/source/api/eip_management/querying_the_number_of_eips.rst index e8fa795..6bb02f9 100644 --- a/api-ref/source/api/eip_management/querying_the_number_of_eips.rst +++ b/api-ref/source/api/eip_management/querying_the_number_of_eips.rst @@ -38,7 +38,7 @@ GET /v1/{project_id}/eip-count/{object_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -82,14 +82,10 @@ Response Parameters +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | eip_total | Integer | Total EIPs | | | | | - | | | Minimum: **0** | - | | | | | | | Default: **0** | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | eip_protected | Integer | protected eip count | | | | | - | | | Minimum: **0** | - | | | | | | | Default: **0** | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | eip_protected_self | Integer | self protected eip count | @@ -99,21 +95,12 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/firewall_management/changing_the_east-west_firewall_protection_status.rst b/api-ref/source/api/firewall_management/changing_the_east-west_firewall_protection_status.rst index 797a3f9..5377011 100644 --- a/api-ref/source/api/firewall_management/changing_the_east-west_firewall_protection_status.rst +++ b/api-ref/source/api/firewall_management/changing_the_east-west_firewall_protection_status.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/firewall/east-west/protect +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -87,21 +87,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/firewall_management/create_east_west_firewall.rst b/api-ref/source/api/firewall_management/create_east_west_firewall.rst index 0910afc..8b8060b 100644 --- a/api-ref/source/api/firewall_management/create_east_west_firewall.rst +++ b/api-ref/source/api/firewall_management/create_east_west_firewall.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/firewall/east-west +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/firewall_management/create_firewall.rst b/api-ref/source/api/firewall_management/create_firewall.rst index fd43af9..3fdc2b4 100644 --- a/api-ref/source/api/firewall_management/create_firewall.rst +++ b/api-ref/source/api/firewall_management/create_firewall.rst @@ -38,21 +38,21 @@ Request Parameters .. table:: **Table 3** Request body parameters - +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================================================================+===================================================================================================================+ - | name | Yes | String | Firewall Name | - +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | - | | | | | - | | | | Default: **0** | - +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | tags | No | Array of :ref:`tags ` objects | Resource Tag | - +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | flavor | Yes | :ref:`flavor ` object | flavor | - +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | charge_info | Yes | :ref:`charge_info ` object | Billing type information, postpaid. | - +-----------------------+-----------------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=======================+=================+=================================================================+==========================================================================================================================================================================+ + | name | Yes | String | Firewall Name | + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | + | | | | | + | | | | Default: **0** | + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | Array of :ref:`tags ` objects | Resource Tag | + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor | Yes | :ref:`flavor ` object | flavor | + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | Yes | :ref:`charge_info ` object | Billing type information, postpaid. | + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _createfirewall__request_tags: @@ -110,21 +110,21 @@ Response Parameters .. table:: **Table 8** CreateFirewallReq - +-----------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==================================================================+===================================================================================================================+ - | name | String | Firewall Name | - +-----------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | - | | | | - | | | Default: **0** | - +-----------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | tags | Array of :ref:`tags ` objects | Resource Tag | - +-----------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | flavor | :ref:`flavor ` object | flavor | - +-----------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ - | charge_info | :ref:`charge_info ` object | Billing type information, postpaid. | - +-----------------------+------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==================================================================+==========================================================================================================================================================================+ + | name | String | Firewall Name | + +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | + | | | | + | | | Default: **0** | + +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`tags ` objects | Resource Tag | + +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | flavor | :ref:`flavor ` object | flavor | + +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_info | :ref:`charge_info ` object | Billing type information, postpaid. | + +-----------------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _createfirewall__response_tags: @@ -165,21 +165,12 @@ Response Parameters .. table:: **Table 12** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/firewall_management/list_firewall_detail.rst b/api-ref/source/api/firewall_management/list_firewall_detail.rst index 68f68de..7a1299a 100644 --- a/api-ref/source/api/firewall_management/list_firewall_detail.rst +++ b/api-ref/source/api/firewall_management/list_firewall_detail.rst @@ -44,7 +44,7 @@ GET /v1/{project_id}/firewall/exist | | | | | | | | | - **1 East-west firewall** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -164,7 +164,7 @@ Response Parameters +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | fw_instance_name | String | firewall name | +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | resource_id | String | resource id | +--------------------------+----------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/firewall_management/list_firewalls.rst b/api-ref/source/api/firewall_management/list_firewalls.rst index c089c10..b053a03 100644 --- a/api-ref/source/api/firewall_management/list_firewalls.rst +++ b/api-ref/source/api/firewall_management/list_firewalls.rst @@ -25,11 +25,11 @@ POST /v1/{project_id}/firewalls/list .. 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. | - +-----------------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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, which can be obtained by calling the ListFirewallList. | + +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -44,19 +44,19 @@ Request Parameters .. table:: **Table 4** Request body 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. | - +-----------------------+-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_word | No | String | key | - +-----------------------+-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | Array of :ref:`TagInfo ` objects | tags | - +-----------------------+-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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**. | - +-----------------------+-----------+---------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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, which can be obtained by calling the ListFirewallList. | + +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | key_word | No | String | key | + +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | No | Array of :ref:`TagInfo ` objects | tags | + +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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**. | + +-----------------------+-----------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _listfirewalllist__request_taginfo: @@ -125,7 +125,7 @@ Response Parameters +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | fw_instance_name | String | firewall instance name | +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ha_type | Integer | ha type | +-----------------------+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/firewall_management/list_job_status.rst b/api-ref/source/api/firewall_management/list_job_status.rst index 815125d..bdd40b3 100644 --- a/api-ref/source/api/firewall_management/list_job_status.rst +++ b/api-ref/source/api/firewall_management/list_job_status.rst @@ -43,23 +43,13 @@ Response Parameters .. table:: **Table 3** Response body parameters - +-----------------------+---------------------------------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=============================================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+---------------------------------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+---------------------------------------------+-----------------------+ - | data | :ref:`data ` object | Job Result | - +-----------------------+---------------------------------------------+-----------------------+ + ========== =========================================== =========== + Parameter Type Description + ========== =========================================== =========== + error_code String Error code + error_msg String Description + data :ref:`data ` object Job Result + ========== =========================================== =========== .. _listjob__response_data: diff --git a/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst b/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst index 6578b9e..809f081 100644 --- a/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst +++ b/api-ref/source/api/firewall_management/obtaining_east-west_firewall_information.rst @@ -32,7 +32,7 @@ GET /v1/{project_id}/firewall/east-west +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -181,21 +181,12 @@ Response Parameters .. table:: **Table 10** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst b/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst index d681614..67e5d4d 100644 --- a/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst +++ b/api-ref/source/api/firewall_management/querying_the_number_of_protected_vpcs.rst @@ -30,7 +30,7 @@ GET /v1/{project_id}/vpcs/protection +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -95,21 +95,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/ips_management/enabling_or_disabling_virtual_patching.rst b/api-ref/source/api/ips_management/enabling_or_disabling_virtual_patching.rst index 7e246f0..d433e18 100644 --- a/api-ref/source/api/ips_management/enabling_or_disabling_virtual_patching.rst +++ b/api-ref/source/api/ips_management/enabling_or_disabling_virtual_patching.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/ips/switch +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/ips_management/querying_the_ips_switch_status.rst b/api-ref/source/api/ips_management/querying_the_ips_switch_status.rst index 1198818..97b7e24 100644 --- a/api-ref/source/api/ips_management/querying_the_ips_switch_status.rst +++ b/api-ref/source/api/ips_management/querying_the_ips_switch_status.rst @@ -30,7 +30,7 @@ GET /v1/{project_id}/ips/switch +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/ips_management/querying_the_protection_mode.rst b/api-ref/source/api/ips_management/querying_the_protection_mode.rst index 2d46c4e..128dd41 100644 --- a/api-ref/source/api/ips_management/querying_the_protection_mode.rst +++ b/api-ref/source/api/ips_management/querying_the_protection_mode.rst @@ -30,7 +30,7 @@ GET /v1/{project_id}/ips/protect +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | object_id | Yes | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -75,21 +75,12 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/ips_management/switching_the_protection_mode.rst b/api-ref/source/api/ips_management/switching_the_protection_mode.rst index 5f92694..fa1ce9c 100644 --- a/api-ref/source/api/ips_management/switching_the_protection_mode.rst +++ b/api-ref/source/api/ips_management/switching_the_protection_mode.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/ips/protect +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,21 +81,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/log_management/add_log_config.rst b/api-ref/source/api/log_management/add_log_config.rst index c41817f..45ca4aa 100644 --- a/api-ref/source/api/log_management/add_log_config.rst +++ b/api-ref/source/api/log_management/add_log_config.rst @@ -30,7 +30,7 @@ POST /v1/{project_id}/cfw/logs/configuration +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/api/log_management/list_log_config.rst b/api-ref/source/api/log_management/list_log_config.rst index cdc4dc5..dd09cd5 100644 --- a/api-ref/source/api/log_management/list_log_config.rst +++ b/api-ref/source/api/log_management/list_log_config.rst @@ -30,7 +30,7 @@ GET /v1/{project_id}/cfw/logs/configuration +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/api/log_management/querying_access_control_logs.rst b/api-ref/source/api/log_management/querying_access_control_logs.rst index 10e8902..fcfd659 100644 --- a/api-ref/source/api/log_management/querying_access_control_logs.rst +++ b/api-ref/source/api/log_management/querying_access_control_logs.rst @@ -66,7 +66,7 @@ GET /v1/{project_id}/cfw/logs/access-control | | | | | | | | | - **vpc** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dst_host | No | String | destination host | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -185,21 +185,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/log_management/querying_attack_logs.rst b/api-ref/source/api/log_management/querying_attack_logs.rst index e42a537..ca07157 100644 --- a/api-ref/source/api/log_management/querying_attack_logs.rst +++ b/api-ref/source/api/log_management/querying_attack_logs.rst @@ -74,7 +74,7 @@ GET /v1/{project_id}/cfw/logs/attack +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | source | No | String | Source | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dst_host | No | String | destination host | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -241,21 +241,12 @@ Response Parameters .. table:: **Table 8** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/log_management/querying_flow_logs.rst b/api-ref/source/api/log_management/querying_flow_logs.rst index ed25462..92ed470 100644 --- a/api-ref/source/api/log_management/querying_flow_logs.rst +++ b/api-ref/source/api/log_management/querying_flow_logs.rst @@ -78,7 +78,7 @@ GET /v1/{project_id}/cfw/logs/flow | | | | | | | | | Maximum: **1024** | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dst_host | No | String | destination host | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -201,21 +201,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/log_management/update_log_config.rst b/api-ref/source/api/log_management/update_log_config.rst index b89b0db..3cff8dc 100644 --- a/api-ref/source/api/log_management/update_log_config.rst +++ b/api-ref/source/api/log_management/update_log_config.rst @@ -30,7 +30,7 @@ PUT /v1/{project_id}/cfw/logs/configuration +=======================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters diff --git a/api-ref/source/api/service_set_management/batch_delete_service_items.rst b/api-ref/source/api/service_set_management/batch_delete_service_items.rst index 79f27f8..432a7b0 100644 --- a/api-ref/source/api/service_set_management/batch_delete_service_items.rst +++ b/api-ref/source/api/service_set_management/batch_delete_service_items.rst @@ -28,7 +28,7 @@ DELETE /v1/{project_id}/service-items +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/api/service_set_management/creating_a_service_member.rst b/api-ref/source/api/service_set_management/creating_a_service_member.rst index bc74eeb..0ce09e7 100644 --- a/api-ref/source/api/service_set_management/creating_a_service_member.rst +++ b/api-ref/source/api/service_set_management/creating_a_service_member.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/service-items +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -107,21 +107,12 @@ Response Parameters .. table:: **Table 9** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/service_set_management/creating_a_service_set.rst b/api-ref/source/api/service_set_management/creating_a_service_set.rst index 90609ca..3c30a53 100644 --- a/api-ref/source/api/service_set_management/creating_a_service_set.rst +++ b/api-ref/source/api/service_set_management/creating_a_service_set.rst @@ -28,7 +28,7 @@ POST /v1/{project_id}/service-set +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -91,21 +91,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/service_set_management/deleting_a_service_member.rst b/api-ref/source/api/service_set_management/deleting_a_service_member.rst index 26eb5d6..cbd2d4a 100644 --- a/api-ref/source/api/service_set_management/deleting_a_service_member.rst +++ b/api-ref/source/api/service_set_management/deleting_a_service_member.rst @@ -29,7 +29,7 @@ DELETE /v1/{project_id}/service-items/{item_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -72,21 +72,12 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/service_set_management/deleting_a_service_set.rst b/api-ref/source/api/service_set_management/deleting_a_service_set.rst index cf609ad..cfcf171 100644 --- a/api-ref/source/api/service_set_management/deleting_a_service_set.rst +++ b/api-ref/source/api/service_set_management/deleting_a_service_set.rst @@ -29,7 +29,7 @@ DELETE /v1/{project_id}/service-sets/{set_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,21 +73,12 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/service_set_management/modifying_a_service_set.rst b/api-ref/source/api/service_set_management/modifying_a_service_set.rst index b2c1938..bf393a1 100644 --- a/api-ref/source/api/service_set_management/modifying_a_service_set.rst +++ b/api-ref/source/api/service_set_management/modifying_a_service_set.rst @@ -29,7 +29,7 @@ PUT /v1/{project_id}/service-sets/{set_id} +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -90,21 +90,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst b/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst index 324452e..0f7c5da 100644 --- a/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst +++ b/api-ref/source/api/service_set_management/obtaining_the_service_set_list.rst @@ -42,7 +42,7 @@ GET /v1/{project_id}/service-sets | | | | | | | | | Minimum: **0** | +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +------------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -115,21 +115,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/service_set_management/querying_service_set_details.rst b/api-ref/source/api/service_set_management/querying_service_set_details.rst index e3b6d9b..382f368 100644 --- a/api-ref/source/api/service_set_management/querying_service_set_details.rst +++ b/api-ref/source/api/service_set_management/querying_service_set_details.rst @@ -29,7 +29,7 @@ GET /v1/{project_id}/service-sets/{set_id} +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -88,21 +88,12 @@ Response Parameters .. table:: **Table 6** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst b/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst index b0cdc1c..36646a4 100644 --- a/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst +++ b/api-ref/source/api/service_set_management/querying_the_service_set_member_list.rst @@ -36,7 +36,7 @@ GET /v1/{project_id}/service-items +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | enterprise_project_id | No | String | Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project, which can be obtained by calling the ListFirewallList. | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -107,21 +107,12 @@ Response Parameters .. table:: **Table 7** Response body parameters - +-----------------------+-----------------------+-----------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================+ - | error_code | String | Error code | - | | | | - | | | Minimum: **8** | - | | | | - | | | Maximum: **36** | - +-----------------------+-----------------------+-----------------------+ - | error_msg | String | Description | - | | | | - | | | Minimum: **2** | - | | | | - | | | Maximum: **512** | - +-----------------------+-----------------------+-----------------------+ + ========== ====== =========== + Parameter Type Description + ========== ====== =========== + error_code String Error code + error_msg String Description + ========== ====== =========== Example Requests ---------------- diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 3ae3817..c68f970 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,14 @@ Change History +-----------------------------------+----------------------------------------------------------------------------------+ | Release Date | Description | +===================================+==================================================================================+ +| 2024-08-14 | This issue is the fifth official release. | +| | | +| | Optimized "ACL Rule Management". | +| | | +| | - Added the description of parameters such as **acl_rule_id**. | +| | - Modified the endpoint example. | +| | - The method of obtaining the **acl_rule_id** parameter is optimized. | ++-----------------------------------+----------------------------------------------------------------------------------+ | 2024-07-29 | This issue is the fourth official release. | | | | | | Optimized parameter description. |