diff --git a/api-ref/source/apis/eip/index.rst b/api-ref/source/apis/eip/index.rst index 0e9e8f0..beb2730 100644 --- a/api-ref/source/apis/eip/index.rst +++ b/api-ref/source/apis/eip/index.rst @@ -6,6 +6,9 @@ EIP === - :ref:`Assigning an EIP ` +- :ref:`Querying an EIP ` +- :ref:`Querying EIPs ` +- :ref:`Updating an EIP ` - :ref:`Releasing an EIP ` .. toctree:: @@ -13,4 +16,7 @@ EIP :hidden: assigning_an_eip + querying_an_eip + querying_eips + updating_an_eip releasing_an_eip diff --git a/api-ref/source/apis/eip/querying_an_eip.rst b/api-ref/source/apis/eip/querying_an_eip.rst new file mode 100644 index 0000000..2ca14df --- /dev/null +++ b/api-ref/source/apis/eip/querying_an_eip.rst @@ -0,0 +1,196 @@ +:original_name: vpc_eip_0002.html + +.. _vpc_eip_0002: + +Querying an EIP +=============== + +Function +-------- + +This API is used to query a specific EIP. + +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be 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 `__. + - 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. + +URI +--- + +GET /v1/{project_id}/publicips/{publicip_id} + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_eip_0002__table57982344: + +.. table:: **Table 1** Parameter description + + =========== ========= ========================================== + Name Mandatory Description + =========== ========= ========================================== + project_id Yes Specifies the project ID. + publicip_id Yes Specifies the unique identifier of an EIP. + =========== ========= ========================================== + +Request Message +--------------- + +- Request parameter + + None + +- Example request + + .. code-block:: + + Get https://{Endpoint}/v1/{project_id}/publicips/{publicip_id} + +Response Message +---------------- + +- Response parameter + + .. table:: **Table 2** Response parameter + + +----------+-----------------------------------------------------+-----------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+=====================================================+=========================================================================================+ + | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | + +----------+-----------------------------------------------------+-----------------------------------------------------------------------------------------+ + + .. _vpc_eip_0002__table3035698: + + .. table:: **Table 3** Description of the **publicip** field + + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===========================================================+=======================================================================================================================================================================================+ + | id | String | Specifies the unique identifier of an EIP. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the EIP status. | + | | | - Possible values are as follows: | + | | | | + | | | - **FREEZED** (Frozen) | + | | | - **BIND_ERROR** (Binding failed) | + | | | - **BINDING** (Binding) | + | | | - **PENDING_DELETE** (Releasing) | + | | | - **PENDING_CREATE** (Assigning) | + | | | - **PENDING_UPDATE** (Updating) | + | | | - **NOTIFYING** (Assigning) | + | | | - **NOTIFY_DELETE** (Releasing) | + | | | - **DOWN** (Unbound) | + | | | - **ACTIVE** (Bound) | + | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | + | | | - **ERROR** (Exceptions) | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 `. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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**. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. Specifies the IPv4 address corresponding to the IPv6 address if IPv6 EIPs are available. IPv6 is not supported currently. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. The value can be **4** or **6**. | + | | | | + | | | - **4**: IPv4 | + | | | - **6**: IPv6 (IPv6 is not supported currently.) | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_ip_address | String | - Specifies the private IP address bound to the EIP. | + | | | - This parameter is returned only if the private IP address is bound to the EIP. | + | | | | + | | | .. note:: | + | | | | + | | | The value of **private_ip_address** is **null** if the EIP is bound to a dedicated load balancer. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_id | String | - Specifies the port ID. | + | | | - This parameter is returned only when a port is associated with the EIP. | + | | | | + | | | .. note:: | + | | | | + | | | The value of **port_id** is null if the EIP is bound to a dedicated load balancer. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | create_time | String | Specifies the time (UTC) when the EIP is assigned. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_id | String | Specifies the ID of the EIP bandwidth. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Integer | Specifies the bandwidth (Mbit/s). | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_share_type | String | - Specifies the EIP bandwidth type. | + | | | - The value can be **PER** or **WHOLE**. | + | | | | + | | | - **PER**: Dedicated bandwidth | + | | | - **WHOLE**: Shared bandwidth | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_name | String | Specifies the bandwidth name. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | + | | | - When assigning an EIP, you need to associate an enterprise project ID with the EIP. | + | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. _vpc_eip_0002__table66651219193417: + + .. table:: **Table 4** Description of the **profile** field + + ========== ====== ========================= + Name Type Description + ========== ====== ========================= + order_id String Specifies the order ID. + product_id String Specifies the product ID. + region_id String Specifies the region ID. + user_id String Specifies the user ID. + ========== ====== ========================= + +- Example response + + .. code-block:: + + { + "publicip": { + "id": "2ec9b78d-9368-46f3-8f29-d1a95622a568", + "status": "DOWN", + "profile": {}, + "type": "5_bgp", + "public_ip_address": "161.xx.xx.12", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "private_ip_address": "192.168.10.5", + "create_time": "2015-07-16 04:32:50", + "bandwidth_id": "49c8825b-bed9-46ff-9416-704b96d876a2", + "bandwidth_share_type": "PER", + "bandwidth_size": 10, //The EIP bandwidth size is 10 Mbit/s. + "bandwidth_name": "bandwidth-test", + "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439", + "ip_version": 4 + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/eip/querying_eips.rst b/api-ref/source/apis/eip/querying_eips.rst new file mode 100644 index 0000000..94bc6f9 --- /dev/null +++ b/api-ref/source/apis/eip/querying_eips.rst @@ -0,0 +1,230 @@ +:original_name: vpc_eip_0003.html + +.. _vpc_eip_0003: + +Querying EIPs +============= + +Function +-------- + +This API is used to query EIPs. + +.. note:: + + Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: + + - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be 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 `__. + - 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. + +URI +--- + +GET /v1/{project_id}/publicips + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_eip_0003__table51200735: + +.. 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 the EIPs of an 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 EIPs 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 + + None + +- Example request + + .. code-block:: text + + GET https://{Endpoint}/v1/{project_id}/publicips?limit={limit}&marker={marker} + +Response Message +---------------- + +- 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 3 `. | + +-----------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + + .. _vpc_eip_0003__table83964341880: + + .. table:: **Table 3** Description of the **publicips** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================================================================+ + | id | String | Specifies the unique identifier of an EIP. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the EIP status. | + | | | - Possible values are as follows: | + | | | | + | | | - **FREEZED** (Frozen) | + | | | - **BIND_ERROR** (Binding failed) | + | | | - **BINDING** (Binding) | + | | | - **PENDING_DELETE** (Releasing) | + | | | - **PENDING_CREATE** (Assigning) | + | | | - **PENDING_UPDATE** (Updating) | + | | | - **DOWN** (Unbound) | + | | | - **ACTIVE** (Bound) | + | | | - **ELB** (Bound to a load balancer) | + | | | - **ERROR** (Exceptions) | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | profile | Object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 `. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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**. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. The value can be **4** or **6**. | + | | | | + | | | - **4**: IPv4 | + | | | - **6**: IPv6 (IPv6 is not supported currently.) | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_ip_address | String | - Specifies the private IP address bound to the EIP. | + | | | - This parameter is returned only if the private IP address is bound to the EIP. | + | | | | + | | | .. note:: | + | | | | + | | | The value of **private_ip_address** is **null** if the EIP is bound to a dedicated load balancer. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_id | String | - Specifies the port ID. | + | | | - This parameter is returned only when a port is associated with the EIP. | + | | | | + | | | .. note:: | + | | | | + | | | The value of **port_id** is null if the EIP is bound to a dedicated load balancer. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | create_time | String | Specifies the time (UTC) when the EIP is assigned. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_id | String | Specifies the ID of the EIP bandwidth. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Integer | Specifies the bandwidth (Mbit/s). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_share_type | String | - Specifies the EIP bandwidth type. | + | | | - The value can be **PER** or **WHOLE**. | + | | | | + | | | - **PER**: Dedicated bandwidth | + | | | - **WHOLE**: Shared bandwidth | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_name | String | Specifies the bandwidth name. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | + | | | - When assigning an EIP, you need to associate an enterprise project ID with the EIP. | + | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. _vpc_eip_0003__table66651219193417: + + .. table:: **Table 4** Description of the **profile** field + + ========== ====== ========================= + Name Type Description + ========== ====== ========================= + order_id String Specifies the order ID. + product_id String Specifies the product ID. + region_id String Specifies the region ID. + user_id String Specifies the user ID. + ========== ====== ========================= + +- Example response + + .. code-block:: + + { + "publicips": [ + { + "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0", + "status": "DOWN", + "profile": {}, + "type": "5_bgp", + "public_ip_address": "161.xx.xx.9", + "private_ip_address": "192.168.10.5", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "create_time": "2015-07-16 04:22:32", + "bandwidth_id": "3fa5b383-5a73-4dcb-a314-c6128546d855", + "bandwidth_share_type": "PER", + "bandwidth_size": 5, + "bandwidth_name": "bandwidth-test", + "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439", + "ip_version": 4 + }, + { + "id": "80d5b82e-43b9-4f82-809a-37bec5793bd4", + "status": "DOWN", + "profile": {}, + "type": "5_bgp", + "public_ip_address": "161.xx.xx.10", + "private_ip_address": "192.168.10.6", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "create_time": "2015-07-16 04:23:03", + "bandwidth_id": "a79fd11a-047b-4f5b-8f12-99c178cc780a", + "bandwidth_share_type": "PER", + "bandwidth_size": 5, + "bandwidth_name": "bandwidth-test1", + "enterprise_project_id":"0", + "ip_version": 4 + } + ] + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/eip/updating_an_eip.rst b/api-ref/source/apis/eip/updating_an_eip.rst new file mode 100644 index 0000000..6f667ce --- /dev/null +++ b/api-ref/source/apis/eip/updating_an_eip.rst @@ -0,0 +1,221 @@ +:original_name: vpc_eip_0004.html + +.. _vpc_eip_0004: + +Updating an EIP +=============== + +Function +-------- + +This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC. + +.. 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 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 `__. + - 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. + +URI +--- + +PUT /v1/{project_id}/publicips/{publicip_id} + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_eip_0004__table25231885: + +.. table:: **Table 1** Parameter description + + =========== ========= ========================================== + Name Mandatory Description + =========== ========= ========================================== + project_id Yes Specifies the project ID. + publicip_id Yes Specifies the unique identifier of an EIP. + =========== ========= ========================================== + +Request Message +--------------- + +- Request parameter + + .. table:: **Table 2** Request parameter + + +----------+-----------+------------------------------------------------------+------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==========+===========+======================================================+==========================================================================================+ + | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | + +----------+-----------+------------------------------------------------------+------------------------------------------------------------------------------------------+ + + .. _vpc_eip_0004__table23403840: + + .. table:: **Table 3** Description of the **publicip** field + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================================================================================================================================================+ + | port_id | No | String | - Specifies the port ID. | + | | | | | + | | | | - The value must be an existing port ID. If this parameter is not included or the parameter value is left blank, the EIP is unbound. If the specified port ID does not exist or has already been bound with an EIP, an error message will be displayed. | + | | | | | + | | | | Leaving this parameter blank does not unbind the EIP from the dedicated load balancer. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +- Example request 1 (Binding an EIP to a NIC) + + .. code-block:: text + + PUT https://{Endpoint}/v1/{project_id}/publicips/{publicip_id} + + { + "publicip": { + "port_id": "f588ccfa-8750-4d7c-bf5d-2ede24414706" + } + } + +Response Message +---------------- + +- Response parameter + + .. table:: **Table 4** Response parameter + + +----------+---------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+=========================================================+=============================================================================================+ + | publicip | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 5 `. | + +----------+---------------------------------------------------------+---------------------------------------------------------------------------------------------+ + + .. _vpc_eip_0004__table83964341880: + + .. table:: **Table 5** Description of the **publicips** field + + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===========================================================+==================================================================================================================================================+ + | id | String | Specifies the unique identifier of an EIP. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the EIP status. | + | | | - Possible values are as follows: | + | | | | + | | | - **FREEZED** (Frozen) | + | | | - **BIND_ERROR** (Binding failed) | + | | | - **BINDING** (Binding) | + | | | - **PENDING_DELETE** (Releasing) | + | | | - **PENDING_CREATE** (Assigning) | + | | | - **PENDING_UPDATE** (Updating) | + | | | - **NOTIFYING** (Assigning) | + | | | - **NOTIFY_DELETE** (Releasing) | + | | | - **DOWN** (Unbound) | + | | | - **ACTIVE** (Bound) | + | | | - **ELB** (Bound to a load balancer) | + | | | - **VPN** (Bound to a VPN) | + | | | - **ERROR** (Exceptions) | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 6 `. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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**. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_ip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. The value can be **4** or **6**. | + | | | | + | | | - **4**: IPv4 | + | | | - **6**: IPv6 (IPv6 is not supported currently.) | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | private_ip_address | String | - Specifies the private IP address bound to the EIP. | + | | | - This parameter is returned only when a port is associated with the EIP. | + | | | | + | | | .. note:: | + | | | | + | | | The value of **private_ip_address** is **null** if the EIP is bound to a dedicated load balancer. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_id | String | - Specifies the port ID. | + | | | - This parameter is returned only when a port is associated with the EIP. | + | | | | + | | | .. note:: | + | | | | + | | | The value of **port_id** is null if the EIP is bound to a dedicated load balancer. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | create_time | String | Specifies the time (UTC) when the EIP is assigned. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_id | String | Specifies the ID of the EIP bandwidth. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_size | Integer | Specifies the bandwidth (Mbit/s). | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | bandwidth_share_type | String | - Specifies the EIP bandwidth type. | + | | | - The value can be **PER** or **WHOLE**. | + | | | | + | | | - **PER**: Dedicated bandwidth | + | | | - **WHOLE**: Shared bandwidth | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | + | | | - When you assign an EIP, associate an enterprise project ID with the EIP. | + | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + + .. _vpc_eip_0004__table66651219193417: + + .. table:: **Table 6** Description of the **profile** field + + ========== ====== ========================= + Name Type Description + ========== ====== ========================= + order_id String Specifies the order ID. + product_id String Specifies the product ID. + region_id String Specifies the region ID. + user_id String Specifies the user ID. + ========== ====== ========================= + +- Example response (Binding an EIP to a NIC) + + .. code-block:: + + { + "publicip": { + "id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb", + "status": "ACTIVE", + "profile": {}, + "type": "5_bgp", + "port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe", + "public_ip_address": "10.xx.xx.162", + "private_ip_address": "192.168.1.131", + "tenant_id": "26ae5181a416420998eb2093aaed84d9", + "create_time": "2019-03-27 01:33:18", + "bandwidth_size": 7, + "ip_version": 4, + "bandwidth_name": "bandwidth-2aef", + "enterprise_project_id": "0", + "bandwidth_share_type": "PER", + "bandwidth_id": "7a258fff-10d8-44b8-8124-c59079eb8f4c" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. 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 da0ac82..4010acc 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,7 +15,9 @@ URI DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key} -:ref:`Table 2 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. + +.. _eip_tag_0003__table5716115334: .. table:: **Table 1** Parameter description @@ -32,17 +34,7 @@ Request Message - Request parameter - .. _eip_tag_0003__table27380479: - - .. table:: **Table 2** 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. - =========== ========= ========================================== + None - Example request diff --git a/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst b/api-ref/source/apis/eip_tag_management/querying_eip_tags.rst index 9f5aa3e..8b7b1d5 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,7 +15,9 @@ URI GET /v2.0/{project_id}/publicips/{publicip_id}/tags -:ref:`Table 2 ` describes the parameters. +:ref:`Table 1 ` describes the parameters. + +.. _eip_tag_0002__table450964213214: .. table:: **Table 1** Parameter description @@ -31,16 +33,7 @@ Request Message - Request parameter - .. _eip_tag_0002__table27380479: - - .. table:: **Table 2** Request parameters - - =========== ========= ========================================== - Name Mandatory Description - =========== ========= ========================================== - project_id Yes Specifies the project ID. - publicip_id Yes Specifies the unique identifier of an EIP. - =========== ========= ========================================== + None - Example request @@ -53,17 +46,17 @@ Response Message - Response parameter - .. table:: **Table 3** Response parameter + .. table:: **Table 2** Response parameter +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +===========+=================================================================+=========================================================================================================+ - | tags | Array of :ref:`tag ` 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 3 `. | +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ .. _eip_tag_0002__table13242848193719: - .. table:: **Table 4** **tag** objects + .. table:: **Table 3** **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 0d26ea7..dcea71e 100644 --- a/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst @@ -32,13 +32,7 @@ Request Message - Request parameter - .. table:: **Table 2** Request parameter - - ========== ========= =========== - Parameter Mandatory Description - ========== ========= =========== - project_id Yes Project ID. - ========== ========= =========== + None - Example request @@ -51,17 +45,17 @@ Response Message - Response parameter - .. table:: **Table 3** Response parameter + .. table:: **Table 2** Response parameter +-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +===========+===============================================================+=======================================================================================================+ - | tags | Array of :ref:`tag ` 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 3 `. | +-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ .. _eip_tag_0006__table043062842515: - .. table:: **Table 4** Description of the **tag** field + .. table:: **Table 3** Description of the **tag** field +-----------------------+-----------------------+---------------------------------------------------------------------+ | Name | Type | Description | 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 9033f88..158d16e 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 @@ -60,7 +60,7 @@ Request Message .. code-block:: text POST https://{Endpoint}/v1/{project_id}/privateips - + Assign two private IP addresses from the subnet whose ID is 531dec0f-3116-411b-a21b-e612e42349fd. One IP address is automatically assigned, and the other is specified to 192.168.1.17. { "privateips": [ 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 00cfa59..79ef98d 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 @@ -71,10 +71,10 @@ Request Message .. code-block:: text POST https://{Endpoint}/v1/{project_id}/security-groups - + Create a security group named sg-01 in VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85. { "security_group": { - "name": "qq", + "name": "sg-01", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85" "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } diff --git a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst index f499a1f..53dd18e 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst @@ -77,7 +77,7 @@ Request Message .. code-block:: text POST https://{Endpoint}/v1/{project_id}/security-group-rules - + Create an inbound rule in the security group whose ID is a7734e61-b545-452d-a3cd-0189cbd9747a. { "security_group_rule": { "direction": "ingress", diff --git a/api-ref/source/apis/subnet/creating_a_subnet.rst b/api-ref/source/apis/subnet/creating_a_subnet.rst index ef71175..0ab5fe0 100644 --- a/api-ref/source/apis/subnet/creating_a_subnet.rst +++ b/api-ref/source/apis/subnet/creating_a_subnet.rst @@ -97,7 +97,7 @@ Request Message | | | | | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -106,7 +106,7 @@ Request Message .. code-block:: text POST https://{Endpoint}/v1/{project_id}/subnets - + Create a subnet with name set to subnet, CIDR block set to 192.168.20.0/24, and gateway IP address set to 192.168.20.1 in the VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85. { "subnet": { "name": "subnet", @@ -223,7 +223,7 @@ Response Message | | | | | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/subnet/querying_subnet_details.rst b/api-ref/source/apis/subnet/querying_subnet_details.rst index 2f2f9d8..f7b7e9a 100644 --- a/api-ref/source/apis/subnet/querying_subnet_details.rst +++ b/api-ref/source/apis/subnet/querying_subnet_details.rst @@ -117,7 +117,7 @@ Response Message | | | | | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/subnet/querying_subnets.rst b/api-ref/source/apis/subnet/querying_subnets.rst index 8c962ba..7d5e970 100644 --- a/api-ref/source/apis/subnet/querying_subnets.rst +++ b/api-ref/source/apis/subnet/querying_subnets.rst @@ -132,7 +132,7 @@ Response Message | | | | | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/subnet/updating_subnet_information.rst b/api-ref/source/apis/subnet/updating_subnet_information.rst index 7dd7a79..31dcf91 100644 --- a/api-ref/source/apis/subnet/updating_subnet_information.rst +++ b/api-ref/source/apis/subnet/updating_subnet_information.rst @@ -90,7 +90,7 @@ Request Message | | | | | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -99,10 +99,10 @@ Request Message .. code-block:: text PUT https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d - + Change the name of the subnet whose ID is 4779ab1c-7c1a-44b1-a02e-93dfc361b32d to subnet02, and also change its DNS and DHCP configurations. { "subnet": { - "name": "subnetqq", + "name": "subnet02", "ipv6_enable": true, "dhcp_enable": false, "primary_dns": "114.xx.xx.115", diff --git a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst b/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst index 5b53106..debbeee 100644 --- a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst +++ b/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst @@ -91,7 +91,7 @@ Request example 1: Creating tags in batches .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action - + Create two tags for a subnet. { "action": "create", "tags": [ @@ -111,7 +111,7 @@ Request example 2: Deleting tags in batches .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action - + Delete two tags for a subnet. { "action": "delete", "tags": [ diff --git a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst b/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst index 7aac7e7..a390467 100644 --- a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst +++ b/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst @@ -78,7 +78,7 @@ Request Message .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags - + Create a tag for a subnet. The key is key1, and the value is value1. { "tag": { "key": "key1", diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst index 778c6eb..0531862 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst @@ -79,7 +79,7 @@ Example request 1: Setting **action** to **filter** .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action - + Filter subnets by setting action to filter. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use matches and tags to filter subnets. { "offset": "0", "limit": "100", @@ -106,7 +106,7 @@ Example request 2: Setting **action** to **count** .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action - + Count subnets by setting action to count. Use matches and tags to filter and count VPCs. { "action": "count", "tags": [ diff --git a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst index 699da0e..1d9799a 100644 --- a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst @@ -77,7 +77,7 @@ Request Message .. code-block:: text POST https://{Endpoint}/v1/{project_id}/vpcs - + Create a VPC named vpc and set its CIDR block to 192.168.0.0/16. { "vpc": { "name": "vpc", diff --git a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst b/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst index 1aaaf60..8645799 100644 --- a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst +++ b/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst @@ -90,7 +90,7 @@ Request Message .. code-block:: text PUT https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3 - + Change the name, description, and CIDR block of the VPC whose ID is 99d9d709-8478-4b46-9f3f-2206b1023fd3 to vpc1, test1, and 192.168.0.0/16, respectively. { "vpc": { "name": "vpc1", diff --git a/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst index 6b6059f..07897f9 100644 --- a/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst @@ -85,7 +85,8 @@ Request Message .. code-block:: text POST https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs - + Create a VPC flow log. Set the resource type to port, resource ID to 05c4052d-8d14-488f-aa00-19fea5a25fde, traffic type to reject, and log group ID to 05c4052d-8d14-488f-aa00-19fea5a25fdd. + The log topic ID is a9d7dee7-37d2-4cba-a208-a016252aaa63. { "flow_log": { "name": "flowlog", diff --git a/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst index 1b47257..9258855 100644 --- a/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst @@ -62,7 +62,7 @@ Request Message .. code-block:: text PUT https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/f49f00f1-0f15-470a-a8c5-4e879e461c8d - + Change the name of the VPC flow log whose ID is f49f00f1-0f15-470a-a8c5-4e879e461c8d to flow-log-update. { "flow_log": { "name": "flow-log-update", diff --git a/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst index 1ba2c0b..fc39f7d 100644 --- a/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst @@ -39,6 +39,7 @@ Request Message .. code-block:: text PUT https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1/accept + Accept the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1. Response Message ---------------- @@ -81,13 +82,13 @@ Response Message .. table:: **Table 3** **vpc_info** objects - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+===============================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst index 89200e2..7dc0116 100644 --- a/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst @@ -69,7 +69,7 @@ Request Message .. code-block:: text POST https://{Endpoint}/v2.0/vpc/peerings - + Create a VPC peering connection. The VPC ID of the requester is 9daeac7c-a98f-430f-8e38-67f9c044e299, the VPC ID of the receiver is f583c072-0bb8-4e19-afb2-afb7c1693be5, and the VPC peering connection is named test. { "peering": { "name": "test", diff --git a/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst index 8aac52d..bd7d66a 100644 --- a/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst @@ -39,6 +39,7 @@ Request Message .. code-block:: text PUT https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1/reject + Reject the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1. Response Message ---------------- @@ -81,13 +82,13 @@ Response Message .. table:: **Table 3** **vpc_info** objects - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+===============================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst index 9d03393..be299e3 100644 --- a/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst @@ -59,6 +59,7 @@ Request Message .. code-block:: text PUT https://{Endpoint}/v2.0/vpc/peerings/7a9a954a-eb41-4954-a300-11ab17a361a2 + Change the name of the VPC peering connection whose ID is 7a9a954a-eb41-4954-a300-11ab17a361a2 to test2. { "peering": { "name": "test2" @@ -116,13 +117,13 @@ Response Message .. table:: **Table 6** **vpc_info** objects - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+===============================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst b/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst index 919fe36..4d2596c 100644 --- a/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst +++ b/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst @@ -51,7 +51,7 @@ Request Message .. code-block:: text POST https://{Endpoint}/v2.0/vpc/routes - + Create a route in the route table of VPC whose ID is ab78be2d-782f-42a5-aa72-35879f6890ff for the VPC peering connection. The next hop is the peering connection whose ID is 60c809cb-6731-45d0-ace8-3bf5626421a9, and the destination is 192.168.200.0/24. { "route": { "type": "peering", diff --git a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst b/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst index 42f365c..ff9c48f 100644 --- a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst +++ b/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst @@ -89,7 +89,7 @@ Request example 1: Creating tags in batches .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action - + Create two tags for a VPC. { "action": "create", "tags": [ @@ -109,7 +109,7 @@ Request example 2: Deleting tags in batches .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action - + Delete two tags for a VPC. { "action": "delete", "tags": [ diff --git a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst b/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst index 26aab6b..3f840ee 100644 --- a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst +++ b/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst @@ -76,7 +76,7 @@ Request Message .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags - + Create a tag for a VPC. The key is key1, and the value is value1. { "tag": { "key": "key1", diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst index 65b9e93..404a71f 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst @@ -83,7 +83,7 @@ Example request 1: Setting **action** to **filter** .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action - + Filter VPCs by setting action to filter. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use matches and tags to filter VPCs. { "offset": "0", "limit": "100", @@ -110,7 +110,7 @@ Example request 2: Setting **action** to **count** .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action - + Count VPCs by setting action to count. Use matches and tags to filter and count VPCs. { "action": "count", "tags": [ diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 60c504d..6932193 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,9 +8,13 @@ Change History +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2023-06-20 | This release incorporates the following changes: | +| | | +| | Modified parameters in :ref:`Deleting an EIP Tag `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-06-06 | This release incorporates the following changes: | | | | -| | - Changed the value of **size** in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | +| | Changed the value of **size** in :ref:`Assigning a Shared Bandwidth ` and :ref:`Adding an EIP to a Shared Bandwidth `. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-05-15 | This release incorporates the following changes: | | | | 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 39bbb3b..211d758 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 @@ -72,7 +72,7 @@ Example Request .. code-block:: text POST https://{Endpoint}/v2.0/fwaas/firewall_groups - + Create an ACL group, associate it with the inbound ACL policy afc52ce9-5305-4ec9-9feb-44feb8330341, and set the port ID to c133f2bf-6937-4416-bb17-012e1be5cd2d. { "firewall_group": { "ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst index 0a31ae4..450918e 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst @@ -54,7 +54,7 @@ Example Request .. code-block:: text POST https://{Endpoint}/v2.0/fwaas/firewall_policies - + Create an ACL policy named test-policy and associate it with the ACL rule whose ID is b8243448-cb3c-496e-851c-dadade4c161b. { "firewall_policy": { "name": "test-policy", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst index 6849da3..c59f8b8 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst @@ -76,7 +76,7 @@ Example Request .. code-block:: text POST https://{Endpoint}/v2.0/fwaas/firewall_rules - + Create an ACL rule with action set to allow, protocol set to tcp, and destination port set to 80. { "firewall_rule": { "action": "allow", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst index 7653c0a..cf9181a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst @@ -52,7 +52,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule - + Insert rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 below rule b8243448-cb3c-496e-851c-dadade4c161b in the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341. { "insert_after": "b8243448-cb3c-496e-851c-dadade4c161b", "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst index 4dd03b6..2d41013 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst @@ -32,7 +32,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/remove_rule - + Remove ACL rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 from the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341. { "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" } 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 f0b204d..de86d83 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 @@ -72,7 +72,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_groups/2fb0e81f-9f63-44b2-9894-c13a3284594a - + Associate the ACL group whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a with the outbound ACL policy 53f36c32-db25-4856-a0ba-e605fd88c5e9. { "firewall_group": { "egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9" diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst index ae70e55..25de44a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst @@ -54,7 +54,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a - + Associate the ACL policy whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a to the ACL rule whose ID is 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1. { "firewall_policy": { "firewall_rules": [ diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst index d419a70..2cb9701 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst @@ -76,7 +76,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28 - + Change the action of the ACL rule whose ID is b94acf06-efc2-485d-ba67-a61acf2a7e28 to deny. { "firewall_rule": { "action": "deny" 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 ed55fbb..217c109 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 @@ -56,7 +56,7 @@ Example Request .. code-block:: text POST https://{Endpoint}/v2.0/networks - + Create a network named network-test. { "network": { "name": "network-test", 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 db72990..37c3b3b 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 @@ -64,7 +64,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/networks/c360322d-5315-45d7-b7d2-481f98c56edb - + Change the name of the network whose ID is c360322d-5315-45d7-b7d2-481f98c56edb to network-test02. { "network": { "name": "network-test02" diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst index f7ff87d..788b08c 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst @@ -138,7 +138,7 @@ Example Request .. code-block:: text POST https://{Endpoint}/v2.0/ports - + Create a port named port-test on network whose ID is 00ae08c5-f727-49ab-ad4b-b069398aa171. { "port": { "admin_state_up": true, diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst index 1af479b..6aa8c2e 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst @@ -125,7 +125,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/ports/7a9a954a-eb41-4954-a300-11ab17a361a2 - + Change the name of the port whose ID is 7a9a954a-eb41-4954-a300-11ab17a361a2 to port-test02. { "port": { "name": "port-test02" diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst index 7e90990..3d5c9ec 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst @@ -43,7 +43,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface - + Add an interface to the router. The router ID is i5b8e885c-1347-4ac2-baf9-2249c8ed1270, and the subnet ID is ab78be2d-782f-42a5-aa72-35879f6890ff. {"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"} Response Message diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst index f2393cf..9b18d44 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst @@ -68,6 +68,7 @@ Example Request .. code-block:: text POST https://{Endpoint}/v2.0/routers + Create a router named router-test2. { "router": { "name": "router-test2", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst index 1ae6e2a..b115704 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst @@ -40,7 +40,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface - + Remove an interface from a router. The router ID is b625c58c-0cfe-49e0-acc8-f2374f8187ff, and the subnet ID is 4b910a10-0860-428b-b463-d84dbc5e288e. {"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"} Response Message diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst index 6977c45..98ad77f 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst @@ -88,6 +88,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/routers/f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 + Change the name of the router whose ID is f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 to router-220. { "router": { "name": "router-220" diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst index 6367e76..381d10d 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst @@ -44,7 +44,7 @@ Example Request .. code-block:: text POST https://{Endpoint}/v2.0/security-groups - + Create a security group named sg-test. { "security_group": { "name": "sg-test" diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst index e70a218..1f59995 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst @@ -79,7 +79,7 @@ Example Request .. code-block:: text POST https://{Endpoint}/v2.0/security-group-rules - + Create an outbound rule in the security group whose ID is 5cb9c1ee-00e0-4d0f-9623-55463cd26ff8. Set protocol to tcp, and remote IP address to 10.10.0.0/24. { "security_group_rule": { "security_group_id": "5cb9c1ee-00e0-4d0f-9623-55463cd26ff8", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst index e2de88f..6143d0b 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst @@ -46,7 +46,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/security-groups/d29ae17d-f355-4992-8747-1fb66cc9afd2 - + Change the name of the security group whose ID is d29ae17d-f355-4992-8747-1fb66cc9afd2 to sg-test02. { "security_group": { "name": "sg-test02" diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst index 55c4677..78b8a05 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst @@ -106,7 +106,7 @@ Example Request .. code-block:: text POST https://{Endpoint}/v2.0/subnets - + Create a subnet named subnet-test, set its network ID to 0133cd73-34d4-4d4c-bf1f-e65b24603206, and CIDR block to 172.16.2.0/24. { "subnet": { "name": "subnet-test", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst index bfac833..b03e605 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst @@ -96,7 +96,7 @@ Example Request .. code-block:: text PUT https://{Endpoint}/v2.0/subnets/98bac90c-0ba7-4a63-8995-097da9bead1c - + Change the name of the subnet whose ID is 98bac90c-0ba7-4a63-8995-097da9bead1c to subnet-test. { "subnet": { "name": "subnet-test"