diff --git a/api-ref/source/api_v3/security_group/updating_a_security_group.rst b/api-ref/source/api_v3/security_group/updating_a_security_group.rst index 99790e9..835378a 100644 --- a/api-ref/source/api_v3/security_group/updating_a_security_group.rst +++ b/api-ref/source/api_v3/security_group/updating_a_security_group.rst @@ -238,8 +238,6 @@ OK "updated_at" : "2020-07-09T05:56:27Z", "ethertype" : "IPv6", "remote_ip_prefix" : null, - "port_range_max" : null, - "port_range_min" : null, "multiport" : null, "remote_address_group_id" : null, "action" : "allow", @@ -256,8 +254,6 @@ OK "updated_at" : "2020-07-09T05:56:27Z", "ethertype" : "IPv6", "remote_ip_prefix" : null, - "port_range_max" : null, - "port_range_min" : null, "multiport" : null, "remote_address_group_id" : null, "action" : "allow", @@ -274,8 +270,6 @@ OK "updated_at" : "2020-07-09T05:56:27Z", "ethertype" : "IPv4", "remote_ip_prefix" : null, - "port_range_max" : null, - "port_range_min" : null, "multiport" : null, "remote_address_group_id" : null, "action" : "allow", @@ -292,8 +286,6 @@ OK "updated_at" : "2020-07-09T05:56:27Z", "ethertype" : "IPv4", "remote_ip_prefix" : null, - "port_range_max" : null, - "port_range_min" : null, "multiport" : null, "remote_address_group_id" : null, "action" : "allow", diff --git a/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst b/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst index 072267a..ec84a46 100644 --- a/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst +++ b/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst @@ -218,8 +218,8 @@ Example Response ], "cloud_resources": [ { - "resrource_type": "routetable", - "resrource_count": 1 + "resource_type": "routetable", + "resource_count": 1 } ], "status": "ACTIVE", diff --git a/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst b/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst index ccbcabe..ea6bed9 100644 --- a/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst +++ b/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst @@ -209,8 +209,8 @@ Example Response ], "cloud_resources": [ { - "resrource_type": "routetable", - "resrource_count": 1 + "resource_type": "routetable", + "resource_count": 1 } ], "status": "ACTIVE", diff --git a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst index 5949a1a..bed8c5a 100644 --- a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst @@ -34,13 +34,7 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + None - Example request @@ -53,7 +47,7 @@ Response Message - Response parameter - .. table:: **Table 3** Response parameter + .. table:: **Table 2** Response parameter +-----------+-------------------------------------------------------------+---------------------------------+ | Name | Type | Description | @@ -63,7 +57,7 @@ Response Message .. _vpc_bandwidth_0001__table60972066: - .. table:: **Table 4** Description of the **bandwidth** field + .. table:: **Table 3** Description of the **bandwidth** field +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -81,7 +75,7 @@ Response Message | | | - **PER**: Dedicated bandwidth | | | | - **WHOLE**: Shared bandwidth | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_info | Array of :ref:`publicip_info ` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 5 `. | + | publicip_info | Array of :ref:`publicip_info ` objects | - Specifies information about the EIP that uses the bandwidth. For details, see :ref:`Table 4 `. | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -121,28 +115,28 @@ Response Message .. _vpc_bandwidth_0001__table30936422: - .. table:: **Table 5** **publicip_info** object + .. table:: **Table 4** **publicip_info** object - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | - Specifies the IP address version. | - | | | - Possible values are as follows: | - | | | | - | | | - **4**: IPv4 | - | | | - **6**: IPv6 (IPv6 is not supported currently.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===============================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - Specifies the IP address version. | + | | | - Possible values are as follows: | + | | | | + | | | - **4**: IPv4 | + | | | - **6**: IPv6 (IPv6 is not supported currently.) | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/bandwidth/querying_bandwidths.rst b/api-ref/source/apis/bandwidth/querying_bandwidths.rst index 472d53c..c8b9e0a 100644 --- a/api-ref/source/apis/bandwidth/querying_bandwidths.rst +++ b/api-ref/source/apis/bandwidth/querying_bandwidths.rst @@ -17,48 +17,40 @@ GET /v1/{project_id}/bandwidths :ref:`Table 1 ` describes the parameters. -.. _vpc_bandwidth_0002__table62833603: - -.. table:: **Table 1** Parameter description - - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=======================+=================+=================+=============================================================================================================================================================================================================================================================+ - | project_id | Yes | String | Specifies the project ID. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | - | | | | | - | | | | This parameter can work together with the parameter **limit**. | - | | | | | - | | | | - 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 (2^31-1). The default value is 2000. | - | | | | | - | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project. | - | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set **all_granted_eps**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Request Message --------------- - Request parameter - .. table:: **Table 2** Request header parameter + .. _vpc_bandwidth_0002__table62833603: - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 1** Request parameters + + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=======================+=================+=================+=============================================================================================================================================================================================================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | + | | | | | + | | | | This parameter can work together with the parameter **limit**. | + | | | | | + | | | | - 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 (2^31-1). The default value is 2000. | + | | | | | + | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project. | + | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set **all_granted_eps**. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This parameter is unsupported. Do not use it. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Example request @@ -71,17 +63,17 @@ Response Message - Response parameter - .. table:: **Table 3** Response parameter + .. table:: **Table 2** Response parameter +------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ | Name | Type | Description | +============+========================================================================+=======================================================================================================+ - | bandwidths | Array of :ref:`bandwidths ` objects | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | + | bandwidths | Array of :ref:`bandwidths ` objects | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | +------------+------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. _vpc_bandwidth_0002__table17227723: - .. table:: **Table 4** Description of the **bandwidths** field + .. table:: **Table 3** Description of the **bandwidths** field +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -101,7 +93,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 5 `. | + | publicip_info | Array of :ref:`publicip_info ` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 4 `. | +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -140,22 +132,22 @@ Response Message .. _vpc_bandwidth_0002__table30936422: - .. table:: **Table 5** **publicip_info** object + .. table:: **Table 4** **publicip_info** object - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===============================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst index d3f6389..c63298d 100644 --- a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst @@ -34,25 +34,17 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. table:: **Table 3** Request parameter + .. table:: **Table 2** Request parameter +-----------+-----------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +===========+===========+=============================================================+=======================================================================================================+ - | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | +-----------+-----------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. _vpc_bandwidth_0003__table31854691: - .. table:: **Table 4** Description of the **bandwidth** field + .. table:: **Table 3** Description of the **bandwidth** field +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -90,17 +82,17 @@ Response Message - Response parameter - .. table:: **Table 5** Response parameter + .. table:: **Table 4** 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 5 `. | +-----------+-------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. _vpc_bandwidth_0003__table17227723: - .. table:: **Table 6** Description of the **bandwidth** field + .. table:: **Table 5** Description of the **bandwidth** field +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -118,7 +110,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 7 `. | + | publicip_info | Array of :ref:`publicip_info ` objects | - Specifies the information about the EIP that uses the bandwidth. For details, see :ref:`Table 6 `. | +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -156,22 +148,22 @@ Response Message .. _vpc_bandwidth_0003__table30936422: - .. table:: **Table 7** **publicip_info** objects + .. table:: **Table 6** **publicip_info** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===============================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - Example response 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 5f88074..e46b0d3 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,49 +34,41 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. table:: **Table 3** Request parameter + .. table:: **Table 2** Request parameter +-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +===========+===========+==================================================================+============================================================================================================+ - | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | +-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. _vpc_sharebandwidth_0004__table31854691: - .. table:: **Table 4** Description of the **bandwidth** field + .. table:: **Table 3** Description of the **bandwidth** field +-----------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+================================================================================+================================================================================================================================================================================================+ - | publicip_info | Yes | Array of :ref:`publicip_info ` objects | - Specifies information about the EIP to be added to the shared bandwidth. For details, see :ref:`Table 5 `. | + | 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 `. | | | | | - 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 5** **publicip_info** object + .. table:: **Table 4** **publicip_info** object - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================+ - | publicip_id | Yes | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | No | String | - Specifies the EIP type. | - | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | | - Constraints: | - | | | | | - | | | | - The configured value must be supported by the system. | - | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+===============================================================================================================+ + | publicip_id | Yes | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_type | No | String | - Specifies the EIP type. | + | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | | - Constraints: | + | | | | | + | | | | - The configured value must be supported by the system. | + | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - Example request @@ -100,17 +92,17 @@ Response Message - Response parameter - .. table:: **Table 6** Response parameter + .. table:: **Table 5** Response parameter +-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | +===========+======================================================================+================================================================================================================+ - | bandwidth | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 7 `. | + | bandwidth | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 6 `. | +-----------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ .. _vpc_sharebandwidth_0004__table138718569112: - .. table:: **Table 7** Description of the **bandwidth** field + .. table:: **Table 6** Description of the **bandwidth** field +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -129,7 +121,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 8 `. | + | 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. | @@ -159,28 +151,28 @@ Response Message .. _vpc_sharebandwidth_0004__table51281965: - .. table:: **Table 8** **publicip_info** objects + .. table:: **Table 7** **publicip_info** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | - Specifies the IP address version. | - | | | - Possible values are as follows: | - | | | | - | | | - **4**: IPv4 | - | | | - **6**: IPv6 (IPv6 is not supported currently.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===============================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - Specifies the IP address version. | + | | | - Possible values are as follows: | + | | | | + | | | - **4**: IPv4 | + | | | - **6**: IPv6 (IPv6 is not supported currently.) | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - Example response 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 8e95ca4..3f0e566 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,25 +32,17 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. table:: **Table 3** Request parameter + .. table:: **Table 2** Request parameter +-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +===========+===========+==================================================================+============================================================================================================+ - | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | +-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. _vpc_sharebandwidth_0001__table11041789: - .. table:: **Table 4** Description of the **bandwidth** field + .. table:: **Table 3** Description of the **bandwidth** field +-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -94,17 +86,17 @@ Response Message - Response parameter - .. table:: **Table 5** Response parameter + .. table:: **Table 4** 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 5 `. | +-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. _vpc_sharebandwidth_0001__table60972066: - .. table:: **Table 6** Description of the **bandwidth** field + .. table:: **Table 5** Description of the **bandwidth** field +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -123,7 +115,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 6 `. | | | | - 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. | @@ -159,22 +151,22 @@ Response Message .. _vpc_sharebandwidth_0001__table30936422: - .. table:: **Table 7** **publicip_info** object + .. table:: **Table 6** **publicip_info** object - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated load balancer, shared load balancer). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===============================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - Example response 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 2e394bb..e0d337d 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,13 +36,7 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + None - Example request 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 e4e6eea..e611466 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,30 +34,22 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. table:: **Table 3** Request parameter + .. table:: **Table 2** Request parameter +-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +===========+===========+==================================================================+============================================================================================================+ - | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 4 `. | + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth objects. For details, see :ref:`Table 3 `. | +-----------+-----------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ .. _vpc_sharebandwidth_0005__table31854691: - .. table:: **Table 4** Description of the **bandwidth** field + .. table:: **Table 3** Description of the **bandwidth** field +-----------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+================================================================================+==================================================================================================================================================================================================================+ - | publicip_info | Yes | Array of :ref:`publicip_info ` objects | - Specifies information about the EIP to be removed from the bandwidth. For details, see :ref:`Table 5 `. | + | 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 `. | | | | | - The bandwidth, whose type is **WHOLE**, can be used by multiple EIPs. The number of EIPs varies depending on the tenant quota. By default, a shared bandwidth can be used by up to 20 EIPs. | +-----------------+-----------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | charge_mode | Yes | String | After an EIP is removed from a shared bandwidth, a dedicated bandwidth will be allocated to the EIP, and you will be billed for the dedicated bandwidth. | @@ -75,7 +67,7 @@ Request Message .. _vpc_sharebandwidth_0005__table30936422: - .. table:: **Table 5** **publicip_info** object + .. table:: **Table 4** **publicip_info** object +-------------+-----------+--------+------------------------------------------------------+ | Name | Mandatory | Type | Description | diff --git a/api-ref/source/apis/eip/assigning_an_eip.rst b/api-ref/source/apis/eip/assigning_an_eip.rst index b5bcf71..e842e3f 100644 --- a/api-ref/source/apis/eip/assigning_an_eip.rst +++ b/api-ref/source/apis/eip/assigning_an_eip.rst @@ -10,18 +10,19 @@ Function 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. +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, NAT gateways, or load balancers. .. 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 anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -45,22 +46,14 @@ POST /v1/{project_id}/publicips Request Parameters ------------------ -.. 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 body parameter +.. table:: **Table 2** Request body parameter +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=======================+=================+=================================================================+==================================================================================================================================================+ - | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 4 `. | + | 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 5 `. | + | 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. | @@ -73,22 +66,29 @@ Request Parameters .. _en-us_topic_0020090596__table4491214: -.. table:: **Table 4** Description of the **publicip** field +.. table:: **Table 3** Description of the **publicip** field - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | 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**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ + | 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**. | + | | | | - 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_version | No | Integer | - Specifies the EIP version. | + | | | | - The value can be **4** and **6**, indicating IPv4 address and IPv6 address, respectively. | + | | | | - Constraints: | + | | | | | + | | | | - The configured value must be supported by the system. | + | | | | - If this parameter is left blank or is an empty string, IPv4 address is created by default. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020090596__table11041789: -.. table:: **Table 5** Description of the **bandwidth** field +.. table:: **Table 4** Description of the **bandwidth** field +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -144,17 +144,17 @@ Response Message - Response parameter - .. table:: **Table 6** Response parameter + .. table:: **Table 5** Response parameter +----------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ | Name | Type | Description | +==========+================================================================+====================================================================================================+ - | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 7 `. | + | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 6 `. | +----------+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020090596__table44471219: - .. table:: **Table 7** Description of the **publicip** field + .. table:: **Table 6** Description of the **publicip** field +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -179,7 +179,7 @@ Response Message | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | 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). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/eip/querying_an_eip.rst b/api-ref/source/apis/eip/querying_an_eip.rst index c9443b6..2ca14df 100644 --- a/api-ref/source/apis/eip/querying_an_eip.rst +++ b/api-ref/source/apis/eip/querying_an_eip.rst @@ -14,12 +14,13 @@ This API is used to query a specific EIP. Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (5_gray) type cannot be created anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -46,13 +47,7 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + None - Example request @@ -65,17 +60,17 @@ Response Message - Response parameter - .. table:: **Table 3** Response parameter + .. table:: **Table 2** Response parameter +----------+-----------------------------------------------------+-----------------------------------------------------------------------------------------+ | Name | Type | Description | +==========+=====================================================+=========================================================================================+ - | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 4 `. | + | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | +----------+-----------------------------------------------------+-----------------------------------------------------------------------------------------+ .. _vpc_eip_0002__table3035698: - .. table:: **Table 4** Description of the **publicip** field + .. table:: **Table 3** Description of the **publicip** field +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -99,10 +94,10 @@ Response Message | | | - **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 5 `. | + | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 `. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | @@ -156,7 +151,7 @@ Response Message .. _vpc_eip_0002__table66651219193417: - .. table:: **Table 5** Description of the **profile** field + .. table:: **Table 4** Description of the **profile** field ========== ====== ========================= Name Type Description diff --git a/api-ref/source/apis/eip/querying_eips.rst b/api-ref/source/apis/eip/querying_eips.rst index 6856db0..94bc6f9 100644 --- a/api-ref/source/apis/eip/querying_eips.rst +++ b/api-ref/source/apis/eip/querying_eips.rst @@ -14,12 +14,13 @@ This API is used to query EIPs. 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 anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -65,13 +66,7 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + None - Example request @@ -84,17 +79,17 @@ Response Message - Response parameter - .. table:: **Table 3** Response parameter + .. table:: **Table 2** Response parameter +-----------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ | Name | Type | Description | +===========+====================================================================+=============================================================================================+ - | publicips | Array of :ref:`publicips ` objects | Specifies the EIP object. For details, see :ref:`Table 4 `. | + | publicips | Array of :ref:`publicips ` objects | Specifies the EIP object. For details, see :ref:`Table 3 `. | +-----------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ .. _vpc_eip_0003__table83964341880: - .. table:: **Table 4** Description of the **publicips** field + .. table:: **Table 3** Description of the **publicips** field +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -115,10 +110,10 @@ 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 5 `. | + | profile | Object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 `. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | 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). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | @@ -172,7 +167,7 @@ Response Message .. _vpc_eip_0003__table66651219193417: - .. table:: **Table 5** Description of the **profile** field + .. table:: **Table 4** 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 index 75c8867..6553e6e 100644 --- a/api-ref/source/apis/eip/releasing_an_eip.rst +++ b/api-ref/source/apis/eip/releasing_an_eip.rst @@ -14,12 +14,13 @@ This API is used to release an EIP. Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (5_gray) type cannot be created anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -46,13 +47,7 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + None - Example request diff --git a/api-ref/source/apis/eip/updating_an_eip.rst b/api-ref/source/apis/eip/updating_an_eip.rst index 7605db5..6f667ce 100644 --- a/api-ref/source/apis/eip/updating_an_eip.rst +++ b/api-ref/source/apis/eip/updating_an_eip.rst @@ -14,12 +14,13 @@ This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC. 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 anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -46,25 +47,17 @@ Request Message - Request parameter - .. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. table:: **Table 3** Request parameter + .. table:: **Table 2** Request parameter +----------+-----------+------------------------------------------------------+------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +==========+===========+======================================================+==========================================================================================+ - | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 4 `. | + | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | +----------+-----------+------------------------------------------------------+------------------------------------------------------------------------------------------+ .. _vpc_eip_0004__table23403840: - .. table:: **Table 4** Description of the **publicip** field + .. table:: **Table 3** Description of the **publicip** field +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -93,17 +86,17 @@ Response Message - Response parameter - .. table:: **Table 5** Response parameter + .. table:: **Table 4** 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 5 `. | +----------+---------------------------------------------------------+---------------------------------------------------------------------------------------------+ .. _vpc_eip_0004__table83964341880: - .. table:: **Table 6** Description of the **publicips** field + .. table:: **Table 5** Description of the **publicips** field +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | @@ -127,10 +120,10 @@ Response Message | | | - **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 7 `. | + | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 6 `. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | 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). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | @@ -182,7 +175,7 @@ Response Message .. _vpc_eip_0004__table66651219193417: - .. table:: **Table 7** Description of the **profile** field + .. table:: **Table 6** Description of the **profile** field ========== ====== ========================= Name Type 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 6727d85..26ae52c 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 @@ -15,9 +15,7 @@ URI DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key} -:ref:`Table 1 ` describes the parameters. - -.. _eip_tag_0003__table27380479: +:ref:`Table 3 ` describes the parameters. .. table:: **Table 1** Parameter description @@ -42,6 +40,18 @@ Request Message | 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. | +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _eip_tag_0003__table27380479: + + .. table:: **Table 3** Request parameters + + =========== ========= ========================================== + Name Mandatory Description + =========== ========= ========================================== + project_id Yes Specifies the project ID. + publicip_id Yes Specifies the unique identifier of an EIP. + key Yes Specifies the tag key. + =========== ========= ========================================== + - Example request .. code-block:: text 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 bfcef7b..4595ee3 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 @@ -15,9 +15,7 @@ URI GET /v2.0/{project_id}/publicips/{publicip_id}/tags -:ref:`Table 1 ` describes the parameters. - -.. _eip_tag_0002__table27380479: +:ref:`Table 3 ` describes the parameters. .. table:: **Table 1** Parameter description @@ -41,6 +39,17 @@ Request Message | 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. | +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + .. _eip_tag_0002__table27380479: + + .. table:: **Table 3** Request parameters + + =========== ========= ========================================== + Name Mandatory Description + =========== ========= ========================================== + project_id Yes Specifies the project ID. + publicip_id Yes Specifies the unique identifier of an EIP. + =========== ========= ========================================== + - Example request .. code-block:: text @@ -52,17 +61,17 @@ Response Message - Response parameter - .. table:: **Table 3** Response parameter + .. table:: **Table 4** Response parameter +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +===========+=================================================================+=========================================================================================================+ - | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 4 `. | + | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 5 `. | +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ .. _eip_tag_0002__table13242848193719: - .. table:: **Table 4** **tag** objects + .. table:: **Table 5** **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 2d9d485..251c126 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 @@ -40,6 +40,14 @@ Request Message | 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 Mandatory Description + ========== ========= =========== + project_id Yes Project ID. + ========== ========= =========== + - Example request .. code-block:: text @@ -51,17 +59,17 @@ Response Message - Response parameter - .. table:: **Table 3** Response parameter + .. table:: **Table 4** Response parameter +-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +===========+===============================================================+=======================================================================================================+ - | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 4 `. | + | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 5 `. | +-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. _eip_tag_0006__table043062842515: - .. table:: **Table 4** Description of the **tag** field + .. table:: **Table 5** Description of the **tag** field +-----------------------+-----------------------+---------------------------------------------------------------------+ | Name | Type | Description | 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 e1061a8..79b23a3 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.az-2.abc.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True", + "href": "https://vpc.region.otctest.t-systems.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True", "rel": "previous" } ] diff --git a/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst b/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst index 6a2074c..9033f88 100644 --- a/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst +++ b/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst @@ -91,29 +91,47 @@ Response Message .. table:: **Table 5** Description of the **privateip** field - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+========================================================================================================================================================================================================================================================================================================+ - | status | String | - Specifies the status of the private IP address. | - | | | - Possible values are as follows: | - | | | | - | | | - **ACTIVE** | - | | | - **DOWN** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | - | | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | - The value range specifies only the type of private IP addresses supported by the current service. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | String | Specifies the assigned private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================+ + | status | String | - Specifies the status of the private IP address. | + | | | - Possible values are as follows: | + | | | | + | | | - **ACTIVE** | + | | | - **DOWN** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | + | | | | + | | | - The value can be: | + | | | | + | | | **network:dhcp**: DHCP service IP address | + | | | | + | | | **network:router_interface_distributed**: Gateway IP address | + | | | | + | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | + | | | | + | | | **neutron:VIP_PORT**: Virtual IP address | + | | | | + | | | **compute:subeni**: IP address of a supplementary network interface | + | | | | + | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | + | | | | + | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | + | | | | + | | | **network:endpoint_interface**: IP address of a VPC endpoint | + | | | | + | | | - The value range specifies only the type of private IP addresses supported by the current service. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | String | Specifies the assigned private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst b/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst index ca3c05c..3315a4e 100644 --- a/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst +++ b/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst @@ -59,29 +59,47 @@ Response .. table:: **Table 3** Description of the **privateip** field - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+========================================================================================================================================================================================================================================================================================================+ - | status | String | - Specifies the status of the private IP address. | - | | | - Possible values are as follows: | - | | | | - | | | - **ACTIVE** | - | | | - **DOWN** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | - | | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | - The value range specifies only the type of private IP addresses supported by the current service. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | String | Specifies the assigned private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================+ + | status | String | - Specifies the status of the private IP address. | + | | | - Possible values are as follows: | + | | | | + | | | - **ACTIVE** | + | | | - **DOWN** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | + | | | | + | | | - The value can be: | + | | | | + | | | **network:dhcp**: DHCP service IP address | + | | | | + | | | **network:router_interface_distributed**: Gateway IP address | + | | | | + | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | + | | | | + | | | **neutron:VIP_PORT**: Virtual IP address | + | | | | + | | | **compute:subeni**: IP address of a supplementary network interface | + | | | | + | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | + | | | | + | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | + | | | | + | | | **network:endpoint_interface**: IP address of a VPC endpoint | + | | | | + | | | - The value range specifies only the type of private IP addresses supported by the current service. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | String | Specifies the assigned private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Example response 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 9ba0de8..5a0a795 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 @@ -80,29 +80,47 @@ Response Message .. table:: **Table 3** Description of the **privateip** field - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+========================================================================================================================================================================================================================================================================================================+ - | status | String | - Specifies the status of the private IP address. | - | | | - Possible values are as follows: | - | | | | - | | | - **ACTIVE** | - | | | - **DOWN** | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | - | | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, or **neutron:VIP_PORT**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | - The value range specifies only the type of private IP addresses supported by the current service. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | String | Specifies the assigned private IP address. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================+ + | status | String | - Specifies the status of the private IP address. | + | | | - Possible values are as follows: | + | | | | + | | | - **ACTIVE** | + | | | - **DOWN** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | + | | | | + | | | - The value can be: | + | | | | + | | | **network:dhcp**: DHCP service IP address | + | | | | + | | | **network:router_interface_distributed**: Gateway IP address | + | | | | + | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | + | | | | + | | | **neutron:VIP_PORT**: Virtual IP address | + | | | | + | | | **compute:subeni**: IP address of a supplementary network interface | + | | | | + | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | + | | | | + | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | + | | | | + | | | **network:endpoint_interface**: IP address of a VPC endpoint | + | | | | + | | | - The value range specifies only the type of private IP addresses supported by the current service. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | String | Specifies the assigned private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/security_group/creating_a_security_group.rst b/api-ref/source/apis/security_group/creating_a_security_group.rst index ed0893b..00cfa59 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group.rst @@ -54,7 +54,9 @@ Request Message | | | | | | | | | .. note:: | | | | | | - | | | | This parameter has been discarded, it is not recommended to use it. | + | | | | This parameter has been discarded. Do not use it. | + | | | | | + | | | | Currently, this parameter is used only as a prompt. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | @@ -108,7 +110,9 @@ Response Message | | | | | | | .. note:: | | | | | - | | | This parameter has been discarded, it is not recommended to use it. | + | | | This parameter has been discarded. Do not use it. | + | | | | + | | | Currently, this parameter is used only as a prompt. | +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 639ed3a..d12c813 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 @@ -73,6 +73,8 @@ Response Message | | | .. note:: | | | | | | | | This parameter has been discarded. Do not use it. | + | | | | + | | | Currently, this parameter is used only as a prompt. | +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 6ef3a46..8afff24 100644 --- a/api-ref/source/apis/security_group/querying_security_groups.rst +++ b/api-ref/source/apis/security_group/querying_security_groups.rst @@ -102,6 +102,8 @@ Response Message | | | .. note:: | | | | | | | | This parameter has been discarded. Do not use it. | + | | | | + | | | Currently, this parameter is used only as a prompt. | +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/subnet/creating_a_subnet.rst b/api-ref/source/apis/subnet/creating_a_subnet.rst index 64003a8..ef71175 100644 --- a/api-ref/source/apis/subnet/creating_a_subnet.rst +++ b/api-ref/source/apis/subnet/creating_a_subnet.rst @@ -120,13 +120,13 @@ Request Message "114.xx.xx.114", "114.xx.xx.115" ], - "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc. + "availability_zone": "aa-bb-cc", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" - } + }, { "opt_value": "24h", "opt_name": "addresstime" @@ -247,14 +247,14 @@ 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": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" - } + }, { "opt_value": "24h", "opt_name": "addresstime" diff --git a/api-ref/source/apis/subnet/querying_subnet_details.rst b/api-ref/source/apis/subnet/querying_subnet_details.rst index 8eae849..2f2f9d8 100644 --- a/api-ref/source/apis/subnet/querying_subnet_details.rst +++ b/api-ref/source/apis/subnet/querying_subnet_details.rst @@ -148,7 +148,7 @@ Response Message { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" - } + }, { "opt_value": "24h", "opt_name": "addresstime" diff --git a/api-ref/source/apis/subnet/querying_subnets.rst b/api-ref/source/apis/subnet/querying_subnets.rst index ffb6503..8c962ba 100644 --- a/api-ref/source/apis/subnet/querying_subnets.rst +++ b/api-ref/source/apis/subnet/querying_subnets.rst @@ -157,14 +157,14 @@ 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": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" - } + }, { "opt_value": "24h", "opt_name": "addresstime" @@ -186,7 +186,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": "531dec0f-3116-411b-a21b-e612e42349fd", "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", "extra_dhcp_opts": [ diff --git a/api-ref/source/apis/subnet/updating_subnet_information.rst b/api-ref/source/apis/subnet/updating_subnet_information.rst index c99f209..7dd7a79 100644 --- a/api-ref/source/apis/subnet/updating_subnet_information.rst +++ b/api-ref/source/apis/subnet/updating_subnet_information.rst @@ -111,7 +111,7 @@ Request Message { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" - } + }, { "opt_value": "24h", "opt_name": "addresstime" diff --git a/api-ref/source/appendix/status_codes.rst b/api-ref/source/appendix/status_codes.rst index b67c9d1..9e2c193 100644 --- a/api-ref/source/appendix/status_codes.rst +++ b/api-ref/source/appendix/status_codes.rst @@ -7,15 +7,15 @@ Status Codes .. table:: **Table 1** Normal values - +----------------------+------------+-----------------------------------------------------------------------------------------+ - | Normal Response Code | Type | Description | - +======================+============+=========================================================================================+ - | 200 | OK | Specifies the normal response code for the GET, PUT, and POST operations. | - +----------------------+------------+-----------------------------------------------------------------------------------------+ - | 201 | Created | Specifies the normal response code for the POST operation of the OpenStack Neutron API. | - +----------------------+------------+-----------------------------------------------------------------------------------------+ - | 204 | No Content | Specifies the normal response code for the DELETE operation. | - +----------------------+------------+-----------------------------------------------------------------------------------------+ + +----------------------+------------+----------------------------------------------------------------------------------------------------+ + | Normal Response Code | Type | Description | + +======================+============+====================================================================================================+ + | 200 | OK | Specifies the normal response code for the GET, PUT, and POST operations. | + +----------------------+------------+----------------------------------------------------------------------------------------------------+ + | 201 | Created | Specifies the normal response code for the POST operation of the OpenStack Neutron API and API V3. | + +----------------------+------------+----------------------------------------------------------------------------------------------------+ + | 204 | No Content | Specifies the normal response code for the DELETE operation. | + +----------------------+------------+----------------------------------------------------------------------------------------------------+ .. table:: **Table 2** Abnormal values diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 5d80272..8f1508f 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,12 @@ Change History +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2023-05-15 | This release incorporates the following changes: | +| | | +| | Modified the following content: | +| | | +| | Modified description of **shared** and **provider:network_type** in :ref:`Network `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-4-7 | This release incorporates the following changes: | | | | | | Added the following sections: | diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index be574f4..c86fa49 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -18,7 +18,7 @@ import os import sys extensions = [ - 'otcdocstheme', + 'otcdocstheme' ] otcdocs_auto_name = False 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 c1b7f75..39bbb3b 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 @@ -97,39 +97,39 @@ Response Message .. table:: **Table 4** **Firewall Group** objects - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | Attribute | Type | Description | - +============================+=======================+===========================================================================+ - | id | String | Specifies the UUID of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | name | String | Specifies the name of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ports | Array of strings | Specifies the list of ports bound with the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | public | Boolean | Specifies whether the firewall policy can be shared by different tenants. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | status | String | Specifies the status of the firewall policy. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status of the firewall. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the resource is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the resource is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | Attribute | Type | Description | + +============================+=======================+==========================================================================+ + | id | String | Specifies the UUID of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | name | String | Specifies the name of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ports | Array of strings | Specifies the list of ports bound with the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | public | Boolean | Specifies whether the firewall group can be shared by different tenants. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | status | String | Specifies the status of the firewall policy. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status of the firewall. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the resource is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the resource is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ Example Response ---------------- 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 20698e3..cc81f65 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 @@ -54,39 +54,39 @@ Response Message .. table:: **Table 3** **Firewall Group** objects - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | Attribute | Type | Description | - +============================+=======================+===========================================================================+ - | id | String | Specifies the UUID of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | name | String | Specifies the name of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ports | Array of strings | Specifies the list of ports bound with the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | public | Boolean | Specifies whether the firewall policy can be shared by different tenants. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | status | String | Specifies the status of the firewall policy. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status of the firewall. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the resource is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the resource is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | Attribute | Type | Description | + +============================+=======================+==========================================================================+ + | id | String | Specifies the UUID of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | name | String | Specifies the name of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ports | Array of strings | Specifies the list of ports bound with the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | public | Boolean | Specifies whether the firewall group can be shared by different tenants. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | status | String | Specifies the status of the firewall policy. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status of the firewall. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the resource is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the resource is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ Example Response ---------------- 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 40a06f3..5b1995b 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 @@ -87,39 +87,39 @@ Response Message .. table:: **Table 3** **Firewall Group** objects - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | Attribute | Type | Description | - +============================+=======================+===========================================================================+ - | id | String | Specifies the UUID of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | name | String | Specifies the name of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ports | Array of strings | Specifies the list of ports bound with the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | public | Boolean | Specifies whether the firewall policy can be shared by different tenants. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | status | String | Specifies the status of the firewall policy. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status of the firewall. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the resource is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the resource is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | Attribute | Type | Description | + +============================+=======================+==========================================================================+ + | id | String | Specifies the UUID of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | name | String | Specifies the name of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ports | Array of strings | Specifies the list of ports bound with the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | public | Boolean | Specifies whether the firewall group can be shared by different tenants. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | status | String | Specifies the status of the firewall policy. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status of the firewall. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the resource is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the resource is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ .. _vpc_firewall_0013__table25150247450: 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 c393f49..f0b204d 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 @@ -94,39 +94,39 @@ Response Message .. table:: **Table 4** **Firewall Group** objects - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | Attribute | Type | Description | - +============================+=======================+===========================================================================+ - | id | String | Specifies the UUID of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | name | String | Specifies the name of the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | ports | Array of strings | Specifies the list of ports bound with the firewall group. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | public | Boolean | Specifies whether the firewall policy can be shared by different tenants. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | status | String | Specifies the status of the firewall policy. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status of the firewall. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the resource is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the resource is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +----------------------------+-----------------------+---------------------------------------------------------------------------+ + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | Attribute | Type | Description | + +============================+=======================+==========================================================================+ + | id | String | Specifies the UUID of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | name | String | Specifies the name of the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ingress_firewall_policy_id | String | Specifies the firewall policy for inbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | egress_firewall_policy_id | String | Specifies the firewall policy for outbound traffic. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | ports | Array of strings | Specifies the list of ports bound with the firewall group. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | public | Boolean | Specifies whether the firewall group can be shared by different tenants. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | status | String | Specifies the status of the firewall policy. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status of the firewall. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the resource is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the resource is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +----------------------------+-----------------------+--------------------------------------------------------------------------+ Example Response ---------------- 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 deb3f6b..b07c570 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 @@ -16,12 +16,13 @@ You can use **GET /v2.0/networks?router:external=True** or run the **neutron net 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 anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -33,25 +34,17 @@ POST /v2.0/floatingips Request Message --------------- -.. 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 +.. table:: **Table 1** 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 2 `. | +------------+---------------------------------------------------------------------+-----------+---------------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0003__table15863423175513: -.. table:: **Table 3** **floatingip** objects +.. table:: **Table 2** **floatingip** objects +---------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -76,17 +69,17 @@ Request Message Response Message ---------------- -.. table:: **Table 4** Response parameter +.. table:: **Table 3** 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 4 `. | +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0003__table8139247714: -.. table:: **Table 5** **floatingip** objects +.. table:: **Table 4** **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 5df573c..981aa30 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 @@ -14,12 +14,13 @@ This API is used to delete a floating IP address. 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 anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -43,13 +44,7 @@ DELETE /v2.0/floatingips/{floatingip_id} Request Message --------------- -.. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +None 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 dcc3899..3f8c9cf 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 @@ -14,12 +14,13 @@ This API is used to query details about a specified floating IP address, includi 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 anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -31,28 +32,22 @@ GET /v2.0/floatingips/{floatingip_id} Request Message --------------- -.. 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. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +None Response Message ---------------- -.. table:: **Table 2** Response parameter +.. table:: **Table 1** Response parameter +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +============+=================================================================+=================================================================================================================+ - | floatingip | :ref:`floatingip ` object | Specifies the floating IP address list. For details, see :ref:`Table 3 `. | + | floatingip | :ref:`floatingip ` object | Specifies the floating IP address list. For details, see :ref:`Table 2 `. | +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0002__table8139247714: -.. table:: **Table 3** **floatingip** objects +.. table:: **Table 2** **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 daf181f..c07a355 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 @@ -16,12 +16,13 @@ You can query the detailed information about a specified floating IP address usi 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 anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -84,28 +85,22 @@ Example: Request Message --------------- -.. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +None Response Message ---------------- -.. table:: **Table 3** Response parameter +.. table:: **Table 2** Response parameter +-------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=============+===========================================================================+=================================================================================================================+ - | floatingips | Array of :ref:`floatingip ` objects | Specifies the floating IP address list. For details, see :ref:`Table 4 `. | + | floatingips | Array of :ref:`floatingip ` objects | Specifies the floating IP address list. For details, see :ref:`Table 3 `. | +-------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0001__table8139247714: -.. table:: **Table 4** **floatingip** objects +.. table:: **Table 3** **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 9f12284..e5f8151 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,12 +21,13 @@ If **port_id** is left blank, the floating IP address has been unbound from the - If a floating IP address that you are binding is 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 anymore. + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. - - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see "Binding an EIP" and "Unbinding an EIP" in "API V3" section in the *Elastic IP API Reference*. + - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. + - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. @@ -52,25 +53,17 @@ PUT /v2.0/floatingips/{floatingip_id} Request Message --------------- -.. table:: **Table 2** Request header parameter - - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+========================================================================================================================================================================================+ - | X-Auth-Token | Yes | String | Specifies the user token. The token can be obtained by calling the IAM API used for obtaining a user token. The value of **X-Subject-Token** in the response header is the user token. | - +--------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** Request parameter +.. table:: **Table 2** Request parameter +------------+-------------------------------------------------------------------+-----------+-------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Mandatory | Description | +============+===================================================================+===========+===================================================================================================================+ - | floatingip | :ref:`floatingip ` object | Yes | Specifies the floating IP address list. For details, see :ref:`Table 4 `. | + | floatingip | :ref:`floatingip ` object | Yes | Specifies the floating IP address list. For details, see :ref:`Table 3 `. | +------------+-------------------------------------------------------------------+-----------+-------------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0004__table547993685510: -.. table:: **Table 4** **floatingip** objects +.. table:: **Table 3** **floatingip** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | @@ -83,17 +76,17 @@ Request Message Response Message ---------------- -.. table:: **Table 5** 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 6 `. | + | floatingip | :ref:`floatingip ` object | Specifies the floating IP address list. For details, see :ref:`Table 5 `. | +------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------+ .. _vpc_floatingip_0004__table8139247714: -.. table:: **Table 6** **floatingip** objects +.. table:: **Table 5** **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 368b6b2..ed55fbb 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 @@ -45,7 +45,7 @@ Request Message +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 **vxlan**. | + | | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -101,7 +101,7 @@ Response Message +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | + | shared | Boolean | Specifies whether the network can be shared by different tenants. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | id | String | Specifies the network ID. | | | | | @@ -109,7 +109,7 @@ Response Message +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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**. | + | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 481b465..affd0f4 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 @@ -75,7 +75,7 @@ Response Message +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | + | shared | Boolean | Specifies whether the network can be shared by different tenants. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | id | String | Specifies the network ID. | | | | | @@ -83,7 +83,7 @@ Response Message +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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**. | + | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 7a80a9d..9a42709 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 @@ -126,7 +126,7 @@ Response Message +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | + | shared | Boolean | Specifies whether the network can be shared by different tenants. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | id | String | Specifies the network ID. | | | | | @@ -134,7 +134,7 @@ Response Message +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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**. | + | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 19fcdf5..db72990 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 @@ -107,7 +107,7 @@ Response Message +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Specifies the project ID. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | Boolean | Specifies whether the firewall rule can be shared by different tenants. | + | shared | Boolean | Specifies whether the network can be shared by different tenants. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | id | String | Specifies the network ID. | | | | | @@ -115,7 +115,7 @@ Response Message +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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**. | + | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 a18221b..d9fdc4f 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 @@ -549,8 +549,7 @@ Example Response "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" @@ -629,8 +628,7 @@ Example Response "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" diff --git a/api-ref/source/permissions_policies_and_supported_actions/bandwidth.rst b/api-ref/source/permissions_policies_and_supported_actions/bandwidth.rst index 9457163..08161ac 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/bandwidth.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/bandwidth.rst @@ -5,12 +5,12 @@ Bandwidth ========= -+----------------------+------------------------------------------------+-----------------------+ -| Permission | API | Action | -+======================+================================================+=======================+ -| Queries a bandwidth. | GET /v1/{project_id}/bandwidths/{bandwidth_id} | vpc:bandwidths:get | -+----------------------+------------------------------------------------+-----------------------+ -| Queries bandwidths. | GET /v1/{project_id}/bandwidths | vpc:bandwidths:list | -+----------------------+------------------------------------------------+-----------------------+ -| Updates a bandwidth. | PUT /v1/{project_id}/bandwidths/{bandwidth_id} | vpc:bandwidths:update | -+----------------------+------------------------------------------------+-----------------------+ ++----------------------+------------------------------------------------+-----------------------+-----------------------+ +| Permission | API | Action | Supported Action | ++======================+================================================+=======================+=======================+ +| Queries a bandwidth. | GET /v1/{project_id}/bandwidths/{bandwidth_id} | vpc:bandwidths:get | eip:bandwidths:get | ++----------------------+------------------------------------------------+-----------------------+-----------------------+ +| Queries bandwidths. | GET /v1/{project_id}/bandwidths | vpc:bandwidths:list | eip:bandwidths:list | ++----------------------+------------------------------------------------+-----------------------+-----------------------+ +| Updates a bandwidth. | PUT /v1/{project_id}/bandwidths/{bandwidth_id} | vpc:bandwidths:update | eip:bandwidths:update | ++----------------------+------------------------------------------------+-----------------------+-----------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/bandwidth_v2.0.rst b/api-ref/source/permissions_policies_and_supported_actions/bandwidth_v2.0.rst index 25a93b6..e5d1c36 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/bandwidth_v2.0.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/bandwidth_v2.0.rst @@ -5,14 +5,14 @@ Bandwidth (V2.0) ================ -+-----------------------------------------+----------------------------------------------------------+-----------------------+ -| Permission | API | Action | -+=========================================+==========================================================+=======================+ -| Allocates a shared bandwidth. | POST /v2.0/{project_id}/bandwidths | vpc:bandwidths:create | -+-----------------------------------------+----------------------------------------------------------+-----------------------+ -| Deletes a shared bandwidth. | DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id} | vpc:bandwidths:delete | -+-----------------------------------------+----------------------------------------------------------+-----------------------+ -| Adds an EIP to a shared bandwidth. | POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert | vpc:publicIps:insert | -+-----------------------------------------+----------------------------------------------------------+-----------------------+ -| Removes an EIP from a shared bandwidth. | POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/remove | vpc:publicIps:remove | -+-----------------------------------------+----------------------------------------------------------+-----------------------+ ++-----------------------------------------+----------------------------------------------------------+-----------------------+--------------------------------+ +| Permission | API | Action | Supported Action | ++=========================================+==========================================================+=======================+================================+ +| Allocates a shared bandwidth. | POST /v2.0/{project_id}/bandwidths | vpc:bandwidths:create | eip:bandwidths:create | ++-----------------------------------------+----------------------------------------------------------+-----------------------+--------------------------------+ +| Deletes a shared bandwidth. | DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id} | vpc:bandwidths:delete | eip:bandwidths:delete | ++-----------------------------------------+----------------------------------------------------------+-----------------------+--------------------------------+ +| Adds an EIP to a shared bandwidth. | POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/insert | vpc:publicIps:insert | eip:bandwidths:insertPublicIps | ++-----------------------------------------+----------------------------------------------------------+-----------------------+--------------------------------+ +| Removes an EIP from a shared bandwidth. | POST /v2.0/{project_id}/bandwidths/{bandwidth_id}/remove | vpc:publicIps:remove | eip:bandwidths:removePublicIps | ++-----------------------------------------+----------------------------------------------------------+-----------------------+--------------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/eip.rst b/api-ref/source/permissions_policies_and_supported_actions/eip.rst index df742e1..c4e26d3 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/eip.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/eip.rst @@ -5,16 +5,16 @@ EIP === -+-----------------+-------------------------------------------------+----------------------+ -| Permission | API | Action | -+=================+=================================================+======================+ -| Assigns an EIP. | POST /v1/{project_id}/publicips | vpc:publicIps:create | -+-----------------+-------------------------------------------------+----------------------+ -| Queries an EIP. | GET /v1/{project_id}/publicips/{publicip_id} | vpc:publicIps:get | -+-----------------+-------------------------------------------------+----------------------+ -| Queries EIPs. | GET /v1/{project_id}/publicips | vpc:publicIps:list | -+-----------------+-------------------------------------------------+----------------------+ -| Updates an EIP. | PUT /v1/{project_id}/publicips/{publicip_id} | vpc:publicIps:update | -+-----------------+-------------------------------------------------+----------------------+ -| Release an EIP. | DELETE /v1/{project_id}/publicips/{publicip_id} | vpc:publicIps:delete | -+-----------------+-------------------------------------------------+----------------------+ ++-----------------+-------------------------------------------------+----------------------+----------------------+ +| Permission | API | Action | Supported Action | ++=================+=================================================+======================+======================+ +| Assigns an EIP. | POST /v1/{project_id}/publicips | vpc:publicIps:create | eip:publicIps:create | ++-----------------+-------------------------------------------------+----------------------+----------------------+ +| Queries an EIP. | GET /v1/{project_id}/publicips/{publicip_id} | vpc:publicIps:get | eip:publicIps:get | ++-----------------+-------------------------------------------------+----------------------+----------------------+ +| Queries EIPs. | GET /v1/{project_id}/publicips | vpc:publicIps:list | eip:publicIps:list | ++-----------------+-------------------------------------------------+----------------------+----------------------+ +| Updates an EIP. | PUT /v1/{project_id}/publicips/{publicip_id} | vpc:publicIps:update | eip:publicIps:update | ++-----------------+-------------------------------------------------+----------------------+----------------------+ +| Release an EIP. | DELETE /v1/{project_id}/publicips/{publicip_id} | vpc:publicIps:delete | eip:publicIps: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 4685334..442821b 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/index.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/index.rst @@ -16,6 +16,7 @@ Permissions Policies and Supported Actions - :ref:`Quota ` - :ref:`Private IP Address ` - :ref:`Security Group ` +- :ref:`VPC Flow Log ` - :ref:`Port (OpenStack Neutron API) ` - :ref:`Network (OpenStack Neutron API) ` - :ref:`Subnet (OpenStack Neutron API) ` @@ -40,6 +41,7 @@ Permissions Policies and Supported Actions quota private_ip_address security_group + vpc_flow_log port_openstack_neutron_api network_openstack_neutron_api subnet_openstack_neutron_api diff --git a/api-ref/source/permissions_policies_and_supported_actions/vpc_flow_log.rst b/api-ref/source/permissions_policies_and_supported_actions/vpc_flow_log.rst new file mode 100644 index 0000000..9197398 --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/vpc_flow_log.rst @@ -0,0 +1,20 @@ +:original_name: vpc_permission_0025.html + +.. _vpc_permission_0025: + +VPC Flow Log +============ + ++-------------------------+---------------------------------------------------+---------------------+ +| Permission | API | Action | ++=========================+===================================================+=====================+ +| Creating a VPC Flow Log | POST /v1/{project_id}/fl/flow_logs | vpc:flowLogs:create | ++-------------------------+---------------------------------------------------+---------------------+ +| Querying VPC Flow Logs | GET /v1/{project_id}/fl/flow_logs | vpc:flowLogs:get | ++-------------------------+---------------------------------------------------+---------------------+ +| Querying a VPC Flow Log | GET /v1/{project_id}/fl/flow_logs/{flowlog_id} | vpc:flowLogs:get | ++-------------------------+---------------------------------------------------+---------------------+ +| Updating a VPC Flow Log | PUT /v1/{project_id}/fl/flow_logs/{flowlog_id} | vpc:flowLogs:update | ++-------------------------+---------------------------------------------------+---------------------+ +| Deleting a Flow Log | DELETE /v1/{project_id}/fl/flow_logs/{flowlog_id} | vpc:flowLogs:delete | ++-------------------------+---------------------------------------------------+---------------------+