diff --git a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst index 2f7ed03..b81da2a 100644 --- a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst @@ -117,26 +117,26 @@ Response Message .. table:: **Table 4** **publicip_info** object - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | - Specifies the IP address version. | - | | | - Possible values are as follows: | - | | | | - | | | - **4**: IPv4 | - | | | - **6**: IPv6 (IPv6 is not supported currently.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - Specifies the IP address version. | + | | | - Possible values are as follows: | + | | | | + | | | - **4**: IPv4 | + | | | - **6**: IPv6 (IPv6 is not supported currently.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/bandwidth/querying_bandwidths.rst b/api-ref/source/apis/bandwidth/querying_bandwidths.rst index 9a0f4f9..1aa0607 100644 --- a/api-ref/source/apis/bandwidth/querying_bandwidths.rst +++ b/api-ref/source/apis/bandwidth/querying_bandwidths.rst @@ -20,11 +20,11 @@ GET /v1/{project_id}/bandwidths Request Message --------------- -- Request parameter +- Query parameters .. _vpc_bandwidth_0002__table62833603: - .. table:: **Table 1** Request parameters + .. table:: **Table 1** Query parameters +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -134,20 +134,20 @@ Response Message .. table:: **Table 4** **publicip_info** object - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst index 9f01c78..03b7e35 100644 --- a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst @@ -150,20 +150,20 @@ Response Message .. table:: **Table 6** **publicip_info** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst index 79ce6ed..f273d0d 100644 --- a/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst @@ -57,18 +57,18 @@ Request Message .. table:: **Table 4** **publicip_info** object - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================================================+ - | publicip_id | Yes | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_type | No | String | - Specifies the EIP type. | - | | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | - | | | | - Constraints: | - | | | | | - | | | | - The configured value must be supported by the system. | - | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+=================================================================================================================+ + | publicip_id | Yes | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | No | String | - Specifies the EIP type. | + | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | | - Constraints: | + | | | | | + | | | | - The configured value must be supported by the system. | + | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ - Example request @@ -153,26 +153,26 @@ Response Message .. table:: **Table 7** **publicip_info** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | - Specifies the IP address version. | - | | | - Possible values are as follows: | - | | | | - | | | - **4**: IPv4 | - | | | - **6**: IPv6 (IPv6 is not supported currently.) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | - Specifies the IP address version. | + | | | - Possible values are as follows: | + | | | | + | | | - **4**: IPv4 | + | | | - **6**: IPv6 (IPv6 is not supported currently.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst index 2a3076b..20694d1 100644 --- a/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst @@ -153,20 +153,20 @@ Response Message .. table:: **Table 6** **publicip_info** object - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===============================================================================================================+ - | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | - | | | - Constraints: | - | | | | - | | | - The configured value must be supported by the system. | - | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=================================================================================================================+ + | publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ + | publicip_type | String | - Specifies the EIP type. | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | + | | | - Constraints: | + | | | | + | | | - The configured value must be supported by the system. | + | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - Example response diff --git a/api-ref/source/apis/eip/assigning_an_eip.rst b/api-ref/source/apis/eip/assigning_an_eip.rst index 8397561..ddf8dae 100644 --- a/api-ref/source/apis/eip/assigning_an_eip.rst +++ b/api-ref/source/apis/eip/assigning_an_eip.rst @@ -48,21 +48,13 @@ Request Parameters .. table:: **Table 2** Request body parameter - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=======================+=================+=================================================================+==================================================================================================================================================+ - | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth object. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | - | | | | - When you assign an EIP, associate an enterprise project ID with the EIP. | - | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------+-----------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===========+===========+=================================================================+==========================================================================================================+ + | publicip | Yes | :ref:`publicip ` object | Specifies the EIP object. For details, see :ref:`Table 3 `. | + +-----------+-----------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ + | bandwidth | Yes | :ref:`bandwidth ` object | Specifies the bandwidth object. For details, see :ref:`Table 4 `. | + +-----------+-----------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020090596__table4491214: @@ -72,7 +64,7 @@ Request Parameters | Name | Mandatory | Type | Description | +=================+=================+=================+===============================================================================================================================+ | type | Yes | String | - Specifies the EIP type. | - | | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | + | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | | | | | - Constraints: | | | | | | | | | | - The configured value must be supported by the system. | @@ -182,7 +174,7 @@ Response Message | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/eip/querying_an_eip.rst b/api-ref/source/apis/eip/querying_an_eip.rst index 2b8376e..5a21e67 100644 --- a/api-ref/source/apis/eip/querying_an_eip.rst +++ b/api-ref/source/apis/eip/querying_an_eip.rst @@ -99,7 +99,7 @@ Response Message | | | This parameter is not supported currently. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | @@ -152,6 +152,15 @@ Response Message | | | | | | | This parameter is unsupported. Do not use it. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | Specifies whether it is in a central site or an edge site. | + | | | | + | | | The value can be: | + | | | | + | | | - center | + | | | - *Edge site name* | + | | | | + | | | An EIP can only be bound to a resource of the same region. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_eip_0002__table66651219193417: diff --git a/api-ref/source/apis/eip/querying_eips.rst b/api-ref/source/apis/eip/querying_eips.rst index be19c90..e9ed689 100644 --- a/api-ref/source/apis/eip/querying_eips.rst +++ b/api-ref/source/apis/eip/querying_eips.rst @@ -115,7 +115,7 @@ Response Message | | | This parameter is not supported currently. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | @@ -168,6 +168,15 @@ Response Message | | | | | | | This parameter is unsupported. Do not use it. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | Specifies whether it is in a central site or an edge site. | + | | | | + | | | The value can be: | + | | | | + | | | - center | + | | | - *Edge site name* | + | | | | + | | | An EIP can only be bound to a resource of the same region. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_eip_0003__table66651219193417: diff --git a/api-ref/source/apis/eip/updating_an_eip.rst b/api-ref/source/apis/eip/updating_an_eip.rst index 15e7b55..7e793e7 100644 --- a/api-ref/source/apis/eip/updating_an_eip.rst +++ b/api-ref/source/apis/eip/updating_an_eip.rst @@ -128,7 +128,7 @@ Response Message | | | This parameter is not supported currently. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | + | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | @@ -179,6 +179,15 @@ Response Message | | | | | | | This parameter is unsupported. Do not use it. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | public_border_group | String | Specifies whether it is in a central site or an edge site. | + | | | | + | | | The value can be: | + | | | | + | | | - center | + | | | - *Edge site name* | + | | | | + | | | An EIP can only be bound to a resource of the same region. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_eip_0004__table66651219193417: diff --git a/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst b/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst index 40652a6..3b29478 100644 --- a/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst +++ b/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst @@ -125,7 +125,7 @@ Response Parameters | | | | | | | **network:endpoint_interface**: IP address of a VPC endpoint | | | | | - | | | **network: nat_gateway**: IP address used by a NAT gateway | + | | | **network:nat_gateway**: IP address used by a NAT gateway | | | | | | | | - The value range specifies only the type of private IP addresses supported by the current service. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst b/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst index 2e95333..9dd4206 100644 --- a/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst +++ b/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst @@ -49,9 +49,7 @@ None Example Response ---------------- -.. code-block:: text - - None +None Status Code ----------- diff --git a/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst b/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst index 3368ffb..3c18e17 100644 --- a/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst +++ b/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst @@ -91,7 +91,7 @@ Response Parameters | | | | | | | **network:endpoint_interface**: IP address of a VPC endpoint | | | | | - | | | **network: nat_gateway**: IP address used by a NAT gateway | + | | | **network:nat_gateway**: IP address used by a NAT gateway | | | | | | | | - The value range specifies only the type of private IP addresses supported by the current service. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst b/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst index 3074989..a550eff 100644 --- a/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst +++ b/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst @@ -112,7 +112,7 @@ Response Parameters | | | | | | | **network:endpoint_interface**: IP address of a VPC endpoint | | | | | - | | | **network: nat_gateway**: IP address used by a NAT gateway | + | | | **network:nat_gateway**: IP address used by a NAT gateway | | | | | | | | - The value range specifies only the type of private IP addresses supported by the current service. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/quota/querying_quotas.rst b/api-ref/source/apis/quota/querying_quotas.rst index 7b3bb32..3bf9f75 100644 --- a/api-ref/source/apis/quota/querying_quotas.rst +++ b/api-ref/source/apis/quota/querying_quotas.rst @@ -43,7 +43,7 @@ Example: | | | | - **vpn**: VPN | | | | | - **vpcPeer**: VPC peering connection | | | | | - **loadbalancer**: Load balancer | - | | | | - **listener**: Listener | + | | | | - **listener**: Load balancer listener | | | | | - **physicalConnect**: Direct Connect connection | | | | | - **virtualInterface**: Virtual interface | | | | | - **firewall**: Firewall | @@ -105,7 +105,7 @@ Response Parameters | | | - **vpn**: VPN | | | | - **vpcPeer**: VPC peering connection | | | | - **loadbalancer**: Load balancer | - | | | - **listener**: Listener | + | | | - **listener**: Load balancer listener | | | | - **physicalConnect**: Direct Connect connection | | | | - **virtualInterface**: Virtual interface | | | | - **firewall**: Firewall | diff --git a/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst b/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst index c0d6409..764281e 100644 --- a/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst +++ b/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst @@ -46,12 +46,12 @@ Request Parameters .. table:: **Table 3** Description of the **routetable** field - +-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+==================================================================+=====================================================================================================+ - | subnets | Yes | :ref:`subnet ` object | - Specifies the subnets associated with the route table. | - | | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | - +-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==================================================================+==================================================================================================================+ + | subnets | Yes | :ref:`subnet ` object | - Specifies the subnets associated with the route table. | + | | | | - Only subnets (network IDs) in the VPC that the route table belongs to can be associated with the route table. | + +-----------------+-----------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0005__table12518142212468: @@ -142,7 +142,6 @@ Response Parameters | | | - **peering** (VPC peering connection) | | | | - **vpn** (VPN) | | | | - **dc** (Direct Connect connection) | - | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ @@ -159,7 +158,6 @@ Response Parameters | | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | - When **type** is **vpn**, the value is the VPN ID. | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/route_table/creating_a_route_table.rst b/api-ref/source/apis/route_table/creating_a_route_table.rst index 770edba..d920568 100644 --- a/api-ref/source/apis/route_table/creating_a_route_table.rst +++ b/api-ref/source/apis/route_table/creating_a_route_table.rst @@ -80,7 +80,6 @@ Request Parameters | | | | - **peering** (VPC peering connection) | | | | | - **vpn** (VPN) | | | | | - **dc** (Direct Connect connection) | - | | | | - **cc** (Cloud Connect connection) | | | | | - **egw**: VPC endpoint node | | | | | - **er**: enterprise router | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ @@ -97,7 +96,6 @@ Request Parameters | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | | - When **type** is **vpn**, the value is the VPN ID. | | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ @@ -169,6 +167,12 @@ Response Parameters | description | String | - Provides supplementary information about the route table. | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 7** Description of the **route** field @@ -185,7 +189,6 @@ Response Parameters | | | - **peering** (VPC peering connection) | | | | - **vpn** (VPN) | | | | - **dc** (Direct Connect connection) | - | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ @@ -202,7 +205,6 @@ Response Parameters | | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | - When **type** is **vpn**, the value is the VPN ID. | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst b/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst index 9644304..83227aa 100644 --- a/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst +++ b/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst @@ -146,7 +146,6 @@ Response Parameters | | | - **peering** (VPC peering connection) | | | | - **vpn** (VPN) | | | | - **dc** (Direct Connect connection) | - | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ @@ -163,7 +162,6 @@ Response Parameters | | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | - When **type** is **vpn**, the value is the VPN ID. | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/route_table/querying_a_route_table.rst b/api-ref/source/apis/route_table/querying_a_route_table.rst index 55bedb7..8390c05 100644 --- a/api-ref/source/apis/route_table/querying_a_route_table.rst +++ b/api-ref/source/apis/route_table/querying_a_route_table.rst @@ -81,6 +81,12 @@ Response Parameters | description | String | - Provides supplementary information about the route table. | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0002__table1687317463915: @@ -99,7 +105,6 @@ Response Parameters | | | - **peering** (VPC peering connection) | | | | - **vpn** (VPN) | | | | - **dc** (Direct Connect connection) | - | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ @@ -116,7 +121,6 @@ Response Parameters | | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | - When **type** is **vpn**, the value is the VPN ID. | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ @@ -180,7 +184,9 @@ Example Response ], "vpc_id": "7978e43c-f892-49d8-9fab-9bb90a51709b", "default": true, - "tenant_id": "05e369f07a800f802f41c002632ba5f9" + "tenant_id": "05e369f07a800f802f41c002632ba5f9", + "created_at": "2022-12-15T02:56:40", + "updated_at": "2022-12-15T02:56:40" } } diff --git a/api-ref/source/apis/route_table/querying_route_tables.rst b/api-ref/source/apis/route_table/querying_route_tables.rst index 434c102..bc1dc28 100644 --- a/api-ref/source/apis/route_table/querying_route_tables.rst +++ b/api-ref/source/apis/route_table/querying_route_tables.rst @@ -103,6 +103,12 @@ Response Parameters | description | String | - Provides supplementary information about the route table. | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0001__table4856530131313: @@ -131,7 +137,9 @@ Example Response } ], "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", - "description": "abc" + "description": "abc", + "created_at": "2022-12-15T02:56:40", + "updated_at": "2022-12-15T02:56:40" }, { "id": "3d42a0d4-a980-4613-ae76-a2cddecfff89", @@ -143,7 +151,9 @@ Example Response } ], "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", - "description": "abc" + "description": "abc", + "created_at": "2022-12-15T02:59:03", + "updated_at": "2022-12-15T02:59:03" } ] } diff --git a/api-ref/source/apis/route_table/updating_a_route_table.rst b/api-ref/source/apis/route_table/updating_a_route_table.rst index ca258fd..c84cbf2 100644 --- a/api-ref/source/apis/route_table/updating_a_route_table.rst +++ b/api-ref/source/apis/route_table/updating_a_route_table.rst @@ -103,7 +103,6 @@ Request Parameters | | | | - **peering** (VPC peering connection) | | | | | - **vpn** (VPN) | | | | | - **dc** (Direct Connect connection) | - | | | | - **cc** (Cloud Connect connection) | | | | | - **egw**: VPC endpoint node | | | | | - **er**: enterprise router | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ @@ -120,7 +119,6 @@ Request Parameters | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | | - When **type** is **vpn**, the value is the VPN ID. | | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ @@ -145,7 +143,6 @@ Request Parameters | | | | - **peering** (VPC peering connection) | | | | | - **vpn** (VPN) | | | | | - **dc** (Direct Connect connection) | - | | | | - **cc** (Cloud Connect connection) | | | | | - **egw**: VPC endpoint node | | | | | - **er**: enterprise router | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ @@ -162,7 +159,6 @@ Request Parameters | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | | - When **type** is **vpn**, the value is the VPN ID. | | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ @@ -187,7 +183,6 @@ Request Parameters | | | | - **peering** (VPC peering connection) | | | | | - **vpn** (VPN) | | | | | - **dc** (Direct Connect connection) | - | | | | - **cc** (Cloud Connect connection) | | | | | - **egw**: VPC endpoint node | | | | | - **er**: enterprise router | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ @@ -204,7 +199,6 @@ Request Parameters | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | | - When **type** is **vpn**, the value is the VPN ID. | | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ @@ -291,6 +285,12 @@ Response Parameters | description | String | - Provides supplementary information about the route table. | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ .. table:: **Table 10** Description of the **route** field @@ -307,7 +307,6 @@ Response Parameters | | | - **peering** (VPC peering connection) | | | | - **vpn** (VPN) | | | | - **dc** (Direct Connect connection) | - | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ @@ -324,7 +323,6 @@ Response Parameters | | | - When **type** is **peering**, the value is the VPC peering connection ID. | | | | - When **type** is **vpn**, the value is the VPN ID. | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | | | | - When **type** is set to **er**, the value is the ID of the enterprise router. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ @@ -350,6 +348,7 @@ Example Response "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", "description": "abc", + "default": false, "routes": [ { "type": "ecs", @@ -363,7 +362,9 @@ Example Response "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" } ], - "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f" + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "created_at": "2022-12-15T02:56:40", + "updated_at": "2022-12-15T03:03:42" } } diff --git a/api-ref/source/apis/security_group/creating_a_security_group.rst b/api-ref/source/apis/security_group/creating_a_security_group.rst index 6613b3a..3b8a339 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group.rst @@ -127,46 +127,49 @@ Response Parameters .. table:: **Table 6** **security_group_rule** objects - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -181,20 +184,63 @@ Example Response "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "369e6499-b2cb-4126-972a-97e589692c62", + { + "id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null }, { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", + "id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, "description": "", - "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "9581f18c-1fdd-43da-ace9-7758a56ef28a", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "created_at": "2020-07-09T05:56:27Z", + "updated_at": "2020-07-09T05:56:27Z", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null } ] } diff --git a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst index 6f91abc..256b914 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst @@ -30,43 +30,46 @@ Request Parameters .. table:: **Table 2** Description of the **security_group_rule** field - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +===================+=================+=================+===========================================================================================================================================================================================================================================================+ - | security_group_id | Yes | String | Specifies the security group ID. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the security group rule. | - | | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | Yes | String | - Access control direction specified in a security group rule. | - | | | | - The value can be: | - | | | | | - | | | | - **egress** | - | | | | - **ingress** | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | No | String | - Specifies the IP protocol version. | - | | | | - The value can be **IPv4** or **IPv6**. | - | | | | - If you do not set this parameter, **IPv4** is used by default. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | - Specifies the protocol type. | - | | | | - The value can be **tcp**, **udp**, **icmp** or an IP protocol number (0 to 255). | - | | | | - If the parameter is left blank, all protocols are supported. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | No | Integer | - Specifies the start port number. | - | | | | - The value ranges from 1 to 65535. | - | | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | No | Integer | - Specifies the end port number. | - | | | | - The value ranges from 1 to 65535. | - | | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | No | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | | - The value can be in the CIDR format or IP addresses. | - | | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | No | String | - Specifies the ID of the peer security group. | - | | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=========================+=================+=================+===========================================================================================================================================================================================================================================================+ + | security_group_id | Yes | String | Specifies the security group ID. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the security group rule. | + | | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | Yes | String | - Access control direction specified in a security group rule. | + | | | | - The value can be: | + | | | | | + | | | | - **egress** | + | | | | - **ingress** | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | No | String | - Specifies the IP protocol version. | + | | | | - The value can be **IPv4** or **IPv6**. | + | | | | - If you do not set this parameter, **IPv4** is used by default. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | String | - Specifies the protocol type. | + | | | | - The value can be **tcp**, **udp**, **icmp** or an IP protocol number (0 to 255). | + | | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | No | Integer | - Specifies the start port number. | + | | | | - The value ranges from 1 to 65535. | + | | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | No | Integer | - Specifies the end port number. | + | | | | - The value ranges from 1 to 65535. | + | | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | No | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | | - The value can be in the CIDR format or IP addresses. | + | | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | No | String | - Specifies the ID of the peer security group. | + | | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | + | | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request --------------- @@ -89,6 +92,21 @@ Example Request } } + .. code-block:: text + + POST https://{Endpoint}/v1/{project_id}/security-group-rules + + { + "security_group_rule": { + "direction": "ingress", + "port_range_min": "80", + "ethertype": "IPv6", + "port_range_max": "90", + "protocol": "tcp", + "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a" + } + } + Response Parameters ------------------- @@ -104,46 +122,49 @@ Response Parameters .. table:: **Table 4** **security_group_rule** objects - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -162,7 +183,8 @@ Example Response "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "remote_ip_prefix": null, "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null } } diff --git a/api-ref/source/apis/security_group/querying_security_group_details.rst b/api-ref/source/apis/security_group/querying_security_group_details.rst index f57f71b..aa752de 100644 --- a/api-ref/source/apis/security_group/querying_security_group_details.rst +++ b/api-ref/source/apis/security_group/querying_security_group_details.rst @@ -87,46 +87,49 @@ Response Parameters .. table:: **Table 4** **security_group_rule** objects - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -141,20 +144,63 @@ Example Response "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "369e6499-b2cb-4126-972a-97e589692c62", + { + "id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null }, { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", + "id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, "description": "", - "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "9581f18c-1fdd-43da-ace9-7758a56ef28a", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "created_at": "2020-07-09T05:56:27Z", + "updated_at": "2020-07-09T05:56:27Z", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null } ] } diff --git a/api-ref/source/apis/security_group/querying_security_group_rule_details.rst b/api-ref/source/apis/security_group/querying_security_group_rule_details.rst index fc3896b..91da481 100644 --- a/api-ref/source/apis/security_group/querying_security_group_rule_details.rst +++ b/api-ref/source/apis/security_group/querying_security_group_rule_details.rst @@ -56,46 +56,49 @@ Response Parameters .. table:: **Table 3** **security_group_rule** objects - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -114,7 +117,8 @@ Example Response "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "remote_ip_prefix": null, "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null } } diff --git a/api-ref/source/apis/security_group/querying_security_group_rules.rst b/api-ref/source/apis/security_group/querying_security_group_rules.rst index 21cad90..1847023 100644 --- a/api-ref/source/apis/security_group/querying_security_group_rules.rst +++ b/api-ref/source/apis/security_group/querying_security_group_rules.rst @@ -73,46 +73,49 @@ Response Parameters .. table:: **Table 2** **security_group_rule** objects - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -132,7 +135,8 @@ Example Response "remote_group_id": null, "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null }, { "direction": "egress", @@ -145,7 +149,8 @@ Example Response "remote_group_id": null, "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null }, { "direction": "ingress", @@ -158,7 +163,8 @@ Example Response "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null }, { "direction": "ingress", @@ -171,7 +177,8 @@ Example Response "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null } ] } diff --git a/api-ref/source/apis/security_group/querying_security_groups.rst b/api-ref/source/apis/security_group/querying_security_groups.rst index 2d8b124..7fad2f8 100644 --- a/api-ref/source/apis/security_group/querying_security_groups.rst +++ b/api-ref/source/apis/security_group/querying_security_groups.rst @@ -113,46 +113,49 @@ Response Parameters .. table:: **Table 4** **security_group_rule** objects - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -168,23 +171,66 @@ Example Response "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "369e6499-b2cb-4126-972a-97e589692c62", - "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", - "description": "", - "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" - } - ] - }, + { + "id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "ethertype": "IPv6", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "9581f18c-1fdd-43da-ace9-7758a56ef28a", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": null, + "direction": "egress", + "protocol": null, + "description": "", + "created_at": "2020-07-09T05:56:27Z", + "updated_at": "2020-07-09T05:56:27Z", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + }, + { + "id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8", + "tenant_id": "060576782980d5762f9ec014dd2f1148", + "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", + "direction": "ingress", + "protocol": null, + "description": "", + "ethertype": "IPv4", + "remote_ip_prefix": null, + "remote_address_group_id": null, + "port_range_max": null, + "port_range_min": null + } + ] + }, { "id": "9c0f56be-a9ac-438c-8c57-fce62de19419", "name": "default", diff --git a/api-ref/source/apis/subnet/creating_a_subnet.rst b/api-ref/source/apis/subnet/creating_a_subnet.rst index 034fa40..49dbd04 100644 --- a/api-ref/source/apis/subnet/creating_a_subnet.rst +++ b/api-ref/source/apis/subnet/creating_a_subnet.rst @@ -83,7 +83,7 @@ Request Parameters +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | vpc_id | Yes | String | Specifies the ID of the VPC to which the subnet belongs. | +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | + | 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_0001__table1805181451016: @@ -93,16 +93,14 @@ Request Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | | | | | | | | | | - Constraints: | | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request @@ -134,10 +132,6 @@ Example Request "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, - { - "opt_value": "24h", - "opt_name": "addresstime" - } ] } } @@ -220,7 +214,7 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 7 `. | + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 7 `. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | scope | String | Specifies where the subnet is used. | | | | | @@ -245,16 +239,14 @@ Response Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | | | | | | | | | | - Constraints: | | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response diff --git a/api-ref/source/apis/subnet/querying_subnet_details.rst b/api-ref/source/apis/subnet/querying_subnet_details.rst index f240051..1af8839 100644 --- a/api-ref/source/apis/subnet/querying_subnet_details.rst +++ b/api-ref/source/apis/subnet/querying_subnet_details.rst @@ -58,67 +58,67 @@ Response Parameters .. table:: **Table 3** **subnet** objects - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+===============================================================================+========================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the subnet name. | - | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the subnet. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the subnet CIDR block. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | Specifies the subnet gateway address. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | scope | String | Specifies where the subnet is used. | - | | | | - | | | Values: | - | | | | - | | | - **center**: The subnet is used in a central AZ. | - | | | - *{azId}*: The subnet is used in an edge AZ. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Project ID | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | - Specifies the time (UTC) when the subnet is created. | - | | | - Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | - Specifies the time (UTC) when the subnet is updated. | - | | | - Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===============================================================================+=====================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the subnet name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the subnet. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the subnet CIDR block. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | Specifies the subnet gateway address. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | scope | String | Specifies where the subnet is used. | + | | | | + | | | Values: | + | | | | + | | | - **center**: The subnet is used in a central AZ. | + | | | - *{azId}*: The subnet is used in an edge AZ. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Project ID | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the subnet is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the subnet is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet01_0002__table019517383270: @@ -127,16 +127,14 @@ Response Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | | | | | | | | | | - Constraints: | | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response @@ -168,10 +166,6 @@ Example Response "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, - { - "opt_value": "24h", - "opt_name": "addresstime" - } ] "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:42:07", diff --git a/api-ref/source/apis/subnet/querying_subnets.rst b/api-ref/source/apis/subnet/querying_subnets.rst index ca5d96b..329beaf 100644 --- a/api-ref/source/apis/subnet/querying_subnets.rst +++ b/api-ref/source/apis/subnet/querying_subnets.rst @@ -73,67 +73,67 @@ Response Parameters .. table:: **Table 3** **subnet** objects - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+===============================================================================+========================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the subnet name. | - | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the subnet. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the subnet CIDR block. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | Specifies the subnet gateway address. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | scope | String | Specifies where the subnet is used. | - | | | | - | | | Values: | - | | | | - | | | - **center**: The subnet is used in a central AZ. | - | | | - *{azId}*: The subnet is used in an edge AZ. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Project ID | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | - Specifies the time (UTC) when the subnet is created. | - | | | - Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | - Specifies the time (UTC) when the subnet is updated. | - | | | - Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===============================================================================+=====================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the subnet name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the subnet. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the subnet CIDR block. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | Specifies the subnet gateway address. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | scope | String | Specifies where the subnet is used. | + | | | | + | | | Values: | + | | | | + | | | - **center**: The subnet is used in a central AZ. | + | | | - *{azId}*: The subnet is used in an edge AZ. | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Project ID | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the subnet is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the subnet is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet01_0003__table019517383270: @@ -142,16 +142,14 @@ Response Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | | | | | | | | | | - Constraints: | | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response @@ -186,10 +184,6 @@ Example Response { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" - }, - { - "opt_value": "24h", - "opt_name": "addresstime" } ] "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", @@ -218,10 +212,6 @@ Example Response { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" - }, - { - "opt_value": "24h", - "opt_name": "addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", diff --git a/api-ref/source/apis/subnet/updating_subnet_information.rst b/api-ref/source/apis/subnet/updating_subnet_information.rst index 9f6eff2..9f94ab5 100644 --- a/api-ref/source/apis/subnet/updating_subnet_information.rst +++ b/api-ref/source/apis/subnet/updating_subnet_information.rst @@ -65,22 +65,20 @@ Request Parameters | | | | - 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. | + | | | | - 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. | + | | | | - The value must be a valid IP address. IPv6 addresses are not supported. | | | | | | - | | | | If the value of **primary_dns** is left blank, the value of **secondary_dns** has to be updated together with that of **primary_dns**. | - | | | | | - | | | | The value of **secondary_dns** to be updated must be different from that of **primary_dns**. | + | | | | The value of **secondary_dns** must be different from that of **primary_dns**. | | | | | | | | | | If there is only one DNS server address, only **primary_dns** is displayed. | +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | + | | | | - 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 or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | + | 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: @@ -90,16 +88,14 @@ Request Parameters +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | opt_value | No | String | - Specifies the NTP server address configured for the subnet. | | | | | | | | | | - Constraints: | | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request @@ -122,10 +118,6 @@ Example Request { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" - }, - { - "opt_value": "24h", - "opt_name": "addresstime" } ] } diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 80d01b6..0818bdb 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,16 @@ Change History +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2023-12-15 | This release incorporates the following changes: | +| | | +| | Fixed known issues. | +| | | +| | Added parameters **address-group** and **ipv6**. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2023-12-11 | This release incorporates the following changes: | +| | | +| | Deleted the content about lease time of **extra_dhcp_opts** from :ref:`Subnet `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-11-15 | This release incorporates the following changes: | | | | | | Modified the alias information in the response body in :ref:`Querying an EIP `. | diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst index b07c570..c7c27d2 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst @@ -109,10 +109,10 @@ Response Message | dns_domain | String | Specifies the DNS domain. | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ -Example: --------- +Example Request +--------------- -Example request +Create a floating IP address whose network is **0a2228f2-7f8a-45f1-8e09-9039e1d09975**. .. code-block:: text @@ -124,7 +124,12 @@ Example request } } -Example response +Example Response +---------------- + +**Status code: 201** + +Normal response to POST requests .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst index 981aa30..2bc3253 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst @@ -51,16 +51,17 @@ Response Message None -Example: --------- +Example Request +--------------- -Example request +Delete the floating IP address whose ID is a95ec431-8473-463b-aede-34fb048ee3a7. .. code-block:: text DELETE https://{Endpoint}/v2.0/floatingips/a95ec431-8473-463b-aede-34fb048ee3a7 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst index 3f8c9cf..b99ec75 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst @@ -95,16 +95,17 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/floatingips/1a3a2818-d9b4-4a9c-8a19-5252c499d1cd -Example response +Example Response +---------------- + +**Status code: 200** .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst index c07a355..cd3810c 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst @@ -148,37 +148,45 @@ Response Message | | | Format: *yyyy-MM-ddTHH:mm:ss* | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ -Example: --------- - -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/floatingips?limit=1 -Example response +Example Response +---------------- + +**Status code: 200** + +Normal response to the GET operation .. code-block:: { - "floatingips": [ - { - "id": "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd", - "status": "DOWN", - "router_id": null, - "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", - "fixed_ip_address": null, - "floating_ip_address": "99.99.99.84", - "port_id": null, - "dns_name": "ecs-80-158-78-239", - "dns_domain": "reverse.domain-name.com", - "created_at": "2017-10-19T12:21:28", - "updated_at": "2018-07-30T12:52:13" - } - ] + "floatingips" : [ { + "id" : "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd", + "status" : "DOWN", + "router_id" : null, + "tenant_id" : "bbfe8c41dd034a07bebd592bf03b4b0c", + "project_id" : "bbfe8c41dd034a07bebd592bf03b4b0c", + "floating_network_id" : "0a2228f2-7f8a-45f1-8e09-9039e1d09975", + "fixed_ip_address" : null, + "floating_ip_address" : "99.99.99.84", + "port_id" : null, + "dns_name" : "ecs-88-99-103-61", + "dns_domain" : "compute.clouds-dns.com.", + "created_at" : "2017-10-19T12:21:28", + "updated_at" : "2018-07-30T12:52:13" + } ], + "floatingips_links" : [ { + "href" : "https://network.region.cn-test-2.clouds.com/v2.0/floatingips.json?limit=2000&marker=000a6144-5010-46f2-bf06-6a1c94477ea3&page_reverse=true", + "rel" : "previous" + }, { + "href" : "https://network.region.cn-test-2.clouds.com/v2.0/floatingips.json?limit=2000&marker=d445e537-bc81-4039-9c7b-f9c1f5c73c78", + "rel" : "next" + } ] } Status Code diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst index e5f8151..0a231f5 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst @@ -116,56 +116,39 @@ Response Message | dns_domain | String | Specifies the DNS domain. | +-----------------------+-----------------------+------------------------------------------------------------------------------------------------+ -Example: --------- +Example Request +--------------- -Example request 1 (Binding a floating IP address to a port) +- Unbind a floating IP address from a port. -.. code-block:: text + .. code-block:: text - PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 + PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 - { - "floatingip": { - "port_id": "f91f5763-c5a2-4458-979d-61e48b3c3fac" - } - } + { + "floatingip": { + "port_id": null + } + } -Example response 1 (Binding a floating IP address to a port) +- Bind a floating IP address to a port. The port ID is f91f5763-c5a2-4458-979d-61e48b3c3fac. -.. code-block:: + .. code-block:: text - { - "floatingip": { - "id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2", - "status": "DOWN", - "router_id": null, - "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", - "fixed_ip_address": "192.168.10.3", - "floating_ip_address": "88.88.215.205", - "port_id": 00587256-27e3-489b-96bf-ea80c1da4aeb, - "dns_name": "ecs-80-158-78-239", - "dns_domain": "reverse.domain-name.com", - "created_at": "2018-09-20T02:10:02", - "updated_at": "2018-09-20T02:10:07" - } - } + PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 -Example request 2 (Unbinding a floating IP address from a port) + { + "floatingip": { + "port_id": "f91f5763-c5a2-4458-979d-61e48b3c3fac" + } + } -.. code-block:: text +Example Response +---------------- - PUT https://{Endpoint}/v2.0/floatingips/b997e0d4-3359-4c74-8f88-bc0af81cd5a2 +**Status code: 200** - { - "floatingip": { - "port_id": null - } - } - -Example response 2 (Unbinding a floating IP address from a port) +(The floating IP address is unbound from the port.) .. code-block:: @@ -187,6 +170,28 @@ Example response 2 (Unbinding a floating IP address from a port) } } +(The floating IP address is bound to the port.) + +.. code-block:: + + { + "floatingip": { + "id": "b997e0d4-3359-4c74-8f88-bc0af81cd5a2", + "status": "DOWN", + "router_id": null, + "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", + "fixed_ip_address": "192.168.10.3", + "floating_ip_address": "88.88.215.205", + "port_id": f91f5763-c5a2-4458-979d-61e48b3c3fac, + "dns_name": "ecs-80-158-78-239", + "dns_domain": "reverse.domain-name.com", + "created_at": "2018-09-20T02:10:02", + "updated_at": "2018-09-20T02:10:07" + } + } + Status Code ----------- 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 8a82344..726d6de 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,25 +30,25 @@ 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. This is an extended attribute. | - | | | | | - | | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. This is an extended attribute. | + | | | | | + | | | | 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**. | + +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 --------------- @@ -112,6 +112,8 @@ Response Parameters | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | | | | | | | | 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**. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 d794922..3b335c2 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 @@ -84,6 +84,8 @@ Response Parameters | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | | | | | | | | 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**. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 02e85c7..45a1f6e 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 @@ -133,6 +133,8 @@ Response Parameters | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | | | | | | | | 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**. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 9a39c4a..3b7d48c 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 @@ -118,6 +118,8 @@ Response Parameters | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | | | | | | | | 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**. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst index 6cde422..c9b77a8 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst @@ -43,6 +43,8 @@ Request Parameters | | | | The default value is **true**. | +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | fixed_ips | No | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 3 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | | + | | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | security_groups | No | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | | | | | | @@ -166,110 +168,112 @@ Response Parameters .. table:: **Table 7** **port** objects - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+======================================================================================+======================================================================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | - | | | | - | | | This parameter is not mandatory when you query ports. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the port name. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the port belongs. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The default value is **true**. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | - | | | | - | | | This value can only be dynamically assigned by the system. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, or **network:nat_gateway**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 do not take effect. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+======================================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + | | | | + | | | The status of a HANA SR-IOV VM port is always **DOWN**. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | + | | | | + | | | Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | + | | | Example: | + | | | | + | | | {"internal_elb": true} | + | | | | + | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | + | | | Example: | + | | | | + | | | {"disable_security_groups": true }, | + | | | | + | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 do not take effect. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0003__table1424105920176: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst index d41d1c2..34e277f 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst @@ -54,110 +54,112 @@ Response Parameters .. table:: **Table 3** **port** objects - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================================================================================================+======================================================================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | - | | | | - | | | This parameter is not mandatory when you query ports. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the port name. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the port belongs. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The default value is **true**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | - | | | | - | | | This value can only be dynamically assigned by the system. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 4 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, or **network:nat_gateway**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 8 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | binding:profile object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 do not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================================================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 4 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + | | | | + | | | The status of a HANA SR-IOV VM port is always **DOWN**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 8 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | binding:profile object | Specifies the user-defined settings. This is an extended attribute. | + | | | | + | | | Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | + | | | Example: | + | | | | + | | | {"internal_elb": true} | + | | | | + | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | + | | | Example: | + | | | | + | | | {"disable_security_groups": true }, | + | | | | + | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 do not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0002__table4290920914597: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst index baebb84..95df59d 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst @@ -33,48 +33,48 @@ Example of querying ports by page .. table:: **Table 1** Parameter description - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+==================+==============================================================================================================================================================================================================================================================================================+ - | id | No | String | Specifies that the port ID is used as the filtering condition. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Specifies that the port name is used as the filtering condition. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies that the admin state is used as the filtering condition. | - | | | | | - | | | | The value can be **true** or **false**. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | No | String | Specifies that the network ID is used as the filtering condition. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | No | String | Specifies that the MAC address is used as the filtering condition. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | No | String | Specifies that the device ID is used as the filtering condition. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | No | String | Specifies that the device owner is used as the filtering condition. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies that the port status is used as the filtering condition. | - | | | | | - | | | | The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | No | Array of strings | Specifies that the ID of the security group is used as the filtering condition. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | No | Array of strings | Filter by IP address of the port, that is **fixed_ips=ip_address={ip_address}** or **fixed_ips=subnet_id={subnet_id}**. Set *{ip_address}* to an IP address, for example, 192.168.21.22. Set *{subnet_id}* to the IPv4 or IPv6 subnet ID, for example, 011fc878-5521-4654-a1ad-f5b0b5820302. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | No | String | Specifies that the project ID 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**. | - | | | | | - | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | - | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | - | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | - | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | - | | | | | - | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==================+======================================================================================================================================================================================================================================================================================================================+ + | id | No | String | Specifies that the port ID is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | No | String | Specifies that the port name is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | No | Boolean | Specifies that the admin state is used as the filtering condition. | + | | | | | + | | | | The value can be **true** or **false**. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | No | String | Specifies that the network ID is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | No | String | Specifies that the MAC address is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | No | String | Specifies that the device ID is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | No | String | Specifies that the device owner is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | No | String | Specifies that the port status is used as the filtering condition. | + | | | | | + | | | | The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | No | Array of strings | Specifies that the ID of the security group is used as the filtering condition. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | No | Array of strings | Filter by IP address of the port, that is **fixed_ips=ip_address={ip_address}** or **fixed_ips=subnet_id={subnet_id}**. Set *{ip_address}* to an IP address, for example, 192.168.21.22 or 2a07:b980:4030:14::1. Set *{subnet_id}* to the IPv4 or IPv6 subnet ID, for example, 011fc878-5521-4654-a1ad-f5b0b5820302. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | No | String | Specifies that the project ID 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**. | + | | | | | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | + | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | + | | | | | + | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | + +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Message --------------- @@ -139,108 +139,110 @@ Response Parameter .. table:: **Table 3** **port** objects - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================================================================================================+======================================================================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | - | | | | - | | | This parameter is not mandatory when you query ports. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the port name. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the port belongs. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The default value is **true**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | - | | | | - | | | This value can only be dynamically assigned by the system. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 4 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, or **network:nat_gateway**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 7 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 do not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================================================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 4 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 7 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | + | | | | + | | | Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | + | | | Example: | + | | | | + | | | {"internal_elb": true} | + | | | | + | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | + | | | Example: | + | | | | + | | | {"disable_security_groups": true }, | + | | | | + | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 do not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0001__table4290920914597: @@ -355,14 +357,42 @@ Example 1 "port_security_enabled": true, "created_at": "2018-09-13T01:43:41", "updated_at": "2018-09-13T01:43:41" - }], + }, + { + "id": "7a8c720d-32b7-47cc-a943-23e48d69e30a", + "name": "a8d001aa-6946-4168-86d9-924c7d3ef8fb", + "status": "DOWN", + "admin_state_up": true, + "fixed_ips": [ + { + "subnet_id": "a8d001aa-6946-4168-86d9-924c7d3ef8fb", + "ip_address": "2a07:b980:4030:14::1" + } + ], + "mac_address": "fa:16:3e:57:39:c3", + "network_id": "26cf88ff-1a8c-4233-a8e6-183e1e299357", + "tenant_id": "db82c9e1415a464ea68048baa8acc6b8", + "project_id": "db82c9e1415a464ea68048baa8acc6b8", + "device_id": "6c2fcea1-b785-4253-b84e-3d887e1c67e1", + "device_owner": "network:router_interface_distributed", + "security_groups": ["34acbeed-8f65-4875-86ca-66417b1733fd"], + "extra_dhcp_opts": [], + "allowed_address_pairs": [], + "binding:vnic_type": "normal", + "binding:vif_details": {}, + "binding:profile": {}, + "port_security_enabled": true, + "created_at": "2018-09-13T01:43:41", + "updated_at": "2018-09-13T01:43:41" + } + ], "ports_links": [ { "rel": "next", - "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=791870bd-36a7-4d9b-b015-a78e9b06af08" + "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=7a8c720d-32b7-47cc-a943-23e48d69e30a" }, { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=791870bd-36a7-4d9b-b015-a78e9b06af08&page_reverse=True" + "href": "https://{Endpoint}/v2.0/ports?limit=1&marker=7a8c720d-32b7-47cc-a943-23e48d69e30a&page_reverse=True" } ] } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst index 66a2a0f..d46c6ba 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst @@ -149,110 +149,112 @@ Response Parameters .. table:: **Table 7** **port** objects - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================================================================================================+======================================================================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | - | | | | - | | | This parameter is not mandatory when you query ports. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the port name. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the port belongs. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | Boolean | Specifies the administrative status. | - | | | | - | | | The default value is **true**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | - | | | | - | | | This value can only be dynamically assigned by the system. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, or **network:nat_gateway**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 do not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================================================================================================+========================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + | | | | + | | | The status of a HANA SR-IOV VM port is always **DOWN**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | + | | | | + | | | Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | + | | | | + | | | Example: | + | | | | + | | | {"internal_elb": true} | + | | | | + | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | + | | | | + | | | Example: | + | | | | + | | | {"disable_security_groups": true }, | + | | | | + | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 do not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0004__table4290920914597: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst index fb54c73..db7cbce 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst @@ -98,49 +98,52 @@ Response Parameters .. table:: **Table 5** **Security Group Rule** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -166,7 +169,8 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2" + "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2", + "remote_address_group_id": null }, { "id": "6332de3e-98fb-4f8c-b44a-fcb8ff09881e", @@ -179,7 +183,8 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2" + "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2", + "remote_address_group_id": null } ], "created_at": "2018-09-20T02:15:34", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst index e69018a..98bede3 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst @@ -30,45 +30,48 @@ Request Parameters .. table:: **Table 2** **Security Group Rule** objects - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +===================+=================+=================+=============================================================================================================================================================================================+ - | description | No | String | Provides supplementary information about the security group rule. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | Yes | String | Specifies the ID of the belonged security group. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | No | String | Specifies the peer ID of the belonged security group. | - | | | | | - | | | | This parameter is mutually exclusive with **remote_ip_prefix**. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | Yes | String | Specifies the direction of the traffic for which the security group rule takes effect. | - | | | | | - | | | | The value can be **ingress** or **egress**. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | No | String | Specifies the peer IP address segment. | - | | | | | - | | | | This parameter is mutually exclusive with **remote_group_id**. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Specifies the protocol type or the IP protocol number. | - | | | | | - | | | | The value can be **tcp**, **udp**, **icmp** or an IP protocol number | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | No | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - | | | | | - | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | No | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | | - | | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | | - | | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - | | | | | - | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | No | String | Specifies the network type. | - | | | | | - | | | | The value can be **IPv4** or **IPv6**. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=========================+=================+=================+=============================================================================================================================================================================================+ + | description | No | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | Yes | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | No | String | Specifies the peer ID of the belonged security group. | + | | | | | + | | | | This parameter is mutually exclusive with **remote_ip_prefix**. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | Yes | String | Specifies the direction of the traffic for which the security group rule takes effect. | + | | | | | + | | | | The value can be **ingress** or **egress**. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | No | String | Specifies the peer IP address segment. | + | | | | | + | | | | This parameter is mutually exclusive with **remote_group_id**. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | String | Specifies the protocol type or the IP protocol number. | + | | | | | + | | | | The value can be **tcp**, **udp**, **icmp** or an IP protocol number | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | No | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + | | | | | + | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | No | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | | + | | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | | + | | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + | | | | | + | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | No | String | Specifies the network type. | + | | | | | + | | | | The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | + | | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request --------------- @@ -103,49 +106,52 @@ Response Parameters .. table:: **Table 4** **Security Group Rule** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -167,7 +173,8 @@ Example Response "id": "7c336b04-1603-4911-a6f4-f2af1d9a0488", "project_id": "6fbe9263116a4b68818cf1edce16bc4f", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst index 6486872..2d62e9b 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst @@ -72,49 +72,52 @@ Response Parameters .. table:: **Table 3** **Security Group Rule** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -140,7 +143,8 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2" + "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", + "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" }, { "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7", @@ -153,7 +157,8 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2" + "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", + "remote_address_group_id": null } ], "created_at": "2018-09-12T08:24:14", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst index 5f870e1..4cfd6af 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst @@ -42,49 +42,52 @@ Response Parameters .. table:: **Table 2** **Security Group Rule** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -106,7 +109,8 @@ Example Response "id": "1755bc80-cf3a-4f57-8ae9-d9796482ddc0", "project_id": "6fbe9263116a4b68818cf1edce16bc4f", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst index 026ab18..3a57ee2 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst @@ -103,49 +103,52 @@ Response Parameters .. table:: **Table 3** **Security Group Rule** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_sg02_0006__table1318194661915: @@ -180,7 +183,8 @@ Example Response "id": "07adc044-3f21-4eeb-bd57-5e5eb6024b7f", "project_id": "6c9298ec8c874f7f99688489ab65f90e", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null }, { "remote_group_id": null, @@ -196,7 +200,8 @@ Example Response "id": "09358f83-f4a5-4386-9563-a1e3c373d655", "project_id": "6c9298ec8c874f7f99688489ab65f90e", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null }, { "remote_group_id": "4c763030-366e-428c-be2b-d48f6baf5297", @@ -212,7 +217,8 @@ Example Response "id": "219a6f56-1069-458b-bec0-df9270e7a074", "project_id": "6c9298ec8c874f7f99688489ab65f90e", "created_at": "2018-09-20T02:15:34", - "updated_at": "2018-09-20T02:15:34" + "updated_at": "2018-09-20T02:15:34", + "remote_address_group_id": null } ], "security_group_rules_links": [ diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst index 4efa855..4467a24 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst @@ -113,49 +113,52 @@ Response Parameters .. table:: **Table 4** **Security Group Rule** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_sg02_0001__table1318194661915: @@ -194,7 +197,8 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2" + "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", + "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" }, { "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7", @@ -207,7 +211,8 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2" + "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", + "remote_address_group_id": null } ], "created_at": "2018-09-12T08:24:14", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst index ffdc256..8553b07 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst @@ -100,49 +100,52 @@ Response Parameters .. table:: **Table 5** **Security Group Rule** objects - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -168,7 +171,8 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2" + "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2", + "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" }, { "id": "3f51e52c-0e85-40f7-a137-85927392e436", @@ -181,7 +185,8 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2" + "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2", + "remote_address_group_id": null } ], "created_at": "2018-09-20T02:15:34", 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 4240465..c1d235c 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 @@ -10,6 +10,11 @@ Function This API is used to create a subnet. +Notes and Constraints +--------------------- + +- IPv6 subnets can be created only when IPv4 subnets have been created on the network. + URI --- @@ -30,59 +35,67 @@ Request Parameters .. table:: **Table 2** **subnet** objects - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +===================+=================+============================================================================+=================================================================================================================================================================================================================================================+ - | name | No | String | Specifies the subnet name. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | No | Integer | Specifies the IP address version. | - | | | | | - | | | | Supported versions: IPv4 | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_address_mode | No | String | Specifies the IPv6 addressing mode. | - | | | | | - | | | | Only **dhcpv6-stateful** is supported. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_ra_mode | No | String | Specifies the IPv6 route broadcast mode. | - | | | | | - | | | | Only **dhcpv6-stateful** is supported. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | Yes | String | Specifies the ID of the network to which the subnet belongs. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | Yes | String | Specifies the CIDR format. | - | | | | | - | | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | No | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | | - | | | | This attribute cannot be modified. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | - | | | | | - | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | | - | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | | - | | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | | - | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | No | Array of strings | Specifies the DNS server address. | - | | | | | - | | | | Instructions: | - | | | | | - | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - | | | | | - | | | | A maximum of five DNS server addresses are supported. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | - | | | | | - | | | | Static routes are not supported, and entered information will be ignored. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | | - | | | | The value can only be **true**. | - +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +========================+=================+============================================================================+============================================================================================================================================================================================================================================+ + | name | No | String | Specifies the subnet name. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | No | Integer | Specifies the IP address version. | + | | | | | + | | | | Supported versions: IPv4 and IPv6 | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | No | String | Specifies the IPv6 addressing mode. | + | | | | | + | | | | Only **dhcpv6-stateful** is supported. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | No | String | Specifies the IPv6 route broadcast mode. | + | | | | | + | | | | Only **dhcpv6-stateful** is supported. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | Yes | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | Yes | String | Specifies the CIDR format. | + | | | | | + | | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | No | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | | + | | | | This attribute cannot be modified. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | + | | | | | + | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | | + | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | | + | | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | | + | | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | | + | | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | | + | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | No | Array of strings | Specifies the DNS server address. | + | | | | | + | | | | Instructions: | + | | | | | + | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + | | | | | + | | | | A maximum of five DNS server addresses are supported. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | + | | | | | + | | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | | + | | | | The value can only be **true**. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | No | Boolean | Specifies whether the default address pool is used. | + | | | | | + | | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+-----------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0003__table24611730: @@ -111,7 +124,7 @@ Request Parameters Example Request --------------- -Create a subnet named **subnet-test**, set its network ID to 0133cd73-34d4-4d4c-bf1f-e65b24603206, and CIDR block to 172.16.2.0/24. +Create an IPv4 subnet named **subnet-test**, set its network ID to 0133cd73-34d4-4d4c-bf1f-e65b24603206, and CIDR block to 172.16.2.0/24. .. code-block:: text @@ -126,6 +139,23 @@ Create a subnet named **subnet-test**, set its network ID to 0133cd73-34d4-4d4c- } } +Create an IPv6 subnet named **subnet-ipv6-test** and with network ID of **0133cd73-34d4-4d4c-bf1f-e65b24603206**. + +.. code-block:: text + + POST https://{Endpoint}/v2.0/subnets + + { + "subnet": { + "name": "subnet-ipv6-test", + "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", + "ip_version": 6, + "enable_dhcp": true, + "ipv6_address_mode": "dhcpv6-stateful", + "ipv6_ra_mode": "dhcpv6-stateful", + } + } + Response Parameters ------------------- @@ -141,71 +171,83 @@ Response Parameters .. table:: **Table 6** **subnet** objects - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=================================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | Supported versions: IPv4 and IPv6 | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 network segments are supported. In addition, the subnet mask cannot be greater than 28. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | - | | | | - | | | :ref:`Table 7 ` | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +========================+=================================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | Supported versions: IPv4 and IPv6 | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. In addition, the subnet mask cannot be greater than 28. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | + | | | | + | | | :ref:`Table 7 ` | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | + | | | | + | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0003__table1777145918276: @@ -258,6 +300,34 @@ Example Response } } +.. code-block:: + + { + "subnet": { + "id": "011fc878-5521-4654-a1ad-f5b0b58203ac", + "name": "subnet-ipv6-test", + "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", + "ip_version": 6, + "cidr": "2001:db8:a583:a0::/64", + "subnetpool_id": "cb03d100-8687-4c0a-9441-ea568dcae47d", + "allocation_pools": [{ + "start": "2001:db8:a583:a0::2", + "end": "2001:db8:a583:a0:ffff:ffff:ffff:fffc" + }], + "gateway_ip": "2001:db8:a583:a0::1", + "enable_dhcp": true, + "ipv6_ra_mode": "dhcpv6-stateful", + "ipv6_address_mode": "dhcpv6-stateful", + "description": "", + "dns_nameservers": [], + "host_routes": [], + "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "created_at": "2021-07-01T07:59:28", + "updated_at": "2021-07-01T07:59:28" + } + } + Status Code ----------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst index 0f08af1..dfadc6f 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst @@ -42,69 +42,81 @@ Response Parameters .. table:: **Table 2** **subnet** objects - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=================================================================================+================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | Supported versions: IPv4 and IPv6 | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +========================+=================================================================================+==========================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | Supported versions: IPv4 and IPv6 | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | + | | | | + | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0002__table1777145918276: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst index 7e0b903..bd11c40 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst @@ -107,71 +107,83 @@ Response Parameters .. table:: **Table 3** **subnet** objects - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=================================================================================+=================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | Supported versions: IPv4 and IPv6 | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies available IP address pools. For details, see :ref:`Table 4 `. | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | - | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 5 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +========================+=================================================================================+=================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | Supported versions: IPv4 and IPv6 | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies available IP address pools. For details, see :ref:`Table 4 `. | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | + | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 5 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | + | | | | + | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0001__table1777145918276: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst index 587f967..f9399b8 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst @@ -36,35 +36,43 @@ Request Parameters .. table:: **Table 2** **subnet** objects - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +==================+=================+============================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ - | name | No | String | Specifies the subnet name. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details about the **allocation_pool** objects, see :ref:`Table 3 `. | - | | | | | - | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | | - | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | | - | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | No | Array of strings | Specifies the DNS server address. | - | | | | | - | | | | Instructions: | - | | | | | - | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - | | | | | - | | | | A maximum of five DNS server addresses are supported. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | - | | | | | - | | | | Static routes are not supported, and entered information will be ignored. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | | - | | | | The value can only be **true**. | - +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +========================+=================+============================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ + | name | No | String | Specifies the subnet name. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details about the **allocation_pool** objects, see :ref:`Table 3 `. | + | | | | | + | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | | + | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | | + | | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | | + | | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | | + | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | No | Array of strings | Specifies the DNS server address. | + | | | | | + | | | | Instructions: | + | | | | | + | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + | | | | | + | | | | A maximum of five DNS server addresses are supported. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | + | | | | | + | | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | | + | | | | The value can only be **true**. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | No | Boolean | Specifies whether the default address pool is used. | + | | | | | + | | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0004__table24611730: @@ -104,6 +112,17 @@ Change the name of the subnet whose ID is 98bac90c-0ba7-4a63-8995-097da9bead1c t } } +Change the name of the subnet whose ID is 98bac90c-0ba7-4a63-8995-097da9bead1c to **subnet-ipv6-test**. + +.. code-block:: text + + PUT https://{Endpoint}/v2.0/subnets/011fc878-5521-4654-a1ad-f5b0b58203ac + { + "subnet": { + "name": "subnet-ipv6-test" + } + } + Response Parameters ------------------- @@ -119,73 +138,85 @@ Response Parameters .. table:: **Table 6** **subnet** objects - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=================================================================================+=================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | Supported versions: IPv4 and IPv6 | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | - | | | | - | | | :ref:`Table 7 ` | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | - | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +========================+=================================================================================+=================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | Supported versions: IPv4 and IPv6 | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | + | | | | + | | | :ref:`Table 7 ` | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | + | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | + | | | | + | | | The value can be set to **true** only when IPv6 is used. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0004__table1777145918276: @@ -238,6 +269,34 @@ Example Response } } +.. code-block:: + + { + "subnet": { + "id": "011fc878-5521-4654-a1ad-f5b0b58203ac", + "name": "subnet-ipv6-test", + "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "network_id": "0133cd73-34d4-4d4c-bf1f-e65b24603206", + "ip_version": 6, + "cidr": "2001:db8:a583:a0::/64", + "subnetpool_id": "cb03d100-8687-4c0a-9441-ea568dcae47d", + "allocation_pools": [{ + "start": "2001:db8:a583:a0::2", + "end": "2001:db8:a583:a0:ffff:ffff:ffff:fffc" + }], + "gateway_ip": "2001:db8:a583:a0::1", + "enable_dhcp": true, + "ipv6_ra_mode": "dhcpv6-stateful", + "ipv6_address_mode": "dhcpv6-stateful", + "description": "", + "dns_nameservers": [], + "host_routes": [], + "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", + "created_at": "2021-07-01T07:59:28", + "updated_at": "2021-07-01T07:59:28" + } + } + Status Code -----------