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

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-01-05 12:09:12 +00:00
parent ab47f26e13
commit f5de3b60ea
94 changed files with 2692 additions and 2320 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
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. |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -115,7 +121,7 @@ Response Message
.. _vpc_bandwidth_0001__table30936422:
.. table:: **Table 4** **publicip_info** object
.. table:: **Table 5** **publicip_info** object
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |

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

@ -30,12 +30,12 @@ GET /v1/{project_id}/bandwidths
| | | | |
| | | | This parameter can work together with the parameter **limit**. |
| | | | |
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
| 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**. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -52,7 +52,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
@ -65,17 +71,17 @@ Response Message
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 3** Response parameter
+------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+============+========================================================================+=======================================================================================================+
| bandwidths | Array of :ref:`bandwidths <vpc_bandwidth_0002__table17227723>` objects | Specifies the bandwidth objects. For details, see :ref:`Table 3 <vpc_bandwidth_0002__table17227723>`. |
| bandwidths | Array of :ref:`bandwidths <vpc_bandwidth_0002__table17227723>` objects | Specifies the bandwidth objects. For details, see :ref:`Table 4 <vpc_bandwidth_0002__table17227723>`. |
+------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
.. _vpc_bandwidth_0002__table17227723:
.. table:: **Table 3** Description of the **bandwidths** field
.. table:: **Table 4** Description of the **bandwidths** field
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -95,7 +101,7 @@ Response Message
| | | |
| | | If this parameter is not set, the list of all bandwidths will be returned by default. |
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| publicip_info | Array of :ref:`publicip_info <vpc_bandwidth_0002__table30936422>` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 4 <vpc_bandwidth_0002__table30936422>`. |
| publicip_info | Array of :ref:`publicip_info <vpc_bandwidth_0002__table30936422>` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 5 <vpc_bandwidth_0002__table30936422>`. |
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -134,7 +140,7 @@ Response Message
.. _vpc_bandwidth_0002__table30936422:
.. table:: **Table 4** **publicip_info** object
.. table:: **Table 5** **publicip_info** object
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |

30
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. |
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -148,7 +156,7 @@ Response Message
.. _vpc_bandwidth_0003__table30936422:
.. table:: **Table 6** **publicip_info** objects
.. table:: **Table 7** **publicip_info** objects
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -157,12 +165,6 @@ Response Message
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| 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: |

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

@ -34,28 +34,36 @@ 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_0004__table31854691>` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 <vpc_sharebandwidth_0004__table31854691>`. |
| bandwidth | Yes | :ref:`bandwidth <vpc_sharebandwidth_0004__table31854691>` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 <vpc_sharebandwidth_0004__table31854691>`. |
+-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
.. _vpc_sharebandwidth_0004__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_0004__table30936422>` objects | - Specifies information about the EIP to be added to the shared bandwidth. For details, see :ref:`Table 4 <vpc_sharebandwidth_0004__table30936422>`. |
| publicip_info | Yes | Array of :ref:`publicip_info <vpc_sharebandwidth_0004__table30936422>` objects | - Specifies information about the EIP to be added to the shared bandwidth. For details, see :ref:`Table 5 <vpc_sharebandwidth_0004__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. |
+-----------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_sharebandwidth_0004__table30936422:
.. table:: **Table 4** **publicip_info** object
.. table:: **Table 5** **publicip_info** object
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -92,17 +100,17 @@ Response Message
- Response parameter
.. table:: **Table 5** Response parameter
.. table:: **Table 6** Response parameter
+-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+===========+======================================================================+================================================================================================================+
| bandwidth | :ref:`bandwidth <vpc_sharebandwidth_0004__table138718569112>` object | Specifies the bandwidth objects. For details, see :ref:`Table 6 <vpc_sharebandwidth_0004__table138718569112>`. |
| bandwidth | :ref:`bandwidth <vpc_sharebandwidth_0004__table138718569112>` object | Specifies the bandwidth objects. For details, see :ref:`Table 7 <vpc_sharebandwidth_0004__table138718569112>`. |
+-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. _vpc_sharebandwidth_0004__table138718569112:
.. table:: **Table 6** Description of the **bandwidth** field
.. table:: **Table 7** Description of the **bandwidth** field
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -121,7 +129,7 @@ Response Message
| | | - **WHOLE**: Shared bandwidth |
| | | - **PER**: Dedicated bandwidth |
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| publicip_info | Array of :ref:`publicip_info <vpc_sharebandwidth_0004__table51281965>` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 7 <vpc_sharebandwidth_0004__table51281965>`. |
| publicip_info | Array of :ref:`publicip_info <vpc_sharebandwidth_0004__table51281965>` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 8 <vpc_sharebandwidth_0004__table51281965>`. |
| | | - The bandwidth, whose type is **WHOLE**, can be used by multiple EIPs. The bandwidth, whose type is **PER**, can be used by only one EIP. |
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
@ -151,7 +159,7 @@ Response Message
.. _vpc_sharebandwidth_0004__table51281965:
.. table:: **Table 7** **publicip_info** objects
.. table:: **Table 8** **publicip_info** objects
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |

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

@ -32,24 +32,31 @@ 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_0001__table11041789>` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 <vpc_sharebandwidth_0001__table11041789>`. |
| bandwidth | Yes | :ref:`bandwidth <vpc_sharebandwidth_0001__table11041789>` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 <vpc_sharebandwidth_0001__table11041789>`. |
+-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
.. _vpc_sharebandwidth_0001__table11041789:
.. table:: **Table 3** Description of the **bandwidth** field
.. table:: **Table 4** Description of the **bandwidth** field
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=======================+=================+=================+================================================================================================================================================================================================================+
| name | Yes | String | Specifies the bandwidth name. |
| | | | |
| | | | The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
| name | Yes | String | - Specifies the bandwidth name. |
| | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| size | Yes | Integer | - Specifies the bandwidth size. The shared bandwidth has a minimum limit, which may vary depending on sites. The default minimum value is 5 Mbit/s. |
| | | | - The value ranges from 5 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) |
@ -87,17 +94,17 @@ Response Message
- Response parameter
.. table:: **Table 4** Response parameter
.. table:: **Table 5** Response parameter
+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+===========+==================================================================+============================================================================================================+
| bandwidth | :ref:`bandwidth <vpc_sharebandwidth_0001__table60972066>` object | Specifies the bandwidth objects. For details, see :ref:`Table 5 <vpc_sharebandwidth_0001__table60972066>`. |
| bandwidth | :ref:`bandwidth <vpc_sharebandwidth_0001__table60972066>` object | Specifies the bandwidth objects. For details, see :ref:`Table 6 <vpc_sharebandwidth_0001__table60972066>`. |
+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
.. _vpc_sharebandwidth_0001__table60972066:
.. table:: **Table 5** Description of the **bandwidth** field
.. table:: **Table 6** Description of the **bandwidth** field
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -116,7 +123,7 @@ Response Message
| | | - **WHOLE**: Shared bandwidth |
| | | - **PER**: Dedicated bandwidth |
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| publicip_info | Array of :ref:`publicip_info <vpc_sharebandwidth_0001__table30936422>` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 6 <vpc_sharebandwidth_0001__table30936422>`. |
| publicip_info | Array of :ref:`publicip_info <vpc_sharebandwidth_0001__table30936422>` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 7 <vpc_sharebandwidth_0001__table30936422>`. |
| | | - The bandwidth, whose type is **WHOLE**, can be used by multiple EIPs. The bandwidth, whose type is **PER**, can be used by only one EIP. |
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
@ -152,7 +159,7 @@ Response Message
.. _vpc_sharebandwidth_0001__table30936422:
.. table:: **Table 6** **publicip_info** object
.. table:: **Table 7** **publicip_info** object
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |

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 |

51
api-ref/source/apis/elastic_ip/assigning_an_eip.rst → api-ref/source/apis/eip/assigning_an_eip.rst
View File

File diff suppressed because it is too large Load Diff

4
api-ref/source/apis/elastic_ip/index.rst → api-ref/source/apis/eip/index.rst
View File

@ -2,8 +2,8 @@
.. _vpc_eip_0000:
Elastic IP
==========
EIP
===
- :ref:`Assigning an EIP <en-us_topic_0020090596>`
- :ref:`Querying an EIP <vpc_eip_0002>`

34
api-ref/source/apis/elastic_ip/querying_an_eip.rst → api-ref/source/apis/eip/querying_an_eip.rst
View File

@ -10,6 +10,19 @@ Function
This API is used to query a specific EIP.
.. note::
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.
- 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*.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- 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.
URI
---
@ -33,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
@ -46,17 +65,17 @@ Response Message
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 3** Response parameter
+----------+-----------------------------------------------------+-----------------------------------------------------------------------------------------+
| Name | Type | Description |
+==========+=====================================================+=========================================================================================+
| publicip | :ref:`publicip <vpc_eip_0002__table3035698>` object | Specifies the EIP object. For details, see :ref:`Table 3 <vpc_eip_0002__table3035698>`. |
| publicip | :ref:`publicip <vpc_eip_0002__table3035698>` object | Specifies the EIP object. For details, see :ref:`Table 4 <vpc_eip_0002__table3035698>`. |
+----------+-----------------------------------------------------+-----------------------------------------------------------------------------------------+
.. _vpc_eip_0002__table3035698:
.. table:: **Table 3** Description of the **publicip** field
.. table:: **Table 4** Description of the **publicip** field
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -72,12 +91,15 @@ Response Message
| | | - **PENDING_DELETE** (Releasing) |
| | | - **PENDING_CREATE** (Assigning) |
| | | - **PENDING_UPDATE** (Updating) |
| | | - **NOTIFYING** (Assigning) |
| | | - **NOTIFY_DELETE** (Releasing) |
| | | - **DOWN** (Unbound) |
| | | - **ACTIVE** (Bound) |
| | | - **ELB** (Bound to a load balancer) |
| | | - **VPN** (Bound to a VPN) |
| | | - **ERROR** (Exceptions) |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| profile | :ref:`profile <vpc_eip_0002__table66651219193417>` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 <vpc_eip_0002__table66651219193417>`. |
| profile | :ref:`profile <vpc_eip_0002__table66651219193417>` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 5 <vpc_eip_0002__table66651219193417>`. |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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). |
@ -134,7 +156,7 @@ Response Message
.. _vpc_eip_0002__table66651219193417:
.. table:: **Table 4** Description of the **profile** field
.. table:: **Table 5** Description of the **profile** field
========== ====== =========================
Name Type Description

35
api-ref/source/apis/elastic_ip/querying_eips.rst → api-ref/source/apis/eip/querying_eips.rst
View File

@ -10,6 +10,19 @@ Function
This API is used to query EIPs.
.. note::
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.
- 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*.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- 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.
URI
---
@ -30,12 +43,12 @@ GET /v1/{project_id}/publicips
| | | | |
| | | | This parameter can work together with the parameter **limit**. |
| | | | |
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
| 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**. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -52,7 +65,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
@ -65,17 +84,17 @@ Response Message
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 3** Response parameter
+-----------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
| Name | Type | Description |
+===========+====================================================================+=============================================================================================+
| publicips | Array of :ref:`publicips <vpc_eip_0003__table83964341880>` objects | Specifies the EIP object. For details, see :ref:`Table 3 <vpc_eip_0003__table83964341880>`. |
| publicips | Array of :ref:`publicips <vpc_eip_0003__table83964341880>` objects | Specifies the EIP object. For details, see :ref:`Table 4 <vpc_eip_0003__table83964341880>`. |
+-----------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------+
.. _vpc_eip_0003__table83964341880:
.. table:: **Table 3** Description of the **publicips** field
.. table:: **Table 4** Description of the **publicips** field
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -96,7 +115,7 @@ Response Message
| | | - **ELB** (Bound to a load balancer) |
| | | - **ERROR** (Exceptions) |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| profile | Object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 <vpc_eip_0003__table66651219193417>`. |
| profile | Object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 5 <vpc_eip_0003__table66651219193417>`. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| 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). |
@ -153,7 +172,7 @@ Response Message
.. _vpc_eip_0003__table66651219193417:
.. table:: **Table 4** Description of the **profile** field
.. table:: **Table 5** Description of the **profile** field
========== ====== =========================
Name Type Description

91
api-ref/source/apis/eip/releasing_an_eip.rst Normal file
View File

@ -0,0 +1,91 @@
:original_name: vpc_eip_0005.html
.. _vpc_eip_0005:
Releasing an EIP
================
Function
--------
This API is used to release an EIP.
.. note::
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.
- 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*.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- 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.
URI
---
DELETE /v1/{project_id}/publicips/{publicip_id}
:ref:`Table 1 <vpc_eip_0005__table45251091>` describes the parameters.
.. _vpc_eip_0005__table45251091:
.. table:: **Table 1** Parameter description
=========== ========= ==========================================
Name Mandatory Description
=========== ========= ==========================================
project_id Yes Specifies the project ID.
publicip_id Yes Specifies the unique identifier of an EIP.
=========== ========= ==========================================
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. |
+--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}
Response Message
----------------
- Response parameter
None
- Example response
None
Or
.. code-block::
{
"code":"xxx",
"message":"xxxxx"
}
Status Code
-----------
See :ref:`Status Codes <vpc_api_0002>`.
Error Code
----------
See :ref:`Error Codes <vpc_api_0003>`.

44
api-ref/source/apis/elastic_ip/updating_an_eip.rst → 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 |

8
api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.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

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

@ -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 |

14
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 |

72
api-ref/source/apis/elastic_ip/releasing_an_eip.rst
View File

@ -1,72 +0,0 @@
:original_name: vpc_eip_0005.html
.. _vpc_eip_0005:
Releasing an EIP
================
Function
--------
This API is used to release an EIP.
URI
---
DELETE /v1/{project_id}/publicips/{publicip_id}
:ref:`Table 1 <vpc_eip_0005__table45251091>` describes the parameters.
.. _vpc_eip_0005__table45251091:
.. table:: **Table 1** Parameter description
=========== ========= ==========================================
Name Mandatory Description
=========== ========= ==========================================
project_id Yes Specifies the project ID.
publicip_id Yes Specifies the unique identifier of an EIP.
=========== ========= ==========================================
Request Message
---------------
- Request parameter
None
- Example request
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/publicips
Response Message
----------------
- Response parameter
None
- Example response
None
Or
.. code-block::
{
"code":"xxx",
"message":"xxxxx"
}
Status Code
-----------
See :ref:`Status Codes <vpc_api_0002>`.
Error Code
----------
See :ref:`Error Codes <vpc_api_0003>`.

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.cn-southwest-2.hwclouds.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"
}
]

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

@ -7,7 +7,7 @@ APIs
- :ref:`Virtual Private Cloud <vpc_api01_0000>`
- :ref:`Subnet <vpc_subnet01_0000>`
- :ref:`Elastic IP <vpc_eip_0000>`
- :ref:`EIP <vpc_eip_0000>`
- :ref:`Floating IP Address (IPv6) <vpc_ipv6_0000>`
- :ref:`Bandwidth <vpc_bandwidth_0000>`
- :ref:`Bandwidth (V2.0) <vpc_sharebandwidth_0000>`
@ -28,7 +28,7 @@ APIs
virtual_private_cloud/index
subnet/index
elastic_ip/index
eip/index
floating_ip_address_ipv6/index
bandwidth/index
bandwidth_v2.0/index

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

@ -40,12 +40,12 @@ Example:
| | | | |
| | | | This parameter can work together with the parameter **limit**. |
| | | | |
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
| 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**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

File diff suppressed because it is too large Load Diff

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

@ -69,7 +69,7 @@ Request Message
| | | | - The value is exclusive with parameter **remote_ip_prefix**. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. |
| | | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
| | | | - This parameter is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request

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

@ -142,7 +142,7 @@ Response Message
"name": "qq",
"description": "qq",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
"enterprise_project_id ": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
"enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
"security_group_rules": [
{
"direction": "egress",

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

@ -36,12 +36,12 @@ Example:
| | | | |
| | | | This parameter can work together with the parameter **limit**. |
| | | | |
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
+-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
| 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**. |
+-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -36,12 +36,12 @@ Example:
| | | | |
| | | | This parameter can work together with the parameter **limit**. |
| | | | |
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
| 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**. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -172,7 +172,7 @@ Response Message
"name": "qq",
"description": "qq",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
"enterprise_project_id ": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
"enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
"security_group_rules": [
{
"direction": "egress",
@ -197,7 +197,7 @@ Response Message
"name": "default",
"description": "qq",
"vpc_id": "13551d6b-755d-4757-b956-536f674975c0",
"enterprise_project_id ": "0",
"enterprise_project_id": "0",
"security_group_rules": [
{
"direction": "egress",

48
api-ref/source/apis/subnet/creating_a_subnet.rst
View File

File diff suppressed because it is too large Load Diff

46
api-ref/source/apis/subnet/querying_subnet_details.rst
View File

@ -61,46 +61,46 @@ Response Message
.. table:: **Table 3** **subnet** objects
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+===============================================================================+=====================================================================================================================================+
+=======================+===============================================================================+========================================================================================================================================================+
| id | String | Specifies a resource ID in UUID format. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | - Specifies the subnet name. |
| | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the subnet. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| cidr | String | Specifies the subnet CIDR block. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| gateway_ip | String | Specifies the subnet gateway address. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone | String | Identifies the AZ to which the subnet belongs. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | String | - Specifies the status of the subnet. |
| | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. |
| | | |
| | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. |
| | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. |
| | | - **ERROR**: indicates that the subnet is abnormal. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0002__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0002__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0002__table019517383270>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0002__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0002__table019517383270:
@ -109,14 +109,16 @@ Response Message
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+
| opt_value | No | String | - Specifies the NTP server address configured for the subnet. |
| opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. |
| | | | |
| | | | - Constraints: |
| | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
| | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. |
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
@ -139,7 +141,7 @@ Response Message
"dhcp_enable": true,
"primary_dns": "114.xx.xx.114",
"secondary_dns": "114.xx.xx.115",
"availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc.
"availability_zone": "aa-bb-cc",
"neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
"neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12",
"extra_dhcp_opts": [

53
api-ref/source/apis/subnet/querying_subnets.rst
View File

File diff suppressed because it is too large Load Diff

10
api-ref/source/apis/subnet/updating_subnet_information.rst
View File

@ -72,7 +72,7 @@ Request Message
| dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. |
| | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0004__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0004__table019517383270>`. |
| extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0004__table019517383270>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0004__table019517383270>`. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0004__table019517383270:
@ -82,14 +82,16 @@ Request Message
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+
| opt_value | No | String | - Specifies the NTP server address configured for the subnet. |
| opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. |
| | | | |
| | | | - Constraints: |
| | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
| | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. |
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request

18
api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst
View File

@ -54,11 +54,13 @@ Request parameter
.. table:: **Table 3** Description of the **tag** field
+------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+======+===========+========+=================================================================================================================================================================================+
+========+===========+==================+====================================================================================================================================================================================+
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
+------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. |
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _subnet_tag_0005__table46291842142217:
@ -166,13 +168,13 @@ Response parameter
.. table:: **Table 7** Description of the **tag** field
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+========+===========+==================+====================================================================================================================================================================================+
+=======+===========+========+====================================================================================================================================================================================+
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. |
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| value | Yes | String | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. |
+-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example response 1: Setting **action** to **filter**

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

@ -34,11 +34,11 @@ Request Message
.. table:: **Table 2** Request parameter
+------+-----------+------------------------------------+-------------------------------------------------------------------+
+------+-----------+---------------------------------------------------+-------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+======+===========+====================================+===================================================================+
| vpc | Yes | :ref:`vpc <vpc_api01_0001>` object | :ref:`Specifies the VPC objects. <vpc_api01_0001__table33750194>` |
+------+-----------+------------------------------------+-------------------------------------------------------------------+
+======+===========+===================================================+===================================================================+
| vpc | Yes | :ref:`vpc <vpc_api01_0001__table33750194>` object | :ref:`Specifies the VPC objects. <vpc_api01_0001__table33750194>` |
+------+-----------+---------------------------------------------------+-------------------------------------------------------------------+
.. _vpc_api01_0001__table33750194:
@ -94,11 +94,11 @@ Response Message
.. table:: **Table 4** Response parameter
+------+------------------------------------+-------------------------------------------------------------------+
+------+---------------------------------------------------+-------------------------------------------------------------------+
| Name | Type | Description |
+======+====================================+===================================================================+
| vpc | :ref:`vpc <vpc_api01_0001>` object | :ref:`Specifies the VPC objects. <vpc_api01_0001__table39714111>` |
+------+------------------------------------+-------------------------------------------------------------------+
+======+===================================================+===================================================================+
| vpc | :ref:`vpc <vpc_api01_0001__table39714111>` object | :ref:`Specifies the VPC objects. <vpc_api01_0001__table39714111>` |
+------+---------------------------------------------------+-------------------------------------------------------------------+
.. _vpc_api01_0001__table39714111:

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

@ -36,12 +36,12 @@ Example:
| | | | |
| | | | This parameter can work together with the parameter **limit**. |
| | | | |
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
| 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**. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

132
api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst
View File

File diff suppressed because it is too large Load Diff

10
api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst
View File

@ -21,12 +21,12 @@ DELETE /v1/{project_id}/fl/flow_logs/{flowlog_id}
.. table:: **Table 1** Parameter description
========== ========= ====== ==============================
========== ========= ====== ===========
Name Mandatory Type Description
========== ========= ====== ==============================
project_id Yes String Specifies the project ID.
flowlog_id Yes String Specifies the VPC flow log ID.
========== ========= ====== ==============================
========== ========= ====== ===========
project_id Yes String Project ID.
flowlog_id Yes String Flow log ID
========== ========= ====== ===========
Request Message
---------------

97
api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst
View File

File diff suppressed because it is too large Load Diff

124
api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst
View File

File diff suppressed because it is too large Load Diff

110
api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst
View File

File diff suppressed because it is too large Load Diff

24
api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst
View File

@ -47,13 +47,13 @@ Response Message
.. table:: **Table 2** Response parameter
+-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=======================+===========================================+====================================================================================================================+
+=======================+===============================================================+====================================================================================================================+
| id | String | Specifies the VPC peering connection ID. |
+-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| name | String | Specifies the VPC peering connection name. |
+-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| status | String | Specifies the VPC peering connection status. Possible values are as follows: |
| | | |
| | | - **PENDING_ACCEPTANCE** |
@ -61,21 +61,21 @@ Response Message
| | | - **EXPIRED** |
| | | - **DELETED** |
| | | - **ACTIVE** |
+-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| request_vpc_info | :ref:`vpc_info <vpc_peering_0004>` object | Specifies information about the local VPC. For details, see :ref:`Table 3 <vpc_peering_0004__table1125991417114>`. |
+-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| accept_vpc_info | :ref:`vpc_info <vpc_peering_0004>` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 <vpc_peering_0004__table1125991417114>`. |
+-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| request_vpc_info | :ref:`vpc_info <vpc_peering_0004__table1125991417114>` object | Specifies information about the local VPC. For details, see :ref:`Table 3 <vpc_peering_0004__table1125991417114>`. |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| accept_vpc_info | :ref:`vpc_info <vpc_peering_0004__table1125991417114>` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 <vpc_peering_0004__table1125991417114>`. |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the VPC peering connection. |
+-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the VPC peering connection is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0004__table1125991417114:

14
api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst
View File

@ -45,12 +45,12 @@ Example:
| | | | |
| | | | This parameter can work together with the parameter **limit**. |
| | | | |
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
| 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**. |
| | | | |
@ -77,15 +77,15 @@ Response Message
.. table:: **Table 2** Response parameter
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+============================================================================+======================================================================================================================================================================================================================+
+=======================+============================================================================+=================================================================================================================================================================================================================+
| peerings | Array of :ref:`peering <vpc_peering_0001__table1026243410414>` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 <vpc_peering_0001__table1026243410414>`. |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| peerings_links | Array of :ref:`peerings_link <vpc_peering_0001__table25150247450>` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 5 <vpc_peering_0001__table25150247450>`. |
| | | |
| | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. |
+-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0001__table1026243410414:

16
api-ref/source/apis/vpc_route/creating_a_vpc_route.rst
View File

@ -32,17 +32,19 @@ Request Message
.. table:: **Table 2** **route** objects
+-------------+--------+-----------+------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+
| Attribute | Type | Mandatory | Description |
+=============+========+===========+================================================================================================+
+=================+=================+=================+=======================================================================================================+
| destination | String | Yes | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. |
+-------------+--------+-----------+------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+
| nexthop | String | Yes | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. |
+-------------+--------+-----------+------------------------------------------------------------------------------------------------+
| type | String | Yes | Specifies the route type. Currently, the value can only be **peering**. |
+-------------+--------+-----------+------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+
| type | String | Yes | Specifies the route type. |
| | | | |
| | | | Currently, only the **peering** type is supported, that is, the next hop is a VPC peering connection. |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+
| vpc_id | String | Yes | Specifies the ID of the VPC ID requesting for creating a route. |
+-------------+--------+-----------+------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+
- Example request

4
api-ref/source/apis/vpc_route/querying_vpc_routes.rst
View File

@ -45,12 +45,12 @@ Example:
| | | | |
| | | | This parameter can work together with the parameter **limit**. |
| | | | |
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
| 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**. |
| | | | |

10
api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst
View File

@ -54,13 +54,13 @@ Request parameter
.. table:: **Table 3** Description of the **tag** field
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+========+===========+==================+====================================================================================================================================================================================+
+========+===========+==================+=================================================================================================================================================================================+
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. |
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+--------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| values | Yes | Array of strings | Specifies the tag values. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. |
+--------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_tag_0005__table104959232192:

20
api-ref/source/appendix/vpc_monitoring_metrics.rst
View File

@ -20,25 +20,25 @@ Metrics
.. table:: **Table 1** EIP and bandwidth metrics
+----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+
+----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+
| ID | Name | Description | Value Range | Monitored Object | Monitoring Interval (Raw Data) |
+======================+====================+=================================================+=============+==================+================================+
+======================+====================+=============================================================+=============+==================+================================+
| upstream_bandwidth | Outbound Bandwidth | Network rate of outbound traffic | >= 0 bit/s | Bandwidth or EIP | 1 minute |
| | | | | | |
| | | Unit: bit/s | | | |
+----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+
+----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+
| downstream_bandwidth | Inbound Bandwidth | Network rate of inbound traffic | >= 0 bit/s | Bandwidth or EIP | 1 minute |
| | | | | | |
| | | Unit: bit/s | | | |
+----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+
| up_stream | Outbound Traffic | Network traffic going out of the cloud platform | >= 0 bytes | Bandwidth or EIP | 1 minute |
+----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+
| up_stream | Outbound Traffic | Network traffic going out of the cloud platform in a minute | >= 0 bytes | Bandwidth or EIP | 1 minute |
| | | | | | |
| | | Unit: byte | | | |
+----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+
| down_stream | Inbound Traffic | Network traffic going into the cloud platform | >= 0 bytes | Bandwidth or EIP | 1 minute |
| | | Unit: byte/s | | | |
+----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+
| down_stream | Inbound Traffic | Network traffic going into the cloud platform in a minute | >= 0 bytes | Bandwidth or EIP | 1 minute |
| | | | | | |
| | | Unit: byte | | | |
+----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+
| | | Unit: byte/s | | | |
+----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+
Dimension
---------

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

File diff suppressed because it is too large Load Diff

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

@ -30,29 +30,49 @@ Request Message
.. table:: **Table 2** **Firewall Group** objects
+----------------------------+-----------------+------------------+--------------------------------------------------------------+
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
| Attribute | Mandatory | Type | Description |
+============================+=================+==================+==============================================================+
+============================+=================+==================+============================================================================================+
| name | No | String | Specifies the name of the firewall group. |
| | | | |
| | | | The value can contain a maximum of 255 characters. |
+----------------------------+-----------------+------------------+--------------------------------------------------------------+
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
| description | No | String | Provides supplementary information about the firewall group. |
| | | | |
| | | | The value can contain a maximum of 255 characters. |
+----------------------------+-----------------+------------------+--------------------------------------------------------------+
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
| ingress_firewall_policy_id | No | String | Specifies the firewall policy for inbound traffic. |
+----------------------------+-----------------+------------------+--------------------------------------------------------------+
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
| egress_firewall_policy_id | No | String | Specifies the firewall policy for outbound traffic. |
+----------------------------+-----------------+------------------+--------------------------------------------------------------+
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
| ports | No | Array of strings | Specifies the list of ports bound with the firewall group. |
| | | | |
| | | | The value must be the port ID of the distributed router. |
+----------------------------+-----------------+------------------+--------------------------------------------------------------+
| | | | The value must be the port ID. |
| | | | |
| | | | .. note:: |
| | | | |
| | | | The port is the one whose **device_owner** is **network:router_interface_distributed**. |
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
| admin_state_up | No | Boolean | Specifies the administrative status of the firewall. |
| | | | |
| | | | The value can be **true** or **false**. |
+----------------------------+-----------------+------------------+--------------------------------------------------------------+
+----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+
Example Request
---------------
.. code-block:: text
POST https://{Endpoint}/v2.0/fwaas/firewall_groups
{
"firewall_group": {
"ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341",
"ports": [
"c133f2bf-6937-4416-bb17-012e1be5cd2d"
]
}
}
Response Message
----------------
@ -103,25 +123,8 @@ Response Message
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+----------------------------+-----------------------+---------------------------------------------------------------------------+
Example:
--------
Example request
.. code-block:: text
POST https://{Endpoint}/v2.0/fwaas/firewall_groups
{
"firewall_group": {
"ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341",
"ports": [
"c133f2bf-6937-4416-bb17-012e1be5cd2d"
]
}
}
Example response
Example Response
----------------
.. code-block::

37
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst
View File

@ -48,6 +48,22 @@ Request Message
| | | | The value can be **true** or **false**. |
+-----------------+-----------------+------------------+-----------------------------------------------------------------+
Example Request
---------------
.. code-block:: text
POST https://{Endpoint}/v2.0/fwaas/firewall_policies
{
"firewall_policy": {
"name": "test-policy",
"firewall_rules": [
"b8243448-cb3c-496e-851c-dadade4c161b"
]
}
}
Response Message
----------------
@ -83,25 +99,8 @@ Response Message
| project_id | String | Specifies the project ID. |
+----------------+------------------+---------------------------------------------------------------------------+
Example:
--------
Example request
.. code-block:: text
POST https://{Endpoint}/v2.0/fwaas/firewall_policies
{
"firewall_policy": {
"name": "test-policy",
"firewall_rules": [
"b8243448-cb3c-496e-851c-dadade4c161b"
]
}
}
Example response
Example Response
----------------
.. code-block::

39
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst
View File

@ -70,6 +70,23 @@ Request Message
| | | | | The value can be **true** or **false**. |
+------------------------+-------------+-------------+----------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------+
Example Request
---------------
.. code-block:: text
POST https://{Endpoint}/v2.0/fwaas/firewall_rules
{
"firewall_rule": {
"action": "allow",
"enabled": true,
"destination_port": "80",
"protocol": "tcp",
"name": "ALLOW_HTTP"
}
}
Response Message
----------------
@ -117,26 +134,8 @@ Response Message
| project_id | String | Specifies the project ID. |
+------------------------+---------+-------------------------------------------------------------------------+
Example:
--------
Example request
.. code-block:: text
POST https://{Endpoint}/v2.0/fwaas/firewall_rules
{
"firewall_rule": {
"action": "allow",
"enabled": true,
"destination_port": "80",
"protocol": "tcp",
"name": "ALLOW_HTTP"
}
}
Example response
Example Response
----------------
.. code-block::

31
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst
View File

@ -46,6 +46,19 @@ Request Message
| | | | If both the **insert_after** and **insert_before** parameters are specified, the **insert_after** parameter will be ignored. |
+------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Request
---------------
.. code-block:: text
PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule
{
"insert_after": "b8243448-cb3c-496e-851c-dadade4c161b",
"firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1",
"insert_before": ""
}
Response Message
----------------
@ -71,22 +84,8 @@ Response Message
| project_id | String | Specifies the project ID. |
+----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example:
--------
Example request
.. code-block:: text
PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule
{
"insert_after": "b8243448-cb3c-496e-851c-dadade4c161b",
"firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1",
"insert_before": ""
}
Example response
Example Response
----------------
.. code-block::

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