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-01-24 09:50:41 +00:00
parent a1d2f3639e
commit a0603bea83
16 changed files with 2640 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
api-ref/source/api_v3/common_pools/index.rst Normal file
View File

@ -0,0 +1,14 @@
:original_name: eip_apiv3_0300.html
.. _eip_apiv3_0300:
Common Pools
============
- :ref:`Querying Common Pools <listcommonpools>`
.. toctree::
:maxdepth: 1
:hidden:
querying_common_pools

160
api-ref/source/api_v3/common_pools/querying_common_pools.rst Normal file
View File

File diff suppressed because it is too large Load Diff

491
api-ref/source/api_v3/eips/binding_an_eip.rst Normal file
View File

File diff suppressed because it is too large Load Diff

20
api-ref/source/api_v3/eips/index.rst Normal file
View File

@ -0,0 +1,20 @@
:original_name: eip_apiv3_0100.html
.. _eip_apiv3_0100:
EIPs
====
- :ref:`Querying All EIPs <listpublicipsv3>`
- :ref:`Querying EIP Details <showpublicipv3>`
- :ref:`Unbinding an EIP <disassociatepublicips>`
- :ref:`Binding an EIP <associatepublicips>`
.. toctree::
:maxdepth: 1
:hidden:
querying_all_eips
querying_eip_details
unbinding_an_eip
binding_an_eip

849
api-ref/source/api_v3/eips/querying_all_eips.rst Normal file
View File

File diff suppressed because it is too large Load Diff

626
api-ref/source/api_v3/eips/querying_eip_details.rst Normal file
View File

File diff suppressed because it is too large Load Diff

428
api-ref/source/api_v3/eips/unbinding_an_eip.rst Normal file
View File

File diff suppressed because it is too large Load Diff

16
api-ref/source/api_v3/index.rst Normal file
View File

@ -0,0 +1,16 @@
:original_name: vpc_apiv3_0000.html
.. _vpc_apiv3_0000:
API V3
======
- :ref:`EIPs <eip_apiv3_0100>`
- :ref:`Common Pools <eip_apiv3_0300>`
.. toctree::
:maxdepth: 1
:hidden:
eips/index
common_pools/index

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

@ -193,7 +193,7 @@ Response Message
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| create_time | String | Specifies the time (UTC) when the EIP is assigned. | | create_time | String | Specifies the time (UTC) when the EIP is assigned. |
| | | | | | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* | | | | Format: *yyyy-MM-dd HH:mm:ss* |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| bandwidth_size | Integer | Specifies the bandwidth (Mbit/s). | | bandwidth_size | Integer | Specifies the bandwidth (Mbit/s). |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -130,7 +130,7 @@ Response Message
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| create_time | String | Specifies the time (UTC) when the EIP is assigned. | | create_time | String | Specifies the time (UTC) when the EIP is assigned. |
| | | | | | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* | | | | Format: *yyyy-MM-dd HH:mm:ss* |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bandwidth_id | String | Specifies the ID of the EIP bandwidth. | | bandwidth_id | String | Specifies the ID of the EIP bandwidth. |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -146,7 +146,7 @@ Response Message
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| create_time | String | Specifies the time (UTC) when the EIP is assigned. | | create_time | String | Specifies the time (UTC) when the EIP is assigned. |
| | | | | | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* | | | | Format: *yyyy-MM-dd HH:mm:ss* |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| bandwidth_id | String | Specifies the ID of the EIP bandwidth. | | bandwidth_id | String | Specifies the ID of the EIP bandwidth. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -159,7 +159,7 @@ Response Message
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| create_time | String | Specifies the time (UTC) when the EIP is assigned. | | create_time | String | Specifies the time (UTC) when the EIP is assigned. |
| | | | | | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* | | | | Format: *yyyy-MM-dd HH:mm:ss* |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| bandwidth_id | String | Specifies the ID of the EIP bandwidth. | | bandwidth_id | String | Specifies the ID of the EIP bandwidth. |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -8,6 +8,13 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description | | Released On | Description |
+===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| 2024-01-18 | This release incorporates the following changes: |
| | |
| | Added the following sections: |
| | |
| | - :ref:`EIPs <eip_apiv3_0100>` |
| | - :ref:`Common Pools <eip_apiv3_0300>` |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2024-01-10 | This release incorporates the following changes: | | 2024-01-10 | This release incorporates the following changes: |
| | | | | |
| | Modified the description about **ip_version** in :ref:`Creating a Subnet <vpc_subnet02_0003>`. | | | Modified the description about **ip_version** in :ref:`Creating a Subnet <vpc_subnet02_0003>`. |

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

@ -7,6 +7,7 @@ Virtual Private Cloud - API Reference
api_usage_guidelines api_usage_guidelines
apis/index apis/index
api_v3/index
native_openstack_neutron_apis_v2.0/index native_openstack_neutron_apis_v2.0/index
permissions_policies_and_supported_actions/index permissions_policies_and_supported_actions/index
faqs/index faqs/index

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

@ -53,7 +53,27 @@ Example Request
Response Parameters Response Parameters
------------------- -------------------
None .. 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**. |
+-----------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _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. |
+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response Example Response
---------------- ----------------

6
api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst
View File

@ -60,11 +60,11 @@ GET /v2.0/floatingips
+---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | No | String | Specifies the project ID. | | tenant_id | No | String | Specifies the project ID. |
+---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | Integer | No | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. |
| | | | | | | | | |
| | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. |
+---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| marker | String | No | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. |
| | | | | | | | | |
| | | | This parameter can work together with the parameter **limit**. | | | | | This parameter can work together with the parameter **limit**. |
| | | | | | | | | |
@ -73,7 +73,7 @@ GET /v2.0/floatingips
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
+---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| page_reverse | Boolean | No | Specifies the page direction. The value can be **True** or **False**. | | page_reverse | No | Boolean | Specifies the page direction. The value can be **True** or **False**. |
+---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example: Example: