Compare commits

...

2 Commits

Author SHA1 Message Date
2ebf32857d Update content 2024-05-25 02:10:47 +00:00
f5fe00c288 Update content 2024-03-20 03:35:46 +00:00
72 changed files with 2592 additions and 2076 deletions

View File

@ -5,6 +5,7 @@
API V3 API V3
====== ======
- :ref:`VPC <vpc_apiv3_0001>`
- :ref:`EIPs <eip_apiv3_0100>` - :ref:`EIPs <eip_apiv3_0100>`
- :ref:`Common Pools <eip_apiv3_0300>` - :ref:`Common Pools <eip_apiv3_0300>`
@ -12,5 +13,6 @@ API V3
:maxdepth: 1 :maxdepth: 1
:hidden: :hidden:
vpc/index
eips/index eips/index
common_pools/index common_pools/index

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,16 @@
:original_name: vpc_apiv3_0001.html
.. _vpc_apiv3_0001:
VPC
===
- :ref:`Adding a Secondary CIDR Block to a VPC <vpc_apiv3_0007>`
- :ref:`Removing a Secondary CIDR Block from a VPC <vpc_apiv3_0008>`
.. toctree::
:maxdepth: 1
:hidden:
adding_a_secondary_cidr_block_to_a_vpc
removing_a_secondary_cidr_block_from_a_vpc

File diff suppressed because it is too large Load Diff

View File

@ -38,9 +38,9 @@ Request Message
- Example request - Example request
.. code-block:: .. code-block:: text
Get https://{Endpoint}//v1/{project_id}/bandwidths/{bandwidth_id} GET https://{Endpoint}//v1/{project_id}/bandwidths/{bandwidth_id}
Response Message Response Message
---------------- ----------------

View File

@ -144,7 +144,7 @@ Response Message
"bandwidths": [ "bandwidths": [
{ {
"id": "09b99c91-da7c-449f-94e2-f4934c5b2a71", "id": "09b99c91-da7c-449f-94e2-f4934c5b2a71",
"name": "vpngw-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977", "name": "test-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977",
"size": 200, "size": 200,
"share_type": "PER", "share_type": "PER",
"publicip_info": [ "publicip_info": [
@ -164,7 +164,7 @@ Response Message
}, },
{ {
"id": "0a583ff1-b43e-4000-ade3-e7af0097f832", "id": "0a583ff1-b43e-4000-ade3-e7af0097f832",
"name": "vpngw-7e880d5b-f458-40ad-a7e5-735c44cd8b7d", "name": "test-7e880d5b-f458-40ad-a7e5-735c44cd8b7d",
"size": 300, "size": 300,
"share_type": "PER", "share_type": "PER",
"publicip_info": [ "publicip_info": [

View File

@ -16,15 +16,15 @@ The EIP service provides independent public IP addresses and bandwidth for Inter
Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: 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. - In **eu-de**, no more new EIPs of this type can be assigned. 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. - Existing EIPs of this 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. - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console.
- 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>`__. - 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. - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - You are advised to bind or unbind BGP EIPs to or 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. - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.
URI URI
--- ---
@ -112,7 +112,8 @@ Request Parameters
| | | | | | | | | |
| | | | - If this parameter is set to **WHOLE**, the bandwidth ID must be specified. | | | | | - If this parameter is set to **WHOLE**, the bandwidth ID must be specified. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| charge_mode | No | String | - The value is **traffic**, indicating that the billing is based on traffic. | | charge_mode | No | String | - Specifies whether the bandwidth is billed by traffic or by bandwidth size. |
| | | | - The value is **traffic**, indicating that the billing is based on traffic. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Request Example Request

View File

@ -14,15 +14,15 @@ This API is used to query a specific EIP.
Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: 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. - In **eu-de**, no more new EIPs of this type can be assigned. 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. - Existing EIPs of this 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. - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console.
- 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>`__. - 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. - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - You are advised to bind or unbind BGP EIPs to or 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. - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.
URI URI
--- ---
@ -51,9 +51,9 @@ Request Message
- Example request - Example request
.. code-block:: .. code-block:: text
Get https://{Endpoint}/v1/{project_id}/publicips/{publicip_id} GET https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}
Response Message Response Message
---------------- ----------------

View File

@ -14,15 +14,15 @@ This API is used to query EIPs.
Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: 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. - In **eu-de**, no more new EIPs of this type can be assigned. 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. - Existing EIPs of this 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. - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console.
- 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>`__. - 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. - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - You are advised to bind or unbind BGP EIPs to or 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. - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.
URI URI
--- ---

View File

@ -14,15 +14,15 @@ This API is used to release an EIP.
Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: 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. - In **eu-de**, no more new EIPs of this type can be assigned. 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. - Existing EIPs of this 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. - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console.
- 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>`__. - 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. - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - You are advised to bind or unbind BGP EIPs to or 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. - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.
URI URI
--- ---

View File

@ -14,15 +14,15 @@ This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC.
Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: 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. - In **eu-de**, no more new EIPs of this type can be assigned. 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. - Existing EIPs of this 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. - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console.
- 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>`__. - 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. - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - You are advised to bind or unbind BGP EIPs to or 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. - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.
URI URI
--- ---

View File

@ -2,13 +2,13 @@
.. _eip_tag_0001: .. _eip_tag_0001:
Creating a Tag for an EIP Adding a Tag to an EIP
========================= ======================
Function Function
-------- --------
This API is used to create a tag for an EIP. This API is used to add a tag to an EIP.
URI URI
--- ---

View File

@ -2,8 +2,8 @@
.. _eip_tag_0004: .. _eip_tag_0004:
Batch Creating or Deleting EIP Tags Batch Adding or Deleting EIP Tags
=================================== =================================
Function Function
-------- --------

View File

@ -2,13 +2,13 @@
.. _eip_tag_0003: .. _eip_tag_0003:
Deleting an EIP Tag Deleting a Tag from an EIP
=================== ==========================
Function Function
-------- --------
This API is used to delete an EIP tag. This API is used to delete a tag from an EIP.
URI URI
--- ---

View File

@ -5,10 +5,10 @@
EIP Tag Management EIP Tag Management
================== ==================
- :ref:`Creating a Tag for an EIP <eip_tag_0001>` - :ref:`Adding a Tag to an EIP <eip_tag_0001>`
- :ref:`Querying EIP Tags <eip_tag_0002>` - :ref:`Querying EIP Tags <eip_tag_0002>`
- :ref:`Deleting an EIP Tag <eip_tag_0003>` - :ref:`Deleting a Tag from an EIP <eip_tag_0003>`
- :ref:`Batch Creating or Deleting EIP Tags <eip_tag_0004>` - :ref:`Batch Adding or Deleting EIP Tags <eip_tag_0004>`
- :ref:`Querying EIPs by Tag <eip_tag_0005>` - :ref:`Querying EIPs by Tag <eip_tag_0005>`
- :ref:`Querying EIP Tags in a Specified Project <eip_tag_0006>` - :ref:`Querying EIP Tags in a Specified Project <eip_tag_0006>`
@ -16,9 +16,9 @@ EIP Tag Management
:maxdepth: 1 :maxdepth: 1
:hidden: :hidden:
creating_a_tag_for_an_eip adding_a_tag_to_an_eip
querying_eip_tags querying_eip_tags
deleting_an_eip_tag deleting_a_tag_from_an_eip
batch_creating_or_deleting_eip_tags batch_adding_or_deleting_eip_tags
querying_eips_by_tag querying_eips_by_tag
querying_eip_tags_in_a_specified_project querying_eip_tags_in_a_specified_project

View File

@ -49,7 +49,6 @@ Example:
| | | | - **firewall**: Firewall | | | | | - **firewall**: Firewall |
| | | | - **shareBandwidthIP**: IP address added to a shared bandwidth | | | | | - **shareBandwidthIP**: IP address added to a shared bandwidth |
| | | | - **shareBandwidth**: Shared bandwidth | | | | | - **shareBandwidth**: Shared bandwidth |
| | | | - **address_group**: IP address group |
| | | | - **flow_log**: VPC fow log | | | | | - **flow_log**: VPC fow log |
| | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC | | | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC |
| | | | - **routetableContainRoutes**: Number of routes in a route table | | | | | - **routetableContainRoutes**: Number of routes in a route table |
@ -112,7 +111,6 @@ Response Parameters
| | | - **firewall**: Firewall | | | | - **firewall**: Firewall |
| | | - **shareBandwidthIP**: IP address added to a shared bandwidth | | | | - **shareBandwidthIP**: IP address added to a shared bandwidth |
| | | - **shareBandwidth**: Shared bandwidth | | | | - **shareBandwidth**: Shared bandwidth |
| | | - **address_group**: IP address group |
| | | - **flow_log**: VPC fow log | | | | - **flow_log**: VPC fow log |
| | | - **vpcContainRoutetable**: Number of route tables associated with a VPC | | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC |
| | | - **routetableContainRoutes**: Number of routes in a route table | | | | - **routetableContainRoutes**: Number of routes in a route table |
@ -168,12 +166,6 @@ Example Response
"quota": 10, "quota": 10,
"min": 0 "min": 0
}, },
{
"type": "vpn",
"used": 0,
"quota": 5,
"min": 0
},
{ {
"type": "vpcPeer", "type": "vpcPeer",
"used": 0, "used": 0,
@ -221,13 +213,7 @@ Example Response
"used": 0, "used": 0,
"quota": 200, "quota": 200,
"min": 0 "min": 0
}, }
{
"type": "address_group",
"used": 0,
"quota": 50,
"min": 0
}
] ]
} }
} }

View File

@ -131,41 +131,41 @@ Response Parameters
.. table:: **Table 7** Description of the **route** field .. table:: **Table 7** Description of the **route** field
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+==================================================================================================+ +=======================+=======================+===========================================================================================+
| type | String | - Specifies the route type. | | type | String | - Specifies the route type. |
| | | - Values: | | | | - Values: |
| | | | | | | |
| | | - **ecs** (ECS) | | | | - **ecs** (ECS) |
| | | - **eni** (NIC) | | | | - **eni** (NIC) |
| | | - **vip** (Virtual IP address) | | | | - **vip** (Virtual IP address) |
| | | - **nat** (NAT gateway) | | | | - **nat** (NAT gateway) |
| | | - **peering** (VPC peering connection) | | | | - **peering** (VPC peering connection) |
| | | - **vpn** (VPN) | | | | - **vpn** (VPN) |
| | | - **dc** (Direct Connect connection) | | | | - **dc** (Direct Connect connection) |
| | | - **egw**: VPC endpoint node | | | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router | | | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
| destination | String | - Specifies the destination CIDR block of a route. | | destination | String | - Specifies the destination CIDR block of a route. |
| | | - The value must be in the valid CIDR format. | | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
| nexthop | String | - Specifies the ID of the next hop in the route. | | nexthop | String | - Specifies the ID of the next hop in the route. |
| | | - Values: | | | | - Values: |
| | | | | | | |
| | | - When **type** is **ecs**, the value is the ECS ID. | | | | - When **type** is **ecs**, the value is an ECS ID. |
| | | - When **type** is **eni**, the value is the extension NIC ID. | | | | - When **type** is **eni**, the value is an extension NIC ID. |
| | | - When **type** is **vip**, the value is the virtual IP address. | | | | - When **type** is **vip**, the value is a virtual IP address. |
| | | - When **type** is **nat**, the value is NAT gateway ID. | | | | - When **type** is **nat**, the value a NAT gateway ID. |
| | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | - When **type** is **peering**, the value is a VPC peering connection ID. |
| | | - When **type** is **vpn**, the value is the VPN ID. | | | | - When **type** is **vpn**, the value is a VPN ID. |
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. | | | | - When **type** is **dc**, the value is a Direct Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. | | | | - When **type** is set to **er**, the value is the ID of an enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the route. | | description | String | - Provides supplementary information about the route. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
.. _vpc_apiroutetab_0005__table17950204203919: .. _vpc_apiroutetab_0005__table17950204203919:

File diff suppressed because it is too large Load Diff

View File

@ -135,41 +135,41 @@ Response Parameters
.. table:: **Table 7** Description of the **route** field .. table:: **Table 7** Description of the **route** field
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+==================================================================================================+ +=======================+=======================+===========================================================================================+
| type | String | - Specifies the route type. | | type | String | - Specifies the route type. |
| | | - Values: | | | | - Values: |
| | | | | | | |
| | | - **ecs** (ECS) | | | | - **ecs** (ECS) |
| | | - **eni** (NIC) | | | | - **eni** (NIC) |
| | | - **vip** (Virtual IP address) | | | | - **vip** (Virtual IP address) |
| | | - **nat** (NAT gateway) | | | | - **nat** (NAT gateway) |
| | | - **peering** (VPC peering connection) | | | | - **peering** (VPC peering connection) |
| | | - **vpn** (VPN) | | | | - **vpn** (VPN) |
| | | - **dc** (Direct Connect connection) | | | | - **dc** (Direct Connect connection) |
| | | - **egw**: VPC endpoint node | | | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router | | | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
| destination | String | - Specifies the destination CIDR block of a route. | | destination | String | - Specifies the destination CIDR block of a route. |
| | | - The value must be in the valid CIDR format. | | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
| nexthop | String | - Specifies the ID of the next hop in the route. | | nexthop | String | - Specifies the ID of the next hop in the route. |
| | | - Values: | | | | - Values: |
| | | | | | | |
| | | - When **type** is **ecs**, the value is the ECS ID. | | | | - When **type** is **ecs**, the value is an ECS ID. |
| | | - When **type** is **eni**, the value is the extension NIC ID. | | | | - When **type** is **eni**, the value is an extension NIC ID. |
| | | - When **type** is **vip**, the value is the virtual IP address. | | | | - When **type** is **vip**, the value is a virtual IP address. |
| | | - When **type** is **nat**, the value is NAT gateway ID. | | | | - When **type** is **nat**, the value a NAT gateway ID. |
| | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | - When **type** is **peering**, the value is a VPC peering connection ID. |
| | | - When **type** is **vpn**, the value is the VPN ID. | | | | - When **type** is **vpn**, the value is a VPN ID. |
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. | | | | - When **type** is **dc**, the value is a Direct Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. | | | | - When **type** is set to **er**, the value is the ID of an enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the route. | | description | String | - Provides supplementary information about the route. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+
.. _vpc_apiroutetab_0007__table17950204203919: .. _vpc_apiroutetab_0007__table17950204203919:

File diff suppressed because it is too large Load Diff

View File

@ -8,7 +8,7 @@ Querying Route Tables
Function Function
-------- --------
This API is used to query all route tables of the tenant submitting the request. The route tables are filtered based on the filtering condition. This API is used to query route tables.
URI URI
--- ---
@ -45,11 +45,11 @@ Example:
| | | | - 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 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. | | | | | - 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. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | No | String | Specifies the route table ID, which can be used to filter the route table with the corresponding ID. | | id | No | String | Specifies the route table ID that is used as the filter. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | No | String | Specifies the VPC UUID. | | vpc_id | No | String | Specifies the VPC UUID that is used as the filter. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| subnet_id | No | String | Specifies the subnet ID. | | subnet_id | No | String | Specifies the subnet UUID that is used as the filter. |
| | | | | | | | | |
| | | | If you use the management console, the value of this parameter is the **Network ID** value. | | | | | If you use the management console, the value of this parameter is the **Network ID** value. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -84,11 +84,11 @@ Response Parameters
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+===========================================================================+=======================================================================================================================================+ +=======================+===========================================================================+=======================================================================================================================================+
| id | String | - Specifies the route table ID, which uniquely identifies the route table. | | id | String | - Specifies the route table ID that uniquely identifies a route table. |
| | | - The value must be in standard UUID format. | | | | - The value must be in standard UUID format. |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| name | String | - Specifies the route table name. | | name | String | - Specifies the route table name. |
| | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | | | | - The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| default | Boolean | - Specifies whether the route table is the default one. | | default | Boolean | - Specifies whether the route table is the default one. |
| | | - The value can be **true** (default route table) or **false** (custom route table). | | | | - The value can be **true** (default route table) or **false** (custom route table). |
@ -101,7 +101,7 @@ Response Parameters
| vpc_id | String | - Specifies the ID of the VPC associated with the route table. | | vpc_id | String | - Specifies the ID of the VPC associated with the route table. |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the route table. | | description | String | - Provides supplementary information about the route table. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | - Specifies the time (UTC) when the route table is created. | | created_at | String | - Specifies the time (UTC) when the route table is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* | | | | - Format: *yyyy-MM-ddTHH:mm:ss* |

File diff suppressed because it is too large Load Diff

View File

@ -53,11 +53,11 @@ Request Message
.. table:: **Table 3** Description of field **Port** .. table:: **Table 3** Description of field **Port**
+------+-----------+--------+------------------------------------------------------------+ +------+-----------+--------+----------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+======+===========+========+============================================================+ +======+===========+========+==========================================================+
| id | Yes | String | Specifies the port ID, which uniquely identifies the port. | | id | Yes | String | Specifies the port ID that uniquely identifies the port. |
+------+-----------+--------+------------------------------------------------------------+ +------+-----------+--------+----------------------------------------------------------+
- Example request - Example request

View File

@ -65,10 +65,10 @@ Request Parameters
| | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | | | | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | No | String | - Specifies the ID of the peer security group. | | remote_group_id | No | String | - Specifies the ID of the peer security group. |
| | | | - This parameter is mutually exclusive with parameter **remote_ip_prefix**. | | | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. |
| | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | | | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Request Example Request

View File

@ -87,7 +87,7 @@ Response Parameters
+-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Specifies the security group ID, which uniquely identifies the security group. | | id | String | Specifies the security group ID, which uniquely identifies the security group. |
+-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | | vpc_id | String | Specifies the ID of the VPC that the security group is associated with. |
| | | | | | | |
| | | .. note:: | | | | .. note:: |
| | | | | | | |

View File

@ -59,7 +59,7 @@ Request Parameters
| | | | - The value must be an IP address in the subnet. | | | | | - The value must be an IP address in the subnet. |
| | | | - The value must be a valid IP address. | | | | | - The value must be a valid IP address. |
+-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | No | Boolean | - Specifies whether IPv6 is enabled. If IPv6 is enabled, you can use IPv6 CIDR blocks. | | ipv6_enable | No | Boolean | - Specifies whether IPv6 is enabled. |
| | | | - The value can be **true** (enabled) or **false** (disabled). | | | | | - The value can be **true** (enabled) or **false** (disabled). |
| | | | - If this parameter is left blank, the system automatically sets it to **false** by default. | | | | | - If this parameter is left blank, the system automatically sets it to **false** by default. |
+-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -67,10 +67,10 @@ Request Parameters
| | | | - The value can be **true** (enabled) or **false** (disabled). | | | | | - The value can be **true** (enabled) or **false** (disabled). |
| | | | - If this parameter is left blank, the value is set to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. | | | | | - If this parameter is left blank, the value is set to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. |
+-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | | primary_dns | No | String | - Specifies the primary IP address of DNS server on the subnet. |
| | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. |
+-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | | secondary_dns | No | String | - Specifies the standby IP address of DNS server on the subnet. |
| | | | | | | | | |
| | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. |
| | | | | | | | | |
@ -99,7 +99,7 @@ Request Parameters
| | | | | | | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. | | | | | - Currently, the value can only be set to **ntp**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -170,7 +170,7 @@ Response Parameters
| | | - The value must be an IP address in the subnet. | | | | - The value must be an IP address in the subnet. |
| | | - The value must be a valid IP address. | | | | - The value must be a valid IP address. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | | ipv6_enable | Boolean | Specifies whether IPv6 is enabled. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -178,10 +178,10 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| primary_dns | String | - Specifies the IP address of DNS server 1 on the subnet. | | primary_dns | String | - Specifies the primary IP address of DNS server on the subnet. |
| | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| secondary_dns | String | - Specifies the IP address of DNS server 2 on the subnet. | | secondary_dns | String | - Specifies the standby IP address of DNS server on the subnet. |
| | | | | | | |
| | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. |
| | | | | | | |
@ -206,7 +206,7 @@ Response Parameters
| | | | | | | |
| | | In the concurrent scenario, if the CIDR block of the created subnet is the same as that of an existing subnet, the created subnet fails to associate with a VPC after underlying system verification. As a result, the subnet creation fails. | | | | In the concurrent scenario, if the CIDR block of the created subnet is the same as that of an existing subnet, the created subnet fails to associate with a VPC after underlying system verification. As a result, the subnet creation fails. |
| | | | | | | |
| | | In this scenario, the returned value of **status** is **UNKNOWN**. | | | | - The value of status is **UNKNOWN** before the subnet is associated with a VPC. After the subnet is associated with a VPC in the threads, the status of the subnet is **ACTIVE**. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -216,14 +216,13 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0001__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 7 <vpc_subnet01_0001__table019517383270>`. | | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0001__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 7 <vpc_subnet01_0001__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| scope | String | Specifies where the subnet is used in edge cloud scenario. | | scope | String | - Specifies where the subnet is used in edge cloud scenario. |
| | | - The value can be: |
| | | | | | | |
| | | Values: | | | | - **center**: The subnet is used in a central AZ. |
| | | | | | | - *{azId}*: The subnet is used in an edge AZ. |
| | | - **center**: The subnet is used in a central AZ. |
| | | - *{azId}*: The subnet is used in an edge AZ. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Project ID | | tenant_id | String | - Project ID |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | - Specifies the time (UTC) when the subnet is created. | | created_at | String | - Specifies the time (UTC) when the subnet is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* | | | | - Format: *yyyy-MM-ddTHH:mm:ss* |
@ -245,7 +244,7 @@ Response Parameters
| | | | | | | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. | | | | | - Currently, the value can only be set to **ntp**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

View File

@ -73,7 +73,7 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| gateway_ip | String | Specifies the subnet gateway address. | | gateway_ip | String | Specifies the subnet gateway address. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | | ipv6_enable | Boolean | Specifies whether IPv6 is enabled. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
@ -81,9 +81,9 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | | primary_dns | String | Specifies the primary IP address of DNS server on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | | secondary_dns | String | Specifies the standby IP address of DNS server on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
@ -104,12 +104,11 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0002__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0002__table019517383270>`. | | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0002__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0002__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| scope | String | Specifies where the subnet is used in edge cloud scenario. | | scope | String | - Specifies where the subnet is used in edge cloud scenario. |
| | | - The value can be: |
| | | | | | | |
| | | Values: | | | | - **center**: The subnet is used in a central AZ. |
| | | | | | | - *{azId}*: The subnet is used in an edge AZ. |
| | | - **center**: The subnet is used in a central AZ. |
| | | - *{azId}*: The subnet is used in an edge AZ. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Project ID | | tenant_id | String | Project ID |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
@ -133,7 +132,7 @@ Response Parameters
| | | | | | | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. | | | | | - Currently, the value can only be set to **ntp**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

View File

@ -21,6 +21,10 @@ Example:
GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85 GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85
:ref:`Table 1 <vpc_subnet01_0003__table42526340>` describes the parameters.
.. _vpc_subnet01_0003__table42526340:
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -41,9 +45,9 @@ Example:
| | | | | | | | | |
| | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | No | String | Specifies that the VPC ID is used as the filtering condition. | | vpc_id | No | String | Specifies the VPC ID that is used to query subnets. |
| | | | | | | | | |
| | | | This field is mandatory in the fine-grained authorization scenario based on enterprise projects. | | | | | This field is mandatory for the fine-grained authorization by enterprise project. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Parameters Request Parameters
@ -63,11 +67,11 @@ Response Parameters
.. table:: **Table 2** Response parameter .. table:: **Table 2** Response parameter
+---------+-----------------------------------------------------------------------+------------------------+ +---------+-----------------------------------------------------------------------+-------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=========+=======================================================================+========================+ +=========+=======================================================================+===============================+
| subnets | Array of :ref:`subnet <vpc_subnet01_0003__table946390317596>` objects | Specifies the subnets. | | subnets | Array of :ref:`subnet <vpc_subnet01_0003__table946390317596>` objects | Specifies the subnet objects. |
+---------+-----------------------------------------------------------------------+------------------------+ +---------+-----------------------------------------------------------------------+-------------------------------+
.. _vpc_subnet01_0003__table946390317596: .. _vpc_subnet01_0003__table946390317596:
@ -88,17 +92,17 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| gateway_ip | String | Specifies the subnet gateway address. | | gateway_ip | String | Specifies the subnet gateway address. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | | ipv6_enable | Boolean | Specifies whether IPv6 is enabled. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. | | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway address. If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | | primary_dns | String | Specifies the primary IP address of DNS server on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | | secondary_dns | String | Specifies the standby IP address of DNS server on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
@ -111,22 +115,21 @@ Response Parameters
| | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. |
| | | - **ERROR**: indicates that the subnet is abnormal. | | | | - **ERROR**: indicates that the subnet is abnormal. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | | neutron_network_id | String | Specifies the ID of the network (OpenStack Neutron API). |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | | neutron_subnet_id | String | Specifies the ID of the subnet (OpenStack Neutron API). |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0003__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0003__table019517383270>`. | | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0003__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0003__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| scope | String | Specifies where the subnet is used in edge cloud scenario. | | scope | String | - Specifies where the subnet is used in edge cloud scenario. |
| | | - The value can be: |
| | | | | | | |
| | | Values: | | | | - **center**: The subnet is used in a central AZ. |
| | | | | | | - *{azId}*: The subnet is used in an edge AZ. |
| | | - **center**: The subnet is used in a central AZ. |
| | | - *{azId}*: The subnet is used in an edge AZ. |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Project ID | | tenant_id | String | - Project ID |
+-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | - Specifies the time (UTC) when the subnet is created. | | created_at | String | - Specifies the time (UTC) when the subnet is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* | | | | - Format: *yyyy-MM-ddTHH:mm:ss* |
@ -148,7 +151,7 @@ Response Parameters
| | | | | | | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. | | | | | - Currently, the value can only be set to **ntp**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

View File

@ -28,7 +28,7 @@ PUT /v1/{project_id}/vpcs/{vpc_id}/subnets/{subnet_id}
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| vpc_id | Yes | Specifies the VPC ID of the subnet. | | vpc_id | Yes | Specifies the VPC ID of the subnet. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| subnet_id | Yes | Specifies the subnet ID, which uniquely identifies the subnet. | | subnet_id | Yes | Specifies the subnet ID that uniquely identifies the subnet. |
| | | | | | | |
| | | If you use the management console, the value of this parameter is the **Network ID** value. | | | | If you use the management console, the value of this parameter is the **Network ID** value. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
@ -48,38 +48,38 @@ Request Parameters
.. table:: **Table 3** **subnet** objects .. table:: **Table 3** **subnet** objects
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description | | Name | Mandatory | Type | Description |
+=================+=================+===============================================================================+======================================================================================================================================================================================================================================================================================================+ +=================+=================+===============================================================================+=====================================================================================================================================================================================================================================================+
| name | Yes | String | - Specifies the subnet name. | | name | Yes | String | - Specifies the subnet name. |
| | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | - Provides supplementary information about the subnet. | | description | No | String | - Provides supplementary information about the subnet. |
| | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | No | Boolean | - Specifies whether an IPv6 subnet can be created. | | ipv6_enable | No | Boolean | - Specifies whether IPv6 is enabled. |
| | | | - The value can be **true** (enabled) or **false** (disabled). | | | | | - The value can be **true** (enabled) or **false** (disabled). |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. |
| | | | - The value can be **true** (enabled) or **false** (disabled). | | | | | - The value can be **true** (enabled) or **false** (disabled). |
| | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. | | | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | | primary_dns | No | String | - Specifies the primary IP address of DNS server on the subnet. |
| | | | - The value must be a valid IP address. IPv6 addresses are not supported. | | | | | - The value must be a valid IP address. IPv6 addresses are not supported. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | | secondary_dns | No | String | - Specifies the standby IP address of DNS server on the subnet. |
| | | | | | | | | |
| | | | - The value must be a valid IP address. IPv6 addresses are not supported. | | | | | - The value must be a valid IP address. IPv6 addresses are not supported. |
| | | | | | | | | |
| | | | The value of **secondary_dns** must be different from that of **primary_dns**. | | | | | The value of **secondary_dns** must be different from that of **primary_dns**. |
| | | | | | | | | |
| | | | If there is only one DNS server address, only **primary_dns** is displayed. | | | | | If there is only one DNS server address, only **primary_dns** is displayed. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | | dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. |
| | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. IPv6 addresses are not supported. | | | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. IPv6 addresses are not supported. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0004__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0004__table019517383270>`. | | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0004__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0004__table019517383270>`. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0004__table019517383270: .. _vpc_subnet01_0004__table019517383270:
@ -94,7 +94,7 @@ Request Parameters
| | | | | | | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. | | | | | - Currently, the value can only be set to **ntp**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

View File

@ -2,13 +2,13 @@
.. _subnet_tag_0001: .. _subnet_tag_0001:
Creating a Tag for a Subnet Adding a Tag to a Subnet
=========================== ========================
Function Function
-------- --------
This API is used to create a tag for a subnet. This API is used to add a tag to a subnet.
URI URI
--- ---

View File

@ -2,8 +2,8 @@
.. _subnet_tag_0004: .. _subnet_tag_0004:
Batch Creating or Deleting Subnet Tags Batch Adding or Deleting Subnet Tags
====================================== ====================================
Function Function
-------- --------

View File

@ -2,13 +2,13 @@
.. _subnet_tag_0003: .. _subnet_tag_0003:
Deleting a Subnet Tag Deleting a Tag from a Subnet
===================== ============================
Function Function
-------- --------
This API is used to delete a subnet tag. This API is used to delete a tag from subnet.
URI URI
--- ---

View File

@ -5,10 +5,10 @@
Subnet Tag Management Subnet Tag Management
===================== =====================
- :ref:`Creating a Tag for a Subnet <subnet_tag_0001>` - :ref:`Adding a Tag to a Subnet <subnet_tag_0001>`
- :ref:`Querying Subnet Tags <subnet_tag_0002>` - :ref:`Querying Subnet Tags <subnet_tag_0002>`
- :ref:`Deleting a Subnet Tag <subnet_tag_0003>` - :ref:`Deleting a Tag from a Subnet <subnet_tag_0003>`
- :ref:`Batch Creating or Deleting Subnet Tags <subnet_tag_0004>` - :ref:`Batch Adding or Deleting Subnet Tags <subnet_tag_0004>`
- :ref:`Querying Subnets by Tag <subnet_tag_0005>` - :ref:`Querying Subnets by Tag <subnet_tag_0005>`
- :ref:`Querying Subnet Tags in a Specified Project <subnet_tag_0006>` - :ref:`Querying Subnet Tags in a Specified Project <subnet_tag_0006>`
@ -16,9 +16,9 @@ Subnet Tag Management
:maxdepth: 1 :maxdepth: 1
:hidden: :hidden:
creating_a_tag_for_a_subnet adding_a_tag_to_a_subnet
querying_subnet_tags querying_subnet_tags
deleting_a_subnet_tag deleting_a_tag_from_a_subnet
batch_creating_or_deleting_subnet_tags batch_adding_or_deleting_subnet_tags
querying_subnets_by_tag querying_subnets_by_tag
querying_subnet_tags_in_a_specified_project querying_subnet_tags_in_a_specified_project

View File

@ -26,7 +26,7 @@ GET /v2.0/{project_id}/subnets/{subnet_id}/tags
+=======================+=======================+=============================================================================================+ +=======================+=======================+=============================================================================================+
| project_id | Yes | Specifies the project ID. | | project_id | Yes | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
| subnet_id | Yes | Specifies the subnet ID, which uniquely identifies the subnet. | | subnet_id | Yes | Specifies the subnet ID that uniquely identifies the subnet. |
| | | | | | | |
| | | If you use the management console, the value of this parameter is the **Network ID** value. | | | | If you use the management console, the value of this parameter is the **Network ID** value. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+

View File

@ -140,15 +140,15 @@ Response Parameters
.. table:: **Table 6** **route** objects .. table:: **Table 6** **route** objects
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+==========================================================================================================================+ +=======================+=======================+=======================================================================================================+
| destination | String | - Specifies the destination network segment of a route. | | destination | String | - Specifies the destination CIDR block of a route. |
| | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | | | | - Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+
| nexthop | String | - Specifies the next hop of a route. | | nexthop | String | - Specifies the next hop of a route. |
| | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | | | | - The value must be an IP address from the subnet of the VPC. IPv4 and IPv6 addresses are supported. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+
Example Response Example Response
---------------- ----------------

View File

@ -21,13 +21,13 @@ DELETE /v1/{project_id}/vpcs/{vpc_id}
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
+------------+-----------+----------------------------------------------------------+ +------------+-----------+--------------------------------------------------------+
| Name | Mandatory | Description | | Name | Mandatory | Description |
+============+===========+==========================================================+ +============+===========+========================================================+
| project_id | Yes | Specifies the project ID. | | project_id | Yes | Specifies the project ID. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+--------------------------------------------------------+
| vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | | vpc_id | Yes | Specifies the VPC ID that uniquely identifies the VPC. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+--------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

View File

@ -8,7 +8,7 @@ Virtual Private Cloud
- :ref:`Creating a VPC <vpc_api01_0001>` - :ref:`Creating a VPC <vpc_api01_0001>`
- :ref:`Querying VPC Details <vpc_api01_0002>` - :ref:`Querying VPC Details <vpc_api01_0002>`
- :ref:`Querying VPCs <vpc_api01_0003>` - :ref:`Querying VPCs <vpc_api01_0003>`
- :ref:`Updating VPC Information <vpc_api01_0004>` - :ref:`Updating a VPC <vpc_api01_0004>`
- :ref:`Deleting a VPC <vpc_api01_0005>` - :ref:`Deleting a VPC <vpc_api01_0005>`
.. toctree:: .. toctree::
@ -18,5 +18,5 @@ Virtual Private Cloud
creating_a_vpc creating_a_vpc
querying_vpc_details querying_vpc_details
querying_vpcs querying_vpcs
updating_vpc_information updating_a_vpc
deleting_a_vpc deleting_a_vpc

View File

@ -97,15 +97,15 @@ Response Parameters
.. table:: **Table 4** **route** objects .. table:: **Table 4** **route** objects
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
+=======================+=======================+==========================================================================================================================+ +=======================+=======================+=======================================================================================================+
| destination | String | - Specifies the destination network segment of a route. | | destination | String | - Specifies the destination network segment of a route. |
| | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | | | | - Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+
| nexthop | String | - Specifies the next hop of a route. | | nexthop | String | - Specifies the next hop of a route. |
| | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | | | | - The value must be an IP address from the subnet of the VPC. IPv4 and IPv6 addresses are supported. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+
Example Response Example Response
---------------- ----------------

File diff suppressed because it is too large Load Diff

View File

@ -109,13 +109,11 @@ Response Parameters
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the VPC peering connection. | | description | String | Provides supplementary information about the VPC peering connection. |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | | created_at | String | - Specifies the time (UTC) when the VPC peering connection is created. |
| | | | | | | - Format: *yyyy-MM-ddTHH:mm:ss* |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | | updated_at | String | - Specifies the time (UTC) when the VPC peering connection is updated. |
| | | | | | | - Format: *yyyy-MM-ddTHH:mm:ss* |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0001__table1132310347417: .. _vpc_peering_0001__table1132310347417:

View File

@ -2,13 +2,13 @@
.. _vpc_tag_0001: .. _vpc_tag_0001:
Creating a Tag for a VPC Adding a Tag to a VPC
======================== =====================
Function Function
-------- --------
This API is used to create a tag for a VPC. This API is used to add a tag to a VPC.
URI URI
--- ---
@ -21,13 +21,13 @@ POST /v2.0/{project_id}/vpcs/{vpc_id}/tags
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
+------------+-----------+----------------------------------------------------------+ +------------+-----------+--------------------------------------------------------+
| Name | Mandatory | Description | | Name | Mandatory | Description |
+============+===========+==========================================================+ +============+===========+========================================================+
| project_id | Yes | Specifies the project ID. | | project_id | Yes | Specifies the project ID. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+--------------------------------------------------------+
| vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | | vpc_id | Yes | Specifies the VPC ID that uniquely identifies the VPC. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+--------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

View File

@ -2,8 +2,8 @@
.. _vpc_tag_0004: .. _vpc_tag_0004:
Batch Creating or Deleting VPC Tags Batch Adding or Deleting VPC Tags
=================================== =================================
Function Function
-------- --------

View File

@ -2,13 +2,13 @@
.. _vpc_tag_0003: .. _vpc_tag_0003:
Deleting a VPC Tag Deleting a Tag from a VPC
================== =========================
Function Function
-------- --------
This API is used to delete a VPC tag. This API is used to delete a tag from a VPC.
URI URI
--- ---

View File

@ -5,10 +5,10 @@
VPC Tag Management VPC Tag Management
================== ==================
- :ref:`Creating a Tag for a VPC <vpc_tag_0001>` - :ref:`Adding a Tag to a VPC <vpc_tag_0001>`
- :ref:`Querying VPC Tags <vpc_tag_0002>` - :ref:`Querying VPC Tags <vpc_tag_0002>`
- :ref:`Deleting a VPC Tag <vpc_tag_0003>` - :ref:`Deleting a Tag from a VPC <vpc_tag_0003>`
- :ref:`Batch Creating or Deleting VPC Tags <vpc_tag_0004>` - :ref:`Batch Adding or Deleting VPC Tags <vpc_tag_0004>`
- :ref:`Querying VPCs by Tag <vpc_tag_0005>` - :ref:`Querying VPCs by Tag <vpc_tag_0005>`
- :ref:`Querying VPC Tags in a Specified Project <vpc_tag_0006>` - :ref:`Querying VPC Tags in a Specified Project <vpc_tag_0006>`
@ -16,9 +16,9 @@ VPC Tag Management
:maxdepth: 1 :maxdepth: 1
:hidden: :hidden:
creating_a_tag_for_a_vpc adding_a_tag_to_a_vpc
querying_vpc_tags querying_vpc_tags
deleting_a_vpc_tag deleting_a_tag_from_a_vpc
batch_creating_or_deleting_vpc_tags batch_adding_or_deleting_vpc_tags
querying_vpcs_by_tag querying_vpcs_by_tag
querying_vpc_tags_in_a_specified_project querying_vpc_tags_in_a_specified_project

View File

@ -21,13 +21,13 @@ GET /v2.0/{project_id}/vpcs/{vpc_id}/tags
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
+------------+-----------+----------------------------------------------------------+ +------------+-----------+--------------------------------------------------------+
| Name | Mandatory | Description | | Name | Mandatory | Description |
+============+===========+==========================================================+ +============+===========+========================================================+
| project_id | Yes | Specifies the project ID. | | project_id | Yes | Specifies the project ID. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+--------------------------------------------------------+
| vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | | vpc_id | Yes | Specifies the VPC ID that uniquely identifies the VPC. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+--------------------------------------------------------+
Request Parameters Request Parameters
------------------ ------------------

View File

@ -68,7 +68,7 @@ Error Code Description
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 500 | VPC.0102 | Delete router fail. | The interface fails to obtain the routing resources. | Contact technical support. | | | 500 | VPC.0102 | Delete router fail. | The interface fails to obtain the routing resources. | Contact technical support. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 409 | VPC.0103 | Resource status is busy, try it again later. | The VPC cannot be deleted because it is being created. | Contact technical support. | | | 409 | VPC.0103 | Resource status is busy. Try again later. | The VPC cannot be deleted because it is being created. | Contact technical support. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 409 | VPC.0104 | Router contains subnets, please delete subnet first. | The VPC cannot be deleted because it contains subnets. | Delete the subnet in the VPC. | | | 409 | VPC.0104 | Router contains subnets, please delete subnet first. | The VPC cannot be deleted because it contains subnets. | Delete the subnet in the VPC. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
@ -78,8 +78,6 @@ Error Code Description
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 409 | VPC.0108 | Router is used not allow deleted. | Failed to delete the VPC because it has EIPs associated. | Delete the EIPs of the tenant first. | | | 409 | VPC.0108 | Router is used not allow deleted. | Failed to delete the VPC because it has EIPs associated. | Delete the EIPs of the tenant first. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 409 | VPC.0109 | Router is used not allow deleted. | Failed to delete the VPC because one or more VPNs have been created for it. | Delete VPNs of the tenant. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 409 | VPC.0110 | deleteDefaultNetworkFromRouter router status is invalid. | The VPC cannot be deleted because its status is unstable. | Contact technical support. | | | 409 | VPC.0110 | deleteDefaultNetworkFromRouter router status is invalid. | The VPC cannot be deleted because its status is unstable. | Contact technical support. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 500 | VPC.0111 | Database Error. | An internal VPC exception occurs. | Contact technical support. | | | 500 | VPC.0111 | Database Error. | An internal VPC exception occurs. | Contact technical support. |
@ -92,6 +90,8 @@ Error Code Description
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 409 | VPC.0120 | exroutes exists under this router, delete exroutes firstly. | The VPC cannot be deleted because it contains extension routes. | Delete extension routes in the VPC. | | | 409 | VPC.0120 | exroutes exists under this router, delete exroutes firstly. | The VPC cannot be deleted because it contains extension routes. | Delete extension routes in the VPC. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| Deleting a VPC | 409 | VPC.0109 | Router is used not allow deleted. | Failed to delete the VPC because one or more VPNs have been created for it. | Delete VPNs of the tenant. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| Updating a VPC | 400 | VPC.0101 | Update router xx is invalid. | Invalid parameters. | Check whether the parameter values are valid based on the returned error message. | | Updating a VPC | 400 | VPC.0101 | Update router xx is invalid. | Invalid parameters. | Check whether the parameter values are valid based on the returned error message. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 404/500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | | | 404/500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. |
@ -124,8 +124,6 @@ Error Code Description
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. | | | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 500 | VPC.0206 | Subnet has been used by VPN, please remove the subnet from the VPN and try again. | The subnet cannot be deleted because it is being used by the VPN. | Delete the subnet that is used by the VPN. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 400 | VPC.0207 | Subnet does not belong to the VPC. | This operation is not allowed because the subnet does not belong to the VPC. | Check whether the subnet is in the VPC. | | | 400 | VPC.0207 | Subnet does not belong to the VPC. | This operation is not allowed because the subnet does not belong to the VPC. | Check whether the subnet is in the VPC. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 500 | VPC.0208 | Subnet is used by private IP, can not be deleted. | The subnet cannot be deleted because it is being used by the private IP address. | Delete the private IP address of the subnet. | | | 500 | VPC.0208 | Subnet is used by private IP, can not be deleted. | The subnet cannot be deleted because it is being used by the private IP address. | Delete the private IP address of the subnet. |
@ -136,6 +134,8 @@ Error Code Description
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 500 | VPC.0211 | subnet is still used by LBaas. | The subnet cannot be deleted because it is being used by load balancers. | Delete load balancers in the subnet. | | | 500 | VPC.0211 | subnet is still used by LBaas. | The subnet cannot be deleted because it is being used by load balancers. | Delete load balancers in the subnet. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| Deleting a subnet | 500 | VPC.0206 | Subnet has been used by VPN, please remove the subnet from the VPN and try again. | The subnet cannot be deleted because it is being used by the VPN. | Delete the subnet that is used by the VPN. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| Updating a subnet | 400 | VPC.0201 | xx is invalid. | Incorrect subnet parameters. | Check whether the parameter values are valid based on the returned error message. | | Updating a subnet | 400 | VPC.0201 | xx is invalid. | Incorrect subnet parameters. | Check whether the parameter values are valid based on the returned error message. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. | | | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. |

View File

@ -8,6 +8,28 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description | | Released On | Description |
+===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| 2024-04-26 | This release incorporates the following changes: |
| | |
| | - Modified descriptions about the response parameter **Tag** in :ref:`Adding a Secondary CIDR Block to a VPC <vpc_apiv3_0007>` and :ref:`Removing a Secondary CIDR Block from a VPC <vpc_apiv3_0008>`. |
| | - Modified the UTC time format of parameters **created_at** and **updated_at** in :ref:`Adding a Secondary CIDR Block to a VPC <vpc_apiv3_0007>` and :ref:`Removing a Secondary CIDR Block from a VPC <vpc_apiv3_0008>`. |
| | - Deleted response parameter **use_default_subnetpool** in :ref:`Subnet <vpc_subnet02_0000>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2024-04-10 | This release incorporates the following changes: |
| | |
| | - Modified the description about request parameter **extend_cidrs** in :ref:`Adding a Secondary CIDR Block to a VPC <vpc_apiv3_0007>`. Added 255.255.255.255/32 as an additional secondary CIDR block that cannot be added to VPCs. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2024-03-28 | This release incorporates the following changes: |
| | |
| | - Modified the description of request parameter **extend_cidrs** and deleted the description indicating only one secondary CIDR block can be added to each VPC in :ref:`Adding a Secondary CIDR Block to a VPC <vpc_apiv3_0007>`. |
| | - Modified the description of request parameter **extend_cidrs** and deleted the description indicating secondary CIDR blocks can only be removed one by one in :ref:`Removing a Secondary CIDR Block from a VPC <vpc_apiv3_0008>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2024-03-11 | This release incorporates the following changes: |
| | |
| | Added the following sections: |
| | |
| | - :ref:`Adding a Secondary CIDR Block to a VPC <vpc_apiv3_0007>` |
| | - :ref:`Removing a Secondary CIDR Block from a VPC <vpc_apiv3_0008>` |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2024-02-02 | This release incorporates the following changes: | | 2024-02-02 | This release incorporates the following changes: |
| | | | | |
| | - Modified the description about parameter **provider:network_type** in :ref:`Network <vpc_network_0000>`. | | | - Modified the description about parameter **provider:network_type** in :ref:`Network <vpc_network_0000>`. |
@ -46,7 +68,7 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-06-20 | This release incorporates the following changes: | | 2023-06-20 | This release incorporates the following changes: |
| | | | | |
| | Modified parameters in :ref:`Deleting an EIP Tag <eip_tag_0003>`. | | | Modified parameters in :ref:`Deleting a Tag from an EIP <eip_tag_0003>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-06-06 | This release incorporates the following changes: | | 2023-06-06 | This release incorporates the following changes: |
| | | | | |
@ -133,7 +155,7 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2020-06-30 | This release incorporates the following changes: | | 2020-06-30 | This release incorporates the following changes: |
| | | | | |
| | - Added the **routes** field in section :ref:`Updating VPC Information <vpc_api01_0004>`. | | | - Added the **routes** field in section :ref:`Updating a VPC <vpc_api01_0004>`. |
| | - Added field **index_enabled** in section :ref:`VPC Flow Log <vpc_flow_0000>`. | | | - Added field **index_enabled** in section :ref:`VPC Flow Log <vpc_flow_0000>`. |
| | - Modified URI parameters in sections :ref:`Querying Security Group Rule Details <vpc_sg01_0006>` and :ref:`Deleting a Security Group Rule <vpc_sg01_0008>`. | | | - Modified URI parameters in sections :ref:`Querying Security Group Rule Details <vpc_sg01_0006>` and :ref:`Deleting a Security Group Rule <vpc_sg01_0008>`. |
| | - Modified description of the **tenant_id** field in section :ref:`Creating a VPC Peering Connection <vpc_peering_0003>`. | | | - Modified description of the **tenant_id** field in section :ref:`Creating a VPC Peering Connection <vpc_peering_0003>`. |

View File

@ -8,7 +8,7 @@ Creating a Firewall Policy
Function Function
-------- --------
This API is used to create a firewall policy. A firewall policy must be associated with a firewall group. You can learn more about the :ref:`relationships among network ACL groups, policies, and rules <en-us_topic_0000001487936070>`. This API is used to create a firewall policy which must be bound to a firewall group. You can learn more about the :ref:`relationships among firewall groups, policies, and rules <en-us_topic_0000001487936070>`.
URI URI
--- ---

View File

@ -16,15 +16,15 @@ You can use **GET /v2.0/networks?router:external=True** or run the **neutron net
Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: 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. - In **eu-de**, no more new EIPs of this type can be assigned. 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. - Existing EIPs of this 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. - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console.
- 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>`__. - 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. - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls.
- You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. - You are advised to bind or unbind BGP EIPs to or 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. - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.
URI URI
--- ---
@ -139,7 +139,6 @@ Normal response to POST requests
"status": "DOWN", "status": "DOWN",
"router_id": null, "router_id": null,
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
"fixed_ip_address": null, "fixed_ip_address": null,
"floating_ip_address": "88.88.215.205", "floating_ip_address": "88.88.215.205",

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