Update content

This commit is contained in:
OpenTelekomCloud Proposal Bot 2024-03-20 03:35:46 +00:00
parent a539bdd666
commit f5fe00c288
32 changed files with 845 additions and 354 deletions

View File

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

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

View File

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

View File

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

View File

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

View File

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

View File

@ -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 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). |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

View File

@ -48,25 +48,25 @@ Request Parameters
.. table:: **Table 3** **subnet** objects
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+===============================================================================+======================================================================================================================================================================================================================================================================================================+
+=================+=================+===============================================================================+=====================================================================================================================================================================================================================================================+
| name | Yes | String | - Specifies the subnet name. |
| | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | No | String | - Provides supplementary information about the subnet. |
| | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | No | Boolean | - Specifies whether an IPv6 subnet can be created. |
| | | | - The value can be **true** (enabled) or **false** (disabled). |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. |
| | | | - The value can be **true** (enabled) or **false** (disabled). |
| | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | - 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. |
| | | | - 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. |
| | | | |
| | | | - The value must be a valid IP address. IPv6 addresses are not supported. |
@ -74,12 +74,12 @@ Request Parameters
| | | | 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. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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:

View File

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

View File

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

View File

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

View File

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

View File

@ -144,7 +144,7 @@ Response Parameters
| Name | Type | Description |
+=======================+=======================+==========================================================================================================================+
| 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. |
| | | - The value must be in CIDR format. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+
| 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. |

View File

@ -8,7 +8,7 @@ Virtual Private Cloud
- :ref:`Creating a VPC <vpc_api01_0001>`
- :ref:`Querying VPC Details <vpc_api01_0002>`
- :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>`
.. toctree::
@ -18,5 +18,5 @@ Virtual Private Cloud
creating_a_vpc
querying_vpc_details
querying_vpcs
updating_vpc_information
updating_a_vpc
deleting_a_vpc

View File

@ -101,7 +101,7 @@ Response Parameters
| Name | Type | Description |
+=======================+=======================+==========================================================================================================================+
| 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. |
| | | - The value must be in CIDR format. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+
| 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. |

View File

@ -32,6 +32,8 @@ Example:
+=======================+=================+=================+=============================================================================================================================================================================================================================================================+
| project_id | Yes | String | Specifies the project ID. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | No | String | Specifies the VPC ID that is used as the filtering condition. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. |
| | | | |
| | | | This parameter can work together with the parameter **limit**. |
@ -122,7 +124,7 @@ Response Parameters
| Name | Type | Description |
+=======================+=======================+==========================================================================================================================+
| 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. |
| | | - The value must be in CIDR format. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+
| 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. |

View File

@ -2,8 +2,8 @@
.. _vpc_api01_0004:
Updating VPC Information
========================
Updating a VPC
==============
Function
--------
@ -83,7 +83,7 @@ Request Parameters
| Name | Mandatory | Type | Description |
+=================+=================+=================+==========================================================================================================================+
| destination | No | 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. |
| | | | - The value must be in CIDR format. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
| nexthop | No | 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. |
@ -165,7 +165,7 @@ Response Parameters
| Name | Type | Description |
+=======================+=======================+==========================================================================================================================+
| 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. |
| | | - The value must be in CIDR format. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+
| 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. |

View File

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

View File

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

View File

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

View File

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

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. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| | 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. |
+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+

View File

@ -8,6 +8,13 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| 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: |
| | |
| | - Modified the description about parameter **provider:network_type** in :ref:`Network <vpc_network_0000>`. |
@ -46,7 +53,7 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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: |
| | |
@ -133,7 +140,7 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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>`. |
| | - 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>`. |

View File

@ -54,64 +54,64 @@ Response Parameters
.. table:: **Table 3** **network** objects
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=========================+=======================+==================================================================================================================================================================================================================+
+=========================+=======================+==========================================================================================================================================================================================================================================================+
| status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. |
| | | |
| | | Only one subnet can be associated with each network. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | Specifies the network name. |
| | | |
| | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| router:external | Boolean | Specifies whether the network is an external network. The default value is **false**. This is an extended attribute. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| admin_state_up | Boolean | Specifies the administrative status. |
| | | |
| | | The value can only be **true**. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| shared | Boolean | Specifies whether the network can be shared by different tenants. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Specifies the network ID. |
| | | |
| | | This parameter is not mandatory when you query networks. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| provider:network_type | String | Specifies the network type. |
| | | |
| | | Only the VXLAN and GENEVE networks are supported. |
| | | |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is **admin_external_net**, set this parameter to **vlan**. |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is preset as **admin_external_net**, this parameter is fixed at **vlan** and cannot be configured. |
| | | |
| | | Note: |
| | | |
| | | - Set this parameter to **geneve** if you want to create GENEVE networks. |
| | | - Do not specify this parameter if you want to create VXLAN networks. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zones | Array of strings | Specifies the availability zone of this network. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. |
| | | |
| | | This parameter is not displayed when an external network is called and the value of **router:external** is **true**. This parameter is visible when the value of **router:external** is **false**. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the network is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the network is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------

View File

@ -105,62 +105,62 @@ Response Parameters
.. table:: **Table 3** **network** object
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=========================+=======================+==================================================================================================================================================================================================================+
+=========================+=======================+==========================================================================================================================================================================================================================================================+
| status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| subnets | Array of strings | Specifies ID of the subnet associated with this network. |
| | | |
| | | Only one subnet can be associated with each network. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | Specifies the network name. |
| | | |
| | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| router:external | Boolean | Specifies whether the network is an external network. The default value is **false**. This is an extended attribute. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| admin_state_up | Boolean | Specifies the administrative status. |
| | | |
| | | The value can only be **true**. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| shared | Boolean | Specifies whether the network can be shared by different tenants. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Specifies the network ID. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| provider:network_type | String | Specifies the network type. |
| | | |
| | | Only the VXLAN and GENEVE networks are supported. |
| | | |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is **admin_external_net**, set this parameter to **vlan**. |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is preset as **admin_external_net**, this parameter is fixed at **vlan** and cannot be configured. |
| | | |
| | | Note: |
| | | |
| | | - Set this parameter to **geneve** if you want to create GENEVE networks. |
| | | - Do not specify this parameter if you want to create VXLAN networks. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zones | Array of strings | Specifies the availability zone of this network. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. |
| | | |
| | | This parameter is not displayed when an external network is called and the value of **router:external** is **true**. This parameter is visible when the value of **router:external** is **false**. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the network is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the network is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_network_0001__table1296611517358:

View File

@ -88,64 +88,64 @@ Response Parameters
.. table:: **Table 5** **network** objects
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=========================+=======================+==================================================================================================================================================================================================================+
+=========================+=======================+==========================================================================================================================================================================================================================================================+
| status | String | Specifies the network status. The value can be **ACTIVE**, **BUILD**, **DOWN**, or **ERROR**. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| subnets | Array of strings | Specifies IDs of the subnets associated with this network. The IDs are in a list. |
| | | |
| | | Only one subnet can be associated with each network. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| name | String | Specifies the network name. |
| | | |
| | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| router:external | Boolean | Specifies whether the network is an external network. The default value is **false**. This is an extended attribute. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| admin_state_up | Boolean | Specifies the administrative status. |
| | | |
| | | The value can only be **true**. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| shared | Boolean | Specifies whether the network can be shared by different tenants. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| id | String | Specifies the network ID. |
| | | |
| | | This parameter is not mandatory when you query networks. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| provider:network_type | String | Specifies the network type. |
| | | |
| | | Only the VXLAN and GENEVE networks are supported. |
| | | |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is **admin_external_net**, set this parameter to **vlan**. |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is preset as **admin_external_net**, this parameter is fixed at **vlan** and cannot be configured. |
| | | |
| | | Note: |
| | | |
| | | - Set this parameter to **geneve** if you want to create GENEVE networks. |
| | | - Do not specify this parameter if you want to create VXLAN networks. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zones | Array of strings | Specifies the availability zone of this network. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. |
| | | |
| | | This parameter is not displayed when an external network is called and the value of **router:external** is **true**. This parameter is visible when the value of **router:external** is **false**. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dns_domain | String | Specifies the default private network DNS domain address. The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the network is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the network is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------

View File

@ -92,7 +92,7 @@ Request Parameters
| | | | |
| | | | The value can only be **true**. |
+------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| use_default_subnetpool | No | Boolean | Specifies whether the default address pool is used. |
| use_default_subnetpool | No | Boolean | Specifies whether to use the default subnet pool. |
| | | | |
| | | | The value can be set to **true** only when IPv6 is used. |
+------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -153,6 +153,7 @@ Create an IPv6 subnet named **subnet-ipv6-test** and with network ID of **0133cd
"enable_dhcp": true,
"ipv6_address_mode": "dhcpv6-stateful",
"ipv6_ra_mode": "dhcpv6-stateful",
"use_default_subnetpool": true
}
}

View File

@ -7,7 +7,7 @@ Introduction
By default, new IAM users do not have permissions assigned. You need to add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups. This way, they can perform specified operations on cloud services based on the permissions.
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query VPCs using an API, the user must have been granted permissions that allow the **vpc:vpcs:list** action.
An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query VPCs using an API, the user must have been granted permissions that allow the **vpc:vpcs:list** action.
Supported Actions
-----------------