forked from docs/virtual-private-cloud
Update content
This commit is contained in:
parent
a72beb5b20
commit
fbdb57d7e9
BIN
api-ref/source/_static/images/en-us_image_0000001487964866.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001487964866.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 14 KiB |
BIN
api-ref/source/_static/images/en-us_image_0000001538444809.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001538444809.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 14 KiB |
BIN
api-ref/source/_static/images/en-us_image_0000001538445357.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001538445357.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 28 KiB |
20
api-ref/source/api_v3/index.rst
Normal file
20
api-ref/source/api_v3/index.rst
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
:original_name: vpc_apiv3_0000.html
|
||||||
|
|
||||||
|
.. _vpc_apiv3_0000:
|
||||||
|
|
||||||
|
API V3
|
||||||
|
======
|
||||||
|
|
||||||
|
- :ref:`VPC <vpc_apiv3_0001>`
|
||||||
|
- :ref:`Security Group <vpc_apiv3_0009>`
|
||||||
|
- :ref:`Security Group Rule <vpc_apiv3_0015>`
|
||||||
|
- :ref:`IP Address Group <vpc_apiv3_0021>`
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
vpc/index
|
||||||
|
security_group/index
|
||||||
|
security_group_rule/index
|
||||||
|
ip_address_group/index
|
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,55 @@
|
|||||||
|
:original_name: vpc_apiv3_0026.html
|
||||||
|
|
||||||
|
.. _vpc_apiv3_0026:
|
||||||
|
|
||||||
|
Deleting an IP Address Group
|
||||||
|
============================
|
||||||
|
|
||||||
|
Function
|
||||||
|
--------
|
||||||
|
|
||||||
|
This API is used to delete an IP address group. Before deleting an IP address group, ensure that no resource is using this group.
|
||||||
|
|
||||||
|
URI
|
||||||
|
---
|
||||||
|
|
||||||
|
DELETE /v3/{project_id}/vpc/address-groups/{address_group_id}
|
||||||
|
|
||||||
|
.. table:: **Table 1** Parameter description
|
||||||
|
|
||||||
|
+------------------+-----------+--------+----------------------------------------------------------------------+
|
||||||
|
| Parameter | Mandatory | Type | Description |
|
||||||
|
+==================+===========+========+======================================================================+
|
||||||
|
| address_group_id | Yes | String | IP address group ID, which uniquely identifies the IP address group. |
|
||||||
|
+------------------+-----------+--------+----------------------------------------------------------------------+
|
||||||
|
| project_id | Yes | String | Project ID. |
|
||||||
|
+------------------+-----------+--------+----------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Request Parameter
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
Example Request
|
||||||
|
---------------
|
||||||
|
|
||||||
|
- Deleting an IP address group
|
||||||
|
|
||||||
|
.. code-block::
|
||||||
|
|
||||||
|
"DELETE https://{{endpoint}}/v3/{{tenant_id}}/vpc/address-groups/dd18a501-fcd5-4adc-acfe-b0e2384baf08"
|
||||||
|
|
||||||
|
Example Response
|
||||||
|
----------------
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
Status Code
|
||||||
|
-----------
|
||||||
|
|
||||||
|
See :ref:`Status Codes <vpc_api_0002>`.
|
||||||
|
|
||||||
|
Error Code
|
||||||
|
----------
|
||||||
|
|
||||||
|
See :ref:`Error Codes <vpc_api_0003>`.
|
@ -0,0 +1,55 @@
|
|||||||
|
:original_name: vpc_apiv3_0027.html
|
||||||
|
|
||||||
|
.. _vpc_apiv3_0027:
|
||||||
|
|
||||||
|
Forcibly Deleting an IP Address Group
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
Function
|
||||||
|
--------
|
||||||
|
|
||||||
|
This API is used to forcibly delete an IP address group. If the IP address group to be deleted has associated security group rules, the IP address group and its associated rules will be deleted together.
|
||||||
|
|
||||||
|
URI
|
||||||
|
---
|
||||||
|
|
||||||
|
DELETE /v3/{project_id}/vpc/address-groups/{address_group_id}/force
|
||||||
|
|
||||||
|
.. table:: **Table 1** Parameter description
|
||||||
|
|
||||||
|
+------------------+-----------+--------+---------------------------------------------------------------------------------------+
|
||||||
|
| Parameter | Mandatory | Type | Description |
|
||||||
|
+==================+===========+========+=======================================================================================+
|
||||||
|
| address_group_id | Yes | String | ID of the IP address group to be deleted. It uniquely identifies an IP address group. |
|
||||||
|
+------------------+-----------+--------+---------------------------------------------------------------------------------------+
|
||||||
|
| project_id | Yes | String | Project ID. |
|
||||||
|
+------------------+-----------+--------+---------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
|
Request Parameter
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
Example Request
|
||||||
|
---------------
|
||||||
|
|
||||||
|
- Forcibly deleting an IP address group
|
||||||
|
|
||||||
|
.. code-block::
|
||||||
|
|
||||||
|
"DELETE https://{{endpoint}}/v3/{{tenant_id}}/vpc/address-groups/dd18a501-fcd5-4adc-acfe-b0e2384baf08/force"
|
||||||
|
|
||||||
|
Example Response
|
||||||
|
----------------
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
Status Code
|
||||||
|
-----------
|
||||||
|
|
||||||
|
See :ref:`Status Codes <vpc_api_0002>`.
|
||||||
|
|
||||||
|
Error Code
|
||||||
|
----------
|
||||||
|
|
||||||
|
See :ref:`Error Codes <vpc_api_0003>`.
|
24
api-ref/source/api_v3/ip_address_group/index.rst
Normal file
24
api-ref/source/api_v3/ip_address_group/index.rst
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
:original_name: vpc_apiv3_0021.html
|
||||||
|
|
||||||
|
.. _vpc_apiv3_0021:
|
||||||
|
|
||||||
|
IP Address Group
|
||||||
|
================
|
||||||
|
|
||||||
|
- :ref:`Creating an IP Address Group <vpc_apiv3_0022>`
|
||||||
|
- :ref:`Querying IP Address Groups <vpc_apiv3_0023>`
|
||||||
|
- :ref:`Querying Details of an IP Address Group <vpc_apiv3_0024>`
|
||||||
|
- :ref:`Updating an IP Address Group <vpc_apiv3_0025>`
|
||||||
|
- :ref:`Deleting an IP Address Group <vpc_apiv3_0026>`
|
||||||
|
- :ref:`Forcibly Deleting an IP Address Group <vpc_apiv3_0027>`
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
creating_an_ip_address_group
|
||||||
|
querying_ip_address_groups
|
||||||
|
querying_details_of_an_ip_address_group
|
||||||
|
updating_an_ip_address_group
|
||||||
|
deleting_an_ip_address_group
|
||||||
|
forcibly_deleting_an_ip_address_group
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
22
api-ref/source/api_v3/security_group/index.rst
Normal file
22
api-ref/source/api_v3/security_group/index.rst
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
:original_name: vpc_apiv3_0009.html
|
||||||
|
|
||||||
|
.. _vpc_apiv3_0009:
|
||||||
|
|
||||||
|
Security Group
|
||||||
|
==============
|
||||||
|
|
||||||
|
- :ref:`Creating a Security Group <vpc_apiv3_0010>`
|
||||||
|
- :ref:`Querying Security Groups <vpc_apiv3_0011>`
|
||||||
|
- :ref:`Querying a Security Group <vpc_apiv3_0012>`
|
||||||
|
- :ref:`Updating a Security Group <vpc_apiv3_0013>`
|
||||||
|
- :ref:`Deleting a Security Group <vpc_apiv3_0014>`
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
creating_a_security_group
|
||||||
|
querying_security_groups
|
||||||
|
querying_a_security_group
|
||||||
|
updating_a_security_group
|
||||||
|
deleting_a_security_group
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,59 @@
|
|||||||
|
:original_name: vpc_apiv3_0019.html
|
||||||
|
|
||||||
|
.. _vpc_apiv3_0019:
|
||||||
|
|
||||||
|
Deleting a Security Group Rule
|
||||||
|
==============================
|
||||||
|
|
||||||
|
Function
|
||||||
|
--------
|
||||||
|
|
||||||
|
This API is used to delete a security group rule.
|
||||||
|
|
||||||
|
URI
|
||||||
|
---
|
||||||
|
|
||||||
|
DELETE /v3/{project_id}/vpc/security-group-rules/{security_group_rule_id}
|
||||||
|
|
||||||
|
.. table:: **Table 1** Parameter description
|
||||||
|
|
||||||
|
====================== ========= ====== =======================
|
||||||
|
Parameter Mandatory Type Description
|
||||||
|
====================== ========= ====== =======================
|
||||||
|
project_id Yes String Project ID.
|
||||||
|
security_group_rule_id Yes String Security group rule ID.
|
||||||
|
====================== ========= ====== =======================
|
||||||
|
|
||||||
|
Request Parameter
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
Example Request
|
||||||
|
---------------
|
||||||
|
|
||||||
|
- Delete a single security group rule.
|
||||||
|
|
||||||
|
.. code-block::
|
||||||
|
|
||||||
|
"DELETE https://{Endpoint}/v3/{project_id}/vpc/security-group-rules/01a772b2-463e-47e3-a95d-bac85ee8adc6"
|
||||||
|
|
||||||
|
Response Parameter
|
||||||
|
------------------
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
Example Response
|
||||||
|
----------------
|
||||||
|
|
||||||
|
None
|
||||||
|
|
||||||
|
Status Code
|
||||||
|
-----------
|
||||||
|
|
||||||
|
See :ref:`Status Codes <vpc_api_0002>`.
|
||||||
|
|
||||||
|
Error Code
|
||||||
|
----------
|
||||||
|
|
||||||
|
See :ref:`Error Codes <vpc_api_0003>`.
|
20
api-ref/source/api_v3/security_group_rule/index.rst
Normal file
20
api-ref/source/api_v3/security_group_rule/index.rst
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
:original_name: vpc_apiv3_0015.html
|
||||||
|
|
||||||
|
.. _vpc_apiv3_0015:
|
||||||
|
|
||||||
|
Security Group Rule
|
||||||
|
===================
|
||||||
|
|
||||||
|
- :ref:`Creating a Security Group Rule <vpc_apiv3_0016>`
|
||||||
|
- :ref:`Querying Security Group Rules <vpc_apiv3_0017>`
|
||||||
|
- :ref:`Querying a Security Group Rule <vpc_apiv3_0018>`
|
||||||
|
- :ref:`Deleting a Security Group Rule <vpc_apiv3_0019>`
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
creating_a_security_group_rule
|
||||||
|
querying_security_group_rules
|
||||||
|
querying_a_security_group_rule
|
||||||
|
deleting_a_security_group_rule
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
20
api-ref/source/api_v3/vpc/index.rst
Normal file
20
api-ref/source/api_v3/vpc/index.rst
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
:original_name: vpc_apiv3_0001.html
|
||||||
|
|
||||||
|
.. _vpc_apiv3_0001:
|
||||||
|
|
||||||
|
VPC
|
||||||
|
===
|
||||||
|
|
||||||
|
- :ref:`Querying VPCs <vpc_apiv3_0003>`
|
||||||
|
- :ref:`Querying Details About a VPC <vpc_apiv3_0004>`
|
||||||
|
- :ref:`Adding a Secondary CIDR Block to a VPC <vpc_apiv3_0007>`
|
||||||
|
- :ref:`Removing a Secondary CIDR Block from a VPC <vpc_apiv3_0008>`
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
querying_vpcs
|
||||||
|
querying_details_about_a_vpc
|
||||||
|
adding_a_secondary_cidr_block_to_a_vpc
|
||||||
|
removing_a_secondary_cidr_block_from_a_vpc
|
195
api-ref/source/api_v3/vpc/querying_details_about_a_vpc.rst
Normal file
195
api-ref/source/api_v3/vpc/querying_details_about_a_vpc.rst
Normal file
File diff suppressed because it is too large
Load Diff
304
api-ref/source/api_v3/vpc/querying_vpcs.rst
Normal file
304
api-ref/source/api_v3/vpc/querying_vpcs.rst
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -92,7 +92,7 @@ Response Message
|
|||||||
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. |
|
| enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. |
|
||||||
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| enterprise_project_id | String | - Specifies the enterprise project ID. |
|
| enterprise_project_id | String | - Enterprise project ID |
|
||||||
| | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. |
|
| | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. |
|
||||||
| | | |
|
| | | |
|
||||||
| | | .. note:: |
|
| | | .. note:: |
|
||||||
|
@ -182,7 +182,6 @@ Response Message
|
|||||||
"traffic_type": "reject",
|
"traffic_type": "reject",
|
||||||
"log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd",
|
"log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd",
|
||||||
"log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
|
"log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
|
||||||
|
|
||||||
"created_at": "2019-01-14T11:03:02",
|
"created_at": "2019-01-14T11:03:02",
|
||||||
"updated_at": "2019-01-14T11:03:02",
|
"updated_at": "2019-01-14T11:03:02",
|
||||||
"index_enabled": false,
|
"index_enabled": false,
|
||||||
|
@ -122,7 +122,6 @@ Response Message
|
|||||||
"traffic_type": "reject",
|
"traffic_type": "reject",
|
||||||
"log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff",
|
"log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff",
|
||||||
"log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
|
"log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
|
||||||
|
|
||||||
"created_at": "2019-01-14T11:03:02",
|
"created_at": "2019-01-14T11:03:02",
|
||||||
"updated_at": "2019-01-14T11:03:02",
|
"updated_at": "2019-01-14T11:03:02",
|
||||||
"status": "ACTIVE",
|
"status": "ACTIVE",
|
||||||
|
@ -177,7 +177,6 @@ Response Message
|
|||||||
"traffic_type": "reject",
|
"traffic_type": "reject",
|
||||||
"log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff",
|
"log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff",
|
||||||
"log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
|
"log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
|
||||||
|
|
||||||
"created_at": "2019-01-14T11:03:02",
|
"created_at": "2019-01-14T11:03:02",
|
||||||
"updated_at": "2019-01-14T11:03:02",
|
"updated_at": "2019-01-14T11:03:02",
|
||||||
"status": "ACTIVE",
|
"status": "ACTIVE",
|
||||||
|
@ -152,7 +152,6 @@ Response Message
|
|||||||
"traffic_type": "reject",
|
"traffic_type": "reject",
|
||||||
"log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd",
|
"log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd",
|
||||||
"log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
|
"log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63",
|
||||||
|
|
||||||
"created_at": "2019-01-14T11:03:02",
|
"created_at": "2019-01-14T11:03:02",
|
||||||
"updated_at": "2019-01-14T12:03:02",
|
"updated_at": "2019-01-14T12:03:02",
|
||||||
"status": "DOWN",
|
"status": "DOWN",
|
||||||
|
@ -54,13 +54,17 @@ Request parameter
|
|||||||
|
|
||||||
.. table:: **Table 3** Description of the **tag** field
|
.. table:: **Table 3** Description of the **tag** field
|
||||||
|
|
||||||
+--------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Name | Mandatory | Type | Description |
|
| Name | Mandatory | Type | Description |
|
||||||
+========+===========+==================+=================================================================================================================================================================================+
|
+=================+=================+==================+=================================================================================================================================================================================================================+
|
||||||
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
|
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
|
||||||
+--------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| values | Yes | Array of strings | Specifies the tag values. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. |
|
| values | Yes | Array of strings | Specifies the tag values. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. |
|
||||||
+--------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
| | | | |
|
||||||
|
| | | | The values are in the OR relationship. |
|
||||||
|
| | | | |
|
||||||
|
| | | | Resources that match any value can be found. For example, if resource A has a tag value of **val1** and resource B has a tag value of **val2**, resources A and B can be found by using **values={val1,val2}**. |
|
||||||
|
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
.. _vpc_tag_0005__table104959232192:
|
.. _vpc_tag_0005__table104959232192:
|
||||||
|
|
||||||
@ -168,13 +172,17 @@ Response parameter
|
|||||||
|
|
||||||
.. table:: **Table 7** Description of the **tag** field
|
.. table:: **Table 7** Description of the **tag** field
|
||||||
|
|
||||||
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Name | Mandatory | Type | Description |
|
| Name | Mandatory | Type | Description |
|
||||||
+========+===========+==================+====================================================================================================================================================================================+
|
+=================+=================+==================+=================================================================================================================================================================================================================+
|
||||||
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
|
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
|
||||||
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. |
|
| values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. |
|
||||||
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
| | | | |
|
||||||
|
| | | | The values are in the OR relationship. |
|
||||||
|
| | | | |
|
||||||
|
| | | | Resources that match any value can be found. For example, if resource A has a tag value of **val1** and resource B has a tag value of **val2**, resources A and B can be found by using **values={val1,val2}**. |
|
||||||
|
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Example response 1: Setting **action** to **filter**
|
Example response 1: Setting **action** to **filter**
|
||||||
|
|
||||||
|
@ -8,7 +8,21 @@ Change History
|
|||||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Released On | Description |
|
| Released On | Description |
|
||||||
+===================================+============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
|
+===================================+============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
|
||||||
| 2022-02-28 | This release incorporates the following changes: |
|
| 2023-4-7 | This release incorporates the following changes: |
|
||||||
|
| | |
|
||||||
|
| | Added the following sections: |
|
||||||
|
| | |
|
||||||
|
| | - :ref:`VPC <vpc_apiv3_0001>` |
|
||||||
|
| | - :ref:`Security Group <vpc_apiv3_0009>` |
|
||||||
|
| | - :ref:`Security Group Rule <vpc_apiv3_0015>` |
|
||||||
|
| | - :ref:`IP Address Group <vpc_apiv3_0021>` |
|
||||||
|
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| 2023-03-10 | This release incorporates the following changes: |
|
||||||
|
| | |
|
||||||
|
| | - Added description that a firewall policy needs to be associated with a firewall group in :ref:`Creating a Firewall Policy <vpc_firewall_0008>`. |
|
||||||
|
| | - Added :ref:`What Are the Relationships Among Firewall Groups, Policies, and Rules? <en-us_topic_0000001487936070>` to describe the relationships among firewall resources and provide examples. |
|
||||||
|
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| 2023-02-28 | This release incorporates the following changes: |
|
||||||
| | |
|
| | |
|
||||||
| | - Modified description about the **limit** parameter in :ref:`Querying Firewall Groups <vpc_firewall_0013>`. |
|
| | - Modified description about the **limit** parameter in :ref:`Querying Firewall Groups <vpc_firewall_0013>`. |
|
||||||
| | - Modified description about the **router:external** parameter in :ref:`Creating a Network <vpc_network_0003>`. |
|
| | - Modified description about the **router:external** parameter in :ref:`Creating a Network <vpc_network_0003>`. |
|
||||||
|
14
api-ref/source/faqs/index.rst
Normal file
14
api-ref/source/faqs/index.rst
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
:original_name: vpc_api_0004.html
|
||||||
|
|
||||||
|
.. _vpc_api_0004:
|
||||||
|
|
||||||
|
FAQs
|
||||||
|
====
|
||||||
|
|
||||||
|
- :ref:`What Are the Relationships Among Firewall Groups, Policies, and Rules? <en-us_topic_0000001487936070>`
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
what_are_the_relationships_among_firewall_groups_policies_and_rules
|
File diff suppressed because it is too large
Load Diff
@ -7,7 +7,9 @@ Virtual Private Cloud - API Reference
|
|||||||
|
|
||||||
api_usage_guidelines
|
api_usage_guidelines
|
||||||
apis/index
|
apis/index
|
||||||
|
api_v3/index
|
||||||
native_openstack_neutron_apis_v2.0/index
|
native_openstack_neutron_apis_v2.0/index
|
||||||
permissions_policies_and_supported_actions/index
|
permissions_policies_and_supported_actions/index
|
||||||
|
faqs/index
|
||||||
appendix/index
|
appendix/index
|
||||||
change_history
|
change_history
|
||||||
|
@ -30,33 +30,41 @@ Request Message
|
|||||||
|
|
||||||
.. table:: **Table 2** **Firewall Group** objects
|
.. table:: **Table 2** **Firewall Group** objects
|
||||||
|
|
||||||
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Attribute | Mandatory | Type | Description |
|
| Attribute | Mandatory | Type | Description |
|
||||||
+============================+=================+==================+============================================================================================+
|
+============================+=================+==================+=================================================================================================================================================================================================================+
|
||||||
| name | No | String | Specifies the name of the firewall group. |
|
| name | No | String | Specifies the name of the firewall group. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The value can contain a maximum of 255 characters. |
|
| | | | The value can contain a maximum of 255 characters. |
|
||||||
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| description | No | String | Provides supplementary information about the firewall group. |
|
| description | No | String | Provides supplementary information about the firewall group. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The value can contain a maximum of 255 characters. |
|
| | | | The value can contain a maximum of 255 characters. |
|
||||||
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| ingress_firewall_policy_id | No | String | Specifies the firewall policy for inbound traffic. |
|
| ingress_firewall_policy_id | No | String | Specifies the firewall policy for inbound traffic. |
|
||||||
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| egress_firewall_policy_id | No | String | Specifies the firewall policy for outbound traffic. |
|
| egress_firewall_policy_id | No | String | Specifies the firewall policy for outbound traffic. |
|
||||||
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| ports | No | Array of strings | Specifies the list of ports bound with the firewall group. |
|
| ports | No | Array of strings | Specifies the list of ports bound with the firewall group. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The value must be the port ID. |
|
| | | | The value must be the port ID. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | .. note:: |
|
| | | | .. note:: |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The port is the one whose **device_owner** is **network:router_interface_distributed**. |
|
| | | | The port is the one whose **device_owner** is **network:router_interface_distributed**. |
|
||||||
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
|
| | | | |
|
||||||
| admin_state_up | No | Boolean | Specifies the administrative status of the firewall. |
|
| | | | - Call the VPC API for querying the port ID. The filtering criteria are the specified **network_id** and **device_owner**. The **network_id** is the network ID of the subnet associated with the firewall. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The value can be **true** or **false**. |
|
| | | | Example: |
|
||||||
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
|
| | | | |
|
||||||
|
| | | | .. code:: text |
|
||||||
|
| | | | |
|
||||||
|
| | | | GET https://{Endpoint}/v1/{project_id}/ports?network_id={network_id}&device_owner=network%3Arouter_interface_distributed |
|
||||||
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
| admin_state_up | No | Boolean | Specifies the administrative status of the firewall. |
|
||||||
|
| | | | |
|
||||||
|
| | | | The value can be **true** or **false**. |
|
||||||
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Example Request
|
Example Request
|
||||||
---------------
|
---------------
|
||||||
|
@ -8,7 +8,7 @@ Creating a Firewall Policy
|
|||||||
Function
|
Function
|
||||||
--------
|
--------
|
||||||
|
|
||||||
This API is used to create a firewall policy.
|
This API is used to create a firewall policy. A firewall policy must be associated with a firewall group. You can learn more about the :ref:`relationships among network ACL groups, policies, and rules <en-us_topic_0000001487936070>`.
|
||||||
|
|
||||||
URI
|
URI
|
||||||
---
|
---
|
||||||
|
@ -30,41 +30,41 @@ Request Message
|
|||||||
|
|
||||||
.. table:: **Table 2** **Firewall Group** objects
|
.. table:: **Table 2** **Firewall Group** objects
|
||||||
|
|
||||||
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| Attribute | Mandatory | Type | Description |
|
| Attribute | Mandatory | Type | Description |
|
||||||
+============================+=================+==================+===================================================================================================================================+
|
+============================+=================+==================+=================================================================================================================================================================================================================+
|
||||||
| name | No | String | Specifies the name of the firewall group. |
|
| name | No | String | Specifies the name of the firewall group. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The value can contain a maximum of 255 characters. |
|
| | | | The value can contain a maximum of 255 characters. |
|
||||||
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| description | No | String | Provides supplementary information about the firewall group. |
|
| description | No | String | Provides supplementary information about the firewall group. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The value can contain a maximum of 255 characters. |
|
| | | | The value can contain a maximum of 255 characters. |
|
||||||
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| ingress_firewall_policy_id | No | String | Specifies the firewall policy for inbound traffic. |
|
| ingress_firewall_policy_id | No | String | Specifies the firewall policy for inbound traffic. |
|
||||||
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| egress_firewall_policy_id | No | String | Specifies the firewall policy for outbound traffic. |
|
| egress_firewall_policy_id | No | String | Specifies the firewall policy for outbound traffic. |
|
||||||
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| ports | No | Array of strings | Specifies the list of ports bound with the firewall group. |
|
| ports | No | Array of strings | Specifies the list of ports bound with the firewall group. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The value must be the port ID. |
|
| | | | The value must be the port ID. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | .. note:: |
|
| | | | .. note:: |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The port is the one whose **device_owner** is **network:router_interface_distributed**. |
|
| | | | The port is the one whose **device_owner** is **network:router_interface_distributed**. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | - Call the VPC API for querying the port ID. The filtering criteria are the specified **network_id** and **device_owner**. |
|
| | | | - Call the VPC API for querying the port ID. The filtering criteria are the specified **network_id** and **device_owner**. The **network_id** is the network ID of the subnet associated with the firewall. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | Example: |
|
| | | | Example: |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | .. code:: text |
|
| | | | .. code:: text |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | GET https://{Endpoint}/v1/{project_id}/ports?network_id={network_id}&device_owner=network%3Arouter_interface_distributed |
|
| | | | GET https://{Endpoint}/v1/{project_id}/ports?network_id={network_id}&device_owner=network%3Arouter_interface_distributed |
|
||||||
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| admin_state_up | No | Boolean | Specifies the administrative status of the firewall. |
|
| admin_state_up | No | Boolean | Specifies the administrative status of the firewall. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The value can be **true** or **false**. |
|
| | | | The value can be **true** or **false**. |
|
||||||
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
+----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
|
|
||||||
Example Request
|
Example Request
|
||||||
---------------
|
---------------
|
||||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -40,7 +40,7 @@ Request Message
|
|||||||
+-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| admin_state_up | No | Boolean | Specifies the administrative status. |
|
| admin_state_up | No | Boolean | Specifies the administrative status. |
|
||||||
| | | | |
|
| | | | |
|
||||||
| | | | The value can only be **true**. |
|
| | | | The default value is **true**. |
|
||||||
+-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| fixed_ips | No | Array of :ref:`fixed_ip <vpc_port02_0003__table335683819394>` objects | Specifies the port IP address. For details, see :ref:`Table 3 <vpc_port02_0003__table335683819394>`. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. |
|
| fixed_ips | No | Array of :ref:`fixed_ip <vpc_port02_0003__table335683819394>` objects | Specifies the port IP address. For details, see :ref:`Table 3 <vpc_port02_0003__table335683819394>`. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. |
|
||||||
+-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
@ -175,7 +175,7 @@ Response Message
|
|||||||
+-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| admin_state_up | Boolean | Specifies the administrative status. |
|
| admin_state_up | Boolean | Specifies the administrative status. |
|
||||||
| | | |
|
| | | |
|
||||||
| | | The value can only be **true**. |
|
| | | The default value is **true**. |
|
||||||
+-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. |
|
| mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. |
|
||||||
| | | |
|
| | | |
|
||||||
|
@ -67,7 +67,7 @@ Response Message
|
|||||||
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| admin_state_up | Boolean | Specifies the administrative status. |
|
| admin_state_up | Boolean | Specifies the administrative status. |
|
||||||
| | | |
|
| | | |
|
||||||
| | | The value can only be **true**. |
|
| | | The default value is **true**. |
|
||||||
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. |
|
| mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. |
|
||||||
| | | |
|
| | | |
|
||||||
|
@ -152,7 +152,7 @@ Response Parameter
|
|||||||
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| admin_state_up | Boolean | Specifies the administrative status. |
|
| admin_state_up | Boolean | Specifies the administrative status. |
|
||||||
| | | |
|
| | | |
|
||||||
| | | The value can only be **true**. |
|
| | | The default value is **true**. |
|
||||||
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. |
|
| mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. |
|
||||||
| | | |
|
| | | |
|
||||||
|
@ -160,7 +160,7 @@ Response Message
|
|||||||
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| admin_state_up | Boolean | Specifies the administrative status. |
|
| admin_state_up | Boolean | Specifies the administrative status. |
|
||||||
| | | |
|
| | | |
|
||||||
| | | The value can only be **true**. |
|
| | | The default value is **true**. |
|
||||||
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
+-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||||
| mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. |
|
| mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. |
|
||||||
| | | |
|
| | | |
|
||||||
|
Loading…
x
Reference in New Issue
Block a user