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

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2024-07-30 09:06:29 +00:00 committed by Lukas Belejkanic
parent c6f8dcefb6
commit 4726b23f2c
58 changed files with 1390 additions and 509 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -75,15 +75,13 @@ Request Parameters
+--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| sequence | Yes | :ref:`OrderRuleAclDto <addaclrule__request_orderruleacldto>` object | Rule sequence |
+--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| address_type | Yes | Integer | Address type. The value can be 0 (IPv4), 1 (IPv6), or 2 (domain). |
| address_type | Yes | Integer | Address type. The value can be 0 (IPv4), 1 (IPv6). |
| | | | |
| | | | Enumeration values: |
| | | | |
| | | | - **0** |
| | | | |
| | | | - **1** |
| | | | |
| | | | - **2** |
+--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| action_type | Yes | Integer | Action. 0: allow; 1: deny |
+--------------------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
@ -155,11 +153,11 @@ Request Parameters
+---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=====================+===========+=======================================================================+====================================================================================================================================================================================================================+
| type | Yes | Integer | Source type. 0: manual input; 1: associated IP address group; 2: domain name; 3: region; 4: domain set 5: multi object, 6: domain set dns, 7: domain url profile |
| 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 |
+---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_type | No | Integer | Source type. 0: IPv4; 1: IPv6 |
| address_type | No | Integer | address type. 0: IPv4; 1: IPv6 |
+---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address | No | String | Source IP address. The value cannot be empty for the manual type, and cannot be empty for the automatic or domain type. |
| address | 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. |
+---------------------+-----------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -223,13 +221,13 @@ Request Parameters
+---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| custom_service | No | Array of :ref:`ServiceItem <addaclrule__request_serviceitem>` objects | custom service |
+---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| predefined_group | No | Array of strings | predefined group |
| predefined_group | No | Array of strings | predefined group, Includes Web Service, Remote Login and Ping, Database |
+---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service_group | No | Array of strings | Service group list |
+---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service_group_names | No | Array of :ref:`ServiceGroupVO <addaclrule__request_servicegroupvo>` objects | Service group name list |
+---------------------+-----------+-----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service_set_type | No | Integer | Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases |
| 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:
@ -308,8 +306,8 @@ Response Parameters
========= ====== ===========
Parameter Type Description
========= ====== ===========
id String id
name String name
id String rule id
name String rule name
========= ====== ===========
**Status code: 400**

4
api-ref/source/api/acl_rule_management/delete_acl_rule.rst
View File

@ -65,8 +65,8 @@ Response Parameters
========= ====== ===========
Parameter Type Description
========= ====== ===========
id String id
name String name
id String rule id
name String rule name
========= ====== ===========
**Status code: 400**

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

@ -46,11 +46,11 @@ Request Parameters
.. table:: **Table 4** Request body parameters
========= ========= ================ ============
Parameter Mandatory Type Description
========= ========= ================ ============
rule_ids Yes Array of strings Rule ID list
========= ========= ================ ============
+-----------+-----------+------------------+------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+==================+====================================================================================+
| rule_ids | Yes | Array of strings | Rule ID list, obtain the ID by calling the API used for querying a protection rule |
+-----------+-----------+------------------+------------------------------------------------------------------------------------+
Response Parameters
-------------------

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

@ -62,15 +62,13 @@ GET /v1/{project_id}/acl-rules
| | | | |
| | | | - **1** |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_type | No | Integer | Address type. The value can be 0 (IPv4). |
| address_type | No | Integer | Address type. The value can be 0 (IPv4), 1 (IPV6). |
| | | | |
| | | | Enumeration values: |
| | | | |
| | | | - **0** |
| | | | |
| | | | - **1** |
| | | | |
| | | | - **2** |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | Yes | Integer | Number of records displayed on each page, in the range 1-1024 |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -88,7 +86,7 @@ GET /v1/{project_id}/acl-rules
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service | No | String | service port |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| application | No | String | application |
| application | No | String | Application protocol, such as HTTP, TLS, etc. |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
@ -286,7 +284,7 @@ Response Parameters
+---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service_group_names | Array of :ref:`ServiceGroupVO <listaclrules__response_servicegroupvo>` objects | Service group name list |
+---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service_set_type | Integer | Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases |
| service_set_type | Integer | predefined service set type, 1 indicates Web Service, 2 indicates Remote login and PING, 3 indicates Databases |
+---------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _listaclrules__response_serviceitem:

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

@ -77,8 +77,8 @@ Response Parameters
========= ====== ===========
Parameter Type Description
========= ====== ===========
id String id
name String name
id String rule id
name String rule name
========= ====== ===========
**Status code: 400**

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

@ -226,13 +226,13 @@ Request Parameters
+---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| custom_service | No | Array of :ref:`ServiceItem <updateaclrule__request_serviceitem>` objects | custom service |
+---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| predefined_group | No | Array of strings | predefined group |
| predefined_group | No | Array of strings | predefined group, Includes Web Service, Remote Login and Ping, Database |
+---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service_group | No | Array of strings | Service group list |
+---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service_group_names | No | Array of :ref:`ServiceGroupVO <updateaclrule__request_servicegroupvo>` objects | Service group name list |
+---------------------+-----------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| service_set_type | No | Integer | Service set type, 0 indicates a custom service set, 1 indicates a predefined service set, 2 indicates commonly used remote login and PING, 3 indicates commonly used databases |
| 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:
@ -301,8 +301,8 @@ Response Parameters
========= ====== ===========
Parameter Type Description
========= ====== ===========
id String id
name String name
id String rule id
name String rule name
========= ====== ===========
**Status code: 400**

26
api-ref/source/api/address_set_management/adding_an_address_set.rst
View File

@ -55,7 +55,7 @@ Request Parameters
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | Address group description |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). |
| address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). The default value is 0 |
| | | | |
| | | | Enumeration values: |
| | | | |
@ -71,22 +71,22 @@ Response Parameters
.. table:: **Table 5** Response body parameters
+-----------+-----------------------------------------------------------+-----------------------------------------------+
| Parameter | Type | Description |
+===========+===========================================================+===============================================+
| data | :ref:`IdObject <addaddressset__response_idobject>` object | Data returned after an address group is added |
+-----------+-----------------------------------------------------------+-----------------------------------------------+
+-----------+-------------------------------------------------------------------------+-----------------------------------------------+
| Parameter | Type | Description |
+===========+=========================================================================+===============================================+
| data | :ref:`AddressIdObject <addaddressset__response_addressidobject>` object | Data returned after an address group is added |
+-----------+-------------------------------------------------------------------------+-----------------------------------------------+
.. _addaddressset__response_idobject:
.. _addaddressset__response_addressidobject:
.. table:: **Table 6** IdObject
.. table:: **Table 6** AddressIdObject
========= ====== ===========
========= ====== ===================
Parameter Type Description
========= ====== ===========
id String ID
name String name
========= ====== ===========
========= ====== ===================
id String ip address set id
name String ip address set name
========= ====== ===================
**Status code: 400**

44
api-ref/source/api/address_set_management/adding_an_address_set_member.rst
View File

@ -46,13 +46,13 @@ Request Parameters
.. table:: **Table 4** Request body parameters
+---------------+-----------+-------------------------------------------------------------------------------+----------------------------------+
| Parameter | Mandatory | Type | Description |
+===============+===========+===============================================================================+==================================+
| set_id | No | String | ID of the IP address group |
+---------------+-----------+-------------------------------------------------------------------------------+----------------------------------+
| address_items | No | Array of :ref:`address_items <addaddressitem__request_address_items>` objects | Address group member information |
+---------------+-----------+-------------------------------------------------------------------------------+----------------------------------+
+---------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===============+===========+===============================================================================+================================================================================================+
| set_id | Yes | String | ID of the IP address group, obtain the ID by calling the API used for querying ip address sets |
+---------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| address_items | Yes | Array of :ref:`address_items <addaddressitem__request_address_items>` objects | Address group member information |
+---------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
.. _addaddressitem__request_address_items:
@ -61,8 +61,6 @@ Request Parameters
+--------------+-----------+---------+------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+=========+======================================================+
| name | Yes | String | Address name |
+--------------+-----------+---------+------------------------------------------------------+
| address_type | No | Integer | Address type. The value can be 0 (IPv4) or 1 (IPv6). |
+--------------+-----------+---------+------------------------------------------------------+
| address | No | String | IP address information of the address group |
@ -87,24 +85,23 @@ Response Parameters
.. table:: **Table 7** AddressItems
+------------+----------------------------------------------------------------------------+----------------------------------+
| Parameter | Type | Description |
+============+============================================================================+==================================+
| items | Array of :ref:`IdObject <addaddressitem__response_idobject>` objects | List of address group member IDs |
+------------+----------------------------------------------------------------------------+----------------------------------+
| covered_ip | Array of :ref:`CoveredIPVO <addaddressitem__response_coveredipvo>` objects | covered ip list |
+------------+----------------------------------------------------------------------------+----------------------------------+
+------------+--------------------------------------------------------------------------------------------+----------------------------------+
| Parameter | Type | Description |
+============+============================================================================================+==================================+
| items | Array of :ref:`AddressItemIdObject <addaddressitem__response_addressitemidobject>` objects | List of address group member IDs |
+------------+--------------------------------------------------------------------------------------------+----------------------------------+
| covered_ip | Array of :ref:`CoveredIPVO <addaddressitem__response_coveredipvo>` objects | covered ip list |
+------------+--------------------------------------------------------------------------------------------+----------------------------------+
.. _addaddressitem__response_idobject:
.. _addaddressitem__response_addressitemidobject:
.. table:: **Table 8** IdObject
.. table:: **Table 8** AddressItemIdObject
========= ====== ===========
========= ====== ===============
Parameter Type Description
========= ====== ===========
id String ID
name String name
========= ====== ===========
========= ====== ===============
id String address item id
========= ====== ===============
.. _addaddressitem__response_coveredipvo:
@ -150,7 +147,6 @@ Add an address group member whose IP address is 2.2.2.2 and name is ceshi to the
"set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c",
"address_items" : [ {
"description" : "",
"name" : "ceshi",
"address" : "2.2.2.2"
} ]
}

13
api-ref/source/api/address_set_management/batch_delete_address_items.rst
View File

@ -46,12 +46,13 @@ Request Parameters
.. table:: **Table 4** Request body parameters
================ ========= ================ ================
Parameter Mandatory Type Description
================ ========= ================ ================
set_id Yes String set id
address_item_ids Yes Array of strings address item ids
================ ========= ================ ================
+------------------+-----------+------------------+-------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==================+===========+==================+===========================================================================================+
| set_id | Yes | String | set id, obtain the ID by calling the API used for querying ip address sets. |
+------------------+-----------+------------------+-------------------------------------------------------------------------------------------+
| address_item_ids | Yes | Array of strings | address item ids, obtain the ID by calling the API used for querying address set members. |
+------------------+-----------+------------------+-------------------------------------------------------------------------------------------+
Response Parameters
-------------------

2
api-ref/source/api/blacklist_and_whitelist_management/creating_a_blacklist_or_whitelist_rule.rst
View File

@ -57,7 +57,7 @@ Request Parameters
+--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address_type | Yes | Integer | IP address type. 0: ipv4; 1: ipv6 |
+--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address | Yes | String | Address type |
| address | Yes | String | IP Address |
+--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | Yes | Integer | Protocol type. The value 6 indicates TCP, 17 indicates UDP, 1 indicates ICMP, 58 indicates ICMPv6, and -1 indicates any protocol. Regarding the addition type, a null value indicates it is automatically added. |
+--------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -45,8 +45,6 @@ GET /v1/{project_id}/black-white-lists
| | | | - **0** |
| | | | |
| | | | - **1** |
| | | | |
| | | | - **2** |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| address | No | String | IP address |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

120
api-ref/source/api/capture_management/cancel_capture_task.rst Normal file
View File

File diff suppressed because it is too large Load Diff

178
api-ref/source/api/capture_management/create_capture_task.rst Normal file
View File

File diff suppressed because it is too large Load Diff

120
api-ref/source/api/capture_management/delete_capture_task.rst Normal file
View File

File diff suppressed because it is too large Load Diff

22
api-ref/source/api/capture_management/index.rst Normal file
View File

@ -0,0 +1,22 @@
:original_name: topic_300000009.html
.. _topic_300000009:
Capture Management
==================
- :ref:`list capture task <listcapturetask>`
- :ref:`Create capture task <createcapturetask>`
- :ref:`Delete capture task <deletecapturetask>`
- :ref:`list capture task result <listcaptureresult>`
- :ref:`cancel capture task <cancelcapturetask>`
.. toctree::
:maxdepth: 1
:hidden:
list_capture_task
create_capture_task
delete_capture_task
list_capture_task_result
cancel_capture_task

183
api-ref/source/api/capture_management/list_capture_task.rst Normal file
View File

File diff suppressed because it is too large Load Diff

144
api-ref/source/api/capture_management/list_capture_task_result.rst Normal file
View File

File diff suppressed because it is too large Load Diff

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

@ -53,7 +53,7 @@ Request Parameters
+-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| object_id | Yes | String | Internet border Protected object ID, You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. |
+-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | Yes | String | name |
| name | Yes | String | domain set name |
+-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | description |
+-----------------+-----------+-----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -66,12 +66,12 @@ Request Parameters
.. table:: **Table 5** DomainSetInfoDto
=========== ========= ====== ===========
=========== ========= ====== =======================================
Parameter Mandatory Type Description
=========== ========= ====== ===========
domain_name Yes String domain name
=========== ========= ====== =======================================
domain_name Yes String domain name, for example, www.test.com.
description No String description
=========== ========= ====== ===========
=========== ========= ====== =======================================
Response Parameters
-------------------
@ -90,12 +90,12 @@ Response Parameters
.. table:: **Table 7** DomainSetResponseData
========= ====== ===========
========= ====== ===============
Parameter Type Description
========= ====== ===========
id String id
name String name
========= ====== ===========
========= ====== ===============
id String domain set id
name String domain set name
========= ====== ===============
Example Requests
----------------

20
api-ref/source/api/domain_parse_and_domain_set_management/add_domains.rst
View File

@ -2,7 +2,7 @@
.. _AddDomains:
add domains
Add Domains
===========
Function
@ -61,12 +61,12 @@ Request Parameters
.. table:: **Table 5** DomainSetInfoDto
=========== ========= ====== ===========
=========== ========= ====== =======================================
Parameter Mandatory Type Description
=========== ========= ====== ===========
domain_name Yes String domain name
=========== ========= ====== =======================================
domain_name Yes String domain name, for example, www.test.com.
description No String description
=========== ========= ====== ===========
=========== ========= ====== =======================================
Response Parameters
-------------------
@ -85,12 +85,12 @@ Response Parameters
.. table:: **Table 7** DomainSetResponseData
========= ====== ===========
========= ====== ===============
Parameter Type Description
========= ====== ===========
id String id
name String name
========= ====== ===========
========= ====== ===============
id String domain set id
name String domain set name
========= ====== ===============
Example Requests
----------------

10
api-ref/source/api/domain_parse_and_domain_set_management/delete_domain_set.rst
View File

@ -62,12 +62,12 @@ Response Parameters
.. table:: **Table 5** DomainSetResponseData
========= ====== ===========
========= ====== ===============
Parameter Type Description
========= ====== ===========
id String id
name String name
========= ====== ===========
========= ====== ===============
id String domain set id
name String domain set name
========= ====== ===============
Example Requests
----------------

12
api-ref/source/api/domain_parse_and_domain_set_management/delete_domains.rst
View File

@ -2,7 +2,7 @@
.. _DeleteDomains:
delete domains
Delete Domains
==============
Function
@ -70,12 +70,12 @@ Response Parameters
.. table:: **Table 6** DomainSetResponseData
========= ====== ===========
========= ====== ===============
Parameter Type Description
========= ====== ===========
id String id
name String name
========= ====== ===========
========= ====== ===============
id String domain set id
name String domain set name
========= ====== ===============
Example Requests
----------------

8
api-ref/source/api/domain_parse_and_domain_set_management/index.rst
View File

@ -8,10 +8,10 @@ Domain Parse and Domain Set Management
- :ref:`Add Domain Set <adddomainset>`
- :ref:`Delete Domain Set <deletedomainset>`
- :ref:`Update Domain Set <updatedomainset>`
- :ref:`list domain sets <listdomainsets>`
- :ref:`list domains <listdomains>`
- :ref:`add domains <adddomains>`
- :ref:`delete domains <deletedomains>`
- :ref:`List Domain Sets <listdomainsets>`
- :ref:`List Domains <listdomains>`
- :ref:`Add Domains <adddomains>`
- :ref:`Delete Domains <deletedomains>`
- :ref:`Querying the DNS Server List <listdnsservers>`
- :ref:`Updating the DNS Server List <updatednsservers>`
- :ref:`Querying the IP Address for Domain Name Resolution <listdomainparsedetail>`

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

@ -2,7 +2,7 @@
.. _ListDomainSets:
list domain sets
List Domain Sets
================
Function
@ -89,25 +89,23 @@ Response Parameters
.. table:: **Table 6** DomainSetVo
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========================================================================+============================================================================+
| set_id | String | set id |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| name | String | domain set name |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| description | String | description |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| ref_count | Integer | reference count |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| domain_set_type | Integer | Domain name group type. 0 means Application type and 1 means Network type. |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| config_status | Integer | config status |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| message | String | message |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
| rules | Array of :ref:`UseRuleVO <listdomainsets__response_userulevo>` objects | used rule list |
+-----------------+------------------------------------------------------------------------+----------------------------------------------------------------------------+
+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=================+========================================================================+===============================================================================+
| set_id | String | set id |
+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| name | String | domain set name |
+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| description | String | description |
+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| ref_count | Integer | Number of times referenced by protection rules |
+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| domain_set_type | Integer | Domain name group type. 0 means Application type and 1 means Network type. |
+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| config_status | Integer | config status, 0(config failed), 1(config success), 2(configuring), 3(normal) |
+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| rules | Array of :ref:`UseRuleVO <listdomainsets__response_userulevo>` objects | used rule list |
+-----------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------+
.. _listdomainsets__response_userulevo:

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

@ -2,7 +2,7 @@
.. _ListDomains:
list domains
List Domains
============
Function
@ -13,16 +13,16 @@ list domains
URI
---
GET /v1/{project_id}/domain-set/domains/{domain_set_id}
GET /v1/{project_id}/domain-set/domains/{set_id}
.. table:: **Table 1** Path Parameters
============= ========= ====== =============
Parameter Mandatory Type Description
============= ========= ====== =============
project_id Yes String Project ID
domain_set_id Yes String domain set id
============= ========= ====== =============
========== ========= ====== =============
Parameter Mandatory Type Description
========== ========= ====== =============
project_id Yes String Project ID
set_id Yes String domain set id
========== ========= ====== =============
.. table:: **Table 2** Query Parameters

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

@ -70,7 +70,7 @@ Response Parameters
+--------------------------+---------+-----------------------------------------------------------------+
| Parameter | Type | Description |
+==========================+=========+=================================================================+
| id | Integer | id |
| id | Integer | dns server id |
+--------------------------+---------+-----------------------------------------------------------------+
| is_applied | Integer | Indicates whether to apply. 0: no; 1: yes |
+--------------------------+---------+-----------------------------------------------------------------+

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

@ -54,11 +54,11 @@ Response Parameters
.. table:: **Table 4** Response body parameters
========= ================ ===================
Parameter Type Description
========= ================ ===================
data Array of strings Domain name ID list
========= ================ ===================
+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+==================+==============================================================================================================================+
| data | Array of strings | Domain name ID list, The resolution result of the domain is returned. If the result is empty, the domain cannot be resolved. |
+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**

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

@ -71,12 +71,12 @@ Response Parameters
.. table:: **Table 6** DomainSetResponseData
========= ====== ===========
========= ====== ===============
Parameter Type Description
========= ====== ===========
id String id
name String name
========= ====== ===========
========= ====== ===============
id String domain set id
name String domain set name
========= ====== ===============
Example Requests
----------------

6
api-ref/source/api/eip_management/enabling_or_disabling_an_eipto_enable_and_disable_eip_you_must_use_listeips_to_synchronize_eip_assets_before_enabling_eip_protection_for_the_first_time_after_purchasing_eip_and_set_the_sync_field_to_1..rst → api-ref/source/api/eip_management/enabling_or_disabling_an_eip.rst
View File

@ -2,8 +2,8 @@
.. _ChangeEipStatus:
Enabling or Disabling an EIP,To enable and disable EIP, you must use ListEips to synchronize EIP assets before enabling EIP protection for the first time after purchasing EIP, and set the sync field to 1.
============================================================================================================================================================================================================
Enabling or Disabling an EIP
============================
Function
--------
@ -116,7 +116,7 @@ Response Parameters
+------------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fail_eip_id_list | Array of strings | failed eip id list |
+------------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | ID |
| id | String | firewall instance id |
+------------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**

4
api-ref/source/api/eip_management/index.rst
View File

@ -6,7 +6,7 @@ EIP Management
==============
- :ref:`Querying the Number of EIPs <listeipcount>`
- :ref:`Enabling or Disabling an EIP,To enable and disable EIP, you must use ListEips to synchronize EIP assets before enabling EIP protection for the first time after purchasing EIP, and set the sync field to 1. <changeeipstatus>`
- :ref:`Enabling or Disabling an EIP <changeeipstatus>`
- :ref:`Querying the EIP List <listeips>`
.. toctree::
@ -14,5 +14,5 @@ EIP Management
:hidden:
querying_the_number_of_eips
enabling_or_disabling_an_eipto_enable_and_disable_eip_you_must_use_listeips_to_synchronize_eip_assets_before_enabling_eip_protection_for_the_first_time_after_purchasing_eip_and_set_the_sync_field_to_1.
enabling_or_disabling_an_eip
querying_the_eip_list

12
api-ref/source/api/firewall_management/changing_the_east-west_firewall_protection_status.rst
View File

@ -72,18 +72,16 @@ Response Parameters
+===========+==================================================================+===============+
| data | :ref:`data <changeeastwestfirewallstatus__response_data>` object | Response body |
+-----------+------------------------------------------------------------------+---------------+
| trace_id | String | trace id |
+-----------+------------------------------------------------------------------+---------------+
.. _changeeastwestfirewallstatus__response_data:
.. table:: **Table 6** data
========= ====== ===========
Parameter Type Description
========= ====== ===========
id String ID
========= ====== ===========
+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+==========================================================================================================================================+
| id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. |
+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**

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

@ -46,15 +46,15 @@ Request Parameters
.. table:: **Table 4** Request body parameters
+-----------------+-----------+--------+-----------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+===========+========+=====================================================+
| er_id | No | String | Instance ID of the associated outbound ER |
+-----------------+-----------+--------+-----------------------------------------------------+
| inspection_cidr | Yes | String | inspection cidr |
+-----------------+-----------+--------+-----------------------------------------------------+
| mode | Yes | String | east-west protection mode,only er mode is supported |
+-----------------+-----------+--------+-----------------------------------------------------+
+-----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+===========+========+=================================================================================================================+
| er_id | No | String | Instance ID of the associated outbound ER, which can be obtained by calling the Querying Enterprise Routers API |
+-----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------+
| inspection_cidr | Yes | String | inspection cidr |
+-----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------+
| mode | Yes | String | east-west protection mode,only er mode is supported |
+-----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------+
Response Parameters
-------------------
@ -73,26 +73,26 @@ Response Parameters
.. table:: **Table 6** CreateEWFirewallResp
+----------------+----------------------------------------------------------------------------------------------------------------+----------------+
| Parameter | Type | Description |
+================+================================================================================================================+================+
| id | String | Id |
+----------------+----------------------------------------------------------------------------------------------------------------+----------------+
| er | :ref:`ER <createeastwestfirewall__response_er>` object | ER data |
+----------------+----------------------------------------------------------------------------------------------------------------+----------------+
| inspertion_vpc | :ref:`CreateEWFirewallInspectVpcResp <createeastwestfirewall__response_createewfirewallinspectvpcresp>` object | inspection vpc |
+----------------+----------------------------------------------------------------------------------------------------------------+----------------+
+----------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+================+================================================================================================================+==========================================================================================================================================+
| id | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. |
+----------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| er | :ref:`ER <createeastwestfirewall__response_er>` object | ER data |
+----------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| inspertion_vpc | :ref:`CreateEWFirewallInspectVpcResp <createeastwestfirewall__response_createewfirewallinspectvpcresp>` object | inspection vpc |
+----------------+----------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
.. _createeastwestfirewall__response_er:
.. table:: **Table 7** ER
============ ====== ============
============ ====== ==================================================
Parameter Type Description
============ ====== ============
============ ====== ==================================================
er_id String ER ID
er_attach_id String ER attach ID
============ ====== ============
er_attach_id String ER attachment ID, connection id between CFW and ER
============ ====== ==================================================
.. _createeastwestfirewall__response_createewfirewallinspectvpcresp:

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

File diff suppressed because it is too large Load Diff

96
api-ref/source/api/firewall_management/create_tags.rst Normal file
View File

@ -0,0 +1,96 @@
:original_name: CreateTag.html
.. _CreateTag:
Create tags
===========
Function
--------
Creating tags for firewalls.
URI
---
POST /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/create
.. table:: **Table 1** Path Parameters
+----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| project_id | Yes | String | project ID |
+----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
.. table:: **Table 2** Request header parameters
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+====================================================================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 3** Request body parameters
+-----------+-----------+------------------------------------------------------------------+-------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+==================================================================+=============+
| tags | No | Array of :ref:`CreateTag <createtag__request_createtag>` objects | tag list |
+-----------+-----------+------------------------------------------------------------------+-------------+
.. _createtag__request_createtag:
.. table:: **Table 4** CreateTag
========= ========= ====== ===========
Parameter Mandatory Type Description
========= ========= ====== ===========
key No String key
value No String value
========= ========= ====== ===========
Response Parameters
-------------------
None
Example Requests
----------------
Add a tag to the project ID 0b2179bbe180d3762fb0c01a2d5725c7 and the firewall ID 5e7eba7f-5de4-4ce9-8f60-11330dfc6565 with the keytest key and valuetest valuetest.
.. code-block::
https://{Endpoint}/v2/0b2179bbe180d3762fb0c01a2d5725c7/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/create
{
"tags" : [ {
"key" : "keytest",
"value" : "valuetest"
} ]
}
Example Responses
-----------------
None
Status Codes
------------
=========== ===========
Status Code Description
=========== ===========
200 OK
=========== ===========
Error Codes
-----------
See :ref:`Error Codes <errorcode>`.

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

@ -17,12 +17,13 @@ DELETE /v2/{project_id}/firewall/{resource_id}
.. table:: **Table 1** Path Parameters
=========== ========= ====== ===========
Parameter Mandatory Type Description
=========== ========= ====== ===========
project_id Yes String Project ID
resource_id Yes String Resource Id
=========== ========= ====== ===========
+-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=============+===========+========+=========================================================================================================================================================================+
| project_id | Yes | String | Project ID |
+-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| resource_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. |
+-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------

97
api-ref/source/api/firewall_management/delete_tags.rst Normal file
View File

@ -0,0 +1,97 @@
:original_name: DeleteTag.html
.. _DeleteTag:
Delete Tags
===========
Function
--------
Deleting firewall tag
URI
---
DELETE /v2/{project_id}/cfw-cfw/{fw_instance_id}/tags/delete
.. table:: **Table 1** Path Parameters
+----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+================+===========+========+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| project_id | Yes | String | project ID |
+----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| fw_instance_id | Yes | String | Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
+----------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
.. table:: **Table 2** Request header parameters
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+====================================================================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 3** Request body parameters
+-----------+-----------+----------------------------------------------------------------------+-------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+======================================================================+=============+
| tags | No | Array of :ref:`ResourceTag <deletetag__request_resourcetag>` objects | tag list |
+-----------+-----------+----------------------------------------------------------------------+-------------+
.. _deletetag__request_resourcetag:
.. table:: **Table 4** ResourceTag
=========== ========= ====== ===========
Parameter Mandatory Type Description
=========== ========= ====== ===========
key No String
value No String
update_time No String update time
=========== ========= ====== ===========
Response Parameters
-------------------
None
Example Requests
----------------
Delete the firewall tag in the firewall where the project ID is 0b2179bbe180d3762fb0c01a2d5725c7 and the firewall ID is 5e7eba7f-5de4-4ce9-8f60-11330dfc6565
.. code-block::
https://{Endpoint}/v2/408972e72dcd4c1a9b033e955802a36b/cfw-cfw/5e7eba7f-5de4-4ce9-8f60-11330dfc6565/tags/delete
{
"tags" : [ {
"key" : "keytest",
"value" : "valuetest"
} ]
}
Example Responses
-----------------
None
Status Codes
------------
=========== ===========
Status Code Description
=========== ===========
200
=========== ===========
Error Codes
-----------
See :ref:`Error Codes <errorcode>`.

8
api-ref/source/api/firewall_management/index.rst
View File

@ -8,12 +8,14 @@ Firewall Management
- :ref:`Create Firewall <createfirewall>`
- :ref:`List Job Status <listjob>`
- :ref:`Delete firewall instance <deletefirewall>`
- :ref:`list firewall list <listfirewalllist>`
- :ref:`List Firewalls <listfirewalllist>`
- :ref:`Obtaining East-West Firewall Information <listeastwestfirewall>`
- :ref:`Create East West Firewall <createeastwestfirewall>`
- :ref:`Querying the Number of Protected VPCs <listprotectedvpcs>`
- :ref:`Changing the East-West Firewall Protection Status <changeeastwestfirewallstatus>`
- :ref:`List Firewall Detail <listfirewalldetail>`
- :ref:`Create tags <createtag>`
- :ref:`Delete Tags <deletetag>`
.. toctree::
:maxdepth: 1
@ -22,9 +24,11 @@ Firewall Management
create_firewall
list_job_status
delete_firewall_instance
list_firewall_list
list_firewalls
obtaining_east-west_firewall_information
create_east_west_firewall
querying_the_number_of_protected_vpcs
changing_the_east-west_firewall_protection_status
list_firewall_detail
create_tags
delete_tags

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

File diff suppressed because it is too large Load Diff

6
api-ref/source/api/firewall_management/list_firewall_list.rst → api-ref/source/api/firewall_management/list_firewalls.rst
View File

@ -2,13 +2,13 @@
.. _ListFirewallList:
list firewall list
==================
List Firewalls
==============
Function
--------
list firewall list
List firewall
URI
---

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

@ -17,12 +17,13 @@ GET /v3/{project_id}/jobs/{job_id}
.. table:: **Table 1** Path Parameters
========== ========= ====== ===========
Parameter Mandatory Type Description
========== ========= ====== ===========
project_id Yes String Project ID
job_id Yes String job id
========== ========= ====== ===========
+------------+-----------+--------+------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+============+===========+========+==================================================================+
| project_id | Yes | String | Project ID |
+------------+-----------+--------+------------------------------------------------------------------+
| job_id | Yes | String | job id,which can be obtained by calling the Create Firewall API. |
+------------+-----------+--------+------------------------------------------------------------------+
Request Parameters
------------------

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

@ -102,7 +102,7 @@ Response Parameters
+-------------------+---------+-------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===================+=========+===========================================================================================+
| availability_zone | String | Subnet ID |
| availability_zone | String | availability zone |
+-------------------+---------+-------------------------------------------------------------------------------------------+
| cidr | String | vpc cidr |
+-------------------+---------+-------------------------------------------------------------------------------------------+
@ -123,17 +123,23 @@ Response Parameters
.. table:: **Table 7** ErInstance
===================== ====== ======================
Parameter Type Description
===================== ====== ======================
id String ER instance ID
name String ER name
state String ER status
enterprise_project_id String Enterprise user ID
project_id String User ID
enable_ipv6 String Whether to enable IPv6
attachment_id String ER attachment id
===================== ====== ======================
+-----------------------+--------+------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+========+========================================================================+
| id | String | ER ID |
+-----------------------+--------+------------------------------------------------------------------------+
| name | String | ER name |
+-----------------------+--------+------------------------------------------------------------------------+
| state | String | Er Running status: pending|available|modifying|deleting|deleted|failed |
+-----------------------+--------+------------------------------------------------------------------------+
| enterprise_project_id | String | Enterprise project ID |
+-----------------------+--------+------------------------------------------------------------------------+
| project_id | String | Project ID |
+-----------------------+--------+------------------------------------------------------------------------+
| enable_ipv6 | String | Whether to enable IPv6 |
+-----------------------+--------+------------------------------------------------------------------------+
| attachment_id | String | ER attachment ID, connection id between CFW and ER |
+-----------------------+--------+------------------------------------------------------------------------+
.. _listeastwestfirewall__response_vpcdetail:
@ -145,7 +151,6 @@ Response Parameters
id String id
name String Name
cidr String vpc cidr
status String Status
========= ====== ===========
.. _listeastwestfirewall__response_ewprotectresourceinfo:
@ -272,8 +277,7 @@ Get EastWest Firewall Response
"status" : 1
} ],
"status" : 0,
"total" : 6,
"special_vpc" : [ ]
"total" : 6
}
}

2
api-ref/source/api/index.rst
View File

@ -14,6 +14,7 @@ API
- :ref:`Domain Parse and Domain Set Management <topic_300000006>`
- :ref:`IPS Management <topic_300000007>`
- :ref:`Log Management <topic_300000008>`
- :ref:`Capture Management <topic_300000009>`
.. toctree::
:maxdepth: 1
@ -28,3 +29,4 @@ API
domain_parse_and_domain_set_management/index
ips_management/index
log_management/index
capture_management/index

21
api-ref/source/api/ips_management/enabling_or_disabling_ips.rst → api-ref/source/api/ips_management/enabling_or_disabling_virtual_patching.rst
View File

@ -2,8 +2,8 @@
.. _ChangeIpsSwitchStatus:
Enabling or Disabling IPS
=========================
Enabling or Disabling Virtual Patching
======================================
Function
--------
@ -43,8 +43,6 @@ Request Parameters
+==============+===========+========+====================================================================================================================================================+
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| X-Language | No | String | Language header, the default is zh-cn, if you need to use English, please select en-us. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 4** Request body parameters
@ -57,11 +55,15 @@ Request Parameters
| | | | |
| | | | Enumeration values: |
| | | | |
| | | | - **1** |
| | | | |
| | | | - **2** |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | Yes | Integer | IPS switch status |
| status | Yes | Integer | IPS switch status, 0: virtual patch is disabled; 1: the virtual patch is enabled; |
| | | | |
| | | | Enumeration values: |
| | | | |
| | | | - **0** |
| | | | |
| | | | - **1** |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters
@ -97,7 +99,7 @@ Enable or disable the basic patch and virtual patch of the engine on the user po
https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default
{
"ips_type" : 1,
"ips_type" : 2,
"object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48",
"status" : 1
}
@ -114,8 +116,7 @@ OK
{
"data" : {
"id" : "1530de8a-522d-4771-9067-9fa4e2f53b48"
},
"trace_id" : "358144a9885ff55100aa63cb0d0e1039"
}
}
Status Codes

4
api-ref/source/api/ips_management/index.rst
View File

@ -6,7 +6,7 @@ IPS Management
==============
- :ref:`Querying the IPS Switch Status <listipsswitchstatus>`
- :ref:`Enabling or Disabling IPS <changeipsswitchstatus>`
- :ref:`Enabling or Disabling Virtual Patching <changeipsswitchstatus>`
- :ref:`Querying the Protection Mode <listipsprotectmode>`
- :ref:`Switching the Protection Mode <changeipsprotectmode>`
@ -15,6 +15,6 @@ IPS Management
:hidden:
querying_the_ips_switch_status
enabling_or_disabling_ips
enabling_or_disabling_virtual_patching
querying_the_protection_mode
switching_the_protection_mode

14
api-ref/source/api/ips_management/querying_the_protection_mode.rst
View File

@ -63,13 +63,13 @@ Response Parameters
.. table:: **Table 5** IpsProtectModeObject
+-----------+---------+-----------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+=========+=========================================================================================+
| id | String | ips protect mode id |
+-----------+---------+-----------------------------------------------------------------------------------------+
| mode | Integer | IPS protection mode. 0: observation mode; 1: strict mode; 2: medium mode; 3: loose mode |
+-----------+---------+-----------------------------------------------------------------------------------------+
+-----------+---------+-----------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+=========+=================================================================================================================+
| id | String | ips protect mode id |
+-----------+---------+-----------------------------------------------------------------------------------------------------------------+
| mode | Integer | IPS protection mode. 0: observation mode; 1: strict mode; 2: medium mode; 3: loose mode, The default value is 0 |
+-----------+---------+-----------------------------------------------------------------------------------------------------------------+
**Status code: 400**

4
api-ref/source/api/ips_management/switching_the_protection_mode.rst
View File

@ -49,9 +49,9 @@ Request Parameters
+-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+=========+================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| object_id | No | String | Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ. |
| object_id | 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. |
+-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| mode | No | Integer | IPS protection mode. 0: observation mode; 1: strict mode; 2: medium mode; 3: loose mode |
| mode | Yes | Integer | IPS protection mode. 0: observation mode; 1: strict mode; 2: medium mode; 3: loose mode |
+-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Parameters

16
api-ref/source/api/log_management/add_log_config.rst
View File

@ -53,17 +53,17 @@ Request Parameters
+------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_enable | Yes | Integer | whether to enable LTS |
+------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_log_group_id | Yes | String | Lts log group id |
| lts_log_group_id | Yes | String | Lts log group id, which can be obtained by calling the Querying All Log Groups of an Account API |
+------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_attack_log_stream_id | No | String | Lts attack log stream id |
| lts_attack_log_stream_id | No | String | Lts attack log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API |
+------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_attack_log_stream_enable | Yes | Integer | whether to enable attack log streaming |
+------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_access_log_stream_id | No | String | Lts access log stream id |
| lts_access_log_stream_id | No | String | Lts access log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API |
+------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_access_log_stream_enable | Yes | Integer | whether to enable access log streaming |
+------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_flow_log_stream_id | No | String | Lts flow log stream id |
| lts_flow_log_stream_id | No | String | Lts flow log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API |
+------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_flow_log_stream_enable | Yes | Integer | whether to enable flow log streaming |
+------------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -75,11 +75,11 @@ Response Parameters
.. table:: **Table 5** Response body parameters
========= ====== ============================
========= ====== ====================
Parameter Type Description
========= ====== ============================
data String Add Log Config Response Body
========= ====== ============================
========= ====== ====================
data String Firewall instance Id
========= ====== ====================
Example Requests
----------------

8
api-ref/source/api/log_management/list_log_config.rst
View File

@ -68,17 +68,17 @@ Response Parameters
+------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_enable | Integer | whether to enable LTS |
+------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_log_group_id | String | Lts log group id |
| lts_log_group_id | String | Lts log group id, which can be obtained by calling the Querying All Log Groups of an Account API |
+------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_attack_log_stream_id | String | Lts attack log stream id |
| lts_attack_log_stream_id | String | Lts attack log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API |
+------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_attack_log_stream_enable | Integer | whether to enable attack log streaming |
+------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_access_log_stream_id | String | Lts access log stream id |
| lts_access_log_stream_id | String | Lts access log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API |
+------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_access_log_stream_enable | Integer | whether to enable access log streaming |
+------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_flow_log_stream_id | String | Lts flow log stream id |
| lts_flow_log_stream_id | String | Lts flow log stream id, which can be obtained by calling the Querying Querying All Log Streams in a Specified Log Group API |
+------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| lts_flow_log_stream_enable | Integer | whether to enable flow log streaming |
+------------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -80,11 +80,11 @@ GET /v1/{project_id}/cfw/logs/access-control
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| src_province_name | No | String | source province name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_province_name | No | String | dst province name |
| dst_province_name | No | String | destination province name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| src_city_name | No | String | source city name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_city_name | No | String | dst city name |
| dst_city_name | No | String | destination city name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
@ -172,13 +172,13 @@ Response Parameters
+-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| src_city_name | String | source city name |
+-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_province_id | String | dst province id |
| dst_province_id | String | destination province id |
+-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_province_name | String | dst province name |
| dst_province_name | String | destination province name |
+-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_city_id | String | dst city id |
| dst_city_id | String | destination city id |
+-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_city_name | String | dst city name |
| dst_city_name | String | destination city name |
+-------------------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**
@ -238,10 +238,10 @@ OK
"src_province_name" : "source province name",
"src_city_id" : "source city id",
"src_city_name" : "source city name",
"dst_province_id" : "dst province id",
"dst_province_name" : "dst province name",
"dst_city_id" : "dst city id",
"dst_city_name" : "dst city name"
"dst_province_id" : "destination province id",
"dst_province_name" : "destination province name",
"dst_city_id" : "destination city id",
"dst_city_name" : "destination city name"
} ],
"total" : 1
}

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

@ -96,11 +96,11 @@ GET /v1/{project_id}/cfw/logs/attack
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| src_province_name | No | String | source province name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_province_name | No | String | dst province name |
| dst_province_name | No | String | destination province name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| src_city_name | No | String | source city name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_city_name | No | String | dst city name |
| dst_city_name | No | String | destination city name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
@ -216,13 +216,13 @@ Response Parameters
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+
| src_city_name | String | source city name |
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+
| dst_province_id | String | dst province id |
| dst_province_id | String | destination province id |
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+
| dst_province_name | String | dst province name |
| dst_province_name | String | destination province name |
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+
| dst_city_id | String | dst city id |
| dst_city_id | String | destination city id |
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+
| dst_city_name | String | dst city name |
| dst_city_name | String | destination city name |
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------+
.. _listattacklogs__response_packetmessage:
@ -333,10 +333,10 @@ OK
"src_province_name" : "source province name",
"src_city_id" : "source city id",
"src_city_name" : "source city name",
"dst_province_id" : "dst province id",
"dst_province_name" : "dst province name",
"dst_city_id" : "dst city id",
"dst_city_name" : "dst city name"
"dst_province_id" : "destination province id",
"dst_province_name" : "destination province name",
"dst_city_id" : "destination city id",
"dst_city_name" : "destination city name"
} ],
"total" : 1
}

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

@ -84,15 +84,15 @@ GET /v1/{project_id}/cfw/logs/flow
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| src_region_name | No | String | source region name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_region_name | No | String | dst region name |
| dst_region_name | No | String | destination region name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| src_province_name | No | String | source province name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_province_name | No | String | dst province name |
| dst_province_name | No | String | destination province name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| src_city_name | No | String | source city name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_city_name | No | String | dst city name |
| dst_city_name | No | String | destination city name |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
@ -188,13 +188,13 @@ Response Parameters
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| src_city_name | String | source city name |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_province_id | String | dst province id |
| dst_province_id | String | destination province id |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_province_name | String | dst province name |
| dst_province_name | String | destination province name |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_city_id | String | dst city id |
| dst_city_id | String | destination city id |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dst_city_name | String | dst city name |
| dst_city_name | String | destination city name |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Status code: 400**
@ -255,10 +255,10 @@ OK
"src_province_name" : "source province name",
"src_city_id" : "source city id",
"src_city_name" : "source city name",
"dst_province_id" : "dst province id",
"dst_province_name" : "dst province name",
"dst_city_id" : "dst city id",
"dst_city_name" : "dst city name"
"dst_province_id" : "destination province id",
"dst_province_name" : "destination province name",
"dst_city_id" : "destination city id",
"dst_city_name" : "destination city name"
} ],
"total" : 1
}

Some files were not shown because too many files have changed in this diff Show More