diff --git a/api-ref/source/api_v3/index.rst b/api-ref/source/api_v3/index.rst index 93fc855..cf35871 100644 --- a/api-ref/source/api_v3/index.rst +++ b/api-ref/source/api_v3/index.rst @@ -5,6 +5,7 @@ API V3 ====== +- :ref:`VPC ` - :ref:`EIPs ` - :ref:`Common Pools ` @@ -12,5 +13,6 @@ API V3 :maxdepth: 1 :hidden: + vpc/index eips/index common_pools/index diff --git a/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst b/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst new file mode 100644 index 0000000..51a3eba --- /dev/null +++ b/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst @@ -0,0 +1,240 @@ +:original_name: vpc_apiv3_0007.html + +.. _vpc_apiv3_0007: + +Adding a Secondary CIDR Block to a VPC +====================================== + +Function +-------- + +This API is used to add a secondary CIDR block to a VPC. + +URI +--- + +PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/add-extend-cidr + +.. table:: **Table 1** Parameter description + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + vpc_id Yes String VPC ID + ========== ========= ====== =========== + +Request Parameter +----------------- + +.. table:: **Table 2** Request body parameter + + +-----------------+-----------------+--------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+========================================================================================================+==============================================================================================================================================================================================================================================================================================+ + | dry_run | No | Boolean | Whether to only check the request. | + | | | | | + | | | | Value range: | + | | | | | + | | | | - **true**: Only the check request will be sent and no secondary CIDR block will be added. Check items include mandatory parameters, request format, and permission verification. If the check fails, an error will be returned. If the check succeeds, response code 202 will be returned. | + | | | | - **false** (default value): A request will be sent and a secondary CIDR block will be added. | + +-----------------+-----------------+--------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc | Yes | :ref:`AddExtendCidrOption ` object | Request body for adding a secondary CIDR block. | + +-----------------+-----------------+--------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiv3_0007__en-us_topic_0267488960_request_addextendcidroption: + +.. table:: **Table 3** AddExtendCidrOption + + +-----------------+-----------------+------------------+--------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+====================================================================+ + | extend_cidrs | Yes | Array of strings | Secondary CIDR blocks that can be added to VPCs | + | | | | | + | | | | The value cannot contain the following: | + | | | | | + | | | | - 100.64.0.0/10 | + | | | | - 214.0.0.0/7 | + | | | | - 198.18.0.0/15 | + | | | | - 169.254.0.0/16 | + | | | | - 0.0.0.0/8 | + | | | | - 127.0.0.0/8 | + | | | | - 240.0.0.0/4 | + | | | | - 172.31.0.0/16 | + | | | | - 192.168.0.0/16 | + | | | | | + | | | | Currently, only one secondary CIDR block can be added to each VPC. | + +-----------------+-----------------+------------------+--------------------------------------------------------------------+ + +Example Request +--------------- + +- Add a secondary CIDR block 23.8.0.0/16 to the VPC whose ID is 99d9d709-8478-4b46-9f3f-2206b1023fd3. + + .. code-block:: text + + PUT https://{Endpoint}/v3/{project_id}/vpc/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3/add-extend-cidr + + { + "vpc": { + "extend_cidrs": [ + "23.8.0.0/16" + ] + } + } + +Response Parameter +------------------ + +.. table:: **Table 4** Response body parameters + + +------------+-------------------------------------------------------------------------+------------------------------------------------+ + | Parameter | Type | Description | + +============+=========================================================================+================================================+ + | request_id | String | Request ID | + +------------+-------------------------------------------------------------------------+------------------------------------------------+ + | vpc | :ref:`Vpc ` object | Response body of adding a secondary CIDR block | + +------------+-------------------------------------------------------------------------+------------------------------------------------+ + +.. _vpc_apiv3_0007__en-us_topic_0267488960_response_vpc: + +.. table:: **Table 5** Vpc + + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================================================================================================+================================================================================================================================================================+ + | id | String | VPC ID, which uniquely identifies the VPC | + | | | | + | | | The value is in UUID format with hyphens (-). | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | VPC name | + | | | | + | | | The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC. | + | | | | + | | | The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Available VPC CIDR blocks | + | | | | + | | | Value range: | + | | | | + | | | - 10.0.0.0/8-10.255.255.240/28 | + | | | - 172.16.0.0/12-172.31.255.240/28 | + | | | - 192.168.0.0/16-192.168.255.240/28 | + | | | | + | | | If **cidr** is not specified, the default value is **""**. | + | | | | + | | | The value must be in IPv4 CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extend_cidrs | Array of strings | Secondary CIDR blocks of VPCs | + | | | | + | | | Currently, only IPv4 CIDR blocks are supported. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | VPC status | + | | | | + | | | Value range: | + | | | | + | | | - **PENDING**: The VPC is being created. | + | | | - **ACTIVE**: The VPC is created successfully. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | ID of the project to which the VPC belongs | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project to which the VPC belongs | + | | | | + | | | The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the VPC is created | + | | | | + | | | UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the VPC is updated | + | | | | + | | | UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cloud_resources | Array of :ref:`CloudResource ` objects | Type and number of resources associated with the VPC | + | | | | + | | | Currently, only route tables and subnets of the VPC are returned. The number of **virsubnets** is the total number of IPv4 and IPv6 subnets. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | VPC tags. For details, see the tag objects. | + | | | | + | | | Value range: 0 to 10 tag key-value pairs | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiv3_0007__en-us_topic_0267488960_response_cloudresource: + +.. table:: **Table 6** CloudResource + + ============== ======= =================== + Parameter Type Description + ============== ======= =================== + resource_type String Resource type + resource_count Integer Number of resources + ============== ======= =================== + +.. _vpc_apiv3_0007__en-us_topic_0267488960_response_tag: + +.. table:: **Table 7** Tag + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==============================================================================================================================================+ + | key | String | Tag key | + | | | | + | | | Value range: | + | | | | + | | | - A tag key contains a maximum of 36 Unicode characters. | + | | | - A tag key cannot be left blank. It cannot contain non-printable ASCII characters (0-31) or the following special characters: ``*,<,>,,=`` | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | value | String | Tag value | + | | | | + | | | Value range: | + | | | | + | | | - A tag value contains a maximum of 43 Unicode characters and can be left blank. | + | | | - A tag value cannot contain non-printable ASCII characters (0-31) or the following special characters: ``*,<,>,,=`` | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "request_id": "84eb4f775d66dd916db121768ec55626", + "vpc": { + "id": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", + "name": "vpc1", + "description": "test1", + "cidr": "192.168.0.0/16", + "extend_cidrs": [ + "23.8.0.0/16" + ], + "enterprise_project_id": "0", + "tags": [ + { + "key": "key", + "value": "value" + } + ], + "cloud_resources": [ + { + "resource_type": "routetable", + "resource_count": 1 + } + ], + "status": "ACTIVE", + "project_id": "060576782980d5762f9ec014dd2f1148", + "created_at": "2018-03-23T09:26:08", + "updated_at": "2018-08-24T08:49:53" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/api_v3/vpc/index.rst b/api-ref/source/api_v3/vpc/index.rst new file mode 100644 index 0000000..5c9d4d9 --- /dev/null +++ b/api-ref/source/api_v3/vpc/index.rst @@ -0,0 +1,16 @@ +:original_name: vpc_apiv3_0001.html + +.. _vpc_apiv3_0001: + +VPC +=== + +- :ref:`Adding a Secondary CIDR Block to a VPC ` +- :ref:`Removing a Secondary CIDR Block from a VPC ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + adding_a_secondary_cidr_block_to_a_vpc + removing_a_secondary_cidr_block_from_a_vpc diff --git a/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst b/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst new file mode 100644 index 0000000..a87c477 --- /dev/null +++ b/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst @@ -0,0 +1,231 @@ +:original_name: vpc_apiv3_0008.html + +.. _vpc_apiv3_0008: + +Removing a Secondary CIDR Block from a VPC +========================================== + +Function +-------- + +This API is used to remove a secondary CIDR block from a VPC. + +URI +--- + +PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/remove-extend-cidr + +.. table:: **Table 1** Parameter description + + ========== ========= ====== =========== + Parameter Mandatory Type Description + ========== ========= ====== =========== + project_id Yes String Project ID. + vpc_id Yes String VPC ID + ========== ========= ====== =========== + +Request Parameter +----------------- + +.. table:: **Table 2** Request body parameter + + +-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==============================================================================================================+==============================================================================================================================================================================================================================================================================================+ + | dry_run | No | Boolean | Whether to only check the request. | + | | | | | + | | | | Value range: | + | | | | | + | | | | - **true**: Only the check request will be sent and no secondary CIDR block will be added. Check items include mandatory parameters, request format, and permission verification. If the check fails, an error will be returned. If the check succeeds, response code 202 will be returned. | + | | | | - **false** (default value): A request will be sent and a secondary CIDR block will be added. | + +-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc | Yes | :ref:`RemoveExtendCidrOption ` object | Request body for removing a secondary CIDR block | + +-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiv3_0008__en-us_topic_0267488922_request_removeextendcidroption: + +.. table:: **Table 3** RemoveExtendCidrOption + + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+========================================================================================+ + | extend_cidrs | Yes | Array of strings | Secondary CIDR blocks that can be removed from VPCs | + | | | | | + | | | | VPCs already have secondary CIDR blocks. | + | | | | | + | | | | Constraints: | + | | | | | + | | | | - Before removing a secondary CIDR block, delete the subnets in the CIDR block first. | + | | | | - Currently, secondary CIDR blocks can only be removed one by one. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------+ + +Example Request +--------------- + +- Remove the secondary CIDR block 23.8.0.0/16 from the VPC whose ID is 99d9d709-8478-4b46-9f3f-2206b1023fd3. + +.. code-block:: text + + PUT https://{Endpoint}/v3/{project_id}/vpc/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3/remove-extend-cidr + + { + "vpc": { + "extend_cidrs": [ + "23.8.0.0/16" + ] + } + } + +Response Parameter +------------------ + +.. table:: **Table 4** Response body parameters + + +------------+-------------------------------------------------------------------------+--------------------------------------------------+ + | Parameter | Type | Description | + +============+=========================================================================+==================================================+ + | request_id | String | Request ID | + +------------+-------------------------------------------------------------------------+--------------------------------------------------+ + | vpc | :ref:`Vpc ` object | Response body of removing a secondary CIDR block | + +------------+-------------------------------------------------------------------------+--------------------------------------------------+ + +.. _vpc_apiv3_0008__en-us_topic_0267488960_response_vpc: + +.. table:: **Table 5** Vpc + + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================================================================================================+================================================================================================================================================================+ + | id | String | VPC ID, which uniquely identifies the VPC | + | | | | + | | | The value is in UUID format with hyphens (-). | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | VPC name | + | | | | + | | | The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC. | + | | | | + | | | The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Available VPC CIDR blocks | + | | | | + | | | Value range: | + | | | | + | | | - 10.0.0.0/8-10.255.255.240/28 | + | | | - 172.16.0.0/12-172.31.255.240/28 | + | | | - 192.168.0.0/16-192.168.255.240/28 | + | | | | + | | | If **cidr** is not specified, the default value is **""**. | + | | | | + | | | - The value must be in IPv4 CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extend_cidrs | Array of strings | Secondary CIDR blocks of VPCs | + | | | | + | | | Currently, only IPv4 CIDR blocks are supported. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | VPC status | + | | | | + | | | Value range: | + | | | | + | | | - **PENDING**: The VPC is being created. | + | | | - **ACTIVE**: The VPC is created successfully. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | ID of the project to which the VPC belongs | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | ID of the enterprise project to which the VPC belongs | + | | | | + | | | The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Time when the VPC is created | + | | | | + | | | UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Time when the VPC is updated | + | | | | + | | | UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cloud_resources | Array of :ref:`CloudResource ` objects | Type and number of resources associated with the VPC | + | | | | + | | | Currently, only route tables and subnets of the VPC are returned. The number of **virsubnets** is the total number of IPv4 and IPv6 subnets. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tags | Array of :ref:`Tag ` objects | VPC tags. For details, see the tag objects. | + | | | | + | | | Value range: 0 to 10 tag key-value pairs | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiv3_0008__en-us_topic_0267488960_response_cloudresource: + +.. table:: **Table 6** CloudResource + + ============== ======= =================== + Parameter Type Description + ============== ======= =================== + resource_type String Resource type + resource_count Integer Number of resources + ============== ======= =================== + +.. _vpc_apiv3_0008__en-us_topic_0267488960_response_tag: + +.. table:: **Table 7** Tag + + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==============================================================================================================================================+ + | key | String | Tag key | + | | | | + | | | Value range: | + | | | | + | | | - A tag key contains a maximum of 36 Unicode characters. | + | | | - A tag key cannot be left blank. It cannot contain non-printable ASCII characters (0-31) or the following special characters: ``*,<,>,,=`` | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + | value | String | Tag value | + | | | | + | | | Value range: | + | | | | + | | | - A tag value contains a maximum of 43 Unicode characters and can be left blank. | + | | | - A tag value cannot contain non-printable ASCII characters (0-31) or the following special characters: ``*,<,>,,=`` | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "request_id": "84eb4f775d66dd916db121768ec55626", + "vpc": { + "id": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", + "name": "vpc1", + "description": "test1", + "cidr": "192.168.0.0/16", + "extend_cidrs": [ ], + "enterprise_project_id": "0", + "tags": [ + { + "key": "key", + "value": "value" + } + ], + "cloud_resources": [ + { + "resource_type": "routetable", + "resource_count": 1 + } + ], + "status": "ACTIVE", + "project_id": "060576782980d5762f9ec014dd2f1148", + "created_at": "2018-03-23T09:26:08", + "updated_at": "2018-08-24T08:49:53" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/eip_tag_management/creating_a_tag_for_an_eip.rst b/api-ref/source/apis/eip_tag_management/adding_a_tag_to_an_eip.rst similarity index 98% rename from api-ref/source/apis/eip_tag_management/creating_a_tag_for_an_eip.rst rename to api-ref/source/apis/eip_tag_management/adding_a_tag_to_an_eip.rst index a2a103e..508376f 100644 --- a/api-ref/source/apis/eip_tag_management/creating_a_tag_for_an_eip.rst +++ b/api-ref/source/apis/eip_tag_management/adding_a_tag_to_an_eip.rst @@ -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 --- diff --git a/api-ref/source/apis/eip_tag_management/batch_creating_or_deleting_eip_tags.rst b/api-ref/source/apis/eip_tag_management/batch_adding_or_deleting_eip_tags.rst similarity index 99% rename from api-ref/source/apis/eip_tag_management/batch_creating_or_deleting_eip_tags.rst rename to api-ref/source/apis/eip_tag_management/batch_adding_or_deleting_eip_tags.rst index 679f39e..265a2ca 100644 --- a/api-ref/source/apis/eip_tag_management/batch_creating_or_deleting_eip_tags.rst +++ b/api-ref/source/apis/eip_tag_management/batch_adding_or_deleting_eip_tags.rst @@ -2,8 +2,8 @@ .. _eip_tag_0004: -Batch Creating or Deleting EIP Tags -=================================== +Batch Adding or Deleting EIP Tags +================================= Function -------- diff --git a/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst b/api-ref/source/apis/eip_tag_management/deleting_a_tag_from_an_eip.rst similarity index 92% rename from api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst rename to api-ref/source/apis/eip_tag_management/deleting_a_tag_from_an_eip.rst index 4010acc..bf65cd0 100644 --- a/api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst +++ b/api-ref/source/apis/eip_tag_management/deleting_a_tag_from_an_eip.rst @@ -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 --- diff --git a/api-ref/source/apis/eip_tag_management/index.rst b/api-ref/source/apis/eip_tag_management/index.rst index 64686a9..47aa730 100644 --- a/api-ref/source/apis/eip_tag_management/index.rst +++ b/api-ref/source/apis/eip_tag_management/index.rst @@ -5,10 +5,10 @@ EIP Tag Management ================== -- :ref:`Creating a Tag for an EIP ` +- :ref:`Adding a Tag to an EIP ` - :ref:`Querying EIP Tags ` -- :ref:`Deleting an EIP Tag ` -- :ref:`Batch Creating or Deleting EIP Tags ` +- :ref:`Deleting a Tag from an EIP ` +- :ref:`Batch Adding or Deleting EIP Tags ` - :ref:`Querying EIPs by Tag ` - :ref:`Querying EIP Tags in a Specified Project ` @@ -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 diff --git a/api-ref/source/apis/quota/querying_quotas.rst b/api-ref/source/apis/quota/querying_quotas.rst index 077abd4..3bf9f75 100644 --- a/api-ref/source/apis/quota/querying_quotas.rst +++ b/api-ref/source/apis/quota/querying_quotas.rst @@ -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,13 +219,7 @@ Example Response "used": 0, "quota": 200, "min": 0 - }, - { - "type": "address_group", - "used": 0, - "quota": 50, - "min": 0 - } + } ] } } diff --git a/api-ref/source/apis/subnet/creating_a_subnet.rst b/api-ref/source/apis/subnet/creating_a_subnet.rst index ab4230b..43c0398 100644 --- a/api-ref/source/apis/subnet/creating_a_subnet.rst +++ b/api-ref/source/apis/subnet/creating_a_subnet.rst @@ -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). | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/subnet/updating_subnet_information.rst b/api-ref/source/apis/subnet/updating_subnet_information.rst index 9f94ab5..261b59b 100644 --- a/api-ref/source/apis/subnet/updating_subnet_information.rst +++ b/api-ref/source/apis/subnet/updating_subnet_information.rst @@ -48,38 +48,38 @@ 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. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | - | | | | | - | | | | 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 ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + | | | | | + | | | | 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 ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet01_0004__table019517383270: diff --git a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst b/api-ref/source/apis/subnet_tag_management/adding_a_tag_to_a_subnet.rst similarity index 98% rename from api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst rename to api-ref/source/apis/subnet_tag_management/adding_a_tag_to_a_subnet.rst index 6a6977e..f21de13 100644 --- a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst +++ b/api-ref/source/apis/subnet_tag_management/adding_a_tag_to_a_subnet.rst @@ -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 --- diff --git a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst b/api-ref/source/apis/subnet_tag_management/batch_adding_or_deleting_subnet_tags.rst similarity index 99% rename from api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst rename to api-ref/source/apis/subnet_tag_management/batch_adding_or_deleting_subnet_tags.rst index 21a2b7a..1777db8 100644 --- a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst +++ b/api-ref/source/apis/subnet_tag_management/batch_adding_or_deleting_subnet_tags.rst @@ -2,8 +2,8 @@ .. _subnet_tag_0004: -Batch Creating or Deleting Subnet Tags -====================================== +Batch Adding or Deleting Subnet Tags +==================================== Function -------- diff --git a/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst b/api-ref/source/apis/subnet_tag_management/deleting_a_tag_from_a_subnet.rst similarity index 95% rename from api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst rename to api-ref/source/apis/subnet_tag_management/deleting_a_tag_from_a_subnet.rst index 9002e41..8da67ac 100644 --- a/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst +++ b/api-ref/source/apis/subnet_tag_management/deleting_a_tag_from_a_subnet.rst @@ -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 --- diff --git a/api-ref/source/apis/subnet_tag_management/index.rst b/api-ref/source/apis/subnet_tag_management/index.rst index a6d0552..14f91eb 100644 --- a/api-ref/source/apis/subnet_tag_management/index.rst +++ b/api-ref/source/apis/subnet_tag_management/index.rst @@ -5,10 +5,10 @@ Subnet Tag Management ===================== -- :ref:`Creating a Tag for a Subnet ` +- :ref:`Adding a Tag to a Subnet ` - :ref:`Querying Subnet Tags ` -- :ref:`Deleting a Subnet Tag ` -- :ref:`Batch Creating or Deleting Subnet Tags ` +- :ref:`Deleting a Tag from a Subnet ` +- :ref:`Batch Adding or Deleting Subnet Tags ` - :ref:`Querying Subnets by Tag ` - :ref:`Querying Subnet Tags in a Specified Project ` @@ -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 diff --git a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst index 2859909..387c935 100644 --- a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst @@ -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. | diff --git a/api-ref/source/apis/virtual_private_cloud/index.rst b/api-ref/source/apis/virtual_private_cloud/index.rst index 52019c3..db8c15c 100644 --- a/api-ref/source/apis/virtual_private_cloud/index.rst +++ b/api-ref/source/apis/virtual_private_cloud/index.rst @@ -8,7 +8,7 @@ Virtual Private Cloud - :ref:`Creating a VPC ` - :ref:`Querying VPC Details ` - :ref:`Querying VPCs ` -- :ref:`Updating VPC Information ` +- :ref:`Updating a VPC ` - :ref:`Deleting a VPC ` .. 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 diff --git a/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst b/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst index 7cc6efe..4cd4b43 100644 --- a/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst +++ b/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst @@ -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. | diff --git a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst index a569f8c..a1e252b 100644 --- a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst +++ b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst @@ -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. | diff --git a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst b/api-ref/source/apis/virtual_private_cloud/updating_a_vpc.rst similarity index 98% rename from api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst rename to api-ref/source/apis/virtual_private_cloud/updating_a_vpc.rst index 8a6812d..39f198d 100644 --- a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst +++ b/api-ref/source/apis/virtual_private_cloud/updating_a_vpc.rst @@ -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. | diff --git a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst b/api-ref/source/apis/vpc_tag_management/adding_a_tag_to_a_vpc.rst similarity index 98% rename from api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst rename to api-ref/source/apis/vpc_tag_management/adding_a_tag_to_a_vpc.rst index f659931..134fcf3 100644 --- a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst +++ b/api-ref/source/apis/vpc_tag_management/adding_a_tag_to_a_vpc.rst @@ -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 --- diff --git a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst b/api-ref/source/apis/vpc_tag_management/batch_adding_or_deleting_vpc_tags.rst similarity index 99% rename from api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst rename to api-ref/source/apis/vpc_tag_management/batch_adding_or_deleting_vpc_tags.rst index 0f5f0f9..70a80cd 100644 --- a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst +++ b/api-ref/source/apis/vpc_tag_management/batch_adding_or_deleting_vpc_tags.rst @@ -2,8 +2,8 @@ .. _vpc_tag_0004: -Batch Creating or Deleting VPC Tags -=================================== +Batch Adding or Deleting VPC Tags +================================= Function -------- diff --git a/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst b/api-ref/source/apis/vpc_tag_management/deleting_a_tag_from_a_vpc.rst similarity index 93% rename from api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst rename to api-ref/source/apis/vpc_tag_management/deleting_a_tag_from_a_vpc.rst index 39000b1..b5af488 100644 --- a/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst +++ b/api-ref/source/apis/vpc_tag_management/deleting_a_tag_from_a_vpc.rst @@ -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 --- diff --git a/api-ref/source/apis/vpc_tag_management/index.rst b/api-ref/source/apis/vpc_tag_management/index.rst index 96958fe..fc82a8a 100644 --- a/api-ref/source/apis/vpc_tag_management/index.rst +++ b/api-ref/source/apis/vpc_tag_management/index.rst @@ -5,10 +5,10 @@ VPC Tag Management ================== -- :ref:`Creating a Tag for a VPC ` +- :ref:`Adding a Tag to a VPC ` - :ref:`Querying VPC Tags ` -- :ref:`Deleting a VPC Tag ` -- :ref:`Batch Creating or Deleting VPC Tags ` +- :ref:`Deleting a Tag from a VPC ` +- :ref:`Batch Adding or Deleting VPC Tags ` - :ref:`Querying VPCs by Tag ` - :ref:`Querying VPC Tags in a Specified Project ` @@ -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 diff --git a/api-ref/source/appendix/error_codes.rst b/api-ref/source/appendix/error_codes.rst index a91c9e7..568324c 100644 --- a/api-ref/source/appendix/error_codes.rst +++ b/api-ref/source/appendix/error_codes.rst @@ -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. | +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 9e58222..53c6028 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -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 ` | +| | - :ref:`Removing a Secondary CIDR Block from a VPC ` | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2024-02-02 | This release incorporates the following changes: | | | | | | - Modified the description about parameter **provider:network_type** in :ref:`Network `. | @@ -46,7 +53,7 @@ Change History +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-06-20 | This release incorporates the following changes: | | | | -| | Modified parameters in :ref:`Deleting an EIP Tag `. | +| | Modified parameters in :ref:`Deleting a Tag from an EIP `. | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 `. | +| | - Added the **routes** field in section :ref:`Updating a VPC `. | | | - Added field **index_enabled** in section :ref:`VPC Flow Log `. | | | - Modified URI parameters in sections :ref:`Querying Security Group Rule Details ` and :ref:`Deleting a Security Group Rule `. | | | - Modified description of the **tenant_id** field in section :ref:`Creating a VPC Peering Connection `. | diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst index 70d8443..f77856e 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst @@ -30,32 +30,32 @@ Request Parameters .. table:: **Table 2** **network** objects - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=======================+=================+=================+==================================================================================================================================================================================================================+ - | name | No | String | Specifies the network name. | - | | | | | - | | | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies the administrative status. | - | | | | | - | | | | The value can only be **true**. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared | No | Boolean | Specifies whether the network can be shared by different tenants. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | provider:network_type | No | 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**. | - | | | | | - | | | | 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. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=======================+=================+=================+==========================================================================================================================================================================================================================================================+ + | name | No | String | Specifies the network name. | + | | | | | + | | | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). | + +-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | No | Boolean | Specifies the administrative status. | + | | | | | + | | | | The value can only be **true**. | + +-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | shared | No | Boolean | Specifies whether the network can be shared by different tenants. | + +-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | provider:network_type | No | 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 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. | + +-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. | + +-----------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request --------------- @@ -89,64 +89,64 @@ Response Parameters .. table:: **Table 4** **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**. | - | | | | - | | | 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* | - +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 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 ---------------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst index 082f21a..436ff86 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst @@ -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**. | - | | | | - | | | 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* | - +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 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 ---------------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst index 9b4419a..9722e48 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst @@ -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**. | - | | | | - | | | 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* | - +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 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: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst index 88020d4..857f8d8 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst @@ -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**. | - | | | | - | | | 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* | - +-------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 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 ---------------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst index 9023e2b..4d0ab64 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst @@ -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 } } diff --git a/api-ref/source/permissions_policies_and_supported_actions/introduction.rst b/api-ref/source/permissions_policies_and_supported_actions/introduction.rst index 4db4af5..9cc42a5 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/introduction.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/introduction.rst @@ -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 -----------------