sgode/virtual-private-cloud
1
0
Fork 0
forked from docs/virtual-private-cloud
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-08-08 09:40:16 +00:00
parent 1f49ae13ed
commit cd0947f8ca
51 changed files with 2389 additions and 858 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/apis/bandwidth/querying_a_bandwidth.rst
View File

@ -131,7 +131,7 @@ Response Message
| | | - **6**: IPv6 (IPv6 is not supported currently.) |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |

2
api-ref/source/apis/bandwidth/querying_bandwidths.rst
View File

@ -142,7 +142,7 @@ Response Message
| publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |

2
api-ref/source/apis/bandwidth/updating_a_bandwidth.rst
View File

@ -158,7 +158,7 @@ Response Message
| publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |

4
api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst
View File

@ -63,7 +63,7 @@ Request Message
| publicip_id | Yes | String | Specifies the ID of the EIP that uses the bandwidth. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+
| publicip_type | No | String | - Specifies the EIP type. |
| | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | | - Constraints: |
| | | | |
| | | | - The configured value must be supported by the system. |
@ -167,7 +167,7 @@ Response Message
| | | - **6**: IPv6 (IPv6 is not supported currently.) |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |

2
api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst
View File

@ -161,7 +161,7 @@ Response Message
| publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |

4
api-ref/source/apis/eip/assigning_an_eip.rst
View File

@ -72,7 +72,7 @@ Request Parameters
| Name | Mandatory | Type | Description |
+=================+=================+=================+===============================================================================================================================+
| type | Yes | String | - Specifies the EIP type. |
| | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | | - Constraints: |
| | | | |
| | | | - The configured value must be supported by the system. |
@ -179,7 +179,7 @@ Response Message
| | | - **ERROR** (Exceptions) |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |

2
api-ref/source/apis/eip/querying_an_eip.rst
View File

@ -99,7 +99,7 @@ Response Message
| | | This parameter is not supported currently. |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |

2
api-ref/source/apis/eip/querying_eips.rst
View File

@ -115,7 +115,7 @@ Response Message
| | | This parameter is not supported currently. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |

4
api-ref/source/apis/eip/updating_an_eip.rst
View File

@ -125,13 +125,13 @@ Response Message
| | | This parameter is not supported currently. |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| public_ip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
| public_ip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. (IPv6 is not supported currently.) |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_version | Integer | Specifies the IP address version. The value can be **4** or **6**. |
| | | |

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

@ -16,6 +16,7 @@ APIs
- :ref:`Security Group <vpc_sg01_0000>`
- :ref:`VPC Peering Connection <vpc_peering_0000>`
- :ref:`VPC Route <vpc_route_0000>`
- :ref:`Route Table <vpc_apiroutetab_0000>`
- :ref:`VPC Tag Management <vpc_tag_0000>`
- :ref:`Subnet Tag Management <subnet_tag_0000>`
- :ref:`EIP Tag Management <eip_tag_0000>`
@ -37,6 +38,7 @@ APIs
security_group/index
vpc_peering_connection/index
vpc_route/index
route_table/index
vpc_tag_management/index
subnet_tag_management/index
eip_tag_management/index

12
api-ref/source/apis/quota/querying_quotas.rst
View File

@ -207,6 +207,18 @@ Example Response
"used": 0,
"quota": 10,
"min": 0
},
{
"type": "vpcContainRoutetable",
"used": 0,
"quota": 1,
"min": 0
},
{
"type": "routetableContainRoutes",
"used": 0,
"quota": 200,
"min": 0
}
]
}

213
api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst Normal file
View File

File diff suppressed because it is too large Load Diff

252
api-ref/source/apis/route_table/creating_a_route_table.rst Normal file
View File

File diff suppressed because it is too large Load Diff

66
api-ref/source/apis/route_table/deleting_a_route_table.rst Normal file
View File

@ -0,0 +1,66 @@
:original_name: vpc_apiroutetab_0006.html
.. _vpc_apiroutetab_0006:
Deleting a Route Table
======================
Function
--------
This API is used to delete a custom route table.
Constraints:
Only custom route tables can be deleted. If a custom route table has subnets associated, disassociate the subnets with the route table and then delete the route table.
URI
---
DELETE /v1/{project_id}/routetables/{routetable_id}
:ref:`Table 1 <vpc_apiroutetab_0006__table13893430173220>` describes the parameters.
.. _vpc_apiroutetab_0006__table13893430173220:
.. table:: **Table 1** Parameter description
+---------------+-----------+--------+------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+===============+===========+========+========================================================================+
| project_id | Yes | String | Specifies the project ID. |
+---------------+-----------+--------+------------------------------------------------------------------------+
| routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. |
+---------------+-----------+--------+------------------------------------------------------------------------+
Request Parameters
------------------
None
Example Request
---------------
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054
Response Parameters
-------------------
None
Example Response
----------------
None
Status Code
-----------
See :ref:`Status Codes <vpc_api_0002>`.
Error Code
----------
See :ref:`Error Codes <vpc_api_0003>`.

217
api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst Normal file
View File

File diff suppressed because it is too large Load Diff

26
api-ref/source/apis/route_table/index.rst Normal file
View File

@ -0,0 +1,26 @@
:original_name: vpc_apiroutetab_0000.html
.. _vpc_apiroutetab_0000:
Route Table
===========
- :ref:`Querying Route Tables <vpc_apiroutetab_0001>`
- :ref:`Querying a Route Table <vpc_apiroutetab_0002>`
- :ref:`Creating a Route Table <vpc_apiroutetab_0003>`
- :ref:`Updating a Route Table <vpc_apiroutetab_0004>`
- :ref:`Associating Subnets with a Route Table <vpc_apiroutetab_0005>`
- :ref:`Disassociating Subnets from a Route Table <vpc_apiroutetab_0007>`
- :ref:`Deleting a Route Table <vpc_apiroutetab_0006>`
.. toctree::
:maxdepth: 1
:hidden:
querying_route_tables
querying_a_route_table
creating_a_route_table
updating_a_route_table
associating_subnets_with_a_route_table
disassociating_subnets_from_a_route_table
deleting_a_route_table

193
api-ref/source/apis/route_table/querying_a_route_table.rst Normal file
View File

File diff suppressed because it is too large Load Diff

159
api-ref/source/apis/route_table/querying_route_tables.rst Normal file
View File

File diff suppressed because it is too large Load Diff

370
api-ref/source/apis/route_table/updating_a_route_table.rst Normal file
View File

File diff suppressed because it is too large Load Diff

86
api-ref/source/apis/security_group/creating_a_security_group.rst
View File

@ -127,49 +127,46 @@ Response Parameters
.. table:: **Table 6** **security_group_rule** objects
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=========================+=======================+===========================================================================================================================================================================================================================================================+
| id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the security group rule. |
| | | - The value can contain no more than 255 characters, including letters and digits. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | - Specifies the direction of access control. |
| | | - Possible values are as follows: |
| | | |
| | | - **egress** |
| | | - **ingress** |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | - Specifies the IP protocol version. |
| | | - The value can be **IPv4** or **IPv6**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | - Specifies the protocol type. |
| | | - The value can be **icmp**, **tcp**, or **udp**. |
| | | - If the parameter is left blank, all protocols are supported. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | - Specifies the start port number. |
| | | - The value ranges from 1 to 65535. |
| | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | - Specifies the end port number. |
| | | - The value ranges from 1 to 65535. |
| | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
| | | - The value can be in the CIDR format or IP addresses. |
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | - Specifies the ID of the peer security group. |
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===========================================================================================================================================================================================================================================================+
| id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the security group rule. |
| | | - The value can contain no more than 255 characters, including letters and digits. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | - Specifies the direction of access control. |
| | | - Possible values are as follows: |
| | | |
| | | - **egress** |
| | | - **ingress** |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | - Specifies the IP protocol version. |
| | | - The value can be **IPv4** or **IPv6**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | - Specifies the protocol type. |
| | | - The value can be **icmp**, **tcp**, or **udp**. |
| | | - If the parameter is left blank, all protocols are supported. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | - Specifies the start port number. |
| | | - The value ranges from 1 to 65535. |
| | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | - Specifies the end port number. |
| | | - The value ranges from 1 to 65535. |
| | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
| | | - The value can be in the CIDR format or IP addresses. |
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | - Specifies the ID of the peer security group. |
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
@ -197,8 +194,7 @@ Example Response
"id": "0222556c-6556-40ad-8aac-9fd5d3c06171",
"description": "",
"remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6",
"security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6",
"remote_address_group_id": null
"security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6"
}
]
}

166
api-ref/source/apis/security_group/creating_a_security_group_rule.rst
View File

File diff suppressed because it is too large Load Diff

86
api-ref/source/apis/security_group/querying_security_group_details.rst
View File

@ -87,49 +87,46 @@ Response Parameters
.. table:: **Table 4** **security_group_rule** objects
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=========================+=======================+===========================================================================================================================================================================================================================================================+
| id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the security group rule. |
| | | - The value can contain no more than 255 characters, including letters and digits. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | - Specifies the direction of access control. |
| | | - Possible values are as follows: |
| | | |
| | | - **egress** |
| | | - **ingress** |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | - Specifies the IP protocol version. |
| | | - The value can be **IPv4** or **IPv6**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | - Specifies the protocol type. |
| | | - The value can be **icmp**, **tcp**, or **udp**. |
| | | - If the parameter is left blank, all protocols are supported. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | - Specifies the start port number. |
| | | - The value ranges from 1 to 65535. |
| | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | - Specifies the end port number. |
| | | - The value ranges from 1 to 65535. |
| | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
| | | - The value can be in the CIDR format or IP addresses. |
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | - Specifies the ID of the peer security group. |
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===========================================================================================================================================================================================================================================================+
| id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the security group rule. |
| | | - The value can contain no more than 255 characters, including letters and digits. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | - Specifies the direction of access control. |
| | | - Possible values are as follows: |
| | | |
| | | - **egress** |
| | | - **ingress** |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | - Specifies the IP protocol version. |
| | | - The value can be **IPv4** or **IPv6**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | - Specifies the protocol type. |
| | | - The value can be **icmp**, **tcp**, or **udp**. |
| | | - If the parameter is left blank, all protocols are supported. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | - Specifies the start port number. |
| | | - The value ranges from 1 to 65535. |
| | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | - Specifies the end port number. |
| | | - The value ranges from 1 to 65535. |
| | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
| | | - The value can be in the CIDR format or IP addresses. |
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | - Specifies the ID of the peer security group. |
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
@ -149,8 +146,7 @@ Example Response
"ethertype": "IPv4",
"id": "369e6499-b2cb-4126-972a-97e589692c62",
"description": "",
"security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6",
"remote_address_group_id": null
"security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6"
},
{
"direction": "ingress",

86
api-ref/source/apis/security_group/querying_security_group_rule_details.rst
View File

@ -56,49 +56,46 @@ Response Parameters
.. table:: **Table 3** **security_group_rule** objects
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=========================+=======================+===========================================================================================================================================================================================================================================================+
| id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the security group rule. |
| | | - The value can contain no more than 255 characters, including letters and digits. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | - Specifies the direction of access control. |
| | | - Possible values are as follows: |
| | | |
| | | - **egress** |
| | | - **ingress** |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | - Specifies the IP protocol version. |
| | | - The value can be **IPv4** or **IPv6**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | - Specifies the protocol type. |
| | | - The value can be **icmp**, **tcp**, or **udp**. |
| | | - If the parameter is left blank, all protocols are supported. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | - Specifies the start port number. |
| | | - The value ranges from 1 to 65535. |
| | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | - Specifies the end port number. |
| | | - The value ranges from 1 to 65535. |
| | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
| | | - The value can be in the CIDR format or IP addresses. |
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | - Specifies the ID of the peer security group. |
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===========================================================================================================================================================================================================================================================+
| id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the security group rule. |
| | | - The value can contain no more than 255 characters, including letters and digits. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | - Specifies the direction of access control. |
| | | - Possible values are as follows: |
| | | |
| | | - **egress** |
| | | - **ingress** |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | - Specifies the IP protocol version. |
| | | - The value can be **IPv4** or **IPv6**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | - Specifies the protocol type. |
| | | - The value can be **icmp**, **tcp**, or **udp**. |
| | | - If the parameter is left blank, all protocols are supported. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | - Specifies the start port number. |
| | | - The value ranges from 1 to 65535. |
| | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | - Specifies the end port number. |
| | | - The value ranges from 1 to 65535. |
| | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
| | | - The value can be in the CIDR format or IP addresses. |
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | - Specifies the ID of the peer security group. |
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
@ -117,8 +114,7 @@ Example Response
"remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"remote_ip_prefix": null,
"security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"remote_address_group_id": null
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
}
}

95
api-ref/source/apis/security_group/querying_security_group_rules.rst
View File

File diff suppressed because it is too large Load Diff

143
api-ref/source/apis/security_group/querying_security_groups.rst
View File

File diff suppressed because it is too large Load Diff

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

@ -8,6 +8,10 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| 2023-08-07 | This release incorporates the following changes: |
| | |
| | Added description about interconnection with IAM fine-grained authorization in :ref:`Permissions Policies and Supported Actions <vpc_permission_0000>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-06-20 | This release incorporates the following changes: |
| | |
| | Modified parameters in :ref:`Deleting an EIP Tag <eip_tag_0003>`. |

158
api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_a_specified_api_version.rst
View File

File diff suppressed because it is too large Load Diff

2
api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_api_versions.rst
View File

@ -80,7 +80,7 @@ Example Response
"id": "v2.0",
"links": [
{
"href": "https://None/v2.0",
"href": "https://{Endpoint}/v2.0",
"rel": "self"
}
]

3
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst
View File

@ -77,6 +77,7 @@ Create an ACL group, associate it with the inbound ACL policy afc52ce9-5305-4ec9
{
"firewall_group": {
"name": "test",
"ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341",
"ports": [
"c133f2bf-6937-4416-bb17-012e1be5cd2d"
@ -143,7 +144,7 @@ Example Response
"status": "PENDING_CREATE",
"public": false,
"egress_firewall_policy_id": null,
"name": "",
"name": "test",
"admin_state_up": true,
"ports": [
"c133f2bf-6937-4416-bb17-012e1be5cd2d"

5
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst
View File

@ -106,7 +106,7 @@ Response Parameters
+----------------------------+-----------------------+--------------------------------------------------------------------------+
| public | Boolean | Specifies whether the firewall group can be shared by different tenants. |
+----------------------------+-----------------------+--------------------------------------------------------------------------+
| status | String | Specifies the status of the firewall policy. |
| status | String | Specifies the status of a firewall group. |
+----------------------------+-----------------------+--------------------------------------------------------------------------+
| admin_state_up | Boolean | Specifies the administrative status of the firewall. |
+----------------------------+-----------------------+--------------------------------------------------------------------------+
@ -173,8 +173,7 @@ Example Response
],
"firewall_groups_links": [
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/
fwaas/firewall_groups?marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=True"
"href": "https://{Endpoint}/v2.0/fwaas/firewall_groups?marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=True"
}
]
}

3
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst
View File

@ -149,8 +149,7 @@ Example Response
],
"firewall_policies_links": [
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/
fwaas/firewall_policies?marker=6b70e321-0c21-4b83-bb8a-a886d1414a5f&page_reverse=True"
"href": "https://{Endpoint}/v2.0/fwaas/firewall_policies?marker=6b70e321-0c21-4b83-bb8a-a886d1414a5f&page_reverse=True"
}
]
}

3
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst
View File

@ -187,8 +187,7 @@ Example Response
],
"firewall_rules_links": [
{ "rel": "previous",
"href": "https://{Endpoint}/v2.0/
fwaas/firewall_rules?marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=True"
"href": "https://{Endpoint}/v2.0/fwaas/firewall_rules?marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=True"
}
]
}

2
api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst
View File

@ -129,8 +129,6 @@ Response Parameters
| shared | Boolean | Specifies whether the network can be shared by different tenants. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Specifies the network ID. |
| | | |
| | | This parameter is not mandatory when you query networks. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. |
| | | |

4
api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst
View File

@ -85,7 +85,9 @@ Request Parameters
+-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. |
+-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| device_owner | No | String | Specifies the device to which the port belongs. Currently, only **""** and **neutron:VIP_PORT** are supported. **neutron:VIP_PORT** indicates the port of a virtual IP address. |
| device_owner | No | String | Specifies the device that the port belongs to. |
| | | | |
| | | | Currently, only **""** and **neutron:VIP_PORT** are supported. **neutron:VIP_PORT** indicates the port of a virtual IP address. |
+-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_port02_0003__table335683819394:

95
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst
View File

File diff suppressed because it is too large Load Diff

170
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst
View File

File diff suppressed because it is too large Load Diff

95
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst
View File

File diff suppressed because it is too large Load Diff

89
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst
View File

@ -42,52 +42,49 @@ Response Parameters
.. table:: **Table 2** **Security Group Rule** objects
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=========================+=======================+=============================================================================================================================================================================================+
| id | String | Specifies the security group rule ID. |
| | | |
| | | This parameter is not mandatory when you query security group rules. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the security group rule. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the ID of the belonged security group. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | Specifies the peer ID of the belonged security group. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | Specifies the direction of the traffic for which the security group rule takes effect. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | Specifies the peer IP address segment. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | Specifies the protocol type or the IP protocol number. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. |
| | | |
| | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. |
| | | |
| | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | Specifies the network type. |
| | | |
| | | IPv4 and IPv6 are supported. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the security group rule is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the security group rule is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================+
| id | String | Specifies the security group rule ID. |
| | | |
| | | This parameter is not mandatory when you query security group rules. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the security group rule. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | Specifies the peer ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | Specifies the direction of the traffic for which the security group rule takes effect. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | Specifies the peer IP address segment. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | Specifies the protocol type or the IP protocol number. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. |
| | | |
| | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. |
| | | |
| | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | Specifies the network type. |
| | | |
| | | IPv4 and IPv6 are supported. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the security group rule is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the security group rule is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------

89
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst
View File

@ -103,52 +103,49 @@ Response Parameters
.. table:: **Table 3** **Security Group Rule** objects
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=========================+=======================+=============================================================================================================================================================================================+
| id | String | Specifies the security group rule ID. |
| | | |
| | | This parameter is not mandatory when you query security group rules. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the security group rule. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the ID of the belonged security group. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | Specifies the peer ID of the belonged security group. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | Specifies the direction of the traffic for which the security group rule takes effect. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | Specifies the peer IP address segment. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | Specifies the protocol type or the IP protocol number. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. |
| | | |
| | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. |
| | | |
| | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | Specifies the network type. |
| | | |
| | | IPv4 and IPv6 are supported. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the security group rule is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the security group rule is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================+
| id | String | Specifies the security group rule ID. |
| | | |
| | | This parameter is not mandatory when you query security group rules. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the security group rule. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | Specifies the peer ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | Specifies the direction of the traffic for which the security group rule takes effect. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | Specifies the peer IP address segment. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | Specifies the protocol type or the IP protocol number. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. |
| | | |
| | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. |
| | | |
| | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | Specifies the network type. |
| | | |
| | | IPv4 and IPv6 are supported. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the security group rule is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the security group rule is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_sg02_0006__table1318194661915:

95
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst
View File

File diff suppressed because it is too large Load Diff

95
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst
View File

File diff suppressed because it is too large Load Diff

5
api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/creating_a_subnet_pool.rst
View File

@ -61,8 +61,6 @@ Request Message
+-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_default | No | Boolean | Specifies whether this is the default subnet pool. |
+-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| revision_number | No | Integer | Specifies the revision number of the subnet pool. |
+-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Message
----------------
@ -124,8 +122,6 @@ Response Message
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_default | Boolean | Specifies whether this is the default subnet pool. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| revision_number | Integer | Specifies the revision number of the subnet pool. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of strings | Specifies the tags. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -173,7 +169,6 @@ Example response
"192.168.0.0/16"
],
"project_id": "9fadcee8aa7c40cdb2114fff7d569c08",
"revision_number": 1,
"shared": false,
"tenant_id": "9fadcee8aa7c40cdb2114fff7d569c08",
"created_at": "2018-09-20T02:15:34",

3
api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_a_subnet_pool.rst
View File

@ -80,8 +80,6 @@ Response Message
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_default | Boolean | Specifies whether this is the default subnet pool. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| revision_number | Integer | Specifies the revision number of the subnet pool. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of strings | Specifies the tags. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -122,7 +120,6 @@ Example response
"ip_version": 6,
"shared": false,
"description": "",
"revision_number": 2,
"tags": []
}
}

4
api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst
View File

@ -96,8 +96,6 @@ Response Message
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_default | Boolean | Specifies whether this is the default subnet pool. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| revision_number | Integer | Specifies the revision number of the subnet pool. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of strings | Specifies the tags. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -146,7 +144,6 @@ Example response
"ip_version": 6,
"shared": false,
"description": "",
"revision_number": 2,
"created_at": "2018-09-20T02:15:34",
"updated_at": "2018-09-20T02:15:34",
"tags": []
@ -169,7 +166,6 @@ Example response
"ip_version": 4,
"shared": false,
"description": "",
"revision_number": 2,
"created_at": "2018-09-20T02:15:34",
"updated_at": "2018-09-20T02:15:34",
"tags": []

5
api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/updating_a_subnet_pool.rst
View File

@ -61,8 +61,6 @@ Request Message
+-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_default | No | Boolean | Specifies whether this is the default subnet pool. |
+-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| revision_number | No | Integer | Specifies the revision number of the subnet pool. |
+-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response Message
----------------
@ -124,8 +122,6 @@ Response Message
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| is_default | Boolean | Specifies whether this is the default subnet pool. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| revision_number | Integer | Specifies the revision number of the subnet pool. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tags | Array of strings | Specifies the tags. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -175,7 +171,6 @@ Example response
"id": "03f761e6-eee0-43fc-a921-8acf64c14988",
"max_prefixlen": 64,
"description": "",
"revision_number": 2,
"created_at": "2018-09-20T02:15:34",
"updated_at": "2018-09-20T02:15:34",
"tags": []

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

@ -5,6 +5,7 @@
Permissions Policies and Supported Actions
==========================================
- :ref:`Introduction <permission_0001>`
- :ref:`VPC <vpc_permission_0022>`
- :ref:`Subnet <vpc_permission_0001>`
- :ref:`EIP <vpc_permission_0002>`
@ -16,6 +17,9 @@ Permissions Policies and Supported Actions
- :ref:`Quota <vpc_permission_0006>`
- :ref:`Private IP Address <vpc_permission_0007>`
- :ref:`Security Group <vpc_permission_0008>`
- :ref:`Security Group Rule <vpc_permission_0009>`
- :ref:`VPC Tags <vpc_permission_0021>`
- :ref:`Subnet Tags <vpc_permission_0019>`
- :ref:`VPC Flow Log <vpc_permission_0025>`
- :ref:`Port (OpenStack Neutron API) <vpc_permission_0010>`
- :ref:`Network (OpenStack Neutron API) <vpc_permission_0011>`
@ -30,6 +34,7 @@ Permissions Policies and Supported Actions
:maxdepth: 1
:hidden:
introduction
vpc
subnet
eip
@ -41,6 +46,9 @@ Permissions Policies and Supported Actions
quota
private_ip_address
security_group
security_group_rule
vpc_tags
subnet_tags
vpc_flow_log
port_openstack_neutron_api
network_openstack_neutron_api

28
api-ref/source/permissions_policies_and_supported_actions/introduction.rst Normal file
View File

@ -0,0 +1,28 @@
:original_name: permission_0001.html
.. _permission_0001:
Introduction
============
By default, new IAM users do not have permissions assigned. You need to add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups. This way, they can perform specified operations on cloud services based on the permissions.
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query VPCs using an API, the user must have been granted permissions that allow the **vpc:vpcs:list** action.
Supported Actions
-----------------
VPC provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
- Permissions: statements in a policy that allow or deny certain operations
- APIs: REST APIs that can be called by a user who has been granted specific permissions
- Actions: specific operations that are allowed or denied
- IAM projects/Enterprise projects: the authorization scope of a custom policy. A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions for both IAM and enterprise projects can be used and applied for both IAM and Enterprise Management. Policies that contain actions only for IAM projects can be used and applied to IAM only.
.. note::
Y: supported; x: not supported
VPC supports the following actions in custom policies:
[Example] :ref:`VPC <vpc_permission_0022>` actions that supported by VPC APIs include creating a VPC, querying a VPC, querying VPCs, updating a VPC, and deleting a VPC.

20
api-ref/source/permissions_policies_and_supported_actions/security_group.rst
View File

@ -5,12 +5,14 @@
Security Group
==============
+---------------------------+----------------------------------------------------------+---------------------------+
| Permission | API | Action |
+===========================+==========================================================+===========================+
| Creates a security group. | POST /v1/{project_id}/security-groups | vpc:securityGroups:create |
+---------------------------+----------------------------------------------------------+---------------------------+
| Queries a security group. | GET /v1/{project_id}/security-groups/{security_group_id} | vpc:securityGroups:get |
+---------------------------+----------------------------------------------------------+---------------------------+
| Queries security groups. | GET /v1/{project_id}/security-groups | vpc:securityGroups:get |
+---------------------------+----------------------------------------------------------+---------------------------+
+---------------------------+-------------------------------------------------------------+---------------------------+
| Permission | API | Action |
+===========================+=============================================================+===========================+
| Creates a security group. | POST /v1/{project_id}/security-groups | vpc:securityGroups:create |
+---------------------------+-------------------------------------------------------------+---------------------------+
| Queries a security group. | GET /v1/{project_id}/security-groups/{security_group_id} | vpc:securityGroups:get |
+---------------------------+-------------------------------------------------------------+---------------------------+
| Queries security groups. | GET /v1/{project_id}/security-groups | vpc:securityGroups:get |
+---------------------------+-------------------------------------------------------------+---------------------------+
| Deletes a security group. | DELETE /v1/{project_id}/security-groups/{security_group_id} | vpc:securityGroups:delete |
+---------------------------+-------------------------------------------------------------+---------------------------+

18
api-ref/source/permissions_policies_and_supported_actions/security_group_rule.rst Normal file
View File

@ -0,0 +1,18 @@
:original_name: vpc_permission_0009.html
.. _vpc_permission_0009:
Security Group Rule
===================
+--------------------------------+-------------------------------------------------------------------------+-------------------------------+
| Permission | API | Action |
+================================+=========================================================================+===============================+
| Creates a security group rule. | POST /v1/{project_id}/security-group-rules | vpc:securityGroupRules:create |
+--------------------------------+-------------------------------------------------------------------------+-------------------------------+
| Queries a security group rule. | GET /v1/{project_id}/security-group-rules/{rules_security_groups_id} | vpc:securityGroupRules:get |
+--------------------------------+-------------------------------------------------------------------------+-------------------------------+
| Queries security group rules. | GET /v1/{project_id}/security-group-rules | vpc:securityGroupRules:get |
+--------------------------------+-------------------------------------------------------------------------+-------------------------------+
| Deletes a security group rule. | DELETE /v1/{project_id}/security-group-rules/{rules_security_groups_id} | vpc:securityGroupRules:delete |
+--------------------------------+-------------------------------------------------------------------------+-------------------------------+

24
api-ref/source/permissions_policies_and_supported_actions/subnet_tags.rst Normal file
View File

@ -0,0 +1,24 @@
:original_name: vpc_permission_0019.html
.. _vpc_permission_0019:
Subnet Tags
===========
+---------------------------------------------+-----------------------------------------------------------+-----------------------+
| Permission | API | Action |
+=============================================+===========================================================+=======================+
| Creating a Tag for a Subnet | POST /v2.0/{project_id}/subnets/{subnet_id}/tags | vpc:subnetTags:create |
+---------------------------------------------+-----------------------------------------------------------+-----------------------+
| Querying Subnet Tags | GET /v2.0/{project_id}/subnets/{subnet_id}/tags | vpc:subnetTags:get |
+---------------------------------------------+-----------------------------------------------------------+-----------------------+
| Deleting a Subnet Tag | DELETE /v2.0/{project_id}/subnets/{subnet_id}/tags/{key} | vpc:subnetTags:delete |
+---------------------------------------------+-----------------------------------------------------------+-----------------------+
| Batch Creating or Deleting Subnet Tags | POST /v2.0/{project_id}/subnets/{subnet_id}/tags/action | vpc:subnetTags:create |
| | | |
| | | vpc:subnetTags:delete |
+---------------------------------------------+-----------------------------------------------------------+-----------------------+
| Querying Subnets by Tag | POST /v2.0/{project_id}/subnets/resource_instances/action | vpc:subnetTags:get |
+---------------------------------------------+-----------------------------------------------------------+-----------------------+
| Querying Subnet Tags in a Specified Project | GET /v2.0/{project_id}/subnets/tags | vpc:subnetTags:get |
+---------------------------------------------+-----------------------------------------------------------+-----------------------+

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