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

Compare commits

base: sgode:propose-vpc_api-ref-553
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:main
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

20 Commits
propose-vp ... main

Author SHA1 Message Date
proposalbot
c3793100a7 Changes to vpc_umn from docs/doc-exports#1154 (VPC UMN 20240422 version 
For det

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2024-05-06 10:47:17 +00:00
Shaaban,Karim
a0502ad2b6 propose-vpc_best-practice-911 
Reviewed-by: Akriotis, Kyriakos <kyriakos.akriotis@t-systems.com>
Co-authored-by: Shaaban,Karim <a200278391@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Shaaban,Karim <a200278391@noreply.gitea.eco.tsi-dev.otc-service.com>
 2024-05-03 11:22:10 +00:00
proposalbot
698e9d1f14 Changes to vpc_umn from docs/doc-exports#1005 (VPC UMN 20240105 version 
For det

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2024-04-18 11:59:58 +00:00
proposalbot
a539bdd666 Changes to vpc_api-ref from docs/doc-exports#556 (VPC API 20230106 version 
VPC

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2024-02-06 09:16:27 +00:00
tischrei
4457c3fad9 Update tox.ini && conf.py file 
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
 2024-01-17 13:36:34 +00:00
proposalbot
4fdb1b87ad Changes to vpc_umn from docs/doc-exports#976 (VPC UMN 20231207 version 
For deta

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-12-20 11:23:13 +00:00
Gode, Sebastian
23bf2a98f0 Update tox.ini && conf.py file 
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
 2023-11-14 13:56:08 +00:00
proposalbot
b54a481241 Changes to vpc_umn from docs/doc-exports#820 (VPC UMN 20230720 version 
VPC UMN

Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-10-27 20:20:19 +00:00
Hasko, Vladimir
4051c527ba adding best-practice to sbv 
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
 2023-10-24 22:18:01 +00:00
proposalbot
784c32d677 Changes to vpc_best-practice from docs/doc-exports#928 (adding best practice doc 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-10-23 23:05:03 +00:00
Hasko, Vladimir
2688eb7e60 fix sphinx problems with constraints 
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
 2023-08-10 16:25:44 +00:00
proposalbot
37a755dc0e Changes to vpc_umn from docs/doc-exports#807 (adding function graph service and 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-07-10 16:04:12 +00:00
proposalbot
05dbe4edc7 Changes to vpc_umn from docs/doc-exports#555 (VPC UMN 20230106 version 
For deta

Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-06-14 19:30:56 +00:00
proposalbot
c8a2ee64ac Changes to vpc_api-ref from docs/doc-exports#769 (chore: use convertor from sepa 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-06-03 17:57:04 +00:00
proposalbot
ad647cc3c2 Changes to vpc_umn from docs/doc-exports#769 (chore: use convertor from separate 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-06-03 17:56:54 +00:00
proposalbot
e02af23a4c Changes to vpc_api-ref from docs/doc-exports#773 (Deprecating Swift API and enab 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-06-01 21:47:06 +00:00
proposalbot
5ffd63b94c Changes to vpc_umn from docs/doc-exports#773 (Deprecating Swift API and enabling 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>
 2023-06-01 21:46:29 +00:00
Gode, Sebastian
0ef3370fff Service Based View 
Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
 2023-05-12 08:29:38 +00:00
Goncharov, Artem
7e5178576f Update Docs configuration 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-committed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
 2023-01-06 19:01:18 +00:00
Goncharov, Artem
9c3b5e6e5d Update Docs configuration 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-committed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
 2023-01-05 21:03:09 +00:00
819 changed files with 22156 additions and 17184 deletions
Show Stats Expand all files Collapse all files

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

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

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

@ -34,13 +34,7 @@ Request Message
- 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. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
None
- Example request
@ -53,7 +47,7 @@ Response Message
- Response parameter
.. table:: **Table 3** Response parameter
.. table:: **Table 2** Response parameter
+-----------+-------------------------------------------------------------+---------------------------------+
| Name | Type | Description |
@ -63,7 +57,7 @@ Response Message
.. _vpc_bandwidth_0001__table60972066:
.. table:: **Table 4** Description of the **bandwidth** field
.. table:: **Table 3** Description of the **bandwidth** field
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -81,7 +75,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 5 <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 4 <vpc_bandwidth_0001__table30936422>`. |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -101,10 +95,6 @@ Response Message
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). |
| | | - When creating a bandwidth, associate the enterprise project ID with the bandwidth. |
| | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. |
| | | |
| | | .. note:: |
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | String | - Specifies the bandwidth status. |
| | | - Possible values are as follows: |
@ -121,28 +111,28 @@ Response Message
.. _vpc_bandwidth_0001__table30936422:
.. table:: **Table 5** **publicip_info** object
.. table:: **Table 4** **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, 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**. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| 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). |
| | | - 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

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

94
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

56
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,13 +36,7 @@ Request Message
- 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. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
None
- Example request

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

@ -34,30 +34,22 @@ Request Message
- 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
.. table:: **Table 2** Request parameter
+-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+===========+===========+==================================================================+============================================================================================================+
| bandwidth | Yes | :ref:`bandwidth <vpc_sharebandwidth_0005__table31854691>` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 <vpc_sharebandwidth_0005__table31854691>`. |
| bandwidth | Yes | :ref:`bandwidth <vpc_sharebandwidth_0005__table31854691>` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 <vpc_sharebandwidth_0005__table31854691>`. |
+-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
.. _vpc_sharebandwidth_0005__table31854691:
.. table:: **Table 4** Description of the **bandwidth** field
.. table:: **Table 3** 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 5 <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 4 <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. |
@ -75,7 +67,7 @@ Request Message
.. _vpc_sharebandwidth_0005__table30936422:
.. table:: **Table 5** **publicip_info** object
.. table:: **Table 4** **publicip_info** object
+-------------+-----------+--------+------------------------------------------------------+
| Name | Mandatory | Type | Description |

161
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,12 +14,13 @@ 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 created any more.
- 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.
- 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" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*.
- 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>`__.
- 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.
@ -46,13 +47,7 @@ Request Message
- 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. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
None
- 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,20 +41,12 @@ Request Message
- 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
.. table:: **Table 2** 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 4 <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 3 <eip_tag_0004__table13242848193719>`. |
+-----------------+-----------------------------------------------------------------+-----------------+---------------------------------------------------------------------------------------------------------+
| action | String | Yes | Specifies the operation. Possible values are as follows: |
| | | | |
@ -64,7 +56,7 @@ Request Message
.. _eip_tag_0004__table13242848193719:
.. table:: **Table 4** **tag** objects
.. table:: **Table 3** **tag** objects
+-----------------+-----------------+-----------------+---------------------------------------------------------------------+
| Attribute | Type | Mandatory | Description |

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

@ -33,25 +33,17 @@ Request Message
- 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
.. table:: **Table 2** Request parameter
+-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+
| Parameter | Type | Mandatory | Description |
+===========+=======================================================+===========+=====================================================================================================+
| tag | :ref:`tag <eip_tag_0001__table13242848193719>` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 4 <eip_tag_0001__table13242848193719>`. |
| tag | :ref:`tag <eip_tag_0001__table13242848193719>` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 3 <eip_tag_0001__table13242848193719>`. |
+-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+
.. _eip_tag_0001__table13242848193719:
.. table:: **Table 4** **tag** objects
.. table:: **Table 3** **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__table27380479>` describes the parameters.
:ref:`Table 1 <eip_tag_0003__table5716115334>` describes the parameters.
.. _eip_tag_0003__table27380479:
.. _eip_tag_0003__table5716115334:
.. table:: **Table 1** Parameter description
@ -34,13 +34,7 @@ Request Message
- 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. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
None
- 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__table27380479>` describes the parameters.
:ref:`Table 1 <eip_tag_0002__table450964213214>` describes the parameters.
.. _eip_tag_0002__table27380479:
.. _eip_tag_0002__table450964213214:
.. table:: **Table 1** Parameter description
@ -33,13 +33,7 @@ Request Message
- 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. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
None
- Example request
@ -52,17 +46,17 @@ Response Message
- Response parameter
.. table:: **Table 3** Response parameter
.. table:: **Table 2** 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 4 <eip_tag_0002__table13242848193719>`. |
| 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>`. |
+-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
.. _eip_tag_0002__table13242848193719:
.. table:: **Table 4** **tag** objects
.. table:: **Table 3** **tag** objects
+-----------------------+-----------------------+---------------------------------------------------------------------+
| Attribute | Type | Description |

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

@ -32,13 +32,7 @@ Request Message
- 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. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
None
- Example request
@ -51,17 +45,17 @@ Response Message
- Response parameter
.. table:: **Table 3** Response parameter
.. table:: **Table 2** 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 4 <eip_tag_0006__table043062842515>`. |
| 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>`. |
+-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
.. _eip_tag_0006__table043062842515:
.. table:: **Table 4** Description of the **tag** field
.. table:: **Table 3** Description of the **tag** field
+-----------------------+-----------------------+---------------------------------------------------------------------+
| Name | Type | Description |
@ -69,7 +63,7 @@ Response Message
| key | String | Specifies the tag key. |
| | | |
| | | - Cannot be left blank. |
| | | - Can contain a maximum of 36 characters. |
| | | - Contain up to 128 characters (36 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |
@ -79,7 +73,7 @@ Response Message
+-----------------------+-----------------------+---------------------------------------------------------------------+
| values | Array of strings | Specifies the tag value list. |
| | | |
| | | - Can contain a maximum of 43 characters. |
| | | - Contain up to 255 characters (43 characters on the console). |
| | | - 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://network.region.az-2.abc.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True",
"href": "https://vpc.region.otctest.t-systems.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,6 +16,7 @@ APIs
- :ref:`Security Group <vpc_sg01_0000>`
- :ref:`VPC Peering Connection <vpc_peering_0000>`
- :ref:`VPC Route <vpc_route_0000>`
- :ref:`Route Table <vpc_apiroutetab_0000>`
- :ref:`VPC Tag Management <vpc_tag_0000>`
- :ref:`Subnet Tag Management <subnet_tag_0000>`
- :ref:`EIP Tag Management <eip_tag_0000>`
@ -37,6 +38,7 @@ APIs
security_group/index
vpc_peering_connection/index
vpc_route/index
route_table/index
vpc_tag_management/index
subnet_tag_management/index
eip_tag_management/index

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

File diff suppressed because it is too large Load Diff

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

@ -29,31 +29,27 @@ 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 Message
Request Parameters
------------------
None
Example Request
---------------
- Request parameter
.. code-block:: text
None
DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
- Example request
Response Parameters
-------------------
.. code-block:: text
None
DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Response Message
Example Response
----------------
- Request parameter
None
- Example response
.. code-block:: text
None
None
Status Code
-----------

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

345
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 Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

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

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

File diff suppressed because it is too large Load Diff

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

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

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

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

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

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

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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