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 2024-02-04 01:59:12 +00:00
parent a0603bea83
commit c59b6ed900
19 changed files with 299 additions and 282 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -95,10 +95,6 @@ Response Message
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). |
| | | - When creating a bandwidth, associate the enterprise project ID with the bandwidth. |
| | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | String | - Specifies the bandwidth status. |
| | | - Possible values are as follows: |

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

@ -41,10 +41,6 @@ GET /v1/{project_id}/bandwidths
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project. |
| | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set **all_granted_eps**. |
| | | | |
| | | | .. note:: |
| | | | |
| | | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request
@ -107,10 +103,6 @@ Response Message
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set **all_granted_eps**. |
| | | - When creating a bandwidth, associate the enterprise project ID with the bandwidth. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | String | - Specifies the bandwidth status. |
| | | - Possible values are as follows: |

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

@ -128,10 +128,6 @@ Response Message
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set **all_granted_eps**. |
| | | - When creating a bandwidth, associate the enterprise project ID with the bandwidth. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | String | - Specifies the bandwidth status. |
| | | - Possible values are as follows: |

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

@ -202,10 +202,6 @@ Response Message
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). |
| | | - When you assign an EIP, associate an enterprise project ID with the EIP. |
| | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| public_border_group | String | Specifies whether it is in a central site or an edge site. |
| | | |

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

@ -49,6 +49,7 @@ Example:
| | | | - **firewall**: Firewall |
| | | | - **shareBandwidthIP**: IP address added to a shared bandwidth |
| | | | - **shareBandwidth**: Shared bandwidth |
| | | | - **address_group**: IP address group |
| | | | - **flow_log**: VPC fow log |
| | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC |
| | | | - **routetableContainRoutes**: Number of routes in a route table |
@ -111,6 +112,7 @@ Response Parameters
| | | - **firewall**: Firewall |
| | | - **shareBandwidthIP**: IP address added to a shared bandwidth |
| | | - **shareBandwidth**: Shared bandwidth |
| | | - **address_group**: IP address group |
| | | - **flow_log**: VPC fow log |
| | | - **vpcContainRoutetable**: Number of route tables associated with a VPC |
| | | - **routetableContainRoutes**: Number of routes in a route table |
@ -219,7 +221,13 @@ Example Response
"used": 0,
"quota": 200,
"min": 0
}
},
{
"type": "address_group",
"used": 0,
"quota": 50,
"min": 0
}
]
}
}

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

@ -56,10 +56,6 @@ Request Parameters
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. |
| | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. |
| | | | |
| | | | .. note:: |
| | | | |
| | | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Request
@ -113,10 +109,6 @@ Response Parameters
+-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. |
| | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0001__table210704979489:

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

@ -49,10 +49,6 @@ Example:
+-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter the security groups of an enterprise project. |
| | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the security groups bound to all enterprise projects of the user or to display the security group list for enterprise project member accounts, set **all_granted_eps**. |
| | | | |
| | | | .. note:: |
| | | | |
| | | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters

8
api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst
View File

@ -64,10 +64,6 @@ Request Parameters
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a VPC, you can associate an enterprise project ID with the VPC. |
| | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. |
| | | | |
| | | | .. note:: |
| | | | |
| | | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Request
@ -138,10 +134,6 @@ Response Parameters
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. |
| | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_api01_0001__table3576833291556:

4
api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst
View File

@ -91,10 +91,6 @@ Response Parameters
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Enterprise project ID |
| | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_api01_0002__table3576833291556:

9
api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst
View File

@ -47,10 +47,7 @@ Example:
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project. |
| | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set **all_granted_eps**. |
| | | | |
| | | | .. note:: |
| | | | |
| | | | This parameter is unsupported. Do not use it. |
| | | | - If this parameter is not specified, VPCs in the default enterprise project are queried and are authenticated based on the default enterprise project. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
@ -110,10 +107,6 @@ Response Parameters
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. |
| | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| routes | Array of :ref:`route <vpc_api01_0003__table3576833291556>` objects | - Specifies the route information. |
| | | - For details, see :ref:`Table 4 <vpc_api01_0003__table3576833291556>`. |

4
api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst
View File

@ -150,10 +150,6 @@ Response Parameters
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. |
| | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| routes | Array of :ref:`route <vpc_api01_0004__table3576833291556>` objects | - Specifies the route information. |
| | | - For details, see the description of the :ref:`route objects <vpc_api01_0004__table3576833291556>`. |

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

@ -8,6 +8,11 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| 2024-02-02 | This release incorporates the following changes: |
| | |
| | - Modified the description about parameter **provider:network_type** in :ref:`Network <vpc_network_0000>`. |
| | - Updated the description about response parameter **{resources}_links** in :ref:`Pagination <vpc_version_0003>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2024-01-18 | This release incorporates the following changes: |
| | |
| | Added the following sections: |

28
api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/pagination.rst
View File

@ -55,25 +55,25 @@ Response Parameters
.. table:: **Table 2** Response parameter
+-----------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+================================================================================+=================================================================================================================================================================================================================+
| {resources}_links | Array of :ref:`{resources}_link <vpc_version_0003__table109221759807>` objects | Specifies the pagination information. For details, :ref:`Table 3 <vpc_version_0003__table109221759807>`. **{resources}** indicates the resource name, for example, **ports** and **networks**. |
| | | |
| | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. |
+-----------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+================================================================================+================================================================================================================================================================================================================================================================================================================================================================================+
| {resources}_links | Array of :ref:`{resources}_link <vpc_version_0003__table109221759807>` objects | Specifies the pagination information. For details, see :ref:`Table 3 <vpc_version_0003__table109221759807>`. **{resources}** indicates the resource name, for example, **ports**, **networks**, **subnets**, **routers**, **firewall_rules**, **firewall_policies**, **firewall_groups**, **security_groups**, **subnetpools**, **floatingips**, and **security_group_rules**. |
| | | |
| | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. |
+-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_version_0003__table109221759807:
.. table:: **Table 3** {resources}_link object
+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+=================================================================================================================================================================================+
| href | String | Specifies the API link. |
+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| rel | String | The API link is used to query the next or previous page. The value can be one of the following: **next**: The next page is queried. **previous**: The previous page is queried. |
+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+========+==========================================================================================================================================+
| href | String | Specifies the API link. |
+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+
| rel | String | The API link is used to query the next or previous page. **next**: The next page is queried. **previous**: The previous page is queried. |
+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------

120
api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst
View File

File diff suppressed because it is too large Load Diff

111
api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

111
api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst
View File

File diff suppressed because it is too large Load Diff

30
api-ref/source/permissions_policies_and_supported_actions/eip_v3.rst Normal file
View File

@ -0,0 +1,30 @@
:original_name: vpc_permission_0031.html
.. _vpc_permission_0031:
EIP V3
======
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Permission | API | Action |
+=======================================+=========================================================================+====================================+
| Querying all EIPs | GET /v3/{project_id}/eip/publicips | eip:publicIps:list |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Querying the details of an EIP | GET /v3/{project_id}/eip/publicips/{publicip_id} | eip:publicIps:get |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Updating an EIP | PUT /v3/{project_id}/eip/publicips/{publicip_id} | eip:publicIps:update |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Binding an EIP to an instance | POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance | eip:publicIps:associateInstance |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Unbinding an EIP from an instance | POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instance | eip:publicIps:disassociateInstance |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Adding EIPs to a shared bandwidth | POST /v3/{project_id}/eip/publicips/attach-share-bandwidth | eip:publicIps:attachBandwidth |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Querying the number of available EIPs | POST /v3/{project_id}/eip/resources/available | eip:publicIps:count |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Querying common pools | GET /v3/{project_id}/eip/publicip-pools/common-pools | eip:publicipPools:list |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Querying EIP pools | GET /v3/{project_id}/eip/publicip-pools | eip:publicipPools:list |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+
| Querying the details of an EIP pool | GET /v3/{project_id}/eip/publicip-pools/{publicip_pool_id} | eip:publicipPools:get |
+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+

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

@ -11,6 +11,7 @@ Permissions Policies and Supported Actions
- :ref:`EIP <vpc_permission_0002>`
- :ref:`Bandwidth <vpc_permission_0003>`
- :ref:`Bandwidth (V2.0) <vpc_permission_0018>`
- :ref:`EIP V3 <vpc_permission_0031>`
- :ref:`VPC Peering Connection <vpc_permission_0005>`
- :ref:`VPC Route <en-us_topic_0000001234666799>`
- :ref:`Route Table <en-us_topic_0000001234585289>`
@ -40,6 +41,7 @@ Permissions Policies and Supported Actions
eip
bandwidth
bandwidth_v2.0
eip_v3
vpc_peering_connection
vpc_route
route_table