From 4ee7d13e19c351b6f3c9050ee0da69da279e1dbd Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Fri, 17 Nov 2023 07:07:10 +0000 Subject: [PATCH] Update content --- api-ref/source/apis/eip/assigning_an_eip.rst | 16 + api-ref/source/apis/eip/querying_an_eip.rst | 3 + api-ref/source/apis/eip/querying_eips.rst | 3 + api-ref/source/apis/eip/updating_an_eip.rst | 6 + ...erying_eip_tags_in_a_specified_project.rst | 4 +- .../assigning_a_private_ip_address.rst | 4 +- .../querying_private_ip_address_details.rst | 4 +- .../querying_private_ip_addresses.rst | 4 +- ...associating_subnets_with_a_route_table.rst | 14 +- .../route_table/creating_a_route_table.rst | 4 + ...associating_subnets_from_a_route_table.rst | 4 +- .../route_table/querying_a_route_table.rst | 2 + .../route_table/updating_a_route_table.rst | 8 + .../source/apis/subnet/creating_a_subnet.rst | 125 ++++--- .../apis/subnet/querying_subnet_details.rst | 30 +- .../source/apis/subnet/querying_subnets.rst | 38 +- .../subnet/updating_subnet_information.rst | 10 + ...batch_creating_or_deleting_subnet_tags.rst | 4 +- .../creating_a_tag_for_a_subnet.rst | 4 +- .../querying_subnet_tags.rst | 4 +- ...ing_subnet_tags_in_a_specified_project.rst | 4 +- .../querying_subnets_by_tag.rst | 4 +- .../updating_vpc_information.rst | 8 +- .../batch_creating_or_deleting_vpc_tags.rst | 4 +- .../creating_a_tag_for_a_vpc.rst | 4 +- .../vpc_tag_management/querying_vpc_tags.rst | 4 +- ...erying_vpc_tags_in_a_specified_project.rst | 4 +- .../querying_vpcs_by_tag.rst | 4 +- api-ref/source/change_history.rst | 6 + api-ref/source/conf.py | 11 + .../port/creating_a_port.rst | 330 +++++++++--------- .../port/querying_a_port.rst | 210 +++++------ .../port/querying_ports.rst | 290 +++++++-------- .../port/updating_a_port.rst | 304 ++++++++-------- .../creating_a_security_group_rule.rst | 4 +- .../subnet/creating_a_subnet.rst | 108 +++--- .../subnet/querying_a_subnet.rst | 10 +- .../subnet/querying_subnets.rst | 10 +- .../subnet/updating_a_subnet.rst | 10 +- 39 files changed, 915 insertions(+), 705 deletions(-) diff --git a/api-ref/source/apis/eip/assigning_an_eip.rst b/api-ref/source/apis/eip/assigning_an_eip.rst index 1f5f9e8..8397561 100644 --- a/api-ref/source/apis/eip/assigning_an_eip.rst +++ b/api-ref/source/apis/eip/assigning_an_eip.rst @@ -85,6 +85,9 @@ Request Parameters | | | | - The configured value must be supported by the system. | | | | | - If this parameter is left blank or is an empty string, IPv4 address is created by default. | +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ + | alias | No | String | - Specifies the EIP name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+ .. _en-us_topic_0020090596__table11041789: @@ -198,6 +201,8 @@ Response Message +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | bandwidth_size | Integer | Specifies the bandwidth (Mbit/s). | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | Specifies the EIP name. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | | | | - When 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. | @@ -206,6 +211,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* | + | | | | + | | | This resource can only be associated with an EIP of the same region. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - Example response (IPv4 EIP with dedicated bandwidth) @@ -214,6 +228,8 @@ Response Message { "publicip": { "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706", + "alias": "tom", + "public_border_group": "center", "status": "PENDING_CREATE", "type": "5_bgp", "public_ip_address": "161.xx.xx.7", diff --git a/api-ref/source/apis/eip/querying_an_eip.rst b/api-ref/source/apis/eip/querying_an_eip.rst index 4e662eb..2b8376e 100644 --- a/api-ref/source/apis/eip/querying_an_eip.rst +++ b/api-ref/source/apis/eip/querying_an_eip.rst @@ -142,6 +142,8 @@ Response Message +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bandwidth_name | String | Specifies the bandwidth name. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | Specifies the EIP name. | + +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | | | | - When assigning an EIP, you need to associate an enterprise project ID with the EIP. | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | @@ -172,6 +174,7 @@ Response Message "publicip": { "id": "2ec9b78d-9368-46f3-8f29-d1a95622a568", "status": "DOWN", + "alias": "tom", "profile": {}, "type": "5_bgp", "public_ip_address": "161.xx.xx.12", diff --git a/api-ref/source/apis/eip/querying_eips.rst b/api-ref/source/apis/eip/querying_eips.rst index 5f2a67c..be19c90 100644 --- a/api-ref/source/apis/eip/querying_eips.rst +++ b/api-ref/source/apis/eip/querying_eips.rst @@ -158,6 +158,8 @@ Response Message +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | bandwidth_name | String | Specifies the bandwidth name. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | Specifies the EIP name. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | | | | - When assigning an EIP, you need to associate an enterprise project ID with the EIP. | | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. | @@ -189,6 +191,7 @@ Response Message { "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0", "status": "DOWN", + "alias": "tom", "profile": {}, "type": "5_bgp", "public_ip_address": "161.xx.xx.9", diff --git a/api-ref/source/apis/eip/updating_an_eip.rst b/api-ref/source/apis/eip/updating_an_eip.rst index e7e6411..15e7b55 100644 --- a/api-ref/source/apis/eip/updating_an_eip.rst +++ b/api-ref/source/apis/eip/updating_an_eip.rst @@ -68,6 +68,9 @@ Request Message | | | | | | | | | Leaving this parameter blank does not unbind the EIP from the dedicated load balancer. | +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | No | String | - Specifies the EIP name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - Example request 1 (Binding an EIP to a NIC) @@ -166,6 +169,8 @@ Response Message | | | - **PER**: Dedicated bandwidth | | | | - **WHOLE**: Shared bandwidth | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + | alias | String | Specifies the EIP name. | + +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). | | | | - When 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. | @@ -196,6 +201,7 @@ Response Message "publicip": { "id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb", "status": "ACTIVE", + "alias": "tom", "profile": {}, "type": "5_bgp", "port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe", diff --git a/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst b/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst index dcea71e..8b0cc2c 100644 --- a/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst @@ -63,7 +63,7 @@ Response Message | key | String | Specifies the tag key. | | | | | | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | + | | | - Contain up to 128 characters (36 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -73,7 +73,7 @@ Response Message +-----------------------+-----------------------+---------------------------------------------------------------------+ | values | Array of strings | Specifies the tag value list. | | | | | - | | | - Can contain a maximum of 43 characters. | + | | | - Contain up to 255 characters (43 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | 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 3d7b866..40652a6 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 @@ -119,14 +119,14 @@ Response Parameters | | | | | | | **neutron:VIP_PORT**: Virtual IP address | | | | | - | | | **compute:subeni**: IP address of a supplementary network interface | - | | | | | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | | | | | | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | | | | | | | | **network:endpoint_interface**: IP address of a VPC endpoint | | | | | + | | | **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. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_address | String | Specifies the assigned private IP address. | 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 1939b75..3368ffb 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 @@ -85,14 +85,14 @@ Response Parameters | | | | | | | **neutron:VIP_PORT**: Virtual IP address | | | | | - | | | **compute:subeni**: IP address of a supplementary network interface | - | | | | | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | | | | | | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | | | | | | | | **network:endpoint_interface**: IP address of a VPC endpoint | | | | | + | | | **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. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_address | String | Specifies the assigned private IP address. | 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 3c8ac45..3074989 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 @@ -106,14 +106,14 @@ Response Parameters | | | | | | | **neutron:VIP_PORT**: Virtual IP address | | | | | - | | | **compute:subeni**: IP address of a supplementary network interface | - | | | | | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | | | | | | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | | | | | | | | **network:endpoint_interface**: IP address of a VPC endpoint | | | | | + | | | **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. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_address | String | Specifies the assigned private IP address. | 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 6bc36cc..c0d6409 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 | Array of :ref:`subnet ` objects | - 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 in the VPC to which the route table belongs can be associated with the route table. | + +-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0005__table12518142212468: @@ -144,6 +144,7 @@ Response Parameters | | | - **dc** (Direct Connect connection) | | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | destination | String | - Specifies the destination CIDR block of a route. | | | | - The value must be in the valid CIDR format. | @@ -160,6 +161,7 @@ Response Parameters | | | - 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. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | description | String | - Provides supplementary information about the route. | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | 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 ca0875f..770edba 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 @@ -82,6 +82,7 @@ Request Parameters | | | | - **dc** (Direct Connect connection) | | | | | - **cc** (Cloud Connect connection) | | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ | destination | Yes | String | - Specifies the destination CIDR block of a route. | | | | | - The value must be in the valid CIDR format. | @@ -98,6 +99,7 @@ Request Parameters | | | | - 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. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ | description | No | String | - Provides supplementary information about the route. | | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | @@ -185,6 +187,7 @@ Response Parameters | | | - **dc** (Direct Connect connection) | | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | destination | String | - Specifies the destination CIDR block of a route. | | | | - The value must be in the valid CIDR format. | @@ -201,6 +204,7 @@ Response Parameters | | | - 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. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | description | String | - Provides supplementary information about the route. | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | 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 c4bc278..9644304 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 @@ -125,7 +125,7 @@ Response Parameters | 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 created. | + | updated_at | String | - Specifies the time (UTC) when the route table is updated. | | | | - Format: *yyyy-MM-ddTHH:mm:ss* | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ @@ -148,6 +148,7 @@ Response Parameters | | | - **dc** (Direct Connect connection) | | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | destination | String | - Specifies the destination CIDR block of a route. | | | | - The value must be in the valid CIDR format. | @@ -164,6 +165,7 @@ Response Parameters | | | - 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. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | description | String | - Provides supplementary information about the route. | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | 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 e4952f9..55bedb7 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 @@ -101,6 +101,7 @@ Response Parameters | | | - **dc** (Direct Connect connection) | | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | destination | String | - Specifies the destination CIDR block of a route. | | | | - The value must be in the valid CIDR format. | @@ -117,6 +118,7 @@ Response Parameters | | | - 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. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | description | String | - Provides supplementary information about the route. | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | 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 490d039..ca258fd 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 @@ -105,6 +105,7 @@ Request Parameters | | | | - **dc** (Direct Connect connection) | | | | | - **cc** (Cloud Connect connection) | | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ | destination | Yes | String | - Specifies the destination CIDR block of a route. | | | | | - The value must be in the valid CIDR format. | @@ -121,6 +122,7 @@ Request Parameters | | | | - 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. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ | description | No | String | - Provides supplementary information about the route. | | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | @@ -145,6 +147,7 @@ Request Parameters | | | | - **dc** (Direct Connect connection) | | | | | - **cc** (Cloud Connect connection) | | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ | destination | Yes | String | - Specifies the destination CIDR block of a route. | | | | | - The value must be in the valid CIDR format. | @@ -161,6 +164,7 @@ Request Parameters | | | | - 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. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ | description | No | String | - Provides supplementary information about the route. | | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | @@ -185,6 +189,7 @@ Request Parameters | | | | - **dc** (Direct Connect connection) | | | | | - **cc** (Cloud Connect connection) | | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ | destination | Yes | String | - Specifies the destination CIDR block of a route. | | | | | - The value must be in the valid CIDR format. | @@ -201,6 +206,7 @@ Request Parameters | | | | - 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. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ | description | No | String | - Provides supplementary information about the route. | | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | @@ -303,6 +309,7 @@ Response Parameters | | | - **dc** (Direct Connect connection) | | | | - **cc** (Cloud Connect connection) | | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | destination | String | - Specifies the destination CIDR block of a route. | | | | - The value must be in the valid CIDR format. | @@ -319,6 +326,7 @@ Response Parameters | | | - 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. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ | description | String | - Provides supplementary information about the route. | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | diff --git a/api-ref/source/apis/subnet/creating_a_subnet.rst b/api-ref/source/apis/subnet/creating_a_subnet.rst index d13ba38..034fa40 100644 --- a/api-ref/source/apis/subnet/creating_a_subnet.rst +++ b/api-ref/source/apis/subnet/creating_a_subnet.rst @@ -42,43 +42,49 @@ Request Parameters .. table:: **Table 3** **subnet** objects - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +===================+=================+================================================================================+=====================================================================================================================================================================================================================================+ - | name | Yes | String | - Specifies the subnet name. | - | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the subnet. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | Yes | String | - Specifies the subnet CIDR block. | - | | | | - The value must be within the VPC CIDR block. | - | | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | Yes | String | - Specifies the gateway of the subnet. | - | | | | - The value must be an IP address in the subnet. | - | | | | - The value must be a valid IP address. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | - | | | | - The value can be **true** (enabled) or **false** (disabled). | - | | | | - If this parameter is left blank, the value is set to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | - | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | - | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | No | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | - | | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 `. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+================================================================================+=====================================================================================================================================================================================================================================+ + | name | Yes | String | - Specifies the subnet name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the subnet. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | Yes | String | - Specifies the subnet CIDR block. | + | | | | - The value must be within the VPC CIDR block. | + | | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | Yes | String | - Specifies the gateway of the subnet. | + | | | | - The value must be an IP address in the subnet. | + | | | | - The value must be a valid IP address. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_enable | No | Boolean | - Specifies whether IPv6 is enabled. If IPv6 is enabled, you can use IPv6 CIDR blocks. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + | | | | - If this parameter is left blank, the system automatically sets it to **false** by default. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + | | | | - If this parameter is left blank, the value is set to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | + | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | | | + | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + | | | | | + | | | | If only **secondary_dns** is specified and **primary_dns** is not specified, **primary_dns** will automatically use the value of **secondary_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. If the value is not specified, the default value will be left blank. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 `. | + +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet01_0001__table1805181451016: @@ -114,6 +120,7 @@ Example Request "description": "", "cidr": "192.168.20.0/24", "gateway_ip": "192.168.20.1", + "ipv6_enable": true, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", @@ -121,7 +128,6 @@ Example Request "114.xx.xx.114", "114.xx.xx.115" ], - "availability_zone": "aa-bb-cc", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "extra_dhcp_opts": [ { @@ -170,20 +176,28 @@ Response Parameters | | | - The value must be an IP address in the subnet. | | | | - The value must be a valid IP address. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | + | 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. | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | secondary_dns | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + | | | | + | | | If only **secondary_dns** is specified and **primary_dns** is not specified, **primary_dns** will automatically use the value of **secondary_dns**. | + | | | | + | | | If there is only one DNS server address, only **primary_dns** is displayed. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dnsList | 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. If the value is not specified, the default value will be left blank. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | - | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | String | - Specifies the status of the subnet. | @@ -204,8 +218,25 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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 7 `. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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_0001__table019517383270: @@ -244,12 +275,15 @@ Example Response "status": "UNKNOWN", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", + "ipv6_enable": true, + "cidr_v6": "2001:db8:a583::/64", + "gateway_ip_v6": "2001:db8:a583::1", "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12" + "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", + "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", @@ -260,6 +294,9 @@ Example Response "opt_name": "addresstime" } ] + "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", + "created_at": "2022-12-15T02:42:07", + "updated_at": "2022-12-15T02:42:07" } } diff --git a/api-ref/source/apis/subnet/querying_subnet_details.rst b/api-ref/source/apis/subnet/querying_subnet_details.rst index 9c9be97..f240051 100644 --- a/api-ref/source/apis/subnet/querying_subnet_details.rst +++ b/api-ref/source/apis/subnet/querying_subnet_details.rst @@ -73,6 +73,12 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | @@ -81,8 +87,6 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | String | Identifies the AZ to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | String | - Specifies the status of the subnet. | @@ -96,8 +100,25 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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* | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet01_0002__table019517383270: @@ -136,10 +157,10 @@ Example Response "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", + "ipv6_enable": false, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "extra_dhcp_opts": [ @@ -152,6 +173,9 @@ Example Response "opt_name": "addresstime" } ] + "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", + "created_at": "2022-12-15T02:42:07", + "updated_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 df8505f..ca5d96b 100644 --- a/api-ref/source/apis/subnet/querying_subnets.rst +++ b/api-ref/source/apis/subnet/querying_subnets.rst @@ -88,6 +88,12 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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. | @@ -96,8 +102,6 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | String | Identifies the AZ to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | status | String | - Specifies the status of the subnet. | @@ -111,8 +115,25 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | 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* | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet01_0003__table019517383270: @@ -152,12 +173,15 @@ Example Response "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", + "ipv6_enable": true, + "cidr_v6": "2001:db8:a583::/64", + "gateway_ip_v6": "2001:db8:a583::1", "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", + "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", @@ -168,6 +192,9 @@ Example Response "opt_name": "addresstime" } ] + "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", + "created_at": "2022-12-15T02:42:07", + "updated_at": "2022-12-15T02:42:07" }, { "id": "531dec0f-3116-411b-a21b-e612e42349fd", @@ -181,10 +208,10 @@ Example Response "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.1.1", + "ipv6_enable": false, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc", "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd", "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", "extra_dhcp_opts": [ @@ -197,6 +224,9 @@ Example Response "opt_name": "addresstime" } ], + "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", + "created_at": "2022-12-15T03:41:22", + "updated_at": "2022-12-15T03:41:22" } ] } diff --git a/api-ref/source/apis/subnet/updating_subnet_information.rst b/api-ref/source/apis/subnet/updating_subnet_information.rst index e573af9..9f6eff2 100644 --- a/api-ref/source/apis/subnet/updating_subnet_information.rst +++ b/api-ref/source/apis/subnet/updating_subnet_information.rst @@ -57,6 +57,9 @@ Request Parameters | description | No | String | - Provides supplementary information about the subnet. | | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_enable | No | Boolean | - Specifies whether an IPv6 subnet can be created. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | | | | | - The value can be **true** (enabled) or **false** (disabled). | | | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. | @@ -65,7 +68,14 @@ Request Parameters | | | | - The value must be a valid IP address. | +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | | | | | | | - The value must be a valid IP address. | + | | | | | + | | | | 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**. | + | | | | | + | | | | 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. | diff --git a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst b/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst index d435d42..21a2b7a 100644 --- a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst +++ b/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst @@ -64,7 +64,7 @@ Request Parameters +=================+=================+=================+=====================================================================+ | key | String | Yes | - Specifies the tag key. | | | | | - Cannot be left blank. | - | | | | - Can contain a maximum of 36 characters. | + | | | | - Contain up to 128 characters (36 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -75,7 +75,7 @@ Request Parameters | | | | - The tag key of a VPC must be unique. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ | value | String | Yes | - Specifies the tag value. | - | | | | - Can contain a maximum of 43 characters. | + | | | | - Contain up to 255 characters (43 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | diff --git a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst b/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst index f6e622b..6a6977e 100644 --- a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst +++ b/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst @@ -51,7 +51,7 @@ Request Parameters +=================+=================+=================+=====================================================================+ | key | String | Yes | - Specifies the tag key. | | | | | - Cannot be left blank. | - | | | | - Can contain a maximum of 36 characters. | + | | | | - Contain up to 128 characters (36 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -62,7 +62,7 @@ Request Parameters | | | | - The tag key of a VPC must be unique. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ | value | String | Yes | - Specifies the tag value. | - | | | | - Can contain a maximum of 43 characters. | + | | | | - Contain up to 255 characters (43 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst index f67640c..fd4d35f 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst @@ -63,7 +63,7 @@ Response Parameters +=======================+=======================+=====================================================================+ | key | String | - Specifies the tag key. | | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | + | | | - Contain up to 128 characters (36 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -74,7 +74,7 @@ Response Parameters | | | - The tag key of a VPC must be unique. | +-----------------------+-----------------------+---------------------------------------------------------------------+ | value | String | - Specifies the tag value. | - | | | - Can contain a maximum of 43 characters. | + | | | - Contain up to 255 characters (43 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst index 20ed72e..7500cac 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst @@ -60,7 +60,7 @@ Response Parameters | key | String | Specifies the tag key. | | | | | | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | + | | | - Contain up to 128 characters (36 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -70,7 +70,7 @@ Response Parameters +-----------------------+-----------------------+---------------------------------------------------------------------+ | values | Array of strings | Specifies the tag value list. | | | | | - | | | - Can contain a maximum of 43 characters. | + | | | - Contain up to 255 characters (43 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst index 0feee9c..cefd65c 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst @@ -55,7 +55,7 @@ Request Parameters +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +========+===========+==================+====================================================================================================================================================================================+ - | key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | + | key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. | +--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -170,7 +170,7 @@ Response Parameters +-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=======+===========+========+====================================================================================================================================================================================+ - | key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | + | key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | +-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | value | Yes | String | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. | +-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst b/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst index 346dccf..7c9674b 100644 --- a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst +++ b/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst @@ -55,6 +55,7 @@ Request Parameters | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | | | | | | | - Possible values are as follows: | | | | | | | | | | - 10.0.0.0/8-24 | @@ -62,7 +63,12 @@ Request Parameters | | | | - 192.168.0.0/16-24 | | | | | | | | | | - If **cidr** is not specified, the default value is left blank. | - | | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The value must be in CIDR format, for example, **192.168.0.0/16**. | + | | | | | + | | | | If you want to update the CIDR block of the VPC, the new CIDR block must contain all subnets in the VPC. | +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | routes | No | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst b/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst index 365ef31..0f5f0f9 100644 --- a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst +++ b/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst @@ -62,7 +62,7 @@ Request Parameters +=================+=================+=================+=====================================================================+ | key | String | Yes | - Specifies the tag key. | | | | | - Cannot be left blank. | - | | | | - Can contain a maximum of 36 characters. | + | | | | - Contain up to 128 characters (36 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -73,7 +73,7 @@ Request Parameters | | | | - The tag key of a VPC must be unique. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ | value | String | Yes | - Specifies the tag value. | - | | | | - Can contain a maximum of 43 characters. | + | | | | - Contain up to 255 characters (43 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | diff --git a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst b/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst index 0683a99..f659931 100644 --- a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst +++ b/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst @@ -49,7 +49,7 @@ Request Parameters +=================+=================+=================+=====================================================================+ | key | String | Yes | - Specifies the tag key. | | | | | - Cannot be left blank. | - | | | | - Can contain a maximum of 36 characters. | + | | | | - Contain up to 128 characters (36 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | @@ -60,7 +60,7 @@ Request Parameters | | | | - The tag key of a VPC must be unique. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ | value | String | Yes | - Specifies the tag value. | - | | | | - Can contain a maximum of 43 characters. | + | | | | - Contain up to 255 characters (43 characters on the console). | | | | | - Can contain only the following character types: | | | | | | | | | | - Uppercase letters | diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst index bbb8065..037b718 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst @@ -61,7 +61,7 @@ Response Parameters +=======================+=======================+=====================================================================+ | key | String | - Specifies the tag key. | | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | + | | | - Contain up to 128 characters (36 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -72,7 +72,7 @@ Response Parameters | | | - The tag key of a VPC must be unique. | +-----------------------+-----------------------+---------------------------------------------------------------------+ | value | String | - Specifies the tag value. | - | | | - Can contain a maximum of 43 characters. | + | | | - Contain up to 255 characters (43 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst index 06f0ae4..f225614 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst @@ -60,7 +60,7 @@ Response Parameters | key | String | Specifies the tag key. | | | | | | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | + | | | - Contain up to 128 characters (36 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | @@ -70,7 +70,7 @@ Response Parameters +-----------------------+-----------------------+---------------------------------------------------------------------+ | values | Array of strings | Specifies the tag value list. | | | | | - | | | - Can contain a maximum of 43 characters. | + | | | - Contain up to 255 characters (43 characters on the console). | | | | - Can contain only the following character types: | | | | | | | | - Uppercase letters | diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst index 7173414..93a86d8 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst @@ -55,7 +55,7 @@ Request Parameters +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+==================+=================================================================================================================================================================================================================+ - | key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | + | key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | values | Yes | Array of strings | Specifies the tag values. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. | | | | | | @@ -174,7 +174,7 @@ Response Parameters +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+==================+=================================================================================================================================================================================================================+ - | key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | + | key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) | +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. | | | | | | diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 2f01682..80d01b6 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,12 @@ Change History +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2023-11-15 | This release incorporates the following changes: | +| | | +| | Modified the alias information in the response body in :ref:`Querying an EIP `. | +| | | +| | Modified IPv6-related fields in :ref:`Subnet `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-08-07 | This release incorporates the following changes: | | | | | | Added description about interconnection with IAM fine-grained authorization in :ref:`Permissions Policies and Supported Actions `. | diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index be574f4..0bb3078 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/virtual-private-cloud' otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' otcdocs_git_type = 'gitea' +# Those variables are needed for indexing into OpenSearch +otcdocs_doc_environment = 'internal' +otcdocs_doc_link = '/virtual-private-cloud/api-ref/' +otcdocs_doc_title = 'API Reference' +otcdocs_doc_type = 'api-ref' +otcdocs_service_category = 'network' +otcdocs_service_title = 'Virtual Private Cloud' +otcdocs_service_type = 'vpc' +otcdocs_search_environment = 'hc_de' +otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/" + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. 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 7a93077..6cde422 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 @@ -30,65 +30,65 @@ Request Parameters .. table:: **Table 2** **port** objects - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=======================+=================+====================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ - | name | No | String | Specifies the port name. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | Yes | String | - Specifies the ID of the network to which the port belongs. | - | | | | - The network ID must be a real one in the network environment. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies the administrative status. | - | | | | | - | | | | 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"}]**. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | - | | | | | - | | | | This parameter cannot be left blank. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | No | Array of :ref:`allow_address_pair ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 4 `. | - | | | | | - | | | | 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 | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 5 `. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | No | 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 | No | String | Specifies the type of the bound vNIC. | - | | | | | - | | | | **normal**: Softswitch | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 do not take effect. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | No | String | Specifies the device that the port belongs to. | - | | | | | - | | | | Currently, only **""** and **neutron:VIP_PORT** are supported. **neutron:VIP_PORT** indicates the port of a virtual IP address. | - +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=======================+=================+=======================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ + | name | No | String | Specifies the port name. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | Yes | String | - Specifies the ID of the network to which the port belongs. | + | | | | - The network ID must be a real one in the network environment. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | No | Boolean | Specifies the administrative status. | + | | | | | + | | | | 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"}]**. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + | | | | | + | | | | This parameter cannot be left blank. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | No | 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 4 `. | + | | | | | + | | | | 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 | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 5 `. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | No | 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 | No | String | Specifies the type of the bound vNIC. | + | | | | | + | | | | **normal**: Softswitch | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 do not take effect. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | No | String | Specifies the device that the port belongs to. | + | | | | | + | | | | Currently, only **""** and **neutron:VIP_PORT** are supported. **neutron:VIP_PORT** indicates the port of a virtual IP address. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0003__table335683819394: @@ -108,7 +108,7 @@ Request Parameters .. _vpc_port02_0003__en-us_topic_0062207355_table57914257: -.. table:: **Table 4** **allow_address_pair** object +.. table:: **Table 4** **allowed_address_pairs** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -166,110 +166,110 @@ 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**, or **neutron:VIP_PORT**. (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:`allow_address_pair ` 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"}]**. | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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* | + +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0003__table1424105920176: @@ -289,7 +289,7 @@ Response Parameters .. _vpc_port02_0003__table13242185941715: -.. table:: **Table 9** **allow_address_pair** objects +.. table:: **Table 9** **allowed_address_pairs** objects +-----------------------+-----------------------+---------------------------------------+ | Attribute | Type | Description | 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 9410df0..d41d1c2 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,110 @@ 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**, or **neutron:VIP_PORT**. (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:`allow_address_pair ` 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"}]**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0002__table4290920914597: @@ -177,7 +177,7 @@ Response Parameters .. _vpc_port02_0002__en-us_topic_0062207355_table57914257: -.. table:: **Table 5** **allow_address_pair** object +.. table:: **Table 5** **allowed_address_pairs** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | 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 8785d31..baebb84 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 | Specifies that the IP address is used as the filtering condition. The value can be **fixed_ips=ip_address** or **fixed_ips=subnet_id**. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. 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,108 @@ 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**, or **neutron:VIP_PORT**. (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:`allow_address_pair ` 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"}]**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0001__table4290920914597: @@ -260,7 +260,7 @@ Response Parameter .. _vpc_port02_0001__en-us_topic_0062207355_table57914257: -.. table:: **Table 5** **allow_address_pair** object +.. table:: **Table 5** **allowed_address_pairs** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | 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 a0f256e..66a2a0f 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 @@ -44,56 +44,56 @@ Request Parameters .. table:: **Table 3** **port** objects - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=======================+=================+==================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ - | name | No | String | Specifies the port name. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | - | | | | | - | | | | This parameter cannot be left blank. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | No | Array of :ref:`allow_address_pair ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 4 `. | - | | | | | - | | | | 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 | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 5 `. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | No | 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 | No | String | Specifies the type of the bound vNIC. | - | | | | | - | | | | **normal**: Softswitch | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 do not take effect. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=======================+=================+=====================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================+ + | name | No | String | Specifies the port name. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. | + | | | | | + | | | | This parameter cannot be left blank. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | No | 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 4 `. | + | | | | | + | | | | 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 | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 5 `. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | No | 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 | No | String | Specifies the type of the bound vNIC. | + | | | | | + | | | | **normal**: Softswitch | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 do not take effect. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0004__table1389733912184: -.. table:: **Table 4** **allow_address_pair** object +.. table:: **Table 4** **allowed_address_pairs** objects +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | @@ -149,110 +149,110 @@ 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**, or **neutron:VIP_PORT**. (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:`allow_address_pair ` 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"}]**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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* | + +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0004__table4290920914597: @@ -272,7 +272,7 @@ Response Parameters .. _vpc_port02_0004__en-us_topic_0062207355_table57914257: -.. table:: **Table 9** **allow_address_pair** objects +.. table:: **Table 9** **allowed_address_pairs** objects +-----------------------+-----------------------+---------------------------------------+ | Attribute | Type | Description | 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 6fbd33a..e69018a 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 @@ -39,7 +39,7 @@ Request Parameters +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_group_id | No | String | Specifies the peer ID of the belonged security group. | | | | | | - | | | | Either **remote_group_id** or **remote_ip_prefix** is used. | + | | | | 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. | | | | | | @@ -47,7 +47,7 @@ Request Parameters +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_ip_prefix | No | String | Specifies the peer IP address segment. | | | | | | - | | | | Either **remote_ip_prefix** or **remote_group_id** is used. | + | | | | This parameter is mutually exclusive with **remote_group_id**. | +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | protocol | No | String | Specifies the protocol type or the IP protocol number. | | | | | | 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 01774d1..4240465 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 @@ -30,51 +30,59 @@ 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 | - +------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 | + +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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**. | + +-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0003__table24611730: @@ -144,7 +152,15 @@ Response Parameters +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. | | | | | - | | | Supported versions: IPv4 | + | | | 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. | +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 592ce21..0f08af1 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 @@ -53,7 +53,15 @@ Response Parameters +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. | | | | | - | | | Supported versions: IPv4 | + | | | 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. | +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 ec1bdbc..7e0b903 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 @@ -118,7 +118,15 @@ Response Parameters +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. | | | | | - | | | Supported versions: IPv4 | + | | | 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. | +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 97c1147..587f967 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 @@ -130,7 +130,15 @@ Response Parameters +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. | | | | | - | | | Supported versions: IPv4 | + | | | 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. | +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+