forked from docs/virtual-private-cloud
Compare commits
15 Commits
main
...
propose-vp
| Author | SHA1 | Date | |
|---|---|---|---|
| c59b6ed900 | |||
| a0603bea83 | |||
| a1d2f3639e | |||
| 7d4e766126 | |||
| d76c3b11c7 | |||
| b91e1f97fd | |||
| 4ee7d13e19 | |||
| cd0947f8ca | |||
| 1f49ae13ed | |||
| 8899eb38e5 | |||
| 91a6e04e62 | |||
| 6c5840102f | |||
| fbdb57d7e9 | |||
| a72beb5b20 | |||
| 50c41de90b |
BIN
api-ref/source/_static/images/en-us_image_0000001487964866.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001487964866.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
BIN
api-ref/source/_static/images/en-us_image_0000001538444809.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001538444809.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
BIN
api-ref/source/_static/images/en-us_image_0000001538445357.png
Normal file
BIN
api-ref/source/_static/images/en-us_image_0000001538445357.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
14
api-ref/source/api_v3/common_pools/index.rst
Normal file
14
api-ref/source/api_v3/common_pools/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
:original_name: eip_apiv3_0300.html
|
||||
|
||||
.. _eip_apiv3_0300:
|
||||
|
||||
Common Pools
|
||||
============
|
||||
|
||||
- :ref:`Querying Common Pools <listcommonpools>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_common_pools
|
||||
160
api-ref/source/api_v3/common_pools/querying_common_pools.rst
Normal file
160
api-ref/source/api_v3/common_pools/querying_common_pools.rst
Normal file
File diff suppressed because it is too large
Load Diff
491
api-ref/source/api_v3/eips/binding_an_eip.rst
Normal file
491
api-ref/source/api_v3/eips/binding_an_eip.rst
Normal file
File diff suppressed because it is too large
Load Diff
20
api-ref/source/api_v3/eips/index.rst
Normal file
20
api-ref/source/api_v3/eips/index.rst
Normal file
@ -0,0 +1,20 @@
|
||||
:original_name: eip_apiv3_0100.html
|
||||
|
||||
.. _eip_apiv3_0100:
|
||||
|
||||
EIPs
|
||||
====
|
||||
|
||||
- :ref:`Querying All EIPs <listpublicipsv3>`
|
||||
- :ref:`Querying EIP Details <showpublicipv3>`
|
||||
- :ref:`Unbinding an EIP <disassociatepublicips>`
|
||||
- :ref:`Binding an EIP <associatepublicips>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_all_eips
|
||||
querying_eip_details
|
||||
unbinding_an_eip
|
||||
binding_an_eip
|
||||
849
api-ref/source/api_v3/eips/querying_all_eips.rst
Normal file
849
api-ref/source/api_v3/eips/querying_all_eips.rst
Normal file
File diff suppressed because it is too large
Load Diff
626
api-ref/source/api_v3/eips/querying_eip_details.rst
Normal file
626
api-ref/source/api_v3/eips/querying_eip_details.rst
Normal file
File diff suppressed because it is too large
Load Diff
428
api-ref/source/api_v3/eips/unbinding_an_eip.rst
Normal file
428
api-ref/source/api_v3/eips/unbinding_an_eip.rst
Normal file
File diff suppressed because it is too large
Load Diff
16
api-ref/source/api_v3/index.rst
Normal file
16
api-ref/source/api_v3/index.rst
Normal file
@ -0,0 +1,16 @@
|
||||
:original_name: vpc_apiv3_0000.html
|
||||
|
||||
.. _vpc_apiv3_0000:
|
||||
|
||||
API V3
|
||||
======
|
||||
|
||||
- :ref:`EIPs <eip_apiv3_0100>`
|
||||
- :ref:`Common Pools <eip_apiv3_0300>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
eips/index
|
||||
common_pools/index
|
||||
@ -95,10 +95,6 @@ Response Message
|
||||
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). |
|
||||
| | | - When creating a bandwidth, associate the enterprise project ID with the bandwidth. |
|
||||
| | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. |
|
||||
| | | |
|
||||
| | | .. note:: |
|
||||
| | | |
|
||||
| | | This parameter is unsupported. Do not use it. |
|
||||
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| status | String | - Specifies the bandwidth status. |
|
||||
| | | - Possible values are as follows: |
|
||||
@ -117,26 +113,26 @@ Response Message
|
||||
|
||||
.. 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). |
|
||||
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
|
||||
| | | - Constraints: |
|
||||
| | | |
|
||||
| | | - The configured value must be supported by the system. |
|
||||
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example response
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -128,10 +128,6 @@ Response Message
|
||||
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the bandwidth bound to all enterprise projects of the user, set **all_granted_eps**. |
|
||||
| | | - When creating a bandwidth, associate the enterprise project ID with the bandwidth. |
|
||||
| | | |
|
||||
| | | .. note:: |
|
||||
| | | |
|
||||
| | | This parameter is unsupported. Do not use it. |
|
||||
+-----------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| status | String | - Specifies the bandwidth status. |
|
||||
| | | - Possible values are as follows: |
|
||||
@ -150,26 +146,20 @@ Response Message
|
||||
|
||||
.. 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. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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). |
|
||||
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
|
||||
| | | - Constraints: |
|
||||
| | | |
|
||||
| | | - The configured value must be supported by the system. |
|
||||
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example response
|
||||
|
||||
|
||||
@ -57,18 +57,18 @@ Request Message
|
||||
|
||||
.. 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). |
|
||||
| | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
|
||||
| | | | - Constraints: |
|
||||
| | | | |
|
||||
| | | | - The configured value must be supported by the system. |
|
||||
| | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
|
||||
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example request
|
||||
|
||||
@ -111,7 +111,7 @@ Response Message
|
||||
| | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
|
||||
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| size | Integer | - Specifies the bandwidth size. |
|
||||
| | | - The value ranges from 5 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) |
|
||||
| | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) |
|
||||
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| id | String | Specifies the bandwidth ID, which uniquely identifies the bandwidth. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -153,26 +153,26 @@ Response Message
|
||||
|
||||
.. 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). |
|
||||
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
|
||||
| | | - Constraints: |
|
||||
| | | |
|
||||
| | | - The configured value must be supported by the system. |
|
||||
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example response
|
||||
|
||||
|
||||
@ -47,12 +47,11 @@ Request Message
|
||||
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+=======================+=================+=================+================================================================================================================================================================================================================+
|
||||
| name | Yes | String | Specifies the bandwidth name. |
|
||||
| | | | |
|
||||
| | | | The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
|
||||
| name | Yes | String | - Specifies the bandwidth name. |
|
||||
| | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
|
||||
+-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| size | Yes | Integer | - Specifies the bandwidth size. The shared bandwidth has a minimum limit, which may vary depending on sites. The default minimum value is 5 Mbit/s. |
|
||||
| | | | - The value ranges from 5 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) |
|
||||
| | | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) |
|
||||
| | | | - If a decimal fraction (for example **10.2**) or a character string (for example **"10"**) is specified, the specified value will be automatically converted to an integer. |
|
||||
| | | | - The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows: |
|
||||
| | | | |
|
||||
@ -106,7 +105,7 @@ Response Message
|
||||
| | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
|
||||
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| size | Integer | - Specifies the bandwidth size. |
|
||||
| | | - The value ranges from 5 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) |
|
||||
| | | - The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the available bandwidth range on the management console.) |
|
||||
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| id | String | Specifies the bandwidth ID, which uniquely identifies the bandwidth. |
|
||||
+-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -154,20 +153,20 @@ Response Message
|
||||
|
||||
.. 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). |
|
||||
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
|
||||
| | | - Constraints: |
|
||||
| | | |
|
||||
| | | - The configured value must be supported by the system. |
|
||||
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example response
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -2,8 +2,8 @@
|
||||
|
||||
.. _vpc_eip_0000:
|
||||
|
||||
Elastic IP
|
||||
==========
|
||||
EIP
|
||||
===
|
||||
|
||||
- :ref:`Assigning an EIP <en-us_topic_0020090596>`
|
||||
- :ref:`Querying an EIP <vpc_eip_0002>`
|
||||
@ -10,6 +10,20 @@ 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 <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/binding_an_eip.html>`__ and `Unbinding an EIP <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/unbinding_an_eip.html>`__.
|
||||
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
|
||||
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
|
||||
|
||||
- Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
@ -72,15 +86,20 @@ Response Message
|
||||
| | | - **PENDING_DELETE** (Releasing) |
|
||||
| | | - **PENDING_CREATE** (Assigning) |
|
||||
| | | - **PENDING_UPDATE** (Updating) |
|
||||
| | | - **NOTIFYING** (Assigning) |
|
||||
| | | - **NOTIFY_DELETE** (Releasing) |
|
||||
| | | - **DOWN** (Unbound) |
|
||||
| | | - **ACTIVE** (Bound) |
|
||||
| | | - **ELB** (Bound to a load balancer) |
|
||||
| | | - **VPN** (Bound to a VPN) |
|
||||
| | | - **ERROR** (Exceptions) |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| profile | :ref:`profile <vpc_eip_0002__table66651219193417>` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 <vpc_eip_0002__table66651219193417>`. |
|
||||
| | | |
|
||||
| | | This parameter is not supported currently. |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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** (Dedicated Load Balancer). |
|
||||
| | | - Constraints: |
|
||||
| | | |
|
||||
| | | - The configured value must be supported by the system. |
|
||||
@ -98,18 +117,20 @@ Response Message
|
||||
| | | |
|
||||
| | | .. note:: |
|
||||
| | | |
|
||||
| | | The value of **private_ip_address** is **null** if the EIP is bound to a dedicated load balancer. |
|
||||
| | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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. |
|
||||
| | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tenant_id | String | Specifies the project ID. |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| create_time | String | Specifies the time (UTC) when the EIP is assigned. |
|
||||
| | | |
|
||||
| | | Format: *yyyy-MM-dd HH:mm:ss* |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| bandwidth_id | String | Specifies the ID of the EIP bandwidth. |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -123,6 +144,8 @@ Response Message
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| bandwidth_name | String | Specifies the bandwidth name. |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| alias | String | Specifies the EIP 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. |
|
||||
@ -131,6 +154,15 @@ Response Message
|
||||
| | | |
|
||||
| | | This parameter is unsupported. Do not use it. |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| public_border_group | String | Specifies whether it is in a central site or an edge site. |
|
||||
| | | |
|
||||
| | | The value can be: |
|
||||
| | | |
|
||||
| | | - center |
|
||||
| | | - *Edge site name* |
|
||||
| | | |
|
||||
| | | An EIP can only be bound to a resource of the same region. |
|
||||
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _vpc_eip_0002__table66651219193417:
|
||||
|
||||
@ -153,6 +185,7 @@ Response Message
|
||||
"publicip": {
|
||||
"id": "2ec9b78d-9368-46f3-8f29-d1a95622a568",
|
||||
"status": "DOWN",
|
||||
"alias": "tom",
|
||||
"profile": {},
|
||||
"type": "5_bgp",
|
||||
"public_ip_address": "161.xx.xx.12",
|
||||
@ -10,6 +10,20 @@ 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 <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/binding_an_eip.html>`__ and `Unbinding an EIP <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/unbinding_an_eip.html>`__.
|
||||
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
|
||||
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
|
||||
|
||||
- Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
@ -30,12 +44,12 @@ GET /v1/{project_id}/publicips
|
||||
| | | | |
|
||||
| | | | This parameter can work together with the parameter **limit**. |
|
||||
| | | | |
|
||||
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
|
||||
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
|
||||
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
|
||||
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
|
||||
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
|
||||
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
|
||||
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. |
|
||||
| | | | |
|
||||
| | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. |
|
||||
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -97,9 +111,11 @@ Response Message
|
||||
| | | - **ERROR** (Exceptions) |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| profile | Object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 <vpc_eip_0003__table66651219193417>`. |
|
||||
| | | |
|
||||
| | | This parameter is not supported currently. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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** (Dedicated Load Balancer). |
|
||||
| | | - Constraints: |
|
||||
| | | |
|
||||
| | | - The configured value must be supported by the system. |
|
||||
@ -117,18 +133,20 @@ Response Message
|
||||
| | | |
|
||||
| | | .. note:: |
|
||||
| | | |
|
||||
| | | The value of **private_ip_address** is **null** if the EIP is bound to a dedicated load balancer. |
|
||||
| | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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. |
|
||||
| | | This parameter is not displayed if the EIP is bound to a dedicated load balancer. This parameter is displayed if the EIP is bound to an ECS. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tenant_id | String | Specifies the project ID. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| create_time | String | Specifies the time (UTC) when the EIP is assigned. |
|
||||
| | | |
|
||||
| | | Format: *yyyy-MM-dd HH:mm:ss* |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| bandwidth_id | String | Specifies the ID of the EIP bandwidth. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -142,6 +160,8 @@ Response Message
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| bandwidth_name | String | Specifies the bandwidth name. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| alias | String | Specifies the EIP 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. |
|
||||
@ -150,6 +170,15 @@ Response Message
|
||||
| | | |
|
||||
| | | This parameter is unsupported. Do not use it. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| public_border_group | String | Specifies whether it is in a central site or an edge site. |
|
||||
| | | |
|
||||
| | | The value can be: |
|
||||
| | | |
|
||||
| | | - center |
|
||||
| | | - *Edge site name* |
|
||||
| | | |
|
||||
| | | An EIP can only be bound to a resource of the same region. |
|
||||
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _vpc_eip_0003__table66651219193417:
|
||||
|
||||
@ -173,6 +202,7 @@ Response Message
|
||||
{
|
||||
"id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
|
||||
"status": "DOWN",
|
||||
"alias": "tom",
|
||||
"profile": {},
|
||||
"type": "5_bgp",
|
||||
"public_ip_address": "161.xx.xx.9",
|
||||
86
api-ref/source/apis/eip/releasing_an_eip.rst
Normal file
86
api-ref/source/apis/eip/releasing_an_eip.rst
Normal file
@ -0,0 +1,86 @@
|
||||
:original_name: vpc_eip_0005.html
|
||||
|
||||
.. _vpc_eip_0005:
|
||||
|
||||
Releasing an EIP
|
||||
================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to release an EIP.
|
||||
|
||||
.. note::
|
||||
|
||||
Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type:
|
||||
|
||||
- In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be 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 <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/binding_an_eip.html>`__ and `Unbinding an EIP <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/unbinding_an_eip.html>`__.
|
||||
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
|
||||
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
|
||||
|
||||
- Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v1/{project_id}/publicips/{publicip_id}
|
||||
|
||||
:ref:`Table 1 <vpc_eip_0005__table45251091>` describes the parameters.
|
||||
|
||||
.. _vpc_eip_0005__table45251091:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
=========== ========= ==========================================
|
||||
Name Mandatory Description
|
||||
=========== ========= ==========================================
|
||||
project_id Yes Specifies the project ID.
|
||||
publicip_id Yes Specifies the unique identifier of an EIP.
|
||||
=========== ========= ==========================================
|
||||
|
||||
Request Message
|
||||
---------------
|
||||
|
||||
- Request parameter
|
||||
|
||||
None
|
||||
|
||||
- Example request
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}
|
||||
|
||||
Response Message
|
||||
----------------
|
||||
|
||||
- Response parameter
|
||||
|
||||
None
|
||||
|
||||
- Example response
|
||||
|
||||
None
|
||||
|
||||
Or
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"code":"xxx",
|
||||
"message":"xxxxx"
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
See :ref:`Status Codes <vpc_api_0002>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
See :ref:`Error Codes <vpc_api_0003>`.
|
||||
File diff suppressed because it is too large
Load Diff
@ -15,9 +15,9 @@ URI
|
||||
|
||||
DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}
|
||||
|
||||
:ref:`Table 1 <eip_tag_0003__table27380479>` describes the parameters.
|
||||
:ref:`Table 1 <eip_tag_0003__table5716115334>` describes the parameters.
|
||||
|
||||
.. _eip_tag_0003__table27380479:
|
||||
.. _eip_tag_0003__table5716115334:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
|
||||
@ -15,9 +15,9 @@ URI
|
||||
|
||||
GET /v2.0/{project_id}/publicips/{publicip_id}/tags
|
||||
|
||||
:ref:`Table 1 <eip_tag_0002__table27380479>` describes the parameters.
|
||||
:ref:`Table 1 <eip_tag_0002__table450964213214>` describes the parameters.
|
||||
|
||||
.. _eip_tag_0002__table27380479:
|
||||
.. _eip_tag_0002__table450964213214:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
|
||||
@ -63,7 +63,7 @@ Response Message
|
||||
| key | String | Specifies the tag key. |
|
||||
| | | |
|
||||
| | | - Cannot be left blank. |
|
||||
| | | - Can contain a maximum of 36 characters. |
|
||||
| | | - Contain up to 128 characters (36 characters on the console). |
|
||||
| | | - Can contain only the following character types: |
|
||||
| | | |
|
||||
| | | - Uppercase letters |
|
||||
@ -73,7 +73,7 @@ Response Message
|
||||
+-----------------------+-----------------------+---------------------------------------------------------------------+
|
||||
| values | Array of strings | Specifies the tag value list. |
|
||||
| | | |
|
||||
| | | - Can contain a maximum of 43 characters. |
|
||||
| | | - Contain up to 255 characters (43 characters on the console). |
|
||||
| | | - Can contain only the following character types: |
|
||||
| | | |
|
||||
| | | - Uppercase letters |
|
||||
|
||||
@ -1,72 +0,0 @@
|
||||
:original_name: vpc_eip_0005.html
|
||||
|
||||
.. _vpc_eip_0005:
|
||||
|
||||
Releasing an EIP
|
||||
================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to release an EIP.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v1/{project_id}/publicips/{publicip_id}
|
||||
|
||||
:ref:`Table 1 <vpc_eip_0005__table45251091>` describes the parameters.
|
||||
|
||||
.. _vpc_eip_0005__table45251091:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
=========== ========= ==========================================
|
||||
Name Mandatory Description
|
||||
=========== ========= ==========================================
|
||||
project_id Yes Specifies the project ID.
|
||||
publicip_id Yes Specifies the unique identifier of an EIP.
|
||||
=========== ========= ==========================================
|
||||
|
||||
Request Message
|
||||
---------------
|
||||
|
||||
- Request parameter
|
||||
|
||||
None
|
||||
|
||||
- Example request
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v1/{project_id}/publicips
|
||||
|
||||
Response Message
|
||||
----------------
|
||||
|
||||
- Response parameter
|
||||
|
||||
None
|
||||
|
||||
- Example response
|
||||
|
||||
None
|
||||
|
||||
Or
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"code":"xxx",
|
||||
"message":"xxxxx"
|
||||
}
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
See :ref:`Status Codes <vpc_api_0002>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
See :ref:`Error Codes <vpc_api_0003>`.
|
||||
@ -127,7 +127,7 @@ Response Message
|
||||
],
|
||||
"floatingips_links": [
|
||||
{
|
||||
"href": "https://network.region.cn-southwest-2.hwclouds.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True",
|
||||
"href": "https://vpc.region.otctest.t-systems.com/v2.0/floatingips_v6?marker=861a4c5b-b17b-4a1d-b653-f3e95dcb3345&page_reverse=true&page_reverse=True",
|
||||
"rel": "previous"
|
||||
}
|
||||
]
|
||||
|
||||
@ -7,7 +7,7 @@ APIs
|
||||
|
||||
- :ref:`Virtual Private Cloud <vpc_api01_0000>`
|
||||
- :ref:`Subnet <vpc_subnet01_0000>`
|
||||
- :ref:`Elastic IP <vpc_eip_0000>`
|
||||
- :ref:`EIP <vpc_eip_0000>`
|
||||
- :ref:`Floating IP Address (IPv6) <vpc_ipv6_0000>`
|
||||
- :ref:`Bandwidth <vpc_bandwidth_0000>`
|
||||
- :ref:`Bandwidth (V2.0) <vpc_sharebandwidth_0000>`
|
||||
@ -16,6 +16,7 @@ APIs
|
||||
- :ref:`Security Group <vpc_sg01_0000>`
|
||||
- :ref:`VPC Peering Connection <vpc_peering_0000>`
|
||||
- :ref:`VPC Route <vpc_route_0000>`
|
||||
- :ref:`Route Table <vpc_apiroutetab_0000>`
|
||||
- :ref:`VPC Tag Management <vpc_tag_0000>`
|
||||
- :ref:`Subnet Tag Management <subnet_tag_0000>`
|
||||
- :ref:`EIP Tag Management <eip_tag_0000>`
|
||||
@ -28,7 +29,7 @@ APIs
|
||||
|
||||
virtual_private_cloud/index
|
||||
subnet/index
|
||||
elastic_ip/index
|
||||
eip/index
|
||||
floating_ip_address_ipv6/index
|
||||
bandwidth/index
|
||||
bandwidth_v2.0/index
|
||||
@ -37,6 +38,7 @@ APIs
|
||||
security_group/index
|
||||
vpc_peering_connection/index
|
||||
vpc_route/index
|
||||
route_table/index
|
||||
vpc_tag_management/index
|
||||
subnet_tag_management/index
|
||||
eip_tag_management/index
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -29,31 +29,27 @@ DELETE /v1/{project_id}/privateips/{privateip_id}
|
||||
| privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
|
||||
+--------------+-----------+-----------------------------------------------------------------------------------------------+
|
||||
|
||||
Request Message
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Example Request
|
||||
---------------
|
||||
|
||||
- Request parameter
|
||||
|
||||
None
|
||||
|
||||
- Example request
|
||||
|
||||
.. code-block:: text
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
|
||||
|
||||
Response Message
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Response
|
||||
----------------
|
||||
|
||||
- Request parameter
|
||||
|
||||
None
|
||||
|
||||
- Example response
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
None
|
||||
None
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -35,25 +35,22 @@ GET /v2.0/network-ip-availabilities/{network_id}
|
||||
network_id String Yes Specifies the network ID.
|
||||
========== ====== ========= =========================
|
||||
|
||||
Request Message
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Example Request
|
||||
---------------
|
||||
|
||||
- Request parameter
|
||||
|
||||
None
|
||||
|
||||
- Example request
|
||||
|
||||
.. code-block:: text
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043
|
||||
|
||||
Response Message
|
||||
----------------
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
- Response parameter
|
||||
|
||||
.. table:: **Table 2** Response parameter
|
||||
.. table:: **Table 2** Response parameter
|
||||
|
||||
+-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
@ -61,9 +58,9 @@ Response Message
|
||||
| network_ip_availability | :ref:`network_ip_availability <vpc_natworkip_0001__table4952133061113>` object | Specifies the **network_ip_availability** objects. For details, see :ref:`Table 3 <vpc_natworkip_0001__table4952133061113>`. |
|
||||
+-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _vpc_natworkip_0001__table4952133061113:
|
||||
.. _vpc_natworkip_0001__table4952133061113:
|
||||
|
||||
.. table:: **Table 3** **network_ip_availability** objects
|
||||
.. table:: **Table 3** **network_ip_availability** objects
|
||||
|
||||
+------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
@ -81,9 +78,9 @@ Response Message
|
||||
| subnet_ip_availability | Array of :ref:`subnet_ip_availability <vpc_natworkip_0001__table110015141519>` objects | Specifies the subnet IP address usage objects. For details, see :ref:`Table 4 <vpc_natworkip_0001__table110015141519>`. |
|
||||
+------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _vpc_natworkip_0001__table110015141519:
|
||||
.. _vpc_natworkip_0001__table110015141519:
|
||||
|
||||
.. table:: **Table 4** Description of the **subnet_ip_availability** field
|
||||
.. table:: **Table 4** Description of the **subnet_ip_availability** field
|
||||
|
||||
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| Parameter | Type | Description |
|
||||
@ -103,9 +100,10 @@ Response Message
|
||||
| total_ips | Integer | Specifies the total number of IP addresses on a subnet. (System reserved IP addresses are not included.) |
|
||||
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example response
|
||||
Example Response
|
||||
----------------
|
||||
|
||||
.. code-block::
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"network_ip_availability": {
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
258
api-ref/source/apis/route_table/creating_a_route_table.rst
Normal file
258
api-ref/source/apis/route_table/creating_a_route_table.rst
Normal file
File diff suppressed because it is too large
Load Diff
66
api-ref/source/apis/route_table/deleting_a_route_table.rst
Normal file
66
api-ref/source/apis/route_table/deleting_a_route_table.rst
Normal file
@ -0,0 +1,66 @@
|
||||
:original_name: vpc_apiroutetab_0006.html
|
||||
|
||||
.. _vpc_apiroutetab_0006:
|
||||
|
||||
Deleting a Route Table
|
||||
======================
|
||||
|
||||
Function
|
||||
--------
|
||||
|
||||
This API is used to delete a custom route table.
|
||||
|
||||
Constraints:
|
||||
|
||||
Only custom route tables can be deleted. If a custom route table has subnets associated, disassociate the subnets with the route table and then delete the route table.
|
||||
|
||||
URI
|
||||
---
|
||||
|
||||
DELETE /v1/{project_id}/routetables/{routetable_id}
|
||||
|
||||
:ref:`Table 1 <vpc_apiroutetab_0006__table13893430173220>` describes the parameters.
|
||||
|
||||
.. _vpc_apiroutetab_0006__table13893430173220:
|
||||
|
||||
.. table:: **Table 1** Parameter description
|
||||
|
||||
+---------------+-----------+--------+------------------------------------------------------------------------+
|
||||
| Name | Mandatory | Type | Description |
|
||||
+===============+===========+========+========================================================================+
|
||||
| project_id | Yes | String | Specifies the project ID. |
|
||||
+---------------+-----------+--------+------------------------------------------------------------------------+
|
||||
| routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. |
|
||||
+---------------+-----------+--------+------------------------------------------------------------------------+
|
||||
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Example Request
|
||||
---------------
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v1/{project_id}/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054
|
||||
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Response
|
||||
----------------
|
||||
|
||||
None
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
See :ref:`Status Codes <vpc_api_0002>`.
|
||||
|
||||
Error Code
|
||||
----------
|
||||
|
||||
See :ref:`Error Codes <vpc_api_0003>`.
|
||||
File diff suppressed because it is too large
Load Diff
26
api-ref/source/apis/route_table/index.rst
Normal file
26
api-ref/source/apis/route_table/index.rst
Normal file
@ -0,0 +1,26 @@
|
||||
:original_name: vpc_apiroutetab_0000.html
|
||||
|
||||
.. _vpc_apiroutetab_0000:
|
||||
|
||||
Route Table
|
||||
===========
|
||||
|
||||
- :ref:`Querying Route Tables <vpc_apiroutetab_0001>`
|
||||
- :ref:`Querying a Route Table <vpc_apiroutetab_0002>`
|
||||
- :ref:`Creating a Route Table <vpc_apiroutetab_0003>`
|
||||
- :ref:`Updating a Route Table <vpc_apiroutetab_0004>`
|
||||
- :ref:`Associating Subnets with a Route Table <vpc_apiroutetab_0005>`
|
||||
- :ref:`Disassociating Subnets from a Route Table <vpc_apiroutetab_0007>`
|
||||
- :ref:`Deleting a Route Table <vpc_apiroutetab_0006>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
querying_route_tables
|
||||
querying_a_route_table
|
||||
creating_a_route_table
|
||||
updating_a_route_table
|
||||
associating_subnets_with_a_route_table
|
||||
disassociating_subnets_from_a_route_table
|
||||
deleting_a_route_table
|
||||
201
api-ref/source/apis/route_table/querying_a_route_table.rst
Normal file
201
api-ref/source/apis/route_table/querying_a_route_table.rst
Normal file
File diff suppressed because it is too large
Load Diff
169
api-ref/source/apis/route_table/querying_route_tables.rst
Normal file
169
api-ref/source/apis/route_table/querying_route_tables.rst
Normal file
File diff suppressed because it is too large
Load Diff
379
api-ref/source/apis/route_table/updating_a_route_table.rst
Normal file
379
api-ref/source/apis/route_table/updating_a_route_table.rst
Normal file
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -29,29 +29,27 @@ DELETE /v1/{project_id}/security-groups/{security_group_id}
|
||||
| project_id | No | Specifies the project ID. |
|
||||
+-------------------+-----------+--------------------------------------------------------------------------------+
|
||||
|
||||
Request Message
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Example Request
|
||||
---------------
|
||||
|
||||
- Request parameter
|
||||
|
||||
None
|
||||
|
||||
- Example request
|
||||
|
||||
.. code-block:: text
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v1/{project_id}/security-groups/0c4a2336-b036-4fa2-bc3c-1a291ed4c431
|
||||
|
||||
Response Message
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Response
|
||||
----------------
|
||||
|
||||
- Response parameter
|
||||
|
||||
None
|
||||
|
||||
- Example response
|
||||
|
||||
None
|
||||
None
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
@ -29,29 +29,27 @@ DELETE /v1/{project_id}/security-group-rules/{security_group_rule_id}
|
||||
| project_id | Yes | Specifies the project ID. |
|
||||
+------------------------+-----------+------------------------------------------------------------------------------------------+
|
||||
|
||||
Request Message
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Example Request
|
||||
---------------
|
||||
|
||||
- Request parameter
|
||||
|
||||
None
|
||||
|
||||
- Example request
|
||||
|
||||
.. code-block:: text
|
||||
.. code-block:: text
|
||||
|
||||
DELETE https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62
|
||||
|
||||
Response Message
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
None
|
||||
|
||||
Example Response
|
||||
----------------
|
||||
|
||||
- Response parameter
|
||||
|
||||
None
|
||||
|
||||
- Example response
|
||||
|
||||
None
|
||||
None
|
||||
|
||||
Status Code
|
||||
-----------
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@ -29,25 +29,22 @@ GET /v1/{project_id}/security-group-rules/{security_group_rule_id}
|
||||
| security_group_rule_id | Yes | Specifies the security group rule ID, which uniquely identifies the security group rule. |
|
||||
+------------------------+-----------+------------------------------------------------------------------------------------------+
|
||||
|
||||
Request Message
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Example Request
|
||||
---------------
|
||||
|
||||
- Request parameter
|
||||
|
||||
None
|
||||
|
||||
- Example request
|
||||
|
||||
.. code-block:: text
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62
|
||||
|
||||
Response Message
|
||||
----------------
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
- Response parameter
|
||||
|
||||
.. table:: **Table 2** Response parameter
|
||||
.. table:: **Table 2** Response parameter
|
||||
|
||||
+---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
@ -55,9 +52,9 @@ Response Message
|
||||
| security_group_rule | :ref:`security_group_rule <vpc_sg01_0006__table488727239520>` object | Specifies the security group rule objects. For details, see :ref:`Table 3 <vpc_sg01_0006__table488727239520>`. |
|
||||
+---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. _vpc_sg01_0006__table488727239520:
|
||||
.. _vpc_sg01_0006__table488727239520:
|
||||
|
||||
.. table:: **Table 3** **security_group_rule** objects
|
||||
.. table:: **Table 3** **security_group_rule** objects
|
||||
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
@ -79,7 +76,7 @@ Response Message
|
||||
| | | - The value can be **IPv4** or **IPv6**. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| protocol | String | - Specifies the protocol type. |
|
||||
| | | - The value can be **icmp**, **tcp**, or **udp**. |
|
||||
| | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) |
|
||||
| | | - If the parameter is left blank, all protocols are supported. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| port_range_min | Integer | - Specifies the start port number. |
|
||||
@ -92,20 +89,21 @@ Response Message
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
|
||||
| | | - The value can be in the CIDR format or IP addresses. |
|
||||
| | | - The parameter is exclusive with parameter **remote_group_id**. |
|
||||
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| remote_group_id | String | - Specifies the ID of the peer security group. |
|
||||
| | | - The value is exclusive with parameter **remote_ip_prefix**. |
|
||||
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
|
||||
| | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
|
||||
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example response
|
||||
Example Response
|
||||
----------------
|
||||
|
||||
.. code-block::
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"security_group_rule": {
|
||||
|
||||
@ -36,45 +36,42 @@ Example:
|
||||
| | | | |
|
||||
| | | | This parameter can work together with the parameter **limit**. |
|
||||
| | | | |
|
||||
| | | | - If parameters **marker** and **limit** are not passed, all resource records will be returned. |
|
||||
| | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. |
|
||||
| | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. |
|
||||
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. |
|
||||
| | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. |
|
||||
+-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax. |
|
||||
| limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. |
|
||||
| | | | |
|
||||
| | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. |
|
||||
+-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| security_group_id | No | String | Specifies the security group ID. |
|
||||
+-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
Request Message
|
||||
Request Parameters
|
||||
------------------
|
||||
|
||||
None
|
||||
|
||||
Example Request
|
||||
---------------
|
||||
|
||||
- Request parameter
|
||||
|
||||
None
|
||||
|
||||
- Example request
|
||||
|
||||
.. code-block:: text
|
||||
.. code-block:: text
|
||||
|
||||
GET https://{Endpoint}/v1/{project_id}/security-group-rules
|
||||
|
||||
Response Message
|
||||
----------------
|
||||
Response Parameters
|
||||
-------------------
|
||||
|
||||
- Response parameter
|
||||
+----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
+======================+================================================================================+================================================================================================================+
|
||||
| security_group_rules | Array of :ref:`security_group_rule <vpc_sg01_0007__table488727239520>` objects | Specifies the security group rule objects. For details, see :ref:`Table 2 <vpc_sg01_0007__table488727239520>`. |
|
||||
+----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
+----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
+======================+================================================================================+================================================================================================================+
|
||||
| security_group_rules | Array of :ref:`security_group_rule <vpc_sg01_0007__table488727239520>` objects | Specifies the security group rule objects. For details, see :ref:`Table 2 <vpc_sg01_0007__table488727239520>`. |
|
||||
+----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
|
||||
.. _vpc_sg01_0007__table488727239520:
|
||||
|
||||
.. _vpc_sg01_0007__table488727239520:
|
||||
|
||||
.. table:: **Table 2** **security_group_rule** objects
|
||||
.. table:: **Table 2** **security_group_rule** objects
|
||||
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| Name | Type | Description |
|
||||
@ -96,7 +93,7 @@ Response Message
|
||||
| | | - The value can be **IPv4** or **IPv6**. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| protocol | String | - Specifies the protocol type. |
|
||||
| | | - The value can be **icmp**, **tcp**, or **udp**. |
|
||||
| | | - The value can be **icmp**, **tcp**, **udp**, or an IP protocol number (0 to 255, for example, 47 for GRE) |
|
||||
| | | - If the parameter is left blank, all protocols are supported. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| port_range_min | Integer | - Specifies the start port number. |
|
||||
@ -109,20 +106,21 @@ Response Message
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
|
||||
| | | - The value can be in the CIDR format or IP addresses. |
|
||||
| | | - The parameter is exclusive with parameter **remote_group_id**. |
|
||||
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| remote_group_id | String | - Specifies the ID of the peer security group. |
|
||||
| | | - The value is exclusive with parameter **remote_ip_prefix**. |
|
||||
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
|
||||
| | | - The value is exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
|
||||
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
|
||||
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
- Example response
|
||||
Example Response
|
||||
----------------
|
||||
|
||||
.. code-block::
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"security_group_rules": [
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user