diff --git a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst index 00bc31d..5949a1a 100644 --- a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst @@ -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 ` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 4 `. | + | publicip_info | Array of :ref:`publicip_info ` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 5 `. | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 | diff --git a/api-ref/source/apis/bandwidth/querying_bandwidths.rst b/api-ref/source/apis/bandwidth/querying_bandwidths.rst index ec222b9..bbe0195 100644 --- a/api-ref/source/apis/bandwidth/querying_bandwidths.rst +++ b/api-ref/source/apis/bandwidth/querying_bandwidths.rst @@ -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 ` objects | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | + | bandwidths | Array of :ref:`bandwidths ` objects | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | +------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. _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 ` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 4 `. | + | publicip_info | Array of :ref:`publicip_info ` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 5 `. | +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 | diff --git a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst index 38521b5..d3f6389 100644 --- a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst @@ -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 ` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | +-----------+-----------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. _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 ` object | Specifies the bandwidth objects. For details, see :ref:`Table 5 `. | + | bandwidth | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 6 `. | +-----------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. _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 ` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 6 `. | + | publicip_info | Array of :ref:`publicip_info ` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 7 `. | +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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: | diff --git a/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst index db35284..5f88074 100644 --- a/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst @@ -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 ` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | +-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. _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 ` objects | - Specifies information about the EIP to be added to the shared bandwidth. For details, see :ref:`Table 4 `. | + | publicip_info | Yes | Array of :ref:`publicip_info ` objects | - Specifies information about the EIP to be added to the shared bandwidth. For details, see :ref:`Table 5 `. | | | | | - 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 ` object | Specifies the bandwidth objects. For details, see :ref:`Table 6 `. | + | bandwidth | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 7 `. | +-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ .. _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 ` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 7 `. | + | publicip_info | Array of :ref:`publicip_info ` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 8 `. | | | | - 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 | diff --git a/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst index 0a77506..8e95ca4 100644 --- a/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst @@ -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 ` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | +-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. _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 ` object | Specifies the bandwidth objects. For details, see :ref:`Table 5 `. | + | bandwidth | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 6 `. | +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. _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 ` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 6 `. | + | publicip_info | Array of :ref:`publicip_info ` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 7 `. | | | | - 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 | diff --git a/api-ref/source/apis/bandwidth_v2.0/deleting_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/deleting_a_shared_bandwidth.rst index e0d337d..2e394bb 100644 --- a/api-ref/source/apis/bandwidth_v2.0/deleting_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/deleting_a_shared_bandwidth.rst @@ -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 diff --git a/api-ref/source/apis/bandwidth_v2.0/removing_an_eip_from_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/removing_an_eip_from_a_shared_bandwidth.rst index e611466..e4e6eea 100644 --- a/api-ref/source/apis/bandwidth_v2.0/removing_an_eip_from_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/removing_an_eip_from_a_shared_bandwidth.rst @@ -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 ` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | +-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. _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 ` objects | - Specifies information about the EIP to be removed from the bandwidth. For details, see :ref:`Table 4 `. | + | publicip_info | Yes | Array of :ref:`publicip_info ` objects | - Specifies information about the EIP to be removed from the bandwidth. For details, see :ref:`Table 5 `. | | | | | - 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 | diff --git a/api-ref/source/apis/elastic_ip/assigning_an_eip.rst b/api-ref/source/apis/eip/assigning_an_eip.rst similarity index 61% rename from api-ref/source/apis/elastic_ip/assigning_an_eip.rst rename to api-ref/source/apis/eip/assigning_an_eip.rst index 2dabcf8..306bf6d 100644 --- a/api-ref/source/apis/elastic_ip/assigning_an_eip.rst +++ b/api-ref/source/apis/eip/assigning_an_eip.rst @@ -12,6 +12,19 @@ This API is used to assign an EIP. The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSs, BMSs, virtual IP addresses, load balancers, and NAT gateways. +.. 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 --- @@ -29,80 +42,83 @@ POST /v1/{project_id}/publicips project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message ---------------- +Request Parameters +------------------ -- Request parameter +.. table:: **Table 2** Request header parameter - .. table:: **Table 2** Request 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. | + +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=======================+=================+=================================================================+==================================================================================================================================================+ - | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth object. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | - | | | | - When you assign an EIP, associate an enterprise project ID with the EIP. | - | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +.. table:: **Table 3** Request body parameter - .. _en-us_topic_0020090596__table4491214: + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=======================+=================+=================================================================+==================================================================================================================================================+ + | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 4 `. | + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth object. For details, see :ref:`Table 5 `. | + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | + | | | | - When you assign an EIP, associate an enterprise project ID with the EIP. | + | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This parameter is unsupported. Do not use it. | + +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - .. table:: **Table 3** Description of the **publicip** field +.. _en-us_topic_0020090596__table4491214: - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================+ - | type | Yes | String | - Specifies the EIP type. | - | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | | - Constraints: | - | | | | | - | | | | - The configured value must be supported by the system. | - | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | String | - Specifies the EIP to be assigned. The system automatically assigns an EIP if you do not specify it. | - | | | | - The value must be a valid IPv4 address in the available IP address range. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ +.. table:: **Table 4** Description of the **publicip** field - .. _en-us_topic_0020090596__table11041789: + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================================================+ + | type | Yes | String | - Specifies the EIP type. | + | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | + | | | | - Constraints: | + | | | | | + | | | | - The configured value must be supported by the system. | + | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - .. table:: **Table 4** Description of the **bandwidth** field +.. _en-us_topic_0020090596__table11041789: - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 (.). | - | | | | - This parameter is mandatory when **share_type** is set to **PER**. This parameter will be ignored when **share_type** is set to **WHOLE** with an ID specified. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Yes | Integer | - Specifies the bandwidth size. | - | | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.) | - | | | | - This parameter is mandatory when **share_type** is set to **PER**. This parameter will be ignored when **share_type** is set to **WHOLE** with an ID specified. | - | | | | - The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows: | - | | | | | - | | | | - The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included). | - | | | | - The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included). | - | | | | - The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | - Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP. | - | | | | - The value can be the ID of the shared bandwidth whose type is set to **WHOLE**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | share_type | Yes | String | - Specifies the bandwidth type. | - | | | | - Possible values are as follows: | - | | | | | - | | | | - **PER**: Dedicated bandwidth | - | | | | - **WHOLE**: Shared bandwidth | - | | | | | - | | | | - If this parameter is set to **WHOLE**, the bandwidth ID must be specified. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | No | String | - The value is **traffic**, indicating that the billing is based on traffic. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +.. table:: **Table 5** 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 (.). | + | | | | - This parameter is mandatory when **share_type** is set to **PER**. This parameter will be ignored when **share_type** is set to **WHOLE** with an ID specified. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | size | Yes | Integer | - Specifies the bandwidth size. | + | | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.) | + | | | | - This parameter is mandatory when **share_type** is set to **PER**. This parameter will be ignored when **share_type** is set to **WHOLE** with an ID specified. | + | | | | - The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows: | + | | | | | + | | | | - The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included). | + | | | | - The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included). | + | | | | - The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | String | - Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP. | + | | | | - The value can be the ID of the shared bandwidth whose type is set to **WHOLE**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | share_type | Yes | String | - Specifies the bandwidth type. | + | | | | - Possible values are as follows: | + | | | | | + | | | | - **PER**: Dedicated bandwidth | + | | | | - **WHOLE**: Shared bandwidth | + | | | | | + | | | | - If this parameter is set to **WHOLE**, the bandwidth ID must be specified. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | charge_mode | No | String | - The value is **traffic**, indicating that the billing is based on traffic. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Example request (IPv4 EIP with dedicated bandwidth) @@ -128,17 +144,17 @@ Response Message - Response parameter - .. table:: **Table 5** Response parameter + .. table:: **Table 6** Response parameter +----------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ | Name | Type | Description | +==========+================================================================+====================================================================================================+ - | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 6 `. | + | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 7 `. | +----------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020090596__table44471219: - .. table:: **Table 6** Description of the **publicip** field + .. table:: **Table 7** Description of the **publicip** field +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -154,9 +170,12 @@ Response Message | | | - **PENDING_DELETE** (Releasing) | | | | - **PENDING_CREATE** (Assigning) | | | | - **PENDING_UPDATE** (Updating) | + | | | - **NOTIFYING** (Assigning) | + | | | - **NOTIFY_DELETE** (Release) | | | | - **DOWN** (Unbound) | | | | - **ACTIVE** (Bound) | | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | diff --git a/api-ref/source/apis/elastic_ip/index.rst b/api-ref/source/apis/eip/index.rst similarity index 94% rename from api-ref/source/apis/elastic_ip/index.rst rename to api-ref/source/apis/eip/index.rst index 50fc1b8..beb2730 100644 --- a/api-ref/source/apis/elastic_ip/index.rst +++ b/api-ref/source/apis/eip/index.rst @@ -2,8 +2,8 @@ .. _vpc_eip_0000: -Elastic IP -========== +EIP +=== - :ref:`Assigning an EIP ` - :ref:`Querying an EIP ` diff --git a/api-ref/source/apis/elastic_ip/querying_an_eip.rst b/api-ref/source/apis/eip/querying_an_eip.rst similarity index 87% rename from api-ref/source/apis/elastic_ip/querying_an_eip.rst rename to api-ref/source/apis/eip/querying_an_eip.rst index db7ea0b..744ee95 100644 --- a/api-ref/source/apis/elastic_ip/querying_an_eip.rst +++ b/api-ref/source/apis/eip/querying_an_eip.rst @@ -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 ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | + | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 4 `. | +----------+-----------------------------------------------------+-----------------------------------------------------------------------------------------+ .. _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 ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 `. | + | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 5 `. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 diff --git a/api-ref/source/apis/elastic_ip/querying_eips.rst b/api-ref/source/apis/eip/querying_eips.rst similarity index 90% rename from api-ref/source/apis/elastic_ip/querying_eips.rst rename to api-ref/source/apis/eip/querying_eips.rst index 5bc28aa..a3d697f 100644 --- a/api-ref/source/apis/elastic_ip/querying_eips.rst +++ b/api-ref/source/apis/eip/querying_eips.rst @@ -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 ` objects | Specifies the EIP object. For details, see :ref:`Table 3 `. | + | publicips | Array of :ref:`publicips ` objects | Specifies the EIP object. For details, see :ref:`Table 4 `. | +-----------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ .. _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 `. | + | profile | Object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 5 `. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 diff --git a/api-ref/source/apis/eip/releasing_an_eip.rst b/api-ref/source/apis/eip/releasing_an_eip.rst new file mode 100644 index 0000000..5bc4618 --- /dev/null +++ b/api-ref/source/apis/eip/releasing_an_eip.rst @@ -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 ` 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 `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/elastic_ip/updating_an_eip.rst b/api-ref/source/apis/eip/updating_an_eip.rst similarity index 87% rename from api-ref/source/apis/elastic_ip/updating_an_eip.rst rename to api-ref/source/apis/eip/updating_an_eip.rst index 8dc8747..0623a2e 100644 --- a/api-ref/source/apis/elastic_ip/updating_an_eip.rst +++ b/api-ref/source/apis/eip/updating_an_eip.rst @@ -12,7 +12,16 @@ This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC. .. note:: - This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer. + 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 --- @@ -37,17 +46,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 | +==========+===========+======================================================+==========================================================================================+ - | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | + | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 4 `. | +----------+-----------+------------------------------------------------------+------------------------------------------------------------------------------------------+ .. _vpc_eip_0004__table23403840: - .. table:: **Table 3** Description of the **publicip** field + .. table:: **Table 4** Description of the **publicip** field +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -76,17 +93,17 @@ Response Message - Response parameter - .. table:: **Table 4** Response parameter + .. table:: **Table 5** Response parameter +----------+---------------------------------------------------------+---------------------------------------------------------------------------------------------+ | Name | Type | Description | +==========+=========================================================+=============================================================================================+ - | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 5 `. | + | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 6 `. | +----------+---------------------------------------------------------+---------------------------------------------------------------------------------------------+ .. _vpc_eip_0004__table83964341880: - .. table:: **Table 5** Description of the **publicips** field + .. table:: **Table 6** Description of the **publicips** field +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -102,12 +119,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 ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 6 `. | + | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 7 `. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | 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). | @@ -162,7 +182,7 @@ Response Message .. _vpc_eip_0004__table66651219193417: - .. table:: **Table 6** Description of the **profile** field + .. table:: **Table 7** Description of the **profile** field ========== ====== ========================= Name Type Description @@ -189,7 +209,11 @@ Response Message "tenant_id": "26ae5181a416420998eb2093aaed84d9", "create_time": "2019-03-27 01:33:18", "bandwidth_size": 7, - "ip_version": 4 + "ip_version": 4, + "bandwidth_name": "bandwidth-2aef", + "enterprise_project_id": "0", + "bandwidth_share_type": "PER", + "bandwidth_id": "7a258fff-10d8-44b8-8124-c59079eb8f4c" } } diff --git a/api-ref/source/apis/eip_tag_management/batch_creating_or_deleting_eip_tags.rst b/api-ref/source/apis/eip_tag_management/batch_creating_or_deleting_eip_tags.rst index 679f39e..443bfaf 100644 --- a/api-ref/source/apis/eip_tag_management/batch_creating_or_deleting_eip_tags.rst +++ b/api-ref/source/apis/eip_tag_management/batch_creating_or_deleting_eip_tags.rst @@ -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 ` objects | Yes | Specifies the **tag** object list. For details, see :ref:`Table 3 `. | + | tags | Array of :ref:`tag ` objects | Yes | Specifies the **tag** object list. For details, see :ref:`Table 4 `. | +-----------------+-----------------------------------------------------------------+-----------------+---------------------------------------------------------------------------------------------------------+ | 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 | diff --git a/api-ref/source/apis/eip_tag_management/creating_a_tag_for_an_eip.rst b/api-ref/source/apis/eip_tag_management/creating_a_tag_for_an_eip.rst index a2a103e..8c150b2 100644 --- a/api-ref/source/apis/eip_tag_management/creating_a_tag_for_an_eip.rst +++ b/api-ref/source/apis/eip_tag_management/creating_a_tag_for_an_eip.rst @@ -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 ` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 3 `. | + | tag | :ref:`tag ` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 4 `. | +-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+ .. _eip_tag_0001__table13242848193719: - .. table:: **Table 3** **tag** objects + .. table:: **Table 4** **tag** objects +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ | Attribute | Type | Mandatory | Description | diff --git a/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst b/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst index 36c2900..6727d85 100644 --- a/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst +++ b/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst @@ -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 diff --git a/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst b/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst index ea4d515..bfcef7b 100644 --- a/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst +++ b/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst @@ -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 ` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 `. | + | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 4 `. | +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ .. _eip_tag_0002__table13242848193719: - .. table:: **Table 3** **tag** objects + .. table:: **Table 4** **tag** objects +-----------------------+-----------------------+---------------------------------------------------------------------+ | Attribute | Type | Description | diff --git a/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst b/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst index dcea71e..2d9d485 100644 --- a/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst @@ -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 ` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 `. | + | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 4 `. | +-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. _eip_tag_0006__table043062842515: - .. table:: **Table 3** Description of the **tag** field + .. table:: **Table 4** Description of the **tag** field +-----------------------+-----------------------+---------------------------------------------------------------------+ | Name | Type | Description | diff --git a/api-ref/source/apis/elastic_ip/releasing_an_eip.rst b/api-ref/source/apis/elastic_ip/releasing_an_eip.rst deleted file mode 100644 index 9593e24..0000000 --- a/api-ref/source/apis/elastic_ip/releasing_an_eip.rst +++ /dev/null @@ -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 ` 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 `. - -Error Code ----------- - -See :ref:`Error Codes `. diff --git a/api-ref/source/apis/floating_ip_address_ipv6/querying_floating_ip_addresses.rst b/api-ref/source/apis/floating_ip_address_ipv6/querying_floating_ip_addresses.rst index 52c0320..e1061a8 100644 --- a/api-ref/source/apis/floating_ip_address_ipv6/querying_floating_ip_addresses.rst +++ b/api-ref/source/apis/floating_ip_address_ipv6/querying_floating_ip_addresses.rst @@ -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" } ] diff --git a/api-ref/source/apis/index.rst b/api-ref/source/apis/index.rst index 6371abb..b9a4329 100644 --- a/api-ref/source/apis/index.rst +++ b/api-ref/source/apis/index.rst @@ -7,7 +7,7 @@ APIs - :ref:`Virtual Private Cloud ` - :ref:`Subnet ` -- :ref:`Elastic IP ` +- :ref:`EIP ` - :ref:`Floating IP Address (IPv6) ` - :ref:`Bandwidth ` - :ref:`Bandwidth (V2.0) ` @@ -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 diff --git a/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst b/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst index d602235..5af995c 100644 --- a/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst +++ b/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst @@ -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**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/quota/querying_quotas.rst b/api-ref/source/apis/quota/querying_quotas.rst index c99c2b3..35bdbfc 100644 --- a/api-ref/source/apis/quota/querying_quotas.rst +++ b/api-ref/source/apis/quota/querying_quotas.rst @@ -27,43 +27,47 @@ Example: .. table:: **Table 1** Parameter description - +-----------------+-----------------+-----------------+---------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+=================================+ - | project_id | Yes | String | Specifies the project ID. | - +-----------------+-----------------+-----------------+---------------------------------+ - | type | No | String | - Specifies the resource type. | - | | | | - Values: | - | | | | | - | | | | - vpc | - | | | | - subnet | - | | | | - securityGroup | - | | | | - securityGroupRule | - | | | | - publicIp | - | | | | - vpn | - | | | | - vpngw | - | | | | - vpcPeer | - | | | | - loadbalancer | - | | | | - listener | - | | | | - physicalConnect | - | | | | - virtualInterface | - | | | | - firewall | - | | | | - shareBandwidthIP | - | | | | - shareBandwidth | - | | | | - address_group | - | | | | - flow_log | - | | | | - vpcContainRoutetable | - | | | | - routetableContainRoutes | - +-----------------+-----------------+-----------------+---------------------------------+ + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+==============================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ + | type | No | String | - Specifies the resource type. | + | | | | - Values: | + | | | | | + | | | | - **vpc**: VPC | + | | | | - **subnet**: Subnet | + | | | | - **securityGroup**: Security group | + | | | | - **securityGroupRule**: Security group rule | + | | | | - **publicIp**: EIP | + | | | | - **vpn**: VPN | + | | | | - **vpngw**: VPN gateway | + | | | | - **vpcPeer**: VPC peering connection | + | | | | - **loadbalancer**: Load balancer | + | | | | - **listener**: Listener | + | | | | - **physicalConnect**: Direct Connect connection | + | | | | - **virtualInterface**: Virtual interface | + | | | | - **firewall**: Firewall | + | | | | - **shareBandwidthIP**: IP address added to a shared bandwidth | + | | | | - **shareBandwidth**: Shared bandwidth | + | | | | - **address_group**: IP address group | + | | | | - **flow_log**: VPC fow log | + | | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC | + | | | | - **routetableContainRoutes**: Number of routes in a route table | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ Request Message --------------- - Request parameter - .. code-block:: text + .. table:: **Table 2** Request header parameter - None + +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 @@ -76,27 +80,27 @@ Response Message - Response parameter - .. table:: **Table 2** Response parameter + .. table:: **Table 3** Response parameter +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ | Name | Type | Description | +========+============================================================+====================================================================================================+ - | quotas | :ref:`quotas ` object | Specifies the quota object. For details, see :ref:`Table 3 `. | + | quotas | :ref:`quotas ` object | Specifies the quota object. For details, see :ref:`Table 4 `. | +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ .. _vpc_quota_0001__table11308015155544: - .. table:: **Table 3** Description of the **quotas** field + .. table:: **Table 4** Description of the **quotas** field +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ | Name | Type | Description | +===========+=================================================================+=================================================================================================+ - | resources | Array of :ref:`resource ` objects | Specifies the resource objects. For details, see :ref:`Table 4 `. | + | resources | Array of :ref:`resource ` objects | Specifies the resource objects. For details, see :ref:`Table 5 `. | +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ .. _vpc_quota_0001__table8208684: - .. table:: **Table 4** Description of the **resource** field + .. table:: **Table 5** Description of the **resource** field +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -104,25 +108,25 @@ Response Message | type | String | - Specifies the resource type. | | | | - Values: | | | | | - | | | - vpc | - | | | - subnet | - | | | - securityGroup | - | | | - securityGroupRule | - | | | - publicIp | - | | | - vpn | - | | | - vpngw | - | | | - vpcPeer | - | | | - loadbalancer | - | | | - listener | - | | | - physicalConnect | - | | | - virtualInterface | - | | | - firewall | - | | | - shareBandwidthIP | - | | | - shareBandwidth | - | | | - address_group | - | | | - flow_log | - | | | - vpcContainRoutetable | - | | | - routetableContainRoutes | + | | | - **vpc**: VPC | + | | | - **subnet**: Subnet | + | | | - **securityGroup**: Security group | + | | | - **securityGroupRule**: Security group rule | + | | | - **publicIp**: EIP | + | | | - **vpn**: VPN | + | | | - **vpngw**: VPN gateway | + | | | - **vpcPeer**: VPC peering connection | + | | | - **loadbalancer**: Load balancer | + | | | - **listener**: Listener | + | | | - **physicalConnect**: Direct Connect connection | + | | | - **virtualInterface**: Virtual interface | + | | | - **firewall**: Firewall | + | | | - **shareBandwidthIP**: IP address added to a shared bandwidth | + | | | - **shareBandwidth**: Shared bandwidth | + | | | - **address_group**: IP address group | + | | | - **flow_log**: VPC fow log | + | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC | + | | | - **routetableContainRoutes**: Number of routes in a route table | +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+ | used | Integer | - Specifies the number of created network resources. | | | | - The value ranges from **0** to the value of **quota**. | @@ -135,25 +139,29 @@ Response Message | | | | | | | Default quota values: | | | | | - | | | - VPC: 150 | - | | | - Subnet: 400 | - | | | - Security group: 100 | - | | | - Security group rule: 5000 | - | | | - EIPs: 10 | - | | | - VPNs: 5 | - | | | - VPC peering connections: 50 | - | | | - Load balancers: 10 | - | | | - Listeners: 10 | - | | | - Firewalls: 200 | - | | | - EIPs that can be added to a shared bandwidth: 20 | - | | | - Shared bandwidths: 5 | - | | | - IP address groups: 50 | - | | | - Route table per VPC: 1 | - | | | - Routes per route table: 200 | + | | | - **vpc**: 150 | + | | | - **subnet**: 400 | + | | | - **securityGroup**: 100 | + | | | - **securityGroupRule**: 5000 | + | | | - **publicIp**: 10 | + | | | - **vpn**: 5 | + | | | - **vpcPeer**: 50 | + | | | - **loadbalancer**: 10 | + | | | - **listener**: 10 | + | | | - **firewall**: 200 | + | | | - **shareBandwidthIP**: 20 | + | | | - **shareBandwidth**: 5 | + | | | - **address_group**: 50 | + | | | - **vpcContainRoutetable**: 1 | + | | | - **routetableContainRoutes**: 200 | +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+ | min | Integer | Specifies the minimum quota value allowed. | +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+ + .. note:: + + If value **-1** is returned when you use an API to query your VPC quota, this indicates that the VPC quota is not limited. + - Example response .. code-block:: @@ -232,7 +240,7 @@ Response Message "used": 0, "quota": 10, "min": 0 - } + }, ] } } diff --git a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst index fb9a977..367249c 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst @@ -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 diff --git a/api-ref/source/apis/security_group/querying_security_group_details.rst b/api-ref/source/apis/security_group/querying_security_group_details.rst index 78dedfd..99860ac 100644 --- a/api-ref/source/apis/security_group/querying_security_group_details.rst +++ b/api-ref/source/apis/security_group/querying_security_group_details.rst @@ -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", diff --git a/api-ref/source/apis/security_group/querying_security_group_rules.rst b/api-ref/source/apis/security_group/querying_security_group_rules.rst index 80427ba..6f2e754 100644 --- a/api-ref/source/apis/security_group/querying_security_group_rules.rst +++ b/api-ref/source/apis/security_group/querying_security_group_rules.rst @@ -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**. | +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/security_group/querying_security_groups.rst b/api-ref/source/apis/security_group/querying_security_groups.rst index c9db829..534bbd6 100644 --- a/api-ref/source/apis/security_group/querying_security_groups.rst +++ b/api-ref/source/apis/security_group/querying_security_groups.rst @@ -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", diff --git a/api-ref/source/apis/subnet/creating_a_subnet.rst b/api-ref/source/apis/subnet/creating_a_subnet.rst index a4f0f5f..cf4a17d 100644 --- a/api-ref/source/apis/subnet/creating_a_subnet.rst +++ b/api-ref/source/apis/subnet/creating_a_subnet.rst @@ -44,43 +44,43 @@ Request Message .. table:: **Table 3** **subnet** objects - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +===================+=================+================================================================================+======================================================================================================================================================================================================================================================================================================+ - | name | Yes | String | - Specifies the subnet name. | - | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the subnet. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | Yes | String | - Specifies the subnet CIDR block. | - | | | | - The value must be within the VPC CIDR block. | - | | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | Yes | String | - Specifies the gateway of the subnet. | - | | | | - The value must be an IP address in the subnet. | - | | | | - The value must be a valid IP address. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | - | | | | - The value can be **true** (enabled) or **false** (disabled). | - | | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | - | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | - | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | No | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | - | | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | Yes | String | Specifies the ID of the VPC to which the subnet belongs. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | - +-------------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===================+=================+================================================================================+==============================================================================================================================================================================================================================================================+ + | name | Yes | String | - Specifies the subnet name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the subnet. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | Yes | String | - Specifies the subnet CIDR block. | + | | | | - The value must be within the VPC CIDR block. | + | | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | Yes | String | - Specifies the gateway of the subnet. | + | | | | - The value must be an IP address in the subnet. | + | | | | - The value must be a valid IP address. | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + | | | | - If this parameter is left blank, the default value **true** is used. The default value is one day. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | + | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. If the value is not specified, the default value will be left blank. | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone | No | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | + | | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | Specifies the ID of the VPC to which the subnet belongs. | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | + +-------------------+-----------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet01_0001__table1805181451016: @@ -89,14 +89,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 @@ -199,7 +201,7 @@ Response Message +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 7 `. | + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 7 `. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet01_0001__table019517383270: @@ -209,14 +211,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 diff --git a/api-ref/source/apis/subnet/querying_subnet_details.rst b/api-ref/source/apis/subnet/querying_subnet_details.rst index b828e87..25eaa83 100644 --- a/api-ref/source/apis/subnet/querying_subnet_details.rst +++ b/api-ref/source/apis/subnet/querying_subnet_details.rst @@ -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 ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _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": [ diff --git a/api-ref/source/apis/subnet/querying_subnets.rst b/api-ref/source/apis/subnet/querying_subnets.rst index 6a87e9a..d633616 100644 --- a/api-ref/source/apis/subnet/querying_subnets.rst +++ b/api-ref/source/apis/subnet/querying_subnets.rst @@ -32,12 +32,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**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -76,46 +76,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 the DHCP function 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 ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 the DHCP function 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 ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet01_0003__table019517383270: @@ -124,14 +124,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 @@ -143,6 +145,7 @@ Response Message { "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet", + "description": "", "cidr": "192.168.20.0/24", "dnsList": [ "114.xx.xx.114", @@ -156,7 +159,7 @@ Response Message "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc. "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12" + "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", @@ -187,7 +190,7 @@ Response Message "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" } - ] + ], } ] } diff --git a/api-ref/source/apis/subnet/updating_subnet_information.rst b/api-ref/source/apis/subnet/updating_subnet_information.rst index f53cca1..c4e3140 100644 --- a/api-ref/source/apis/subnet/updating_subnet_information.rst +++ b/api-ref/source/apis/subnet/updating_subnet_information.rst @@ -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 ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | + | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _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 diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst index 7ecbfe6..778c6eb 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst @@ -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.) | - +------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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.) | + +-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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** diff --git a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst index 9c501ed..699da0e 100644 --- a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst @@ -34,11 +34,11 @@ Request Message .. table:: **Table 2** Request parameter - +------+-----------+------------------------------------+-------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +======+===========+====================================+===================================================================+ - | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+-----------+------------------------------------+-------------------------------------------------------------------+ + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +======+===========+===================================================+===================================================================+ + | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ .. _vpc_api01_0001__table33750194: @@ -94,11 +94,11 @@ Response Message .. table:: **Table 4** Response parameter - +------+------------------------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +======+====================================+===================================================================+ - | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+------------------------------------+-------------------------------------------------------------------+ + +------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +======+===================================================+===================================================================+ + | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+---------------------------------------------------+-------------------------------------------------------------------+ .. _vpc_api01_0001__table39714111: diff --git a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst index 71bbe4b..3aad305 100644 --- a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst +++ b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst @@ -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**. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst index 8708212..bbb695c 100644 --- a/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst @@ -8,7 +8,7 @@ Creating a VPC Flow Log Function -------- -This API is used to create a flow log. +This API is used to create a VPC flow log. A VPC flow log captures information about the traffic going to and from your VPC. You can use flow logs to monitor network traffic, analyze network attacks, and to determine whether security group and firewall rules need to be modified. @@ -25,24 +25,24 @@ POST /v1/{project_id}/fl/flow_logs .. table:: **Table 1** Parameter description - ========== ========= ====== ========================= + ========== ========= ====== =========== Name Mandatory Type Description - ========== ========= ====== ========================= - project_id Yes String Specifies the project ID. - ========== ========= ====== ========================= + ========== ========= ====== =========== + project_id Yes String Project ID. + ========== ========= ====== =========== Request Message --------------- -- Request parameter +#. Request parameter .. table:: **Table 2** Request parameter - +----------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+===========================================================+========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 3 `. | - +----------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + +----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==========+===========+===========================================================+==========================================================================================+ + | flow_log | Yes | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | + +----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ .. _vpc_flow_0001__table656165873916: @@ -51,30 +51,36 @@ Request Message +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+=================+================================================================================================================================+ - | name | No | String | - Specifies the VPC flow log name. | + | name | No | String | - Flow log name. | | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the VPC flow log. | + | description | No | String | - Flow log description | | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | Yes | String | Specifies the type of resource on which to create the VPC flow log. The value can be **Port**, **VPC**, and **Network**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | Yes | String | Specifies the unique resource ID. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | traffic_type | Yes | String | Specifies the type of traffic to log. The value can be: | + | resource_type | Yes | String | - Type of the resource for which that the logs to be collected. | + | | | | - The value can be: | | | | | | - | | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | - | | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | - | | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + | | | | - **port**: NIC | + | | | | - **vpc**: All NICs in a VPC | + | | | | - **network**: All NICs in a subnet | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | Yes | String | Specifies the log group ID. | + | resource_id | Yes | String | - ID of the resource for which that the logs to be collected. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_topic_id | Yes | String | Specifies the log topic ID. | + | traffic_type | Yes | String | - Type of the traffic for which that the logs to be collected. | + | | | | - The value can be: | + | | | | | + | | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | index_enabled | No | Boolean | Specifies whether to enable the log index. | + | log_group_id | Yes | String | - Log group ID | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | Yes | String | - Log topic ID | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | index_enabled | No | Boolean | Whether to enable the log index. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ -- Example request +#. Example request .. code-block:: text @@ -100,51 +106,66 @@ Response Message .. table:: **Table 4** Response parameter - +----------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+===========================================================+========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 5 `. | - +----------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------+ + +----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+===========================================================+==========================================================================================+ + | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 5 `. | + +----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ .. _vpc_flow_0001__table763920584395: .. table:: **Table 5** Description of the **FlowLog** field - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the VPC flow log UUID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | name | String | Specifies the VPC flow log name. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_type | String | Specifies the type of resource on which to create the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_id | String | Specifies the unique resource ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | traffic_type | String | Specifies the type of traffic to log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_group_id | String | Specifies the log group ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_topic_id | String | Specifies the log topic ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | index_enabled | Boolean | Specifies whether to enable the log index. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | admin_state | Boolean | Specifies whether to enable the VPC flow log function. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | status | String | Specifies the VPC flow log status. | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal fault | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | created_at | String | Specifies the time when the VPC flow log was created. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the VPC flow log was updated. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | index_enabled | Boolean | - Whether to enable the log index function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - Example response @@ -161,6 +182,7 @@ Response Message "traffic_type": "reject", "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "log_store_type": "lts", "created_at": "2019-01-14T11:03:02", "updated_at": "2019-01-14T11:03:02", "index_enabled": false, diff --git a/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst index 19671ca..9c0cb83 100644 --- a/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst @@ -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 --------------- diff --git a/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst index a96f6bd..8350a53 100644 --- a/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst @@ -21,13 +21,12 @@ GET /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, which uniquely identifies the VPC flow log. | - +------------+-----------+--------+----------------------------------------------------------------------------+ + ========== ========= ====== =========== + Name Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + flowlog_id Yes String Flow log ID + ========== ========= ====== =========== Request Message --------------- @@ -49,49 +48,64 @@ Response Message .. table:: **Table 2** Response parameter - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+=============================================================+==========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 3 `. | - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+=============================================================+============================================================================================+ + | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. _vpc_flow_0003__table17299234185110: .. table:: **Table 3** Description of the **FlowLog** field - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the VPC flow log UUID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | name | String | Specifies the VPC flow log name. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_type | String | Specifies the type of resource on which to create the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_id | String | Specifies the unique resource ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | traffic_type | String | Specifies the type of traffic to log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_group_id | String | Specifies the log group ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_topic_id | String | Specifies the log topic ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | admin_state | Boolean | Specifies whether to enable the VPC flow log function. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | status | String | Specifies the VPC flow log status. | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal fault | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | created_at | String | Specifies the time when the VPC flow log was created. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the VPC flow log was updated. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - Example response @@ -108,8 +122,9 @@ Response Message "traffic_type": "reject", "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "log_store_type": "lts", "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T11:03:02" + "updated_at": "2019-01-14T11:03:02", "status": "ACTIVE", "admin_state": true } diff --git a/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst b/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst index 87c5b89..d4d8342 100644 --- a/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst +++ b/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst @@ -30,30 +30,40 @@ Example: +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+=================+========================================================================================================================================================================================================================+ - | project_id | Yes | String | Specifies the project ID. | + | project_id | Yes | String | - Project ID. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | Specifies the VPC flow log UUID. | + | id | No | String | - Flow log ID | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | - Specifies the VPC flow log name. | + | name | No | String | - Flow log name | | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | No | String | Specifies the type of resource on which to create the VPC flow log. | + | resource_type | No | String | - Type of the resource for which that the logs to be collected. | + | | | | - The value can be: | + | | | | | + | | | | - **port**: NIC | + | | | | - **vpc**: All NICs in a VPC | + | | | | - **network**: All NICs in a subnet | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | No | String | Specifies the unique resource ID. | + | resource_id | No | String | - ID of the resource for which that the logs to be collected. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | traffic_type | No | String | Specifies the type of traffic to log. | + | traffic_type | No | String | - Type of the traffic for which that the logs to be collected. | + | | | | - The value can be: | + | | | | | + | | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | No | String | Specifies the log group ID. | + | log_group_id | No | String | - Log group ID | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_topic_id | No | String | Specifies the log topic ID. | + | log_topic_id | No | String | - Log topic ID | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies the VPC flow log status. | + | status | No | String | Flow log status | | | | | | | | | | - **ACTIVE**: Enabled | | | | | - **DOWN**: Disabled | - | | | | - **ERROR**: Abnormal fault | + | | | | - **ERROR**: Abnormal | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,7 +71,7 @@ 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. | @@ -76,7 +86,9 @@ Request Message - Example request - None + .. code-block:: text + + GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog Response Message ---------------- @@ -85,49 +97,64 @@ Response Message .. table:: **Table 2** Response parameter - +-----------+----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +===========+======================================================================+==============================================================================================================+ - | flow_logs | Array of :ref:`FlowLog ` objects | Specifies the **FlowLog** object list. For details, see :ref:`Table 3 `. | - +-----------+----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ + +-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +===========+======================================================================+================================================================================================+ + | flow_logs | Array of :ref:`FlowLog ` objects | **FlowLog** object list. For details, see :ref:`Table 3 `. | + +-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ .. _vpc_flow_0002__table34811015184118: .. table:: **Table 3** Description of the **FlowLog** field - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the VPC flow log UUID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | name | String | Specifies the VPC flow log name. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_type | String | Specifies the type of resource on which to create the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_id | String | Specifies the unique resource ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | traffic_type | String | Specifies the type of traffic to log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_group_id | String | Specifies the log group ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_topic_id | String | Specifies the log topic ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | admin_state | Boolean | Specifies whether to enable the VPC flow log function. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | status | String | Specifies the VPC flow log status. | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal fault | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | created_at | String | Specifies the time when the VPC flow log was created. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the VPC flow log was updated. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - Example response @@ -137,7 +164,7 @@ Response Message "flow_logs": [ { "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a", - "name": "flow", + "name": "flowlog", "description": "just a test", "tenant_id": "b2782e6708b8475c993e6064bc456bf8", "resource_type": "port", @@ -145,8 +172,9 @@ Response Message "traffic_type": "reject", "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "log_store_type": "lts", "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T11:03:02" + "updated_at": "2019-01-14T11:03:02", "status": "ACTIVE", "admin_state": true } diff --git a/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst index 8dcfa6a..1b2415c 100644 --- a/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst @@ -21,12 +21,12 @@ PUT /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 --------------- @@ -35,11 +35,11 @@ Request Message .. table:: **Table 2** Request parameter - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+=============================================================+==========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 3 `. | - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + +----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==========+===========+=============================================================+============================================================================================+ + | flow_log | Yes | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | + +----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. _vpc_flow_0004__table13828101864013: @@ -48,13 +48,13 @@ Request Message +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+=================+================================================================================================================================+ - | name | No | String | - Specifies the VPC flow log name. | + | name | No | String | - Flow log name | | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the VPC flow log. | + | description | No | String | - Flow log description | | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | admin_state | No | Boolean | Specifies whether to enable the VPC flow log function. | + | admin_state | No | Boolean | - Whether to enable the flow log function | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - Example request @@ -78,49 +78,64 @@ Response Message .. table:: **Table 4** Response parameter - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+=============================================================+==========================================================================================================+ - | flow_log | :ref:`flow_log ` object | Specifies the **FlowLog** objects. For details, see :ref:`Table 5 `. | - +----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+=============================================================+============================================================================================+ + | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 5 `. | + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ .. _vpc_flow_0004__table17299234185110: .. table:: **Table 5** Description of the **FlowLog** field - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the VPC flow log UUID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | name | String | Specifies the VPC flow log name. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_type | String | Specifies the type of resource on which to create the VPC flow log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | resource_id | String | Specifies the unique resource ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | traffic_type | String | Specifies the type of traffic to log. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_group_id | String | Specifies the log group ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | log_topic_id | String | Specifies the log topic ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | admin_state | Boolean | Specifies whether to enable the VPC flow log function. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | status | String | Specifies the VPC flow log status. | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal fault | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | created_at | String | Specifies the time when the VPC flow log was created. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the VPC flow log was updated. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - Example response @@ -137,8 +152,9 @@ Response Message "traffic_type": "reject", "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "log_store_type": "lts", "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T12:03:02" + "updated_at": "2019-01-14T12:03:02", "status": "DOWN", "admin_state": false } diff --git a/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst index 826cc5c..3ed9e09 100644 --- a/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst @@ -47,35 +47,35 @@ 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** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | 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* | - +-----------------------+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | 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** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | 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: @@ -102,7 +102,7 @@ Response Message }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "059a737356594b41b447b557bf0aae56" + "tenant_id": "059a737356594b41b447b557bf0aae56" }, "status": "ACTIVE" } diff --git a/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst b/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst index 8067341..ff4ae1c 100644 --- a/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst +++ b/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst @@ -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 ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | peerings_links | Array of :ref:`peerings_link ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 5 `. | - | | | | - | | | 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**). | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+============================================================================+=================================================================================================================================================================================================================+ + | peerings | Array of :ref:`peering ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | + +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | peerings_links | Array of :ref:`peerings_link ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 5 `. | + | | | | + | | | 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: diff --git a/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst b/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst index 4ca471d..919fe36 100644 --- a/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst +++ b/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst @@ -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**. | - +-------------+--------+-----------+------------------------------------------------------------------------------------------------+ - | vpc_id | String | Yes | Specifies the ID of the VPC ID requesting for creating a route. | - +-------------+--------+-----------+------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | 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, 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 diff --git a/api-ref/source/apis/vpc_route/querying_vpc_routes.rst b/api-ref/source/apis/vpc_route/querying_vpc_routes.rst index 8fe2712..4f40225 100644 --- a/api-ref/source/apis/vpc_route/querying_vpc_routes.rst +++ b/api-ref/source/apis/vpc_route/querying_vpc_routes.rst @@ -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**. | | | | | | diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst index e9f09ac..2be391d 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst @@ -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. | - +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +--------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 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: diff --git a/api-ref/source/appendix/vpc_monitoring_metrics.rst b/api-ref/source/appendix/vpc_monitoring_metrics.rst index c173739..f04aa54 100644 --- a/api-ref/source/appendix/vpc_monitoring_metrics.rst +++ b/api-ref/source/appendix/vpc_monitoring_metrics.rst @@ -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 | - | | | | | | | - | | | Unit: byte | | | | - +----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+ - | down_stream | Inbound Traffic | Network traffic going into the cloud platform | >= 0 bytes | Bandwidth or EIP | 1 minute | - | | | | | | | - | | | Unit: byte | | | | - +----------------------+--------------------+-------------------------------------------------+-------------+------------------+--------------------------------+ + +----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+ + | 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 in a minute | >= 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/s | | | | + +----------------------+--------------------+-------------------------------------------------------------+-------------+------------------+--------------------------------+ Dimension --------- diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index a5de736..25dedf9 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -5,259 +5,274 @@ Change History ============== -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Released On | Description | -+===================================+=============================================================================================================================================================================================================================================================================================================================================================================================================+ -| 2022-06-25 | This release incorporates the following changes: | -| | | -| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Assigning an EIP `, :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | -| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Querying a Bandwidth `, :ref:`Querying Bandwidths `, and :ref:`Updating a Bandwidth `. | -| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2022-03-03 | This release incorporates the following changes: | -| | | -| | Added descriptions of parameters **private_ip_address** and **port_id** in :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2022-02-15 | This release incorporates the following changes: | -| | | -| | - Added **5_gray** to the value range of parameter **type** in sections :ref:`Assigning an EIP `, :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | -| | - Added **5_gray** to the value range of parameter **publicip_type** and **gray** for parameter **bandwidth_type** in sections :ref:`Querying a Bandwidth ` and :ref:`Querying Bandwidths `. | -| | - Added **5_gray** to the value range of parameter **publicip_type** in sections :ref:`Updating a Bandwidth `, :ref:`Assigning a Shared Bandwidth `, and :ref:`Adding an EIP to a Shared Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-08-25 | This release incorporates the following changes: | -| | | -| | - Modified the description about parameter **updated_at** and added parameters **billing_info** and **enterprise_project_id** in :ref:`Bandwidth ` and :ref:`Bandwidth (V2.0) `. | -| | - Changed the value range of **type** in :ref:`Querying Quotas `. | -| | - Added parameter **remote_address_group_id** to sections :ref:`Security Group ` and :ref:`Security Group `. | -| | - Deleted parameters **ipv6_address_mode** and **ipv6_ra_mode** from :ref:`Subnet `. | -| | - Added parameter **enterprise_project_id** to section :ref:`Elastic IP `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-06-22 | This release incorporates the following changes: | -| | | -| | - Added parameter **profile** to sections :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | -| | - Changed the value range of the **size** parameter to 1 Mbit/s to 1000 Mbit/s in :ref:`Querying Bandwidths `, :ref:`Updating a Bandwidth `, and :ref:`Removing an EIP from a Shared Bandwidth `. | -| | - Changed the value range of the **size** parameter to 5 Mbit/s to 1000 Mbit/s in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | -| | - Updated response examples in sections :ref:`Querying a Bandwidth `, :ref:`Querying Bandwidths `, :ref:`Updating a Bandwidth `, :ref:`Assigning a Shared Bandwidth `, and :ref:`Adding an EIP to a Shared Bandwidth `. | -| | - Changed the parameter of **binding:vif_details** to **primary_interface** in sections :ref:`Querying Ports `, :ref:`Querying a Port `, :ref:`Creating a Port `, and :ref:`Updating a Port `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-05-25 | This release incorporates the following changes: | -| | | -| | - Added parameter **id** to the **bandwidth** field in section :ref:`Assigning an EIP `. | -| | - Added parameter **ip_version** to sections :ref:`Elastic IP `, :ref:`Bandwidth `, and :ref:`Bandwidth (V2.0) `. | -| | - Added parameter **bandwidth_name** to section :ref:`Elastic IP `. | -| | - Deleted description about IP address version conversion from section :ref:`Updating an EIP `. | -| | - Added parameters **created_at**, **updated_at**, **enable_bandwidth_rules**, **rule_quota**, and **bandwidth_rules** in sections :ref:`Bandwidth ` and :ref:`Assigning a Shared Bandwidth `. | -| | - Added value **share** to the value range of parameter **bandwidth_type** in section :ref:`Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-05-10 | This release incorporates the following changes: | -| | | -| | - Added description that the IP addresses reserved by the system cannot be obtained using APIs in :ref:`Querying Private IP Address Details `. | -| | - Moved :ref:`Error Codes ` and :ref:`Status Codes ` to :ref:`Appendix `. | -| | - Added a value for the **type** parameter of the **publicip** field in section :ref:`Elastic IP ` and :ref:`Bandwidth `. | -| | - Added **WHOLE** to the value range of parameter **share_type** in section :ref:`Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-03-16 | This release incorporates the following changes: | -| | | -| | Added description that leaving parameter **port_id** blank cannot be used to unbind an EIP from a dedicated load balancer in sections :ref:`Updating an EIP ` and :ref:`Updating a Floating IP Address `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-12-16 | This release incorporates the following changes: | -| | | -| | - Modified the value range of **cidr** in section :ref:`Virtual Private Cloud `. | -| | - Changed the maximum number of tags in sections :ref:`Querying VPCs by Tag ` and :ref:`Querying Subnets by Tag `. | -| | - Added fields **port_security_enabled**, **dns_name**, and **dns_assignment** to section :ref:`Port `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-06-30 | This release incorporates the following changes: | -| | | -| | - Added the **routes** field in section :ref:`Updating VPC Information `. | -| | - Added field **index_enabled** in section :ref:`VPC Flow Log `. | -| | - Modified URI parameters in sections :ref:`Querying Security Group Rule Details ` and :ref:`Deleting a Security Group Rule `. | -| | - Modified description of the **tenant_id** field in section :ref:`Creating a VPC Peering Connection `. | -| | - Modified the **network_ip_availability** parameter type in section :ref:`Querying IP Address Usage on a Specified Network `. | -| | - Modified the **networks** parameter type in section :ref:`Querying Networks `. | -| | - Added response parameter **project_id** in sections :ref:`Adding an Interface to a Router ` and :ref:`Removing an Interface from a Router `. | -| | - Added the **device_owner** field in section :ref:`Creating a Port `. | -| | - Added information about whether the **allow_address_pair** and **extra_dhcp_opt** fields are mandatory in section :ref:`Updating a Port `. | -| | - Added or modified the **ports_links**, **binding:profile**, and **binding:vif_details** fields in section :ref:`Port `. | -| | - Added the **networks_links** field in section :ref:`Network `. | -| | - Added the **subnets_links** field in section :ref:`Subnet `. | -| | - Added the **routers_links** field in section :ref:`Router `. | -| | - Added or modified the **firewall_rules_links** and **firewall_policies** fields in section :ref:`Firewall `. | -| | - Modified the URI in sections :ref:`Querying a Security Group Rule ` and :ref:`Deleting a Security Group Rule `. | -| | - Added the **tenant_id** field in sections :ref:`Creating a Security Group ` and :ref:`Querying Security Group Rule Details `. | -| | - Added the **peerings_link** object in section :ref:`Querying VPC Peering Connections `. | -| | - Added the **routes_link** object in section :ref:`Querying VPC Routes `. | -| | - Added the **fixed_ip** field in section :ref:`Creating a Port `. | -| | - Added the **firewall_policies_link** object in section :ref:`Querying Firewall Policies `. | -| | - Added the **project_id** field in sections :ref:`Inserting a Firewall Rule ` and :ref:`Removing a Firewall Rule `. | -| | - Added the **created_at** and **updated_at** fields in sections :ref:`Querying Firewall Groups `, :ref:`Querying a Firewall Group `, :ref:`Creating a Firewall Group `, and :ref:`Updating a Firewall Group `. | -| | - Added the **firewall_groups_link** object in section :ref:`Querying Firewall Groups `. | -| | - Changed the position of the section :ref:`Permissions Policies and Supported Actions ` and adjusted the table. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-04-13 | This release incorporates the following changes: | -| | | -| | - Modified description of parameters in the **security_group_rule** field in section :ref:`Creating a Security Group Rule `. | -| | - Added URI parameter description in :ref:`Port `, :ref:`Network `, :ref:`Querying Subnets `, :ref:`Querying Routers `, :ref:`Firewall `, and :ref:`Security Group `. | -| | - Added description of discarding **vpc_id** in section :ref:`Creating a Security Group `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-03-20 | This release incorporates the following changes: | -| | | -| | Added the value of **5_mailbgp** for parameters **type** and **publicip_type** | -| | | -| | in sections :ref:`Assigning an EIP `, :ref:`Bandwidth `, and :ref:`Bandwidth (V2.0) `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-02-25 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Bandwidth (V2.0) `. | -| | - Added :ref:`Bandwidth (V2.0) ` in section :ref:`Permissions Policies and Supported Actions `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-09-10 | This release incorporates the following changes: | -| | | -| | - Added APIs described in section :ref:`VPC Flow Log ` and VPC flow log error codes to section :ref:`Error Codes `. | -| | - Modified the description of the **charge_mode** field and its value in the response example in :ref:`Bandwidth `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-11-30 | This release incorporates the following changes: | -| | | -| | - Added the **extra_dhcp_opts** field in sections :ref:`Creating a Subnet `, :ref:`Querying Subnet Details `, :ref:`Querying Subnets `, and :ref:`Updating Subnet Information `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-10-22 | This release incorporates the following changes: | -| | | -| | - Added sections :ref:`APIs ` and :ref:`Native OpenStack Neutron APIs (V2.0) ` and categorized VPC APIs and native OpenStack APIs. | -| | - Deleted description about the **Reject** rule from section :ref:`Updating a Firewall Rule `. | -| | - Added the **project_id**, **created_at**, and **updated_at** fields to and modified the example request and response in sections :ref:`Port `, :ref:`Network `, :ref:`Subnet `, :ref:`Router `, :ref:`Floating IP Address `, :ref:`Firewall `, and :ref:`Security Group `. | -| | - Modified the API format to ensure consistency. | -| | - Modified description about the **tenant_id** and **project_id** fields to ensure consistency. | -| | - Added section :ref:`VPC Peering Connection ` under **API Permissions**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-10-12 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Querying a Specified API Version `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-09-04 | This release incorporates the following changes: | -| | | -| | - Modified the response example in section :ref:`Associating Multiple NIC Ports to or Disassociating Them from a Security Group at a Time `. | -| | - Added error messages for associating multiple NIC ports to or disassociating them from a security group at a time in section :ref:`Error Codes `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-08-30 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Associating Multiple NIC Ports to or Disassociating Them from a Security Group at a Time `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-07-30 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Permissions Policies and Supported Actions `. | -| | - Deleted sections related to VPNs. An independent VPN API reference will be provided. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-11 | This release incorporates the following changes: | -| | | -| | - Modified VPC tagging description in section :ref:`Querying VPC Tags in a Specified Project `. | -| | - Modified subnet tagging description in section :ref:`Querying Subnet Tags in a Specified Project `. | -| | - Modified EIP tagging description in section :ref:`Querying EIP Tags in a Specified Project `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-04-28 | This release incorporates the following changes: | -| | | -| | - Opened APIs described in section :ref:`Floating IP Address (IPv6) `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-03-30 | This release incorporates the following changes: | -| | | -| | - Added section :ref:`Querying API Versions `. | -| | - Modified the content in section :ref:`VPC Tag Management `. | -| | - Added section :ref:`Subnet Tag Management `. | -| | - Added section :ref:`EIP Tag Management `. | -| | - Added metrics **Upstream Traffic** and **Downstream Traffic** in section :ref:`VPC Monitoring Metrics `. | -| | - Modified the content in section :ref:`API Usage Guidelines `. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-28 | This release incorporates the following changes: | -| | | -| | - Modified the URI and description in the API format in section :ref:`Querying VPC Peering Connections `. | -| | - Modified the URI and description in the API format in section :ref:`Querying VPC Routes `. | -| | - Modified the response parameters and parameter examples in section :ref:`Accepting a VPC Peering Connection `. | -| | - Modified the response parameters and parameter examples in section :ref:`Refusing a VPC Peering Connection `. | -| | - Provided the address for downloading the sample code in section **Sample Code**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-14 | This release incorporates the following changes: | -| | | -| | - Modified the title of section **VPN (Native OpenStack API)**. | -| | - Linked the error codes in subsections of **VPN (Native OpenStack API)** to **Error Codes**. | -| | - Linked the error codes in subsection :ref:`Subnet Pool ` to :ref:`Status Codes `. | -| | - Linked the error codes in the tag management sections. | -| | - Adjusted the sequence of subsections under :ref:`Subnet Pool `. | -| | - Modified the description of parameters **share_type** and **charge_mode** in the **bandwidth** field in section :ref:`Assigning an EIP `. | -| | - Added the example request in section **Creating a VPN Service**. | -| | - Added the example request and example response in section **Querying VPN Endpoint Groups**. | -| | - Added the example request in section **Querying Details About a VPN Service**. | -| | - Modified the example response in section **Deleting an IKE Policy**. | -| | - Added the example request in section **Deleting a VPN Service**. | -| | - Added the example request in section **Querying Details About an IKE Policy**. | -| | - Added the example response in section **Querying Details About a VPN Endpoint Group**. | -| | - Added the example response in section **Querying Details About a VPN Service**. | -| | - Added the example response in section **Updating an IPsec Policy**. | -| | - Added the example response in section **Updating a VPN Service**. | -| | - Modified the example request and example response in section **Updating an IPsec VPN Connection**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-01-30 | This release incorporates the following changes: | -| | | -| | - Deleted the section **Port**. | -| | - Added section **VPN (Native OpenStack API)**. | -| | - Added section **Subnet Pool (Native OpenStack API)**. | -| | - Added parameters **dns_name** and **dns_domain** in the floating IP address object table in section **Floating IP Address (Native OpenStack API)**. | -| | - Added parameters **dns_name** and **dns_assignment** in the **port object** table in section **Port (Native OpenStack API)** > **Overview**. | -| | - Added the parameter **dns_domain** in the **network object** table in section **Network (Native OpenStack API)** > **Overview**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-11-30 | This release incorporates the following changes: | -| | | -| | - Added parameter **port_security_enable** in section **Creating a Subnet**. | -| | - Modified the **port_id** parameter description in the **publicip** fields in section **Binding or Unbinding an EIP** under **Elastic IP Address**. | -| | - Updated the **device_owner** parameter description in the **port object** table in section **Port (Native OpenStack API)** > **Overview**. | -| | - Added the **min** parameter to the **resources** field in the response in section **Querying Quotas**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-09-30 | This release incorporates the following changes: | -| | | -| | - Deleted the **ip_version** field from the **floatingip** object, request parameter, and response parameter in section **Floating IP Address (Native OpenStack API)**. | -| | - Added section **VPC Peering Connection**. | -| | - Added section **VPC Route**. | -| | - Added a filter field to the URI of the APIs in sections **Querying Ports** and **Querying VPC Routes**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-08-30 | This release incorporates the following changes: | -| | | -| | Updated description in section **Updating a Network** under **Network (Native OpenStack API)**. | -| | | -| | - Added section **Elastic IP Address V2.0 (Extended OpenStack API)**. | -| | - Deleted the **ip_version** field from the **floatingip** object, request parameter, and response parameter in section **Floating IP Address (Native OpenStack API)**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-07-30 | This release incorporates the following changes: | -| | | -| | - Changed the allowed maximum subnet mask value to 28 for CIDR blocks in the **subnet** object in section **Overview** under **Subnet (Native OpenStack API)**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-06-30 | This release incorporates the following changes: | -| | | -| | - Changed the **CRUD** value of parameter **router_id** to **R** for the **Floating IP address** object in section **Overview** under **Floating IP Address (Native OpenStack API)**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-05-30 | Added the following sections: | -| | | -| | - Network (Native OpenStack API) | -| | - Router (Native OpenStack API) | -| | - Floating IP Address (Native OpenStack API) | -| | - firewall (Native OpenStack API) | -| | - Security Group (Native OpenStack API) | -| | - Modified the request URI in section **Security Group**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-04-28 | This release incorporates the following changes: | -| | | -| | - Added monitoring metrics **up_stream** and **down_stream**. | -| | - Added field **dnsList** for APIs used to create a subnet, query a subnet, query subnets, and update a subnet. | -| | - Changed the bandwidth size value to 1 Mbit/s to 500 Mbit/s in sections **Elastic IP Address** and **Bandwidth**. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-10-29 | This release incorporates the following changes: | -| | | -| | - Added the **ip_address** field to enable users to obtain a specified EIP. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-06-02 | This release incorporates the following changes: | -| | | -| | Changed the **ethertype** field for creating a security group rule to an optional field. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-04-14 | This release incorporates the following changes: | -| | | -| | - Modified the URL parameter description in section **Service Usage**. | -| | - Modified the procedure for making API calls for token authentication. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-03-09 | This issue is the first official release. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Released On | Description | ++===================================+============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2022-12-12 | This release incorporates the following change: | +| | | +| | Modified the following content: | +| | | +| | Added description that EIPs of the Dedicated Load Balancer (5_gray) type cannot be created in :ref:`Assigning an EIP `, :ref:`Querying an EIP `, :ref:`Querying EIPs `, :ref:`Updating an EIP `, :ref:`Releasing an EIP `, :ref:`Querying Floating IP Addresses `, :ref:`Querying a Floating IP Address `, :ref:`Assigning a Floating IP Address `, :ref:`Updating a Floating IP Address `, and :ref:`Deleting a Floating IP Address `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-11-15 | This release incorporates the following changes: | +| | | +| | Added support for binding and unbinding EIPs of the Dedicated Load Balancer (5_gray) type using APIs in :ref:`Assigning an EIP `, :ref:`Querying an EIP `, :ref:`Querying EIPs `, :ref:`Updating an EIP `, :ref:`Releasing an EIP `, :ref:`Querying Floating IP Addresses `, :ref:`Querying a Floating IP Address `, :ref:`Assigning a Floating IP Address `, :ref:`Updating a Floating IP Address `, and :ref:`Deleting a Floating IP Address `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-09-07 | This release incorporates the following changes: | +| | | +| | - Added description about binding EIPs of the dedicated load balancer **(5_gray)** type to load balancers in :ref:`Assigning an EIP `, :ref:`Querying an EIP `, :ref:`Querying EIPs `, :ref:`Updating an EIP `, and :ref:`Releasing an EIP `. | +| | - Added description about binding EIPs of the dedicated load balancer **(5_gray)** type to load balancers in :ref:`Querying Floating IP Addresses `, :ref:`Querying a Floating IP Address `, :ref:`Assigning a Floating IP Address `, :ref:`Updating a Floating IP Address `, and :ref:`Deleting a Floating IP Address `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-06-25 | This release incorporates the following changes: | +| | | +| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Assigning an EIP `, :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | +| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Querying a Bandwidth `, :ref:`Querying Bandwidths `, and :ref:`Updating a Bandwidth `. | +| | - Modified the load balancer types applicable to the **5_gray** type in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-03-03 | This release incorporates the following changes: | +| | | +| | Added descriptions of parameters **private_ip_address** and **port_id** in :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2022-02-15 | This release incorporates the following changes: | +| | | +| | - Added **5_gray** to the value range of parameter **type** in sections :ref:`Assigning an EIP `, :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | +| | - Added **5_gray** to the value range of parameter **publicip_type** and **gray** for parameter **bandwidth_type** in sections :ref:`Querying a Bandwidth ` and :ref:`Querying Bandwidths `. | +| | - Added **5_gray** to the value range of parameter **publicip_type** in sections :ref:`Updating a Bandwidth `, :ref:`Assigning a Shared Bandwidth `, and :ref:`Adding an EIP to a Shared Bandwidth `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-08-25 | This release incorporates the following changes: | +| | | +| | - Modified the description about parameter **updated_at** and added parameters **billing_info** and **enterprise_project_id** in :ref:`Bandwidth ` and :ref:`Bandwidth (V2.0) `. | +| | - Changed the value range of **type** in :ref:`Querying Quotas `. | +| | - Added parameter **remote_address_group_id** to sections :ref:`Security Group ` and :ref:`Security Group `. | +| | - Deleted parameters **ipv6_address_mode** and **ipv6_ra_mode** from :ref:`Subnet `. | +| | - Added parameter **enterprise_project_id** to section :ref:`EIP `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-06-22 | This release incorporates the following changes: | +| | | +| | - Added parameter **profile** to sections :ref:`Querying an EIP `, :ref:`Querying EIPs `, and :ref:`Updating an EIP `. | +| | - Changed the value range of the **size** parameter to 1 Mbit/s to 1000 Mbit/s in :ref:`Querying Bandwidths `, :ref:`Updating a Bandwidth `, and :ref:`Removing an EIP from a Shared Bandwidth `. | +| | - Changed the value range of the **size** parameter to 5 Mbit/s to 1000 Mbit/s in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | +| | - Updated response examples in sections :ref:`Querying a Bandwidth `, :ref:`Querying Bandwidths `, :ref:`Updating a Bandwidth `, :ref:`Assigning a Shared Bandwidth `, and :ref:`Adding an EIP to a Shared Bandwidth `. | +| | - Changed the parameter of **binding:vif_details** to **primary_interface** in sections :ref:`Querying Ports `, :ref:`Querying a Port `, :ref:`Creating a Port `, and :ref:`Updating a Port `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-05-25 | This release incorporates the following changes: | +| | | +| | - Added parameter **id** to the **bandwidth** field in section :ref:`Assigning an EIP `. | +| | - Added parameter **ip_version** to sections :ref:`EIP `, :ref:`Bandwidth `, and :ref:`Bandwidth (V2.0) `. | +| | - Added parameter **bandwidth_name** to section :ref:`EIP `. | +| | - Deleted description about IP address version conversion from section :ref:`Updating an EIP `. | +| | - Added parameters **created_at**, **updated_at**, **enable_bandwidth_rules**, **rule_quota**, and **bandwidth_rules** in sections :ref:`Bandwidth ` and :ref:`Assigning a Shared Bandwidth `. | +| | - Added value **share** to the value range of parameter **bandwidth_type** in section :ref:`Bandwidth `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-05-10 | This release incorporates the following changes: | +| | | +| | - Added description that the IP addresses reserved by the system cannot be obtained using APIs in :ref:`Querying Private IP Address Details `. | +| | - Moved :ref:`Error Codes ` and :ref:`Status Codes ` to :ref:`Appendix `. | +| | - Added a value for the **type** parameter of the **publicip** field in section :ref:`EIP ` and :ref:`Bandwidth `. | +| | - Added **WHOLE** to the value range of parameter **share_type** in section :ref:`Bandwidth `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2021-03-16 | This release incorporates the following changes: | +| | | +| | Added description that leaving parameter **port_id** blank cannot be used to unbind an EIP from a dedicated load balancer in sections :ref:`Updating an EIP ` and :ref:`Updating a Floating IP Address `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-12-16 | This release incorporates the following changes: | +| | | +| | - Modified the value range of **cidr** in section :ref:`Virtual Private Cloud `. | +| | - Changed the maximum number of tags in sections :ref:`Querying VPCs by Tag ` and :ref:`Querying Subnets by Tag `. | +| | - Added fields **port_security_enabled**, **dns_name**, and **dns_assignment** to section :ref:`Port `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-06-30 | This release incorporates the following changes: | +| | | +| | - Added the **routes** field in section :ref:`Updating VPC Information `. | +| | - Added field **index_enabled** in section :ref:`VPC Flow Log `. | +| | - Modified URI parameters in sections :ref:`Querying Security Group Rule Details ` and :ref:`Deleting a Security Group Rule `. | +| | - Modified description of the **tenant_id** field in section :ref:`Creating a VPC Peering Connection `. | +| | - Modified the **network_ip_availability** parameter type in section :ref:`Querying IP Address Usage on a Specified Network `. | +| | - Modified the **networks** parameter type in section :ref:`Querying Networks `. | +| | - Added response parameter **project_id** in sections :ref:`Adding an Interface to a Router ` and :ref:`Removing an Interface from a Router `. | +| | - Added the **device_owner** field in section :ref:`Creating a Port `. | +| | - Added information about whether the **allow_address_pair** and **extra_dhcp_opt** fields are mandatory in section :ref:`Updating a Port `. | +| | - Added or modified the **ports_links**, **binding:profile**, and **binding:vif_details** fields in section :ref:`Port `. | +| | - Added the **networks_links** field in section :ref:`Network `. | +| | - Added the **subnets_links** field in section :ref:`Subnet `. | +| | - Added the **routers_links** field in section :ref:`Router `. | +| | - Added or modified the **firewall_rules_links** and **firewall_policies** fields in section :ref:`Firewall `. | +| | - Modified the URI in sections :ref:`Querying a Security Group Rule ` and :ref:`Deleting a Security Group Rule `. | +| | - Added the **tenant_id** field in sections :ref:`Creating a Security Group ` and :ref:`Querying Security Group Rule Details `. | +| | - Added the **peerings_link** object in section :ref:`Querying VPC Peering Connections `. | +| | - Added the **routes_link** object in section :ref:`Querying VPC Routes `. | +| | - Added the **fixed_ip** field in section :ref:`Creating a Port `. | +| | - Added the **firewall_policies_link** object in section :ref:`Querying Firewall Policies `. | +| | - Added the **project_id** field in sections :ref:`Inserting a Firewall Rule ` and :ref:`Removing a Firewall Rule `. | +| | - Added the **created_at** and **updated_at** fields in sections :ref:`Querying Firewall Groups `, :ref:`Querying a Firewall Group `, :ref:`Creating a Firewall Group `, and :ref:`Updating a Firewall Group `. | +| | - Added the **firewall_groups_link** object in section :ref:`Querying Firewall Groups `. | +| | - Changed the position of the section :ref:`Permissions Policies and Supported Actions ` and adjusted the table. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-04-13 | This release incorporates the following changes: | +| | | +| | - Modified description of parameters in the **security_group_rule** field in section :ref:`Creating a Security Group Rule `. | +| | - Added URI parameter description in :ref:`Port `, :ref:`Network `, :ref:`Querying Subnets `, :ref:`Querying Routers `, :ref:`Firewall `, and :ref:`Security Group `. | +| | - Added description of discarding **vpc_id** in section :ref:`Creating a Security Group `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-03-20 | This release incorporates the following changes: | +| | | +| | Added the value of **5_mailbgp** for parameters **type** and **publicip_type** | +| | | +| | in sections :ref:`Assigning an EIP `, :ref:`Bandwidth `, and :ref:`Bandwidth (V2.0) `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2020-02-25 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Bandwidth (V2.0) `. | +| | - Added :ref:`Bandwidth (V2.0) ` in section :ref:`Permissions Policies and Supported Actions `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2019-09-10 | This release incorporates the following changes: | +| | | +| | - Added APIs described in section :ref:`VPC Flow Log ` and VPC flow log error codes to section :ref:`Error Codes `. | +| | - Modified the description of the **charge_mode** field and its value in the response example in :ref:`Bandwidth `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-11-30 | This release incorporates the following changes: | +| | | +| | - Added the **extra_dhcp_opts** field in sections :ref:`Creating a Subnet `, :ref:`Querying Subnet Details `, :ref:`Querying Subnets `, and :ref:`Updating Subnet Information `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-10-22 | This release incorporates the following changes: | +| | | +| | - Added sections :ref:`APIs ` and :ref:`Native OpenStack Neutron APIs (V2.0) ` and categorized VPC APIs and native OpenStack APIs. | +| | - Deleted description about the **Reject** rule from section :ref:`Updating a Firewall Rule `. | +| | - Added the **project_id**, **created_at**, and **updated_at** fields to and modified the example request and response in sections :ref:`Port `, :ref:`Network `, :ref:`Subnet `, :ref:`Router `, :ref:`Floating IP Address `, :ref:`Firewall `, and :ref:`Security Group `. | +| | - Modified the API format to ensure consistency. | +| | - Modified description about the **tenant_id** and **project_id** fields to ensure consistency. | +| | - Added section :ref:`VPC Peering Connection ` under **API Permissions**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-10-12 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Querying a Specified API Version `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-09-04 | This release incorporates the following changes: | +| | | +| | - Modified the response example in section :ref:`Associating Multiple NIC Ports to or Disassociating Them from a Security Group at a Time `. | +| | - Added error messages for associating multiple NIC ports to or disassociating them from a security group at a time in section :ref:`Error Codes `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-08-30 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Associating Multiple NIC Ports to or Disassociating Them from a Security Group at a Time `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-07-30 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Permissions Policies and Supported Actions `. | +| | - Deleted sections related to VPNs. An independent VPN API reference will be provided. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-06-11 | This release incorporates the following changes: | +| | | +| | - Modified VPC tagging description in section :ref:`Querying VPC Tags in a Specified Project `. | +| | - Modified subnet tagging description in section :ref:`Querying Subnet Tags in a Specified Project `. | +| | - Modified EIP tagging description in section :ref:`Querying EIP Tags in a Specified Project `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-04-28 | This release incorporates the following changes: | +| | | +| | - Opened APIs described in section :ref:`Floating IP Address (IPv6) `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-03-30 | This release incorporates the following changes: | +| | | +| | - Added section :ref:`Querying API Versions `. | +| | - Modified the content in section :ref:`VPC Tag Management `. | +| | - Added section :ref:`Subnet Tag Management `. | +| | - Added section :ref:`EIP Tag Management `. | +| | - Added metrics **Upstream Traffic** and **Downstream Traffic** in section :ref:`VPC Monitoring Metrics `. | +| | - Modified the content in section :ref:`API Usage Guidelines `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-02-28 | This release incorporates the following changes: | +| | | +| | - Modified the URI and description in the API format in section :ref:`Querying VPC Peering Connections `. | +| | - Modified the URI and description in the API format in section :ref:`Querying VPC Routes `. | +| | - Modified the response parameters and parameter examples in section :ref:`Accepting a VPC Peering Connection `. | +| | - Modified the response parameters and parameter examples in section :ref:`Refusing a VPC Peering Connection `. | +| | - Provided the address for downloading the sample code in section **Sample Code**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-02-14 | This release incorporates the following changes: | +| | | +| | - Modified the title of section **VPN (Native OpenStack API)**. | +| | - Linked the error codes in subsections of **VPN (Native OpenStack API)** to **Error Codes**. | +| | - Linked the error codes in subsection :ref:`Subnet Pool ` to :ref:`Status Codes `. | +| | - Linked the error codes in the tag management sections. | +| | - Adjusted the sequence of subsections under :ref:`Subnet Pool `. | +| | - Modified the description of parameters **share_type** and **charge_mode** in the **bandwidth** field in section :ref:`Assigning an EIP `. | +| | - Added the example request in section **Creating a VPN Service**. | +| | - Added the example request and example response in section **Querying VPN Endpoint Groups**. | +| | - Added the example request in section **Querying Details About a VPN Service**. | +| | - Modified the example response in section **Deleting an IKE Policy**. | +| | - Added the example request in section **Deleting a VPN Service**. | +| | - Added the example request in section **Querying Details About an IKE Policy**. | +| | - Added the example response in section **Querying Details About a VPN Endpoint Group**. | +| | - Added the example response in section **Querying Details About a VPN Service**. | +| | - Added the example response in section **Updating an IPsec Policy**. | +| | - Added the example response in section **Updating a VPN Service**. | +| | - Modified the example request and example response in section **Updating an IPsec VPN Connection**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2018-01-30 | This release incorporates the following changes: | +| | | +| | - Deleted the section **Port**. | +| | - Added section **VPN (Native OpenStack API)**. | +| | - Added section **Subnet Pool (Native OpenStack API)**. | +| | - Added parameters **dns_name** and **dns_domain** in the floating IP address object table in section **Floating IP Address (Native OpenStack API)**. | +| | - Added parameters **dns_name** and **dns_assignment** in the **port object** table in section **Port (Native OpenStack API)** > **Overview**. | +| | - Added the parameter **dns_domain** in the **network object** table in section **Network (Native OpenStack API)** > **Overview**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-11-30 | This release incorporates the following changes: | +| | | +| | - Added parameter **port_security_enable** in section **Creating a Subnet**. | +| | - Modified the **port_id** parameter description in the **publicip** fields in section **Binding or Unbinding an EIP** under **Elastic IP Address**. | +| | - Updated the **device_owner** parameter description in the **port object** table in section **Port (Native OpenStack API)** > **Overview**. | +| | - Added the **min** parameter to the **resources** field in the response in section **Querying Quotas**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-09-30 | This release incorporates the following changes: | +| | | +| | - Deleted the **ip_version** field from the **floatingip** object, request parameter, and response parameter in section **Floating IP Address (Native OpenStack API)**. | +| | - Added section **VPC Peering Connection**. | +| | - Added section **VPC Route**. | +| | - Added a filter field to the URI of the APIs in sections **Querying Ports** and **Querying VPC Routes**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-08-30 | This release incorporates the following changes: | +| | | +| | Updated description in section **Updating a Network** under **Network (Native OpenStack API)**. | +| | | +| | - Added section **Elastic IP Address V2.0 (Extended OpenStack API)**. | +| | - Deleted the **ip_version** field from the **floatingip** object, request parameter, and response parameter in section **Floating IP Address (Native OpenStack API)**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-07-30 | This release incorporates the following changes: | +| | | +| | - Changed the allowed maximum subnet mask value to 28 for CIDR blocks in the **subnet** object in section **Overview** under **Subnet (Native OpenStack API)**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-06-30 | This release incorporates the following changes: | +| | | +| | - Changed the **CRUD** value of parameter **router_id** to **R** for the **Floating IP address** object in section **Overview** under **Floating IP Address (Native OpenStack API)**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-05-30 | Added the following sections: | +| | | +| | - Network (Native OpenStack API) | +| | - Router (Native OpenStack API) | +| | - Floating IP Address (Native OpenStack API) | +| | - firewall (Native OpenStack API) | +| | - Security Group (Native OpenStack API) | +| | - Modified the request URI in section **Security Group**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2017-04-28 | This release incorporates the following changes: | +| | | +| | - Added monitoring metrics **up_stream** and **down_stream**. | +| | - Added field **dnsList** for APIs used to create a subnet, query a subnet, query subnets, and update a subnet. | +| | - Changed the bandwidth size value to 1 Mbit/s to 500 Mbit/s in sections **Elastic IP Address** and **Bandwidth**. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2016-10-29 | This release incorporates the following changes: | +| | | +| | - Added the **ip_address** field to enable users to obtain a specified EIP. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2016-06-02 | This release incorporates the following changes: | +| | | +| | Changed the **ethertype** field for creating a security group rule to an optional field. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2016-04-14 | This release incorporates the following changes: | +| | | +| | - Modified the URL parameter description in section **Service Usage**. | +| | - Modified the procedure for making API calls for token authentication. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2016-03-09 | This issue is the first official release. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst index 0c48097..f016747 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst @@ -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. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies the administrative status of the firewall. | - | | | | | - | | | | The value can be **true** or **false**. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ + +----------------------------+-----------------+------------------+--------------------------------------------------------------------------------------------+ + | 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. | + | | | | | + | | | | .. 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:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst index 484a86d..2848140 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst @@ -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:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst index 8046db9..6849da3 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst @@ -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:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst index 7d5afc6..7653c0a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst @@ -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:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst index b1569e0..20698e3 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst @@ -32,6 +32,13 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_groups/a504a4cf-9300-40e0-b2d4-649bd157c55a + Response Message ---------------- @@ -81,16 +88,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +----------------------------+-----------------------+---------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_groups/a504a4cf-9300-40e0-b2d4-649bd157c55a - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst index 90307f2..024bdc1 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst @@ -32,6 +32,13 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_policies/fed2d88f-d0e7-4cc5-bd7e-c495f67037b6 + Response Message ---------------- @@ -67,16 +74,8 @@ Response Message | project_id | String | Specifies the project ID. | +----------------+------------------+---------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_policies/fed2d88f-d0e7-4cc5-bd7e-c495f67037b6 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst index b30bcdb..dd879c7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst @@ -32,6 +32,13 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_rules/514e6776-162a-4b5d-ab8b-aa36b86655ef + Response Message ---------------- @@ -79,39 +86,27 @@ Response Message | project_id | String | Specifies the project ID. | +------------------------+---------+-------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_rules/514e6776-162a-4b5d-ab8b-aa36b86655ef - -Example response +Example Response +---------------- .. code-block:: { "firewall_rule": { "protocol": "tcp", - "name": "bobby_rule", - "mode": "normal", - "tenant_id": "4490a89232ce46d4ae4bfb227ef1a40a", - "rule_profile": "", - "enabled": true, - "source_port": null, - "source_ip_address": null, - "destination_ip_address": null, - "firewall_policy_id": null, - "action": "allow", - "position": null, - "ip_version": 4, - "shared": false, + "description": "update check parameter", + "source_ip_address": "116.66.184.0/24", + "destination_ip_address": "0.0.0.0/0", "destination_port": null, + "source_port": null, "id": "514e6776-162a-4b5d-ab8b-aa36b86655ef", - "description": "", - "project_id": "4490a89232ce46d4ae4bfb227ef1a40a" + "name": "test", + "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68", + "project_id": "a1c6f90c94334bd2953d9a61b8031a68", + "enabled": true, + "action": "allow", + "ip_version": 4, + "public": false } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst index c1ec80e..b3efdb6 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst @@ -46,12 +46,12 @@ Example of querying groups by page | | | | | | | | | 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**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,20 +61,27 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_groups + Response Message ---------------- .. table:: **Table 2** Response parameter - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================================+======================================================================================================================================================================================================================+ - | firewall_groups | Array of :ref:`Firewall Group ` objects | Specifies the firewall group list. For details, see :ref:`Table 3 `. | - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | firewall_groups_links | Array of :ref:`firewall_groups_link ` objects | Specifies the **firewall_groups_link** object list. For details, see :ref:`Table 4 `. | - | | | | - | | | 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**). | - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+====================================================================================+=================================================================================================================================================================================================================+ + | firewall_groups | Array of :ref:`Firewall Group ` objects | Specifies the firewall group list. For details, see :ref:`Table 3 `. | + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | firewall_groups_links | Array of :ref:`firewall_groups_link ` objects | Specifies the **firewall_groups_link** object list. For details, see :ref:`Table 4 `. | + | | | | + | | | 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_firewall_0013__table31629250121127: @@ -126,16 +133,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +------+--------+----------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_groups - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst index f9a3392..0ef5cf6 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst @@ -42,12 +42,12 @@ Example of querying policies by page | | | | | | | | | 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**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,20 +57,27 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_policies + Response Message ---------------- .. table:: **Table 2** Response parameter - +-------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=====================================================================================+======================================================================================================================================================================================================================+ - | firewall_policies | Array of :ref:`firewall Policy ` object | Specifies the firewall policies. For details, see :ref:`Table 3 `. | - +-------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | firewall_policies_links | Array of :ref:`firewall_policies_link ` object | **firewall_policies_link** object For details, see :ref:`Table 4 `. | - | | | | - | | | 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**). | - +-------------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=========================+=====================================================================================+=================================================================================================================================================================================================================+ + | firewall_policies | Array of :ref:`firewall Policy ` object | Specifies the firewall policies. For details, see :ref:`Table 3 `. | + +-------------------------+-------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | firewall_policies_links | Array of :ref:`firewall_policies_link ` object | **firewall_policies_link** object For details, see :ref:`Table 4 `. | + | | | | + | | | 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_firewall_0006__table17002720121127: @@ -108,16 +115,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +------+--------+----------------------------------------------------------------------+ -Example -------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_policies - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst index 600e66e..a36b654 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst @@ -60,12 +60,12 @@ Example of querying rules by page | | | | | | | | | 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**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -75,20 +75,27 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/fwaas/firewall_rules + Response Message ---------------- .. table:: **Table 2** Response parameter - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================================+======================================================================================================================================================================================================================+ - | firewall_rules | Array of :ref:`Firewall Rule ` objects | Specifies the firewall rule list. For details, see :ref:`Table 4 `. | - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | firewall_rules_links | Array of :ref:`firewall_rules_link ` Object | Specifies the pagination information. For details, see :ref:`Table 3 `. | - | | | | - | | | 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**). | - +-----------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+====================================================================================+=================================================================================================================================================================================================================+ + | firewall_rules | Array of :ref:`Firewall Rule ` objects | Specifies the firewall rule list. For details, see :ref:`Table 4 `. | + +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | firewall_rules_links | Array of :ref:`firewall_rules_link ` Object | Specifies the pagination information. For details, see :ref:`Table 3 `. | + | | | | + | | | 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_firewall_0001__table2049004519490: @@ -138,16 +145,8 @@ Response Message | project_id | String | Specifies the project ID. | +------------------------+---------+-------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/fwaas/firewall_rules - -Example response +Example Response +---------------- .. code-block:: @@ -155,43 +154,35 @@ Example response "firewall_rules": [ { "protocol": "tcp", - "name": "crhfwruleupdate", - "mode": "normal", - "tenant_id": "f480f5d250824e5fafedcf05acf1419c", - "rule_profile": "", - "enabled": true, - "source_port": null, - "source_ip_address": null, - "destination_ip_address": null, - "firewall_policy_id": "b4f81251-c47a-4fe1-8579-6f9271d015d1", - "action": "deny", - "position": 1, - "ip_version": 4, - "shared": false, + "description": "update check parameter", + "source_ip_address": "116.66.184.0/24", + "destination_ip_address": "0.0.0.0/0", "destination_port": null, + "source_port": null, "id": "2a193015-4a88-4aa1-84ad-d4955adae707", - "description": "", - "project_id": "f480f5d250824e5fafedcf05acf1419c" + "name": "crhfwruleupdate", + "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68", + "project_id": "a1c6f90c94334bd2953d9a61b8031a68", + "enabled": true, + "action": "allow", + "ip_version": 4, + "public": false }, { "protocol": "tcp", - "name": "update_firewall-role-tommy", - "mode": "mix", - "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68", - "rule_profile": "", - "enabled": false, - "source_port": "20:50", + "description": "update check parameter", "source_ip_address": null, "destination_ip_address": null, - "firewall_policy_id": null, - "action": "deny", - "position": null, - "ip_version": 4, - "shared": true, "destination_port": "40:60", + "source_port": "20:50", "id": "db7a204c-9eb1-40a2-9bd6-ed5cfd3cff32", - "description": "update check parameter", - "project_id": "a1c6f90c94334bd2953d9a61b8031a68" + "name": "update_firewall-role-tommy", + "tenant_id": "a1c6f90c94334bd2953d9a61b8031a68", + "project_id": "a1c6f90c94334bd2953d9a61b8031a68", + "enabled": false, + "action": "deny", + "ip_version": 4, + "public": false } ], "firewall_rules_links": [ diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst index 7036157..4dd03b6 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst @@ -26,6 +26,17 @@ Request Message | firewall_rule_id | String | Yes | Specifies the firewall rule ID, which uniquely identifies the firewall rule. | +------------------+--------+-----------+------------------------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/remove_rule + + { + "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" + } + Response Message ---------------- @@ -51,20 +62,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/remove_rule - - { - "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst index 7369035..1cda520 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst @@ -30,29 +30,54 @@ 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. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies the administrative status of the firewall. | - | | | | | - | | | | The value can be **true** or **false**. | - +----------------------------+-----------------+------------------+--------------------------------------------------------------+ + +----------------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | The port is the one whose **device_owner** is **network:router_interface_distributed**. | + | | | | | + | | | | - Call the VPC API for querying the port ID. The filtering criteria are the specified subnet ID and **device_owner**. | + | | | | | + | | | | Example: | + | | | | | + | | | | .. code:: text | + | | | | | + | | | | GET https://{Endpoint}/v1/{project_id}/ports?network_id={network_id}&device_owner=network%3Arouter_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 + + PUT https://{Endpoint}/v2.0/fwaas/firewall_groups/2fb0e81f-9f63-44b2-9894-c13a3284594a + + { + "firewall_group": { + "egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9" + } + } Response Message ---------------- @@ -103,22 +128,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +----------------------------+-----------------------+---------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/fwaas/firewall_groups/2fb0e81f-9f63-44b2-9894-c13a3284594a - - { - "firewall_group": { - "egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst index 5b6faa7..ae70e55 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst @@ -48,6 +48,21 @@ Request Message | | | | The value can be **true** or **false**. | +-----------------+-----------------+------------------+-----------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a + + { + "firewall_policy": { + "firewall_rules": [ + "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" + ] + } + } + Response Message ---------------- @@ -83,24 +98,8 @@ Response Message | project_id | String | Specifies the project ID. | +----------------+------------------+---------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a - - { - "firewall_policy": { - "firewall_rules": [ - "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" - ] - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst index 9ec8ef6..d419a70 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst @@ -70,6 +70,19 @@ Request Message | | | | The value can be **true** or **false**. | +------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28 + + { + "firewall_rule": { + "action": "deny" + } + } + Response Message ---------------- @@ -117,22 +130,8 @@ Response Message | project_id | String | Specifies the project ID. | +------------------------+---------+-------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28 - - { - "firewall_rule": { - "action": "deny" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst index e6c601a..6a29bdc 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst @@ -12,6 +12,19 @@ When assigning a floating IP address, you need to obtain the external network ID You can use **GET /v2.0/networks?router:external=True** or run the **neutron net-external-list** command to obtain the UUID of the external network required for assigning a floating IP address. +.. 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 --- @@ -20,17 +33,25 @@ POST /v2.0/floatingips Request Message --------------- -.. table:: **Table 1** Request parameter +.. table:: **Table 1** 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 2** Request parameter +------------+---------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Mandatory | Description | +============+=====================================================================+===========+=====================================================================================================================+ - | floatingip | :ref:`floatingip ` object | Yes | Specifies the floating IP address list. For details, see :ref:`Table 2 `. | + | floatingip | :ref:`floatingip ` object | Yes | Specifies the floating IP address list. For details, see :ref:`Table 3 `. | +------------+---------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0003__table15863423175513: -.. table:: **Table 2** **floatingip** objects +.. table:: **Table 3** **floatingip** objects +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -55,17 +76,17 @@ Request Message Response Message ---------------- -.. table:: **Table 3** Response parameter +.. table:: **Table 4** Response parameter +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +============+=================================================================+=================================================================================================================+ - | floatingip | :ref:`floatingip ` object | Specifies the floating IP address list. For details, see :ref:`Table 4 `. | + | floatingip | :ref:`floatingip ` object | Specifies the floating IP address list. For details, see :ref:`Table 5 `. | +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0003__table8139247714: -.. table:: **Table 4** **floatingip** objects +.. table:: **Table 5** **floatingip** objects +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ | Attribute | Type | Description | diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst index b594a38..412c7be 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst @@ -10,6 +10,19 @@ Function This API is used to delete a floating IP address. +.. 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,7 +43,13 @@ DELETE /v2.0/floatingips/{floatingip_id} Request Message --------------- -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. | + +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Message ---------------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst index 8561174..58f7ebb 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst @@ -10,6 +10,19 @@ Function This API is used to query details about a specified floating IP address, including the floating IP address status, ID of the router to which the floating IP address belongs, and external network ID of the floating IP address. +.. 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 --- @@ -18,22 +31,28 @@ GET /v2.0/floatingips/{floatingip_id} Request Message --------------- -None +.. table:: **Table 1** 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. | + +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Message ---------------- -.. table:: **Table 1** Response parameter +.. table:: **Table 2** Response parameter +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +============+=================================================================+=================================================================================================================+ - | floatingip | :ref:`floatingip ` object | Specifies the floating IP address list. For details, see :ref:`Table 2 `. | + | floatingip | :ref:`floatingip ` object | Specifies the floating IP address list. For details, see :ref:`Table 3 `. | +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0002__table8139247714: -.. table:: **Table 2** **floatingip** objects +.. table:: **Table 3** **floatingip** objects +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ | Attribute | Type | Description | diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst index 6b4651b..cd67ff2 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst @@ -12,6 +12,19 @@ This API is used to query all floating IP addresses accessible to the tenant sub You can query the detailed information about a specified floating IP address using the API for :ref:`Querying a Floating IP Address `. +.. 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 --- @@ -46,7 +59,7 @@ GET /v2.0/floatingips +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | No | String | Specifies the project ID. | +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | Integer | No | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. | + | limit | Integer | No | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). | | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -54,7 +67,7 @@ GET /v2.0/floatingips | | | | | | | | | 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. | @@ -71,22 +84,28 @@ Example: Request Message --------------- -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. | + +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Message ---------------- -.. table:: **Table 2** Response parameter +.. table:: **Table 3** Response parameter +-------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=============+===========================================================================+=================================================================================================================+ - | floatingips | Array of :ref:`floatingip ` objects | Specifies the floating IP address list. For details, see :ref:`Table 3 `. | + | floatingips | Array of :ref:`floatingip ` objects | Specifies the floating IP address list. For details, see :ref:`Table 4 `. | +-------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0001__table8139247714: -.. table:: **Table 3** **floatingip** objects +.. table:: **Table 4** **floatingip** objects +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst index 2ce3c72..ef2e635 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst @@ -21,6 +21,14 @@ If **port_id** is left blank, the floating IP address has been unbound from the - If you want to bind a floating IP address in the **error** state, unbind the IP address first. - Do not associate a port that has a floating IP address associated to another floating IP address. You must first disassociate the port from the IP address and then associate it with another IP address. - This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer. + - 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 --- @@ -44,17 +52,25 @@ PUT /v2.0/floatingips/{floatingip_id} Request Message --------------- -.. 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 | +============+===================================================================+===========+===================================================================================================================+ - | floatingip | :ref:`floatingip ` object | Yes | Specifies the floating IP address list. For details, see :ref:`Table 3 `. | + | floatingip | :ref:`floatingip ` object | Yes | Specifies the floating IP address list. For details, see :ref:`Table 4 `. | +------------+-------------------------------------------------------------------+-----------+-------------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0004__table547993685510: -.. table:: **Table 3** **floatingip** objects +.. table:: **Table 4** **floatingip** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -67,17 +83,17 @@ Request Message Response Message ---------------- -.. table:: **Table 4** Response parameter +.. table:: **Table 5** Response parameter +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +============+=================================================================+=================================================================================================================+ - | floatingip | :ref:`floatingip ` object | Specifies the floating IP address list. For details, see :ref:`Table 5 `. | + | floatingip | :ref:`floatingip ` object | Specifies the floating IP address list. For details, see :ref:`Table 6 `. | +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0004__table8139247714: -.. table:: **Table 5** **floatingip** objects +.. table:: **Table 6** **floatingip** objects +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ | Attribute | Type | Description | diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst index 99a7d49..7509066 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst @@ -41,6 +41,8 @@ Request Message | | | | | | | | | The value can only be **true**. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | No | Boolean | Specifies whether the firewall rule can be shared by different tenants. | + +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | provider:network_type | No | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | | | | | | | | | | Tenants can create only networks whose type is **geneve**. | @@ -48,6 +50,21 @@ Request Message | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + POST https://{Endpoint}/v2.0/networks + + { + "network": { + "name": "network-test", + "shared": false, + "admin_state_up": true + } + } + Response Message ---------------- @@ -63,70 +80,58 @@ Response Message .. table:: **Table 4** **network** objects - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | - | | | | - | | | Only one subnet can be associated with each network. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the network name. | - | | | | - | | | The name cannot be the same as the **admin_external_net** value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the network ID. | - | | | | - | | | This parameter is not mandatory when you query networks. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | - | | | | - | | | Tenants can create only networks whose type is **geneve**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the network is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the network is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+==========================================================================================================================================================================================+ + | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | + | | | | + | | | Only one subnet can be associated with each network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the network name. | + | | | | + | | | The name cannot be the same as the **admin_external_net** value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The value can only be **true**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the network ID. | + | | | | + | | | This parameter is not mandatory when you query networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | + | | | | + | | | Tenants can create only networks whose type is **geneve**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zones | Array of strings | Specifies the availability zone of this network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the network is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the network is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/networks - - { - "network": { - "name": "network-test", - "shared": false, - "admin_state_up": true - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst index 63a40af..bd7ba23 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst @@ -32,6 +32,13 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/networks/0133cd73-34d4-4d4c-bf1f-e65b24603206 + Response Message ---------------- @@ -47,62 +54,58 @@ Response Message .. table:: **Table 3** **network** objects - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | - | | | | - | | | Only one subnet can be associated with each network. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the network name. | - | | | | - | | | The name cannot be the same as the **admin_external_net** value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the network ID. | - | | | | - | | | This parameter is not mandatory when you query networks. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | - | | | | - | | | Tenants can create only networks whose type is **geneve**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the network is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the network is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+==========================================================================================================================================================================================+ + | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | + | | | | + | | | Only one subnet can be associated with each network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the network name. | + | | | | + | | | The name cannot be the same as the **admin_external_net** value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The value can only be **true**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the network ID. | + | | | | + | | | This parameter is not mandatory when you query networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | + | | | | + | | | Tenants can create only networks whose type is **geneve**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zones | Array of strings | Specifies the availability zone of this network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the network is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the network is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/networks/0133cd73-34d4-4d4c-bf1f-e65b24603206 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst index ab19c3a..f10432a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst @@ -64,12 +64,12 @@ Example of querying ports by page | | | | | | | | | 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**. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -79,70 +79,81 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/networks?limit=1 + Response Message ---------------- .. table:: **Table 2** Response parameter - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==============================================================================+======================================================================================================================================================================================================================+ - | networks | Array of :ref:`network ` objects | Specifies the network list. For details, see :ref:`Table 3 `. | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | networks_links | Array of :ref:`networks_link ` objects | Specifies the pagination information. For details, see :ref:`Table 4 `. | - | | | | - | | | 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**). | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==============================================================================+=================================================================================================================================================================================================================+ + | networks | Array of :ref:`network ` objects | Specifies the network list. For details, see :ref:`Table 3 `. | + +-----------------------+------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | networks_links | Array of :ref:`networks_link ` objects | Specifies the pagination information. For details, see :ref:`Table 4 `. | + | | | | + | | | 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_network_0001__table49902238182444: .. table:: **Table 3** **network** object - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | - | | | | - | | | Only one subnet can be associated with each network. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the network name. | - | | | | - | | | The name cannot be the same as the **admin_external_net** value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the network ID. | - | | | | - | | | This parameter is not mandatory when you query networks. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | - | | | | - | | | Tenants can create only networks whose type is **geneve**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the network is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the network is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+==========================================================================================================================================================================================+ + | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | + | | | | + | | | Only one subnet can be associated with each network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the network name. | + | | | | + | | | The name cannot be the same as the **admin_external_net** value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The value can only be **true**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the network ID. | + | | | | + | | | This parameter is not mandatory when you query networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | + | | | | + | | | Tenants can create only networks whose type is **geneve**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zones | Array of strings | Specifies the availability zone of this network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the network is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the network is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_network_0001__table1296611517358: @@ -156,16 +167,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/networks?limit=1 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst index 40a4414..46eb604 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst @@ -58,6 +58,19 @@ Request Message | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/networks/c360322d-5315-45d7-b7d2-481f98c56edb + + { + "network": { + "name": "network-test02" + } + } + Response Message ---------------- @@ -73,68 +86,58 @@ Response Message .. table:: **Table 5** **network** objects - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | - | | | | - | | | Only one subnet can be associated with each network. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the network name. | - | | | | - | | | The name cannot be the same as the **admin_external_net** value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The value can only be **true**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the network ID. | - | | | | - | | | This parameter is not mandatory when you query networks. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | - | | | | - | | | Tenants can create only networks whose type is **geneve**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the network is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the network is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+==========================================================================================================================================================================================+ + | status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. | + | | | | + | | | Only one subnet can be associated with each network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the network name. | + | | | | + | | | The name cannot be the same as the **admin_external_net** value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | router:external | Boolean | Specifies whether the network is an external network. This is an extended attribute. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The value can only be **true**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the network ID. | + | | | | + | | | This parameter is not mandatory when you query networks. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | + | | | | + | | | Tenants can create only networks whose type is **geneve**. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zones | Array of strings | Specifies the availability zone of this network. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the network is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the network is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/networks/c360322d-5315-45d7-b7d2-481f98c56edb - - { - "network": { - "name": "network-test02" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst index 8cdbbdd..d863173 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst @@ -38,6 +38,10 @@ Request Message | network_id | Yes | String | - Specifies the ID of the network to which the port belongs. | | | | | - The network ID must be a real one in the network environment. | +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | No | Boolean | Specifies the administrative status. | + | | | | | + | | | | The value can only be **true**. | + +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | fixed_ips | No | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 3 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | security_groups | No | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | @@ -128,6 +132,21 @@ Request Message opt_value No String Specifies the option value. ========= ========= ====== =========================== +Example Request +--------------- + +.. code-block:: text + + POST https://{Endpoint}/v2.0/ports + + { + "port": { + "admin_state_up": true, + "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", + "name": "port-test" + } + } + Response Message ---------------- @@ -317,24 +336,8 @@ Response Message | fqdn | String | Specifies the private network fully qualified domain name (FQDN) of the port. | +------------+--------+-------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/ports - - { - "port": { - "admin_state_up": true, - "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", - "name": "port-test" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst index 2b79154..69c01ec 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst @@ -32,6 +32,13 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports/791870bd-36a7-4d9b-b015-a78e9b06af08 + Response Message ---------------- @@ -224,16 +231,8 @@ Response Message | ovs_hybrid_plug | Boolean | Specifies that OVS hybrid plug should be used by Nova APIs. | +-------------------+---------+-------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/ports/791870bd-36a7-4d9b-b015-a78e9b06af08 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst index e172adb..c64c92a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst @@ -64,12 +64,12 @@ Example of querying ports by page | | | | | | | | | 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**. | +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -79,20 +79,59 @@ Request Message None +Example Request +--------------- + +[Example 1] + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?limit=1 + +[Example 2] + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?mac_address=fa:16:3e:f1:0b:09 + +[Example 3] + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?admin_state_up=False + +[Example 4] + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?device_id=e6c05704-c907-4cc1-8106-69b0996c43b9 + +[Example 5] + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?tenant_id=6c9298ec8c874f7f99688489ab65f90e&name=port_vm_50_3 + +[Example 6] + +.. code-block:: text + + GET https://{Endpoint}/v2.0/ports?name=port_vm_50_3 + Response Parameter ------------------ .. table:: **Table 2** Response parameter - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================================+======================================================================================================================================================================================================================+ - | ports | Array of :ref:`port ` objects | Specifies the port object list. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ports_links | Array of :ref:`ports_link ` objects | Specifies the pagination information. For details, see :ref:`Table 9 `. | - | | | | - | | | 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**). | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=========================================================================+=================================================================================================================================================================================================================+ + | ports | Array of :ref:`port ` objects | Specifies the port object list. For details, see :ref:`Table 3 `. | + +-----------------------+-------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ports_links | Array of :ref:`ports_link ` objects | Specifies the pagination information. For details, see :ref:`Table 9 `. | + | | | | + | | | 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_port02_0001__table15919752145624: @@ -134,8 +173,6 @@ Response Parameter | tenant_id | String | Specifies the project ID. | +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | +-----------------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | | | | | @@ -287,365 +324,317 @@ Response Parameter | rel | String | Specifies the relationship between the API link and the API version. | +------+--------+----------------------------------------------------------------------+ -Example: --------- +Example Response +---------------- [Example 1] -- Example request +.. code-block:: - .. code-block:: text - - GET https://{Endpoint}/v2.0/ports?limit=1 - -- Example response - - .. code-block:: - - { - "ports": [{ - "id": "791870bd-36a7-4d9b-b015-a78e9b06af08", - "name": "port-test", - "status": "DOWN", - "admin_state_up": true, - "fixed_ips": [], - "mac_address": "fa:16:3e:01:e0:b2", - "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", - "tenant_id": "db82c9e1415a464ea68048baa8acc6b8", - "project_id": "db82c9e1415a464ea68048baa8acc6b8", - "device_id": "", - "device_owner": "", - "security_groups": ["d0d58aa9-cda9-414c-9c52-6c3daf8534e6"], - "extra_dhcp_opts": [], - "allowed_address_pairs": [], - "binding: vnic_type": "normal", - "binding: vif_details": {}, - "binding: profile": {}, - "port_security_enabled": true, - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - }], - "ports_links": [ - { - "rel": "next", - "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=791870bd-36a7-4d9b-b015-a78e9b06af08" - }, - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=791870bd-36a7-4d9b-b015-a78e9b06af08&page_reverse=True" - } - ] - } + { + "ports": [{ + "id": "791870bd-36a7-4d9b-b015-a78e9b06af08", + "name": "port-test", + "status": "DOWN", + "admin_state_up": true, + "fixed_ips": [], + "mac_address": "fa:16:3e:01:e0:b2", + "network_id": "00ae08c5-f727-49ab-ad4b-b069398aa171", + "tenant_id": "db82c9e1415a464ea68048baa8acc6b8", + "project_id": "db82c9e1415a464ea68048baa8acc6b8", + "device_id": "", + "device_owner": "", + "security_groups": ["d0d58aa9-cda9-414c-9c52-6c3daf8534e6"], + "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "binding:vif_details": {}, + "binding:profile": {}, + "port_security_enabled": true, + "created_at": "2018-09-13T01: 43: 41", + "updated_at": "2018-09-13T01: 43: 41" + }], + "ports_links": [ + { + "rel": "next", + "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=791870bd-36a7-4d9b-b015-a78e9b06af08" + }, + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=791870bd-36a7-4d9b-b015-a78e9b06af08&page_reverse=True" + } + ] + } [Example 2] -- Example request +.. code-block:: - .. code-block:: text - - GET https://{Endpoint}/v2.0/ports?mac_address=fa:16:3e:f1:0b:09 - -- Example response - - .. code-block:: - - { - "ports": [ - { - "admin_state_up": true, - "allowed_address_pairs": [], - "binding:vnic_type": "normal", - "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", - "device_owner": "compute:az3.dc1", - "port_security_enabled":true, - "extra_dhcp_opts": [], - "fixed_ips": [ - { - "ip_address": "172.16.0.37", - "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" - } - ], - "dns_assignment": [ - { - "hostname": "ip-172-16-0-37", - "ip_address": "172.16.0.37", - "fqdn": "ip-172-16-0-37.xxx.compute.internal." - } - ], - "dns_name": "ip-172-16-0-37", - "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", - "mac_address": "fa:16:3e:f1:0b:09", - "name": "port_vm_50_3", - "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "status": "ACTIVE", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "6c9298ec8c874f7f99688489ab65f90e", - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - } - ], - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?mac_address=fa%3A16%3A3e%3Af1%3A0b%3A09&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" - } - ] - } + { + "ports": [ + { + "admin_state_up": true, + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", + "device_owner": "compute:az3.dc1", + "port_security_enabled":true, + "extra_dhcp_opts": [], + "fixed_ips": [ + { + "ip_address": "172.16.0.37", + "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" + } + ], + "dns_assignment": [ + { + "hostname": "ip-172-16-0-37", + "ip_address": "172.16.0.37", + "fqdn": "ip-172-16-0-37.xxx.compute.internal." + } + ], + "dns_name": "ip-172-16-0-37", + "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", + "mac_address": "fa:16:3e:f1:0b:09", + "name": "port_vm_50_3", + "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "status": "ACTIVE", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "6c9298ec8c874f7f99688489ab65f90e", + "created_at": "2018-09-13T01: 43: 41", + "updated_at": "2018-09-13T01: 43: 41" + } + ], + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?mac_address=fa%3A16%3A3e%3Af1%3A0b%3A09&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" + } + ] + } [Example 3] -- Example request +.. code-block:: - .. code-block:: text + { + "ports": [ - GET https://{Endpoint}/v2.0/ports?admin_state_up=False - -- Example response - - .. code-block:: - - { - "ports": [ - - { - "admin_state_up": false, - "allowed_address_pairs": [], - "binding:vnic_type": "normal", - "device_id": "", - "device_owner": "", - "port_security_enabled":true, - "extra_dhcp_opts": [], - "fixed_ips": [ - { - "ip_address": "10.100.100.62", - "subnet_id": "9b28f20c-0234-419f-a0b4-4a84f182f64b" - } - ], - "dns_name": "", - "id": "ffc0bdee-8413-4fa2-bd82-fa8efe5b3a87", - "mac_address": "fa:16:3e:2b:bc:57", - "name": "small_net_port", - "network_id": "b299b151-7a66-4c6f-a313-cdd3b5724296", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "status": "DOWN", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "6c9298ec8c874f7f99688489ab65f90e", - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - } - ], - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?admin_state_up=False&marker=ffc0bdee-8413-4fa2-bd82-fa8efe5b3a87&page_reverse=True" - } - ] - } + { + "admin_state_up": false, + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "device_id": "", + "device_owner": "", + "port_security_enabled":true, + "extra_dhcp_opts": [], + "fixed_ips": [ + { + "ip_address": "10.100.100.62", + "subnet_id": "9b28f20c-0234-419f-a0b4-4a84f182f64b" + } + ], + "dns_name": "", + "id": "ffc0bdee-8413-4fa2-bd82-fa8efe5b3a87", + "mac_address": "fa:16:3e:2b:bc:57", + "name": "small_net_port", + "network_id": "b299b151-7a66-4c6f-a313-cdd3b5724296", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "status": "DOWN", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "6c9298ec8c874f7f99688489ab65f90e", + "created_at": "2018-09-13T01: 43: 41", + "updated_at": "2018-09-13T01: 43: 41" + } + ], + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?admin_state_up=False&marker=ffc0bdee-8413-4fa2-bd82-fa8efe5b3a87&page_reverse=True" + } + ] + } [Example 4] -- Example request +.. code-block:: - .. code-block:: text - - GET https://{Endpoint}/v2.0/ports?device_id=e6c05704-c907-4cc1-8106-69b0996c43b9 - -- Example response - - .. code-block:: - - { - "ports": [ - { - "admin_state_up": true, - "allowed_address_pairs": [], - "binding:vnic_type": "normal", - "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", - "device_owner": "compute:az3.dc1", - "port_security_enabled":true, - "extra_dhcp_opts": [], - "fixed_ips": [ - { - "ip_address": "10.1.0.37", - "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" - } - ], - "dns_assignment": [ - { - "hostname": "ip-10-1-0-37", - "ip_address": "10.1.0.37", - "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. - } - ], - "dns_name": "ip-10-1-0-37", - "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", - "mac_address": "fa:16:3e:f1:0b:09", - "name": "port_vm_50_3", - "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "status": "ACTIVE", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "6c9298ec8c874f7f99688489ab65f90e" , - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - } - ], - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?device_id=77307088-ae60-49fb-9146-924dcf1d1402&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" - } - ] - } + { + "ports": [ + { + "admin_state_up": true, + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", + "device_owner": "compute:az3.dc1", + "port_security_enabled":true, + "extra_dhcp_opts": [], + "fixed_ips": [ + { + "ip_address": "10.1.0.37", + "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" + } + ], + "dns_assignment": [ + { + "hostname": "ip-10-1-0-37", + "ip_address": "10.1.0.37", + "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. + } + ], + "dns_name": "ip-10-1-0-37", + "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", + "mac_address": "fa:16:3e:f1:0b:09", + "name": "port_vm_50_3", + "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "status": "ACTIVE", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "6c9298ec8c874f7f99688489ab65f90e" , + "created_at": "2018-09-13T01: 43: 41", + "updated_at": "2018-09-13T01: 43: 41" + } + ], + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?device_id=77307088-ae60-49fb-9146-924dcf1d1402&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" + } + ] + } [Example 5] -- Example request +.. code-block:: - .. code-block:: text - - GET https://{Endpoint}/v2.0/ports?tenant_id=6c9298ec8c874f7f99688489ab65f90e&name=port_vm_50_3 - -- Example response - - .. code-block:: - - { - "ports": [ - { - "admin_state_up": true, - "allowed_address_pairs": [], - "binding:vnic_type": "normal", - "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", - "device_owner": "compute:az3.dc1", - "port_security_enabled":true, - "extra_dhcp_opts": [], - "fixed_ips": [ - { - "ip_address": "10.1.0.37", - "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" - } - ], - "dns_assignment": [ - { - "hostname": "ip-10-1-0-37", - "ip_address": "10.1.0.37", - "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. - } - ], - "dns_name": "ip-10-1-0-37", - "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", - "mac_address": "fa:16:3e:f1:0b:09", - "name": "port_vm_50_3", - "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "status": "ACTIVE", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "6c9298ec8c874f7f99688489ab65f90e" , - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41" - } - ] - , - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?tenant_id=6c9298ec8c874f7f99688489ab65f90e&name=port_vm_50_3&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" - } - ] - } + { + "ports": [ + { + "admin_state_up": true, + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", + "device_owner": "compute:az3.dc1", + "port_secuirty_enabled":true, + "extra_dhcp_opts": [], + "fixed_ips": [ + { + "ip_address": "10.1.0.37", + "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5" + } + ], + "dns_assignment": [ + { + "hostname": "ip-10-1-0-37", + "ip_address": "10.1.0.37", + "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. + } + ], + "dns_name": "ip-10-1-0-37", + "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", + "mac_address": "fa:16:3e:f1:0b:09", + "name": "port_vm_50_3", + "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "status": "ACTIVE", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "6c9298ec8c874f7f99688489ab65f90e" , + "created_at": "2018-09-13T01: 43: 41", + "updated_at": "2018-09-13T01: 43: 41" + } + ] + , + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?tenant_id=6c9298ec8c874f7f99688489ab65f90e&name=port_vm_50_3&marker=7bb64706-6e46-4f94-a28a-4bc7caaab87d&page_reverse=True" + } + ] + } [Example 6] -- Example request +.. code-block:: - .. code-block:: text - - GET https://{Endpoint}/v2.0/ports?name=port_vm_50_3 - -- Example response - - .. code-block:: - - { - "ports": [ - { - "status": "DOWN", - "allowed_address_pairs": [], - "extra_dhcp_opts": [], - "device_owner": "", - "port_security_enabled":true, - "fixed_ips": [ - { - "subnet_id": "391c74f7-e3b1-405c-8473-2f71a0aec7dc", - "ip_address": "10.1.0.33" - } - ], - "dns_name": "", - "id": "0f405555-739f-4a19-abb7-ec11d005b3a9", - "security_groups": [ - "043548bc-1020-4be0-885a-caac8530e8f6" - ], - "device_id": "", - "port_security_enabled":true, - "name": "port_vm_50_3", - "admin_state_up": true, - "network_id": "9898a82d-7795-4ad5-bf2c-0ed8b822be4f", - "tenant_id": "3e4a1816927f405cacbc3dca1e05111e", - "project_id": "3e4a1816927f405cacbc3dca1e05111e", - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41", - "binding:vnic_type": "normal", - "mac_address": "fa:16:3e:b0:d9:cf" - }, - { - "status": "ACTIVE", - "allowed_address_pairs": [], - "extra_dhcp_opts": [], - "device_owner": "compute:az3.dc1", - "port_security_enabled":true, - "fixed_ips": [ - { - "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5", - "ip_address": "10.1.0.37" - } - ], - "dns_assignment": [ - { - "hostname": "ip-10-1-0-37", - "ip_address": "10.1.0.37", - "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. - } - ], - "dns_name": "ip-10-1-0-37", - "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", - "security_groups": [ - "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" - ], - "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", - "name": "port_vm_50_3", - "admin_state_up": true, - "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", - "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", - "project_id": "3e4a1816927f405cacbc3dca1e05111e", - "created_at": "2018-09-13T01: 43: 41", - "updated_at": "2018-09-13T01: 43: 41", - "binding:vnic_type": "normal", - "binding:vnic_type": "normal", - "mac_address": "fa:16:3e:f1:0b:09" - } - ] - , - "ports_links": [ - { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?name=port_vm_50_3&marker=0f405555-739f-4a19-abb7-ec11d005b3a9&page_reverse=True" - } - ] - } + { + "ports": [ + { + "status": "DOWN", + "allowed_address_pairs": [], + "extra_dhcp_opts": [], + "device_owner": "", + "port_security_enabled":true, + "fixed_ips": [ + { + "subnet_id": "391c74f7-e3b1-405c-8473-2f71a0aec7dc", + "ip_address": "10.1.0.33" + } + ], + "dns_name": "", + "id": "0f405555-739f-4a19-abb7-ec11d005b3a9", + "security_groups": [ + "043548bc-1020-4be0-885a-caac8530e8f6" + ], + "device_id": "", + "port_security_enabled":true, + "name": "port_vm_50_3", + "admin_state_up": true, + "network_id": "9898a82d-7795-4ad5-bf2c-0ed8b822be4f", + "tenant_id": "3e4a1816927f405cacbc3dca1e05111e", + "project_id": "3e4a1816927f405cacbc3dca1e05111e", + "created_at": "2018-09-13T01: 43: 41", + "updated_at": "2018-09-13T01: 43: 41", + "binding:vnic_type": "normal", + "mac_address": "fa:16:3e:b0:d9:cf" + }, + { + "status": "ACTIVE", + "allowed_address_pairs": [], + "extra_dhcp_opts": [], + "device_owner": "compute:az3.dc1", + "port_security_enabled":true, + "fixed_ips": [ + { + "subnet_id": "b3ac1347-63f2-4e82-b853-3d86416a0db5", + "ip_address": "10.1.0.37" + } + ], + "dns_assignment": [ + { + "hostname": "ip-10-1-0-37", + "ip_address": "10.1.0.37", + "fqdn": "ip-10-1-0-37.xxx.compute.internal."//xxx indicates the region name. + } + ], + "dns_name": "ip-10-1-0-37", + "id": "7bb64706-6e46-4f94-a28a-4bc7caaab87d", + "security_groups": [ + "ef69bc60-2f4b-4f97-b95b-e3b68df0c0b2" + ], + "device_id": "e6c05704-c907-4cc1-8106-69b0996c43b9", + "name": "port_vm_50_3", + "admin_state_up": true, + "network_id": "a54e1b19-ce78-4b7e-b28b-d2d716cdc161", + "tenant_id": "6c9298ec8c874f7f99688489ab65f90e", + "project_id": "3e4a1816927f405cacbc3dca1e05111e", + "created_at": "2018-09-13T01: 43: 41", + "updated_at": "2018-09-13T01: 43: 41", + "binding:vnic_type": "normal", + "binding:vnic_type": "normal", + "mac_address": "fa:16:3e:f1:0b:09" + } + ] + , + "ports_links": [ + { "rel": "previous", + "href": "https://{Endpoint}/v2.0/ports?name=port_vm_50_3&marker=0f405555-739f-4a19-abb7-ec11d005b3a9&page_reverse=True" + } + ] + } Status Code ----------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst index fac582c..0137b4a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst @@ -119,6 +119,19 @@ Request Message opt_value No String Specifies the option value. ========= ========= ====== =========================== +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/ports/7a9a954a-eb41-4954-a300-11ab17a361a2 + + { + "port": { + "name": "port-test02" + } + } + Response Message ---------------- @@ -308,22 +321,8 @@ Response Message | fqdn | String | Specifies the private network fully qualified domain name (FQDN) of the port. | +------------+--------+-------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/ports/7a9a954a-eb41-4954-a300-11ab17a361a2 - - { - "port": { - "name": "port-test02" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst index 70149a7..7e90990 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst @@ -37,6 +37,15 @@ Request Message | port_id | String | No | Specifies the port ID. Either **subnet_id** or **port_id** is used. Use the port IP address to create a router interface. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface + + {"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"} + Response Message ---------------- @@ -52,18 +61,8 @@ Response Message id String Specifies the router ID. ========== ====== ========================= -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface - - {"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"} - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst index 44cbdce..f2393cf 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst @@ -62,6 +62,19 @@ Request Message | | | | The default value is **false**. | +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + POST https://{Endpoint}/v2.0/routers + { + "router": { + "name": "router-test2", + "admin_state_up": true + } + } + Response Message ---------------- @@ -137,22 +150,8 @@ Response Message | nexthop | String | Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router. | +-------------+--------+-------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/routers - { - "router": { - "name": "router-test2", - "admin_state_up": true - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst index 45f2349..40a634c 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst @@ -20,6 +20,13 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/routers/01ab4be1-4447-45fb-94be-3ee787ed4ebe + Response Message ---------------- @@ -95,16 +102,8 @@ Response Message | nexthop | String | Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router. | +-------------+--------+-------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/routers/01ab4be1-4447-45fb-94be-3ee787ed4ebe - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst index d4aed7b..bc232e4 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst @@ -52,12 +52,12 @@ Example of querying routers by page | | | | | | | | | 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**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -67,20 +67,27 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/routers?limit=1 + Response Message ---------------- .. table:: **Table 2** Response parameter - +-----------------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================================+======================================================================================================================================================================================================================+ - | routers | Array of :ref:`router ` objects | Specifies the router list. For details, see :ref:`Table 3 `. | - +-----------------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routers_links | Array of :ref:`routers_link ` objects | Specifies the pagination information. For details, see :ref:`Table 6 `. | - | | | | - | | | 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**). | - +-----------------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+==========================================================================+=================================================================================================================================================================================================================+ + | routers | Array of :ref:`router ` objects | Specifies the router list. For details, see :ref:`Table 3 `. | + +-----------------------+--------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routers_links | Array of :ref:`routers_link ` objects | Specifies the pagination information. For details, see :ref:`Table 6 `. | + | | | | + | | | 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_router_0001__table24153696181443: @@ -160,16 +167,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +------+--------+----------------------------------------------------------------------+ -Example -------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/routers?limit=1 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst index 4433e4d..1ae6e2a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst @@ -34,6 +34,15 @@ Request Message | port_id | String | No | Specifies the port ID. Either **subnet_id** or **port_id** is used. Use the port IP address to create a router interface. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface + + {"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"} + Response Message ---------------- @@ -49,18 +58,8 @@ Response Message id String Specifies the router ID. ========== ====== ========================= -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface - - {"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"} - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst index a315e38..6977c45 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst @@ -82,6 +82,18 @@ Request Message | nexthop | No | String | Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router. | +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/routers/f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 + { + "router": { + "name": "router-220" + } + } + Response Message ---------------- @@ -159,21 +171,8 @@ Response Message | nexthop | String | Specifies the next hop IP address. The IP address can only be one in the subnet associated with the router. | +-------------+--------+-------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/routers/f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 - { - "router": { - "name": "router-220" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst index 1020289..af09dd7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst @@ -15,8 +15,8 @@ URI POST /v2.0/security-groups -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -38,6 +38,19 @@ Request Message | description | No | String | Provides supplementary information about the security group. | +-------------+-----------+--------+--------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + POST https://{Endpoint}/v2.0/security-groups + + { + "security_group": { + "name": "sg-test" + } + } + Response Message ---------------- @@ -130,22 +143,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/security-groups - - { - "security_group": { - "name": "sg-test" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst index adff74b..0cdd2dd 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst @@ -70,9 +70,25 @@ Request Message | | | | The value can be **IPv4** or **IPv6**. | +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 +--------------- + +.. code-block:: text + + POST https://{Endpoint}/v2.0/security-group-rules + + { + "security_group_rule": { + "security_group_id": "5cb9c1ee-00e0-4d0f-9623-55463cd26ff8", + "direction": "egress", + "protocol": "tcp", + "remote_ip_prefix": "10.10.0.0/24" + } + } + Response Message ---------------- @@ -135,25 +151,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/security-group-rules - - { - "security_group_rule": { - "security_group_id": "5cb9c1ee-00e0-4d0f-9623-55463cd26ff8", - "direction": "egress", - "protocol": "tcp", - "remote_ip_prefix": "10.10.0.0/24" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst index d6dbb88..df28b31 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst @@ -20,6 +20,13 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/security-groups/0431c9c5-1660-42e0-8a00-134bec7f03e2 + Response Message ---------------- @@ -112,16 +119,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/security-groups/0431c9c5-1660-42e0-8a00-134bec7f03e2 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst index e62904c..c669b47 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst @@ -20,6 +20,13 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/security-group-rules/1755bc80-cf3a-4f57-8ae9-d9796482ddc0 + Response Message ---------------- @@ -82,16 +89,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/security-group-rules/1755bc80-cf3a-4f57-8ae9-d9796482ddc0 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst index 4103876..1c9c393 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst @@ -62,12 +62,12 @@ Example of querying security group rules by page | | | | | | | | | 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,20 +77,27 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/security-group-rules + Response Message ---------------- .. table:: **Table 2** Response parameter - +----------------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============================+====================================================================================+======================================================================================================================================================================================================================+ - | security_group_rules | Array of :ref:`Security Group Rule ` objects | Specifies the security group rule list. For details, see :ref:`Table 3 `. | - +----------------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_rules_links | Array of :ref:`SecurityGroupRulesLink ` objects | Shows pagination information about security group rules. | - | | | | - | | | 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**). | - +----------------------------+------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +----------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============================+====================================================================================+=================================================================================================================================================================================================================+ + | security_group_rules | Array of :ref:`Security Group Rule ` objects | Specifies the security group rule list. For details, see :ref:`Table 3 `. | + +----------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_rules_links | Array of :ref:`SecurityGroupRulesLink ` objects | Shows pagination information about security group rules. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +----------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_sg02_0006__table655457801607: @@ -155,16 +162,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/security-group-rules - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst index dc6b9e5..fb50db7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst @@ -42,12 +42,12 @@ Example of querying security groups by page | | | | | | | | | 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**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -57,20 +57,27 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/security-groups?limit=1 + Response Message ---------------- .. table:: **Table 2** Response parameter - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================+======================================================================================================================================================================================================================+ - | security_groups | Array of :ref:`Security Group ` objects | Specifies the security group list. For details, see :ref:`Table 3 `. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups_links | Array of :ref:`SecurityGroupsLink ` objects | Shows pagination information about security groups. | - | | | | - | | | 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**). | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+================================================================================+=================================================================================================================================================================================================================+ + | security_groups | Array of :ref:`Security Group ` objects | Specifies the security group list. For details, see :ref:`Table 3 `. | + +-----------------------+--------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups_links | Array of :ref:`SecurityGroupsLink ` objects | Shows pagination information about security groups. | + | | | | + | | | 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_sg02_0001__table513726041607: @@ -165,16 +172,8 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/security-groups?limit=1 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst index 86fa75e..9303ff8 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst @@ -40,6 +40,19 @@ Request Message | description | No | String | Provides supplementary information about the security group. | +-------------+-----------+--------+--------------------------------------------------------------+ +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/security-groups/d29ae17d-f355-4992-8747-1fb66cc9afd2 + + { + "security_group": { + "name": "sg-test02" + } + } + Response Message ---------------- @@ -132,22 +145,8 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/security-groups/d29ae17d-f355-4992-8747-1fb66cc9afd2 - - { - "security_group": { - "name": "sg-test02" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst index 1ec9962..4b23184 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst @@ -15,8 +15,8 @@ URI POST /v2.0/subnets -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -43,15 +43,13 @@ Request Message +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cidr | Yes | String | Specifies the CIDR format. | | | | | | - | | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the subnet mask cannot be greater than 28. | + | | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | gateway_ip | No | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | | | | | | | | | | This attribute cannot be modified. | +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | - | | | | | - | | | | :ref:`Table 3 ` | + | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | | | | | | | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | | | | | | @@ -102,8 +100,24 @@ Request Message | nexthop | No | String | Specifies the next-hop IP address of a route. | +-------------+-----------+--------+-----------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + POST https://{Endpoint}/v2.0/subnets + + { + "subnet": { + "name": "subnet-test", + "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", + "cidr": "172.16.2.0/24", + "enable_dhcp": true + } + } + +Response Parameters +------------------- .. table:: **Table 5** Response parameter @@ -197,25 +211,8 @@ Response Message nexthop String Specifies the next-hop IP address of a route. =========== ====== ============================================= -Example: --------- - -Example request - -.. code-block:: text - - POST https://{Endpoint}/v2.0/subnets - - { - "subnet": { - "name": "subnet-test", - "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", - "cidr": "172.16.2.0/24", - "enable_dhcp": true - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst index 157cdc1..027160a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst @@ -20,6 +20,13 @@ Request Message None +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v2.0/subnets/011fc878-5521-4654-a1ad-f5b0b5820302 + Response Message ---------------- @@ -52,7 +59,7 @@ Response Message +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cidr | String | Specifies the CIDR format. | | | | | - | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the subnet mask cannot be greater than 28. | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | | | | | @@ -113,16 +120,8 @@ Response Message nexthop String Specifies the next-hop IP address of a route. =========== ====== ============================================= -Example: --------- - -Example request - -.. code-block:: text - - GET https://{Endpoint}/v2.0/subnets/011fc878-5521-4654-a1ad-f5b0b5820302 - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst index ca86bf9..def03ec 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst @@ -58,12 +58,12 @@ Example of querying networks by page | | | | | | | | | 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**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -73,20 +73,35 @@ Request Message None +Example Request +--------------- + +[Example 1] + +.. code-block:: text + + GET https://{Endpoint}/v2.0/subnets?limit=1 + +[Example 2] + +.. code-block:: text + + GET https://{Endpoint}/v2.0/subnets?id=011fc878-5521-4654-a1ad-f5b0b5820322 + Response Message ---------------- .. table:: **Table 2** Response parameter - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================+======================================================================================================================================================================================================================+ - | subnets | Array of :ref:`subnet ` objects | Specifies the subnet list. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnets_links | Array of :ref:`subnets_link ` objects | Specifies the pagination information. For details, see :ref:`Table 6 `. | - | | | | - | | | 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**). | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+===============================================================================+=================================================================================================================================================================================================================+ + | subnets | Array of :ref:`subnet ` objects | Specifies the subnet list. For details, see :ref:`Table 3 `. | + +-----------------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnets_links | Array of :ref:`subnets_link ` objects | Specifies the pagination information. For details, see :ref:`Table 6 `. | + | | | | + | | | 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_subnet02_0001__table176735992713: @@ -109,7 +124,7 @@ Response Message +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cidr | String | Specifies the CIDR format. | | | | | - | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the IPv4 mask cannot be greater than 28. | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | | | | | @@ -184,16 +199,10 @@ Response Message | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example -------- +Example Response +---------------- -Example request 1 - -.. code-block:: text - - GET https://{Endpoint}/v2.0/subnets?limit=1 - -Example response 1 +[Example 1] .. code-block:: @@ -232,13 +241,7 @@ Example response 1 ] } -Example request 2 - -.. code-block:: text - - GET https://{Endpoint}/v2.0/subnets?id=011fc878-5521-4654-a1ad-f5b0b5820322 - -Example response 2 +[Example 2] .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst index 31bdf25..0f7d997 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst @@ -19,8 +19,8 @@ URI PUT /v2.0/subnets/{subnet_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -90,8 +90,21 @@ Request Message | nexthop | No | String | Specifies the next-hop IP address of a route. | +-------------+-----------+--------+-----------------------------------------------+ -Response Message ----------------- +Example Request +--------------- + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/subnets/98bac90c-0ba7-4a63-8995-097da9bead1c + + { + "subnet": { + "name": "subnet-test" + } + } + +Response Parameters +------------------- .. table:: **Table 5** Response parameter @@ -122,7 +135,7 @@ Response Message +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cidr | String | Specifies the CIDR format. | | | | | - | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the subnet mask cannot be greater than 28. | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | | | | | @@ -187,22 +200,8 @@ Response Message nexthop String Specifies the next-hop IP address of a route. =========== ====== ============================================= -Example: --------- - -Example request - -.. code-block:: text - - PUT https://{Endpoint}/v2.0/subnets/98bac90c-0ba7-4a63-8995-097da9bead1c - - { - "subnet": { - "name": "subnet-test" - } - } - -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst index d160051..57b0fe5 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst @@ -37,15 +37,15 @@ Response Message .. table:: **Table 1** Response parameter - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+======================================================================================+======================================================================================================================================================================================================================+ - | subnetpools | Array of :ref:`subnetpool ` objects | Specifies the subnet pool list. For details, see :ref:`Table 2 `. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnetpools_links | Array of :ref:`SecuritypoolsLink ` objects | Shows pagination information about subnet pools. | - | | | | - | | | 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**). | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+======================================================================================+=================================================================================================================================================================================================================+ + | subnetpools | Array of :ref:`subnetpool ` objects | Specifies the subnet pool list. For details, see :ref:`Table 2 `. | + +-----------------------+--------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpools_links | Array of :ref:`SecuritypoolsLink ` objects | Shows pagination information about subnet pools. | + | | | | + | | | 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_subnetpools_0002__table149662441462: diff --git a/api-ref/source/permissions_policies_and_supported_actions/elastic_ip.rst b/api-ref/source/permissions_policies_and_supported_actions/eip.rst similarity index 98% rename from api-ref/source/permissions_policies_and_supported_actions/elastic_ip.rst rename to api-ref/source/permissions_policies_and_supported_actions/eip.rst index 759bf1f..df742e1 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/elastic_ip.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/eip.rst @@ -2,8 +2,8 @@ .. _vpc_permission_0002: -Elastic IP -========== +EIP +=== +-----------------+-------------------------------------------------+----------------------+ | Permission | API | Action | diff --git a/api-ref/source/permissions_policies_and_supported_actions/firewall_openstack_neutron_api.rst b/api-ref/source/permissions_policies_and_supported_actions/firewall_openstack_neutron_api.rst index 07d236e..7ea2dbe 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/firewall_openstack_neutron_api.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/firewall_openstack_neutron_api.rst @@ -42,5 +42,5 @@ Firewall (OpenStack Neutron API) +--------------------------------+--------------------------------------------------------------------+------------------------------------+ | Updates a firewall group. | PUT /v2.0/fwaas/firewall_groups/{firewall_group_id} | vpc:firewallGroups:update | +--------------------------------+--------------------------------------------------------------------+------------------------------------+ -| Deletes a firewall group. | DELETE /v2.0/fwaas/firewall_groups/{firewall_group_id} | vpc:firewallGroups:delete | +| Deletes a firewall group | DELETE /v2.0/fwaas/firewall_groups/{firewall_group_id} | vpc:firewallGroups:delete | +--------------------------------+--------------------------------------------------------------------+------------------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/index.rst b/api-ref/source/permissions_policies_and_supported_actions/index.rst index 6194ba3..4685334 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/index.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/index.rst @@ -7,7 +7,7 @@ Permissions Policies and Supported Actions - :ref:`VPC ` - :ref:`Subnet ` -- :ref:`Elastic IP ` +- :ref:`EIP ` - :ref:`Bandwidth ` - :ref:`Bandwidth (V2.0) ` - :ref:`VPC Peering Connection ` @@ -31,7 +31,7 @@ Permissions Policies and Supported Actions vpc subnet - elastic_ip + eip bandwidth bandwidth_v2.0 vpc_peering_connection