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

Compare commits

base: sgode:main
Branches Tags
sgode:main
sgode:propose-vpc_best-practice-1110
sgode:propose-vpc_api-ref-1118
sgode:propose-vpc_umn-1154
sgode:propose-vpc_umn-1005
sgode:propose-vpc_api-ref-556
sgode:zuul-tox-update
sgode:update_config_pdf
sgode:propose-vpc_umn-976
sgode:propose-vpc_umn-989
sgode:minify_sphinx_gitea
sgode:minify_sphinx_internal
sgode:propose-vpc_umn-820
sgode:propose-vpc_best-practice-911
sgode:confpy
sgode:propose-vpc_best-practice-928
sgode:propose-vpc_umn-834
sgode:propose-vpc_api-ref-834
sgode:propose-vpc_umn-833
sgode:propose-vpc_api-ref-833
sgode:constraints
sgode:propose-vpc_umn-807
sgode:propose-vpc_umn-555
sgode:propose-vpc_umn-769
sgode:propose-vpc_api-ref-769
sgode:propose-vpc_umn-773
sgode:propose-vpc_api-ref-773
sgode:service_based_view
sgode:tox4-cleanup
sgode:tox4
sgode:propose-vpc_umn-553
sgode:propose-vpc_api-ref-553
sgode:x4
sgode:propose-vpc_umn-451
sgode:x2
sgode:propose-vpc_umn-425
sgode:confpy-2
sgode:propose-vpc_umn-385
sgode:propose-vpc_api-ref-371
sgode:propose-vpc_umn-373
sgode:propose-vpc_api-ref-373
sgode:propose-vpc_umn-371
sgode:propose-vpc_api-ref-328
sgode:propose-vpc_api-ref-278
sgode:propose-vpc_umn-276
sgode:propose-vpc_umn-192
sgode:propose-vpc_api-ref-192
sgode:propose-vpc_umn-184
sgode:propose-vpc_api-ref-184
sgode:gtema-patch-1
..
compare: sgode:propose-vpc_api-ref-553
Branches Tags
sgode:propose-vpc_best-practice-1110
sgode:propose-vpc_api-ref-1118
sgode:main
sgode:propose-vpc_umn-1154
sgode:propose-vpc_umn-1005
sgode:propose-vpc_api-ref-556
sgode:zuul-tox-update
sgode:update_config_pdf
sgode:propose-vpc_umn-976
sgode:propose-vpc_umn-989
sgode:minify_sphinx_gitea
sgode:minify_sphinx_internal
sgode:propose-vpc_umn-820
sgode:propose-vpc_best-practice-911
sgode:confpy
sgode:propose-vpc_best-practice-928
sgode:propose-vpc_umn-834
sgode:propose-vpc_api-ref-834
sgode:propose-vpc_umn-833
sgode:propose-vpc_api-ref-833
sgode:constraints
sgode:propose-vpc_umn-807
sgode:propose-vpc_umn-555
sgode:propose-vpc_umn-769
sgode:propose-vpc_api-ref-769
sgode:propose-vpc_umn-773
sgode:propose-vpc_api-ref-773
sgode:service_based_view
sgode:tox4-cleanup
sgode:tox4
sgode:propose-vpc_umn-553
sgode:propose-vpc_api-ref-553
sgode:x4
sgode:propose-vpc_umn-451
sgode:x2
sgode:propose-vpc_umn-425
sgode:confpy-2
sgode:propose-vpc_umn-385
sgode:propose-vpc_api-ref-371
sgode:propose-vpc_umn-373
sgode:propose-vpc_api-ref-373
sgode:propose-vpc_umn-371
sgode:propose-vpc_api-ref-328
sgode:propose-vpc_api-ref-278
sgode:propose-vpc_umn-276
sgode:propose-vpc_umn-192
sgode:propose-vpc_api-ref-192
sgode:propose-vpc_umn-184
sgode:propose-vpc_api-ref-184
sgode:gtema-patch-1

1 Commits
main ... propose-vp

Author SHA1 Message Date
OpenTelekomCloud Proposal Bot
f5de3b60ea Update content 2023-01-05 12:09:12 +00:00
819 changed files with 17183 additions and 22155 deletions
Show Stats Expand all files Collapse all files

BIN
api-ref/source/_static/images/en-us_image_0000001487964866.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 14 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001538444809.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 14 KiB

BIN
api-ref/source/_static/images/en-us_image_0000001538445357.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 28 KiB

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

@ -1,14 +0,0 @@
: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
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@ -1,20 +0,0 @@
: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
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@ -1,16 +0,0 @@
: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

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

@ -34,7 +34,13 @@ Request Message
- Request parameter
None
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request
@ -47,7 +53,7 @@ Response Message
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 3** Response parameter
+-----------+-------------------------------------------------------------+---------------------------------+
| Name | Type | Description |
@ -57,7 +63,7 @@ Response Message
.. _vpc_bandwidth_0001__table60972066:
.. table:: **Table 3** Description of the **bandwidth** field
.. table:: **Table 4** Description of the **bandwidth** field
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -75,7 +81,7 @@ Response Message
| | | - **PER**: Dedicated bandwidth |
| | | - **WHOLE**: Shared bandwidth |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| publicip_info | Array of :ref:`publicip_info <vpc_bandwidth_0001__table30936422>` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 4 <vpc_bandwidth_0001__table30936422>`. |
| publicip_info | Array of :ref:`publicip_info <vpc_bandwidth_0001__table30936422>` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 5 <vpc_bandwidth_0001__table30936422>`. |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -95,6 +101,10 @@ 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: |
@ -111,28 +121,28 @@ Response Message
.. _vpc_bandwidth_0001__table30936422:
.. table:: **Table 4** **publicip_info** object
.. table:: **Table 5** **publicip_info** object
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+=================================================================================================================+
+=======================+=======================+=======================================================================================================================================+
| publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| ip_version | Integer | - Specifies the IP address version. |
| | | - Possible values are as follows: |
| | | |
| | | - **4**: IPv4 |
| | | - **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** (Dedicated Load Balancer). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). |
| | | - 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**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- Example response

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

File diff suppressed because it is too large Load Diff

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

@ -34,17 +34,25 @@ Request Message
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 3** Request parameter
+-----------+-----------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+===========+===========+=============================================================+=======================================================================================================+
| bandwidth | Yes | :ref:`bandwidth <vpc_bandwidth_0003__table31854691>` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 <vpc_bandwidth_0003__table31854691>`. |
| bandwidth | Yes | :ref:`bandwidth <vpc_bandwidth_0003__table31854691>` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 <vpc_bandwidth_0003__table31854691>`. |
+-----------+-----------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
.. _vpc_bandwidth_0003__table31854691:
.. table:: **Table 3** Description of the **bandwidth** field
.. table:: **Table 4** Description of the **bandwidth** field
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -82,17 +90,17 @@ Response Message
- Response parameter
.. table:: **Table 4** Response parameter
.. table:: **Table 5** Response parameter
+-----------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+===========+=============================================================+=======================================================================================================+
| bandwidth | :ref:`bandwidth <vpc_bandwidth_0003__table17227723>` object | Specifies the bandwidth objects. For details, see :ref:`Table 5 <vpc_bandwidth_0003__table17227723>`. |
| bandwidth | :ref:`bandwidth <vpc_bandwidth_0003__table17227723>` object | Specifies the bandwidth objects. For details, see :ref:`Table 6 <vpc_bandwidth_0003__table17227723>`. |
+-----------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
.. _vpc_bandwidth_0003__table17227723:
.. table:: **Table 5** Description of the **bandwidth** field
.. table:: **Table 6** Description of the **bandwidth** field
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -110,7 +118,7 @@ Response Message
| | | - **PER**: Dedicated bandwidth |
| | | - **WHOLE**: Shared bandwidth |
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| publicip_info | Array of :ref:`publicip_info <vpc_bandwidth_0003__table30936422>` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 6 <vpc_bandwidth_0003__table30936422>`. |
| publicip_info | Array of :ref:`publicip_info <vpc_bandwidth_0003__table30936422>` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 7 <vpc_bandwidth_0003__table30936422>`. |
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -128,6 +136,10 @@ 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: |
@ -144,22 +156,22 @@ Response Message
.. _vpc_bandwidth_0003__table30936422:
.. table:: **Table 6** **publicip_info** objects
.. table:: **Table 7** **publicip_info** objects
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+=================================================================================================================+
+=======================+=======================+=======================================================================================================================================+
| publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| 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** (Dedicated Load Balancer). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). |
| | | - 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**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
- Example response

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

8
api-ref/source/apis/bandwidth_v2.0/deleting_a_shared_bandwidth.rst
View File

@ -36,7 +36,13 @@ Request Message
- Request parameter
None
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request

18
api-ref/source/apis/bandwidth_v2.0/removing_an_eip_from_a_shared_bandwidth.rst
View File

@ -34,22 +34,30 @@ Request Message
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 3** Request parameter
+-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+===========+===========+==================================================================+============================================================================================================+
| bandwidth | Yes | :ref:`bandwidth <vpc_sharebandwidth_0005__table31854691>` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 <vpc_sharebandwidth_0005__table31854691>`. |
| bandwidth | Yes | :ref:`bandwidth <vpc_sharebandwidth_0005__table31854691>` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 <vpc_sharebandwidth_0005__table31854691>`. |
+-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
.. _vpc_sharebandwidth_0005__table31854691:
.. table:: **Table 3** Description of the **bandwidth** field
.. table:: **Table 4** Description of the **bandwidth** field
+-----------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+================================================================================+==================================================================================================================================================================================================================+
| publicip_info | Yes | Array of :ref:`publicip_info <vpc_sharebandwidth_0005__table30936422>` objects | - Specifies information about the EIP to be removed from the bandwidth. For details, see :ref:`Table 4 <vpc_sharebandwidth_0005__table30936422>`. |
| publicip_info | Yes | Array of :ref:`publicip_info <vpc_sharebandwidth_0005__table30936422>` objects | - Specifies information about the EIP to be removed from the bandwidth. For details, see :ref:`Table 5 <vpc_sharebandwidth_0005__table30936422>`. |
| | | | - The bandwidth, whose type is **WHOLE**, can be used by multiple EIPs. The number of EIPs varies depending on the tenant quota. By default, a shared bandwidth can be used by up to 20 EIPs. |
+-----------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| charge_mode | Yes | String | After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth. |
@ -67,7 +75,7 @@ Request Message
.. _vpc_sharebandwidth_0005__table30936422:
.. table:: **Table 4** **publicip_info** object
.. table:: **Table 5** **publicip_info** object
+-------------+-----------+--------+------------------------------------------------------+
| Name | Mandatory | Type | Description |

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

13
api-ref/source/apis/eip/releasing_an_eip.rst
View File

@ -14,13 +14,12 @@ This API is used to release an EIP.
Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type:
- In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type.
- In **eu-de**, EIPs of the Dedicated Load Balancer (5_gray) type cannot be created any more.
- Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers.
- The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
- You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/binding_an_eip.html>`__ and `Unbinding an EIP <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/unbinding_an_eip.html>`__.
- You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
- Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
@ -47,7 +46,13 @@ Request Message
- Request parameter
None
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request

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

File diff suppressed because it is too large Load Diff

14
api-ref/source/apis/eip_tag_management/batch_creating_or_deleting_eip_tags.rst
View File

@ -41,12 +41,20 @@ Request Message
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 3** Request parameter
+-----------------+-----------------------------------------------------------------+-----------------+---------------------------------------------------------------------------------------------------------+
| Parameter | Type | Mandatory | Description |
+=================+=================================================================+=================+=========================================================================================================+
| tags | Array of :ref:`tag <eip_tag_0004__table13242848193719>` objects | Yes | Specifies the **tag** object list. For details, see :ref:`Table 3 <eip_tag_0004__table13242848193719>`. |
| tags | Array of :ref:`tag <eip_tag_0004__table13242848193719>` objects | Yes | Specifies the **tag** object list. For details, see :ref:`Table 4 <eip_tag_0004__table13242848193719>`. |
+-----------------+-----------------------------------------------------------------+-----------------+---------------------------------------------------------------------------------------------------------+
| action | String | Yes | Specifies the operation. Possible values are as follows: |
| | | | |
@ -56,7 +64,7 @@ Request Message
.. _eip_tag_0004__table13242848193719:
.. table:: **Table 3** **tag** objects
.. table:: **Table 4** **tag** objects
+-----------------+-----------------+-----------------+---------------------------------------------------------------------+
| Attribute | Type | Mandatory | Description |

14
api-ref/source/apis/eip_tag_management/creating_a_tag_for_an_eip.rst
View File

@ -33,17 +33,25 @@ Request Message
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 3** Request parameter
+-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+
| Parameter | Type | Mandatory | Description |
+===========+=======================================================+===========+=====================================================================================================+
| tag | :ref:`tag <eip_tag_0001__table13242848193719>` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 3 <eip_tag_0001__table13242848193719>`. |
| tag | :ref:`tag <eip_tag_0001__table13242848193719>` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 4 <eip_tag_0001__table13242848193719>`. |
+-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+
.. _eip_tag_0001__table13242848193719:
.. table:: **Table 3** **tag** objects
.. table:: **Table 4** **tag** objects
+-----------------+-----------------+-----------------+---------------------------------------------------------------------+
| Attribute | Type | Mandatory | Description |

12
api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst
View File

@ -15,9 +15,9 @@ URI
DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}
:ref:`Table 1 <eip_tag_0003__table5716115334>` describes the parameters.
:ref:`Table 1 <eip_tag_0003__table27380479>` describes the parameters.
.. _eip_tag_0003__table5716115334:
.. _eip_tag_0003__table27380479:
.. table:: **Table 1** Parameter description
@ -34,7 +34,13 @@ Request Message
- Request parameter
None
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request

18
api-ref/source/apis/eip_tag_management/querying_eip_tags.rst
View File

@ -15,9 +15,9 @@ URI
GET /v2.0/{project_id}/publicips/{publicip_id}/tags
:ref:`Table 1 <eip_tag_0002__table450964213214>` describes the parameters.
:ref:`Table 1 <eip_tag_0002__table27380479>` describes the parameters.
.. _eip_tag_0002__table450964213214:
.. _eip_tag_0002__table27380479:
.. table:: **Table 1** Parameter description
@ -33,7 +33,13 @@ Request Message
- Request parameter
None
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request
@ -46,17 +52,17 @@ Response Message
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 3** Response parameter
+-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+=================================================================+=========================================================================================================+
| tags | Array of :ref:`tag <eip_tag_0002__table13242848193719>` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 <eip_tag_0002__table13242848193719>`. |
| tags | Array of :ref:`tag <eip_tag_0002__table13242848193719>` objects | Specifies the **tag** object list. For details, see :ref:`Table 4 <eip_tag_0002__table13242848193719>`. |
+-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
.. _eip_tag_0002__table13242848193719:
.. table:: **Table 3** **tag** objects
.. table:: **Table 4** **tag** objects
+-----------------------+-----------------------+---------------------------------------------------------------------+
| Attribute | Type | Description |

18
api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst
View File

@ -32,7 +32,13 @@ Request Message
- Request parameter
None
.. table:: **Table 2** Request header parameter
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==============+===========+========+========================================================================================================================================================================================+
| X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request
@ -45,17 +51,17 @@ Response Message
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 3** Response parameter
+-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+===============================================================+=======================================================================================================+
| tags | Array of :ref:`tag <eip_tag_0006__table043062842515>` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 <eip_tag_0006__table043062842515>`. |
| tags | Array of :ref:`tag <eip_tag_0006__table043062842515>` objects | Specifies the **tag** object list. For details, see :ref:`Table 4 <eip_tag_0006__table043062842515>`. |
+-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
.. _eip_tag_0006__table043062842515:
.. table:: **Table 3** Description of the **tag** field
.. table:: **Table 4** Description of the **tag** field
+-----------------------+-----------------------+---------------------------------------------------------------------+
| Name | Type | Description |
@ -63,7 +69,7 @@ Response Message
| key | String | Specifies the tag key. |
| | | |
| | | - Cannot be left blank. |
| | | - Contain up to 128 characters (36 characters on the console). |
| | | - Can contain a maximum of 36 characters. |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |
@ -73,7 +79,7 @@ Response Message
+-----------------------+-----------------------+---------------------------------------------------------------------+
| values | Array of strings | Specifies the tag value list. |
| | | |
| | | - Contain up to 255 characters (43 characters on the console). |
| | | - Can contain a maximum of 43 characters. |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |

2
api-ref/source/apis/floating_ip_address_ipv6/querying_floating_ip_addresses.rst
View File

@ -127,7 +127,7 @@ Response Message
],
"floatingips_links": [
{
"href": "https://vpc.region.otctest.t-systems.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True",
"href": "https://network.region.az-2.abc.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True",
"rel": "previous"
}
]

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

@ -16,7 +16,6 @@ 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>`
@ -38,7 +37,6 @@ 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

56
api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst
View File

@ -27,8 +27,10 @@ POST /v1/{project_id}/privateips
project_id Yes Specifies the project ID.
========== ========= =========================
Request Parameters
------------------
Request Message
---------------
- Request parameter
.. table:: **Table 2** Request parameter
@ -53,10 +55,7 @@ Request Parameters
| | | | - The value can be an available IP address in the subnet. If it is not specified, the system automatically assigns an IP address. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+
Example Request
---------------
- Assign two private IP addresses from the subnet whose ID is 531dec0f-3116-411b-a21b-e612e42349fd. One IP address is automatically assigned, and the other is specified to 192.168.1.17.
- Example request
.. code-block:: text
@ -75,8 +74,10 @@ Example Request
]
}
Response Parameters
-------------------
Response Message
----------------
- Response parameter
.. table:: **Table 4** Response parameter
@ -90,50 +91,31 @@ Response Parameters
.. table:: **Table 5** Description of the **privateip** field
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+=======================================================================================================================================================================================+
+=======================+=======================+========================================================================================================================================================================================================================================================================================================+
| status | String | - Specifies the status of the private IP address. |
| | | - Possible values are as follows: |
| | | |
| | | - **ACTIVE** |
| | | - **DOWN** |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. |
| | | |
| | | If you use the management console, the value of this parameter is the **Network ID** value. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. |
| | | |
| | | - The value can be: |
| | | |
| | | **network:dhcp**: DHCP service IP address |
| | | |
| | | **network:router_interface_distributed**: Gateway IP address |
| | | |
| | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC |
| | | |
| | | **neutron:VIP_PORT**: Virtual IP address |
| | | |
| | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer |
| | | |
| | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer |
| | | |
| | | **network:endpoint_interface**: IP address of a VPC endpoint |
| | | |
| | | **network:nat_gateway**: IP address used by a NAT gateway |
| | | |
| | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). |
| | | - The value range specifies only the type of private IP addresses supported by the current service. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_address | String | Specifies the assigned private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
- Example response
.. code-block::

20
api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst
View File

@ -29,25 +29,29 @@ DELETE /v1/{project_id}/privateips/{privateip_id}
| privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
+--------------+-----------+-----------------------------------------------------------------------------------------------+
Request Parameters
------------------
Request Message
---------------
- Request parameter
None
Example Request
---------------
- Example request
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Response Parameters
-------------------
Response Message
----------------
- Request parameter
None
Example Response
----------------
- Example response
.. code-block:: text
None

54
api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst
View File

@ -29,20 +29,23 @@ GET /v1/{project_id}/privateips/{privateip_id}
| privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
+--------------+-----------+-----------------------------------------------------------------------------------------------+
Request Parameters
------------------
Request Message
---------------
- Request parameter
None
Example Request
---------------
- Example request
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78
Response Parameters
-------------------
Response
--------
- Response parameter
.. table:: **Table 2** Response parameter
@ -56,50 +59,31 @@ Response Parameters
.. table:: **Table 3** Description of the **privateip** field
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+=======================================================================================================================================================================================+
+=======================+=======================+========================================================================================================================================================================================================================================================================================================+
| status | String | - Specifies the status of the private IP address. |
| | | - Possible values are as follows: |
| | | |
| | | - **ACTIVE** |
| | | - **DOWN** |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. |
| | | |
| | | If you use the management console, the value of this parameter is the **Network ID** value. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. |
| | | |
| | | - The value can be: |
| | | |
| | | **network:dhcp**: DHCP service IP address |
| | | |
| | | **network:router_interface_distributed**: Gateway IP address |
| | | |
| | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC |
| | | |
| | | **neutron:VIP_PORT**: Virtual IP address |
| | | |
| | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer |
| | | |
| | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer |
| | | |
| | | **network:endpoint_interface**: IP address of a VPC endpoint |
| | | |
| | | **network:nat_gateway**: IP address used by a NAT gateway |
| | | |
| | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). |
| | | - The value range specifies only the type of private IP addresses supported by the current service. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_address | String | Specifies the assigned private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
- Example response
.. code-block::

56
api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst
View File

@ -45,25 +45,28 @@ Example:
| | | | - 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. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). |
| | | | |
| | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters
------------------
Request Message
---------------
- Request parameter
None
Example Request
---------------
- Example request
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips
Response Parameters
-------------------
Response Message
----------------
- Request parameter
.. table:: **Table 2** Request parameter
@ -77,50 +80,31 @@ Response Parameters
.. table:: **Table 3** Description of the **privateip** field
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+=======================================================================================================================================================================================+
+=======================+=======================+========================================================================================================================================================================================================================================================================================================+
| status | String | - Specifies the status of the private IP address. |
| | | - Possible values are as follows: |
| | | |
| | | - **ACTIVE** |
| | | - **DOWN** |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. |
| | | |
| | | If you use the management console, the value of this parameter is the **Network ID** value. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. |
| | | |
| | | - The value can be: |
| | | |
| | | **network:dhcp**: DHCP service IP address |
| | | |
| | | **network:router_interface_distributed**: Gateway IP address |
| | | |
| | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC |
| | | |
| | | **neutron:VIP_PORT**: Virtual IP address |
| | | |
| | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer |
| | | |
| | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer |
| | | |
| | | **network:endpoint_interface**: IP address of a VPC endpoint |
| | | |
| | | **network:nat_gateway**: IP address used by a NAT gateway |
| | | |
| | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). |
| | | - The value range specifies only the type of private IP addresses supported by the current service. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_address | String | Specifies the assigned private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
- Example response
.. code-block::

18
api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst
View File

@ -35,20 +35,23 @@ GET /v2.0/network-ip-availabilities/{network_id}
network_id String Yes Specifies the network ID.
========== ====== ========= =========================
Request Parameters
------------------
Request Message
---------------
- Request parameter
None
Example Request
---------------
- Example request
.. code-block:: text
GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043
Response Parameters
-------------------
Response Message
----------------
- Response parameter
.. table:: **Table 2** Response parameter
@ -100,8 +103,7 @@ Response Parameters
| total_ips | Integer | Specifies the total number of IP addresses on a subnet. (System reserved IP addresses are not included.) |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+
Example Response
----------------
- Example response
.. code-block::

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

File diff suppressed because it is too large Load Diff

215
api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst
View File

File diff suppressed because it is too large Load Diff

258
api-ref/source/apis/route_table/creating_a_route_table.rst
View File

File diff suppressed because it is too large Load Diff

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

@ -1,66 +0,0 @@
: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>`.

219
api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst
View File

File diff suppressed because it is too large Load Diff

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

@ -1,26 +0,0 @@
: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

201
api-ref/source/apis/route_table/querying_a_route_table.rst
View File

File diff suppressed because it is too large Load Diff

169
api-ref/source/apis/route_table/querying_route_tables.rst
View File

File diff suppressed because it is too large Load Diff

379
api-ref/source/apis/route_table/updating_a_route_table.rst
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

18
api-ref/source/apis/security_group/deleting_a_security_group.rst
View File

@ -29,25 +29,27 @@ DELETE /v1/{project_id}/security-groups/{security_group_id}
| project_id | No | Specifies the project ID. |
+-------------------+-----------+--------------------------------------------------------------------------------+
Request Parameters
------------------
Request Message
---------------
- Request parameter
None
Example Request
---------------
- Example request
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/security-groups/0c4a2336-b036-4fa2-bc3c-1a291ed4c431
Response Parameters
-------------------
Response Message
----------------
- Response parameter
None
Example Response
----------------
- Example response
None

18
api-ref/source/apis/security_group/deleting_a_security_group_rule.rst
View File

@ -29,25 +29,27 @@ DELETE /v1/{project_id}/security-group-rules/{security_group_rule_id}
| project_id | Yes | Specifies the project ID. |
+------------------------+-----------+------------------------------------------------------------------------------------------+
Request Parameters
------------------
Request Message
---------------
- Request parameter
None
Example Request
---------------
- Example request
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62
Response Parameters
-------------------
Response Message
----------------
- Response parameter
None
Example Response
----------------
- Example response
None

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

File diff suppressed because it is too large Load Diff

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

@ -29,20 +29,23 @@ GET /v1/{project_id}/security-group-rules/{security_group_rule_id}
| security_group_rule_id | Yes | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+------------------------+-----------+------------------------------------------------------------------------------------------+
Request Parameters
------------------
Request Message
---------------
- Request parameter
None
Example Request
---------------
- Example request
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62
Response Parameters
-------------------
Response Message
----------------
- Response parameter
.. table:: **Table 2** Response parameter
@ -76,7 +79,7 @@ Response Parameters
| | | - The value can be **IPv4** or **IPv6**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | - Specifies the protocol type. |
| | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) |
| | | - 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. |
@ -89,19 +92,18 @@ Response Parameters
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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**. |
| | | - The parameter is 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**. |
| | | - The value is 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**. |
| | | - The value is 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. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
- Example response
.. code-block::

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