diff --git a/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst b/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst index 51a3eba..fc01ff2 100644 --- a/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst +++ b/api-ref/source/api_v3/vpc/adding_a_secondary_cidr_block_to_a_vpc.rst @@ -21,7 +21,7 @@ PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/add-extend-cidr Parameter Mandatory Type Description ========== ========= ====== =========== project_id Yes String Project ID. - vpc_id Yes String VPC ID + vpc_id Yes String VPC ID. ========== ========= ====== =========== Request Parameter @@ -32,7 +32,7 @@ Request Parameter +-----------------+-----------------+--------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+========================================================================================================+==============================================================================================================================================================================================================================================================================================+ - | dry_run | No | Boolean | Whether to only check the request. | + | dry_run | No | Boolean | Whether to only send the check request. | | | | | | | | | | Value range: | | | | | | @@ -46,25 +46,26 @@ Request Parameter .. table:: **Table 3** AddExtendCidrOption - +-----------------+-----------------+------------------+--------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+====================================================================+ - | extend_cidrs | Yes | Array of strings | Secondary CIDR blocks that can be added to VPCs | - | | | | | - | | | | The value cannot contain the following: | - | | | | | - | | | | - 100.64.0.0/10 | - | | | | - 214.0.0.0/7 | - | | | | - 198.18.0.0/15 | - | | | | - 169.254.0.0/16 | - | | | | - 0.0.0.0/8 | - | | | | - 127.0.0.0/8 | - | | | | - 240.0.0.0/4 | - | | | | - 172.31.0.0/16 | - | | | | - 192.168.0.0/16 | - | | | | | - | | | | Currently, only one secondary CIDR block can be added to each VPC. | - +-----------------+-----------------+------------------+--------------------------------------------------------------------+ + +-----------------+-----------------+------------------+-------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==================+=======================================================+ + | extend_cidrs | Yes | Array of strings | Secondary CIDR blocks that can be added to VPCs | + | | | | | + | | | | The value cannot contain the following: | + | | | | | + | | | | - 100.64.0.0/10 | + | | | | - 214.0.0.0/7 | + | | | | - 198.18.0.0/15 | + | | | | - 169.254.0.0/16 | + | | | | - 0.0.0.0/8 | + | | | | - 127.0.0.0/8 | + | | | | - 240.0.0.0/4 | + | | | | - 172.31.0.0/16 | + | | | | - 192.168.0.0/16 | + | | | | - 255.255.255.255/32 | + | | | | | + | | | | A maximum of five secondary CIDR blocks can be added. | + +-----------------+-----------------+------------------+-------------------------------------------------------+ Example Request --------------- @@ -103,17 +104,17 @@ Response Parameter +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================================================================================================+================================================================================================================================================================+ - | id | String | VPC ID, which uniquely identifies the VPC | + | id | String | VPC ID that uniquely identifies the VPC | | | | | | | | The value is in UUID format with hyphens (-). | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | String | VPC name | | | | | - | | | The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | String | Provides supplementary information about the VPC. | | | | | - | | | The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + | | | The value can contain up to 255 characters and cannot contain angle brackets (< or >). | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cidr | String | Available VPC CIDR blocks | | | | | @@ -146,11 +147,11 @@ Response Parameter +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | created_at | String | Time when the VPC is created | | | | | - | | | UTC time in the format of yyyy-MM-ddTHH:mmss | + | | | UTC time in the format of yyyy-MM-ddTHH:mm:ssZ | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | updated_at | String | Time when the VPC is updated | | | | | - | | | UTC time in the format of yyyy-MM-ddTHH:mmss | + | | | UTC time in the format of yyyy-MM-ddTHH:mm:ssZ | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cloud_resources | Array of :ref:`CloudResource ` objects | Type and number of resources associated with the VPC | | | | | @@ -158,7 +159,7 @@ Response Parameter +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of :ref:`Tag ` objects | VPC tags. For details, see the tag objects. | | | | | - | | | Value range: 0 to 10 tag key-value pairs | + | | | Value range: 0 to 20 tag key-value pairs | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_apiv3_0007__en-us_topic_0267488960_response_cloudresource: @@ -176,23 +177,31 @@ Response Parameter .. table:: **Table 7** Tag - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================================================================================================+ - | key | String | Tag key | - | | | | - | | | Value range: | - | | | | - | | | - A tag key contains a maximum of 36 Unicode characters. | - | | | - A tag key cannot be left blank. It cannot contain non-printable ASCII characters (0-31) or the following special characters: ``*,<,>,,=`` | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | value | String | Tag value | - | | | | - | | | Value range: | - | | | | - | | | - A tag value contains a maximum of 43 Unicode characters and can be left blank. | - | | | - A tag value cannot contain non-printable ASCII characters (0-31) or the following special characters: ``*,<,>,,=`` | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===============================================================================+ + | key | String | Tag key | + | | | | + | | | Value range: | + | | | | + | | | - Each key can contain up to 36 Unicode characters and cannot be left blank. | + | | | - The value can contain: | + | | | | + | | | - Letters | + | | | - Digits | + | | | - Special characters: underscores (_) ,at signs (@), and hyphens (-) | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | value | String | Tag value | + | | | | + | | | Value range: | + | | | | + | | | - Each value can contain up to 43 Unicode characters and can be left blank. | + | | | - The value can contain: | + | | | | + | | | - Letters | + | | | - Digits | + | | | - Special characters: underscore (_), at signs (@), and hyphen (-) | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ Example Response ---------------- @@ -224,8 +233,8 @@ Example Response ], "status": "ACTIVE", "project_id": "060576782980d5762f9ec014dd2f1148", - "created_at": "2018-03-23T09:26:08", - "updated_at": "2018-08-24T08:49:53" + "created_at": "2018-03-23T09:26:08Z", + "updated_at": "2018-08-24T08:49:53Z" } } diff --git a/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst b/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst index a87c477..76a45b2 100644 --- a/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst +++ b/api-ref/source/api_v3/vpc/removing_a_secondary_cidr_block_from_a_vpc.rst @@ -21,7 +21,7 @@ PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/remove-extend-cidr Parameter Mandatory Type Description ========== ========= ====== =========== project_id Yes String Project ID. - vpc_id Yes String VPC ID + vpc_id Yes String VPC ID. ========== ========= ====== =========== Request Parameter @@ -32,7 +32,7 @@ Request Parameter +-----------------+-----------------+--------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Mandatory | Type | Description | +=================+=================+==============================================================================================================+==============================================================================================================================================================================================================================================================================================+ - | dry_run | No | Boolean | Whether to only check the request. | + | dry_run | No | Boolean | Whether to only send the check request. | | | | | | | | | | Value range: | | | | | | @@ -56,7 +56,6 @@ Request Parameter | | | | Constraints: | | | | | | | | | | - Before removing a secondary CIDR block, delete the subnets in the CIDR block first. | - | | | | - Currently, secondary CIDR blocks can only be removed one by one. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------+ Example Request @@ -96,17 +95,17 @@ Response Parameter +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Parameter | Type | Description | +=======================+=======================================================================================================+================================================================================================================================================================+ - | id | String | VPC ID, which uniquely identifies the VPC | + | id | String | VPC ID that uniquely identifies the VPC | | | | | | | | The value is in UUID format with hyphens (-). | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | name | String | VPC name | | | | | - | | | The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | String | Provides supplementary information about the VPC. | | | | | - | | | The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + | | | The value can contain up to 255 characters and cannot contain angle brackets (< or >). | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cidr | String | Available VPC CIDR blocks | | | | | @@ -139,11 +138,11 @@ Response Parameter +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | created_at | String | Time when the VPC is created | | | | | - | | | UTC time in the format of yyyy-MM-ddTHH:mmss | + | | | UTC time in the format of yyyy-MM-ddTHH:mm:ssZ | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | updated_at | String | Time when the VPC is updated | | | | | - | | | UTC time in the format of yyyy-MM-ddTHH:mmss | + | | | UTC time in the format of yyyy-MM-ddTHH:mm:ssZ | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cloud_resources | Array of :ref:`CloudResource ` objects | Type and number of resources associated with the VPC | | | | | @@ -151,7 +150,7 @@ Response Parameter +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of :ref:`Tag ` objects | VPC tags. For details, see the tag objects. | | | | | - | | | Value range: 0 to 10 tag key-value pairs | + | | | Value range: 0 to 20 tag key-value pairs | +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_apiv3_0008__en-us_topic_0267488960_response_cloudresource: @@ -169,23 +168,31 @@ Response Parameter .. table:: **Table 7** Tag - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================================================================================================+ - | key | String | Tag key | - | | | | - | | | Value range: | - | | | | - | | | - A tag key contains a maximum of 36 Unicode characters. | - | | | - A tag key cannot be left blank. It cannot contain non-printable ASCII characters (0-31) or the following special characters: ``*,<,>,,=`` | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | value | String | Tag value | - | | | | - | | | Value range: | - | | | | - | | | - A tag value contains a maximum of 43 Unicode characters and can be left blank. | - | | | - A tag value cannot contain non-printable ASCII characters (0-31) or the following special characters: ``*,<,>,,=`` | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===============================================================================+ + | key | String | Tag key | + | | | | + | | | Value range: | + | | | | + | | | - Each key can contain up to 36 Unicode characters and cannot be left blank. | + | | | - The value can contain: | + | | | | + | | | - Letters | + | | | - Digits | + | | | - Special characters: underscores (_) ,at signs (@), and hyphens (-) | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ + | value | String | Tag value | + | | | | + | | | Value range: | + | | | | + | | | - Each value can contain up to 43 Unicode characters and can be left blank. | + | | | - The value can contain: | + | | | | + | | | - Letters | + | | | - Digits | + | | | - Special characters: underscore (_), at signs (@), and hyphen (-) | + +-----------------------+-----------------------+-------------------------------------------------------------------------------+ Example Response ---------------- @@ -215,8 +222,8 @@ Example Response ], "status": "ACTIVE", "project_id": "060576782980d5762f9ec014dd2f1148", - "created_at": "2018-03-23T09:26:08", - "updated_at": "2018-08-24T08:49:53" + "created_at": "2018-03-23T09:26:08Z", + "updated_at": "2018-08-24T08:49:53Z" } } diff --git a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst index 28d32aa..a8f6fd9 100644 --- a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst @@ -38,9 +38,9 @@ Request Message - Example request - .. code-block:: + .. code-block:: text - Get https://{Endpoint}//v1/{project_id}/bandwidths/{bandwidth_id} + GET https://{Endpoint}//v1/{project_id}/bandwidths/{bandwidth_id} Response Message ---------------- diff --git a/api-ref/source/apis/bandwidth/querying_bandwidths.rst b/api-ref/source/apis/bandwidth/querying_bandwidths.rst index 7b9eb48..dc0a5ff 100644 --- a/api-ref/source/apis/bandwidth/querying_bandwidths.rst +++ b/api-ref/source/apis/bandwidth/querying_bandwidths.rst @@ -144,7 +144,7 @@ Response Message "bandwidths": [ { "id": "09b99c91-da7c-449f-94e2-f4934c5b2a71", - "name": "vpngw-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977", + "name": "test-f632a7b0-ef50-4ac5-97e9-ddc56b3d5977", "size": 200, "share_type": "PER", "publicip_info": [ @@ -164,7 +164,7 @@ Response Message }, { "id": "0a583ff1-b43e-4000-ade3-e7af0097f832", - "name": "vpngw-7e880d5b-f458-40ad-a7e5-735c44cd8b7d", + "name": "test-7e880d5b-f458-40ad-a7e5-735c44cd8b7d", "size": 300, "share_type": "PER", "publicip_info": [ diff --git a/api-ref/source/apis/eip/assigning_an_eip.rst b/api-ref/source/apis/eip/assigning_an_eip.rst index 20ceb47..52f34d9 100644 --- a/api-ref/source/apis/eip/assigning_an_eip.rst +++ b/api-ref/source/apis/eip/assigning_an_eip.rst @@ -16,15 +16,15 @@ The EIP service provides independent public IP addresses and bandwidth for Inter Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- @@ -112,7 +112,8 @@ Request Parameters | | | | | | | | | - If this parameter is set to **WHOLE**, the bandwidth ID must be specified. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | charge_mode | No | String | - The value is **traffic**, indicating that the billing is based on traffic. | + | charge_mode | No | String | - Specifies whether the bandwidth is billed by traffic or by bandwidth size. | + | | | | - The value is **traffic**, indicating that the billing is based on traffic. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request diff --git a/api-ref/source/apis/eip/querying_an_eip.rst b/api-ref/source/apis/eip/querying_an_eip.rst index d39a4e9..dc4117b 100644 --- a/api-ref/source/apis/eip/querying_an_eip.rst +++ b/api-ref/source/apis/eip/querying_an_eip.rst @@ -14,15 +14,15 @@ This API is used to query a specific EIP. Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- @@ -51,9 +51,9 @@ Request Message - Example request - .. code-block:: + .. code-block:: text - Get https://{Endpoint}/v1/{project_id}/publicips/{publicip_id} + GET https://{Endpoint}/v1/{project_id}/publicips/{publicip_id} Response Message ---------------- diff --git a/api-ref/source/apis/eip/querying_eips.rst b/api-ref/source/apis/eip/querying_eips.rst index 66a30c5..aa1793c 100644 --- a/api-ref/source/apis/eip/querying_eips.rst +++ b/api-ref/source/apis/eip/querying_eips.rst @@ -14,15 +14,15 @@ This API is used to query EIPs. Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- diff --git a/api-ref/source/apis/eip/releasing_an_eip.rst b/api-ref/source/apis/eip/releasing_an_eip.rst index 6553e6e..89f0ef0 100644 --- a/api-ref/source/apis/eip/releasing_an_eip.rst +++ b/api-ref/source/apis/eip/releasing_an_eip.rst @@ -14,15 +14,15 @@ This API is used to release an EIP. Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- diff --git a/api-ref/source/apis/eip/updating_an_eip.rst b/api-ref/source/apis/eip/updating_an_eip.rst index b8fff13..8fdca19 100644 --- a/api-ref/source/apis/eip/updating_an_eip.rst +++ b/api-ref/source/apis/eip/updating_an_eip.rst @@ -14,15 +14,15 @@ This API is used to bind an EIP to a NIC, or unbind an EIP from a NIC. Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- diff --git a/api-ref/source/apis/quota/querying_quotas.rst b/api-ref/source/apis/quota/querying_quotas.rst index 3bf9f75..7256a28 100644 --- a/api-ref/source/apis/quota/querying_quotas.rst +++ b/api-ref/source/apis/quota/querying_quotas.rst @@ -166,12 +166,6 @@ Example Response "quota": 10, "min": 0 }, - { - "type": "vpn", - "used": 0, - "quota": 5, - "min": 0 - }, { "type": "vpcPeer", "used": 0, 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 61c9ec6..526e305 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 @@ -131,41 +131,41 @@ Response Parameters .. table:: **Table 7** Description of the **route** field - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==================================================================================================+ - | type | String | - Specifies the route type. | - | | | - Values: | - | | | | - | | | - **ecs** (ECS) | - | | | - **eni** (NIC) | - | | | - **vip** (Virtual IP address) | - | | | - **nat** (NAT gateway) | - | | | - **peering** (VPC peering connection) | - | | | - **vpn** (VPN) | - | | | - **dc** (Direct 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. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the ID of the next hop in the route. | - | | | - Values: | - | | | | - | | | - When **type** is **ecs**, the value is the ECS ID. | - | | | - When **type** is **eni**, the value is the extension NIC ID. | - | | | - When **type** is **vip**, the value is the virtual IP address. | - | | | - When **type** is **nat**, the value is NAT gateway ID. | - | | | - When **type** is **peering**, the value is the VPC peering connection ID. | - | | | - When **type** is **vpn**, the value is the VPN ID. | - | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is 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 >). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is an ECS ID. | + | | | - When **type** is **eni**, the value is an extension NIC ID. | + | | | - When **type** is **vip**, the value is a virtual IP address. | + | | | - When **type** is **nat**, the value a NAT gateway ID. | + | | | - When **type** is **peering**, the value is a VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is a VPN ID. | + | | | - When **type** is **dc**, the value is a Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of an enterprise router. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0005__table17950204203919: 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 d920568..64bce55 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 @@ -67,41 +67,41 @@ Request Parameters .. table:: **Table 4** Description of the **route** field - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================================+ - | type | Yes | String | - Specifies the route type. | - | | | | - Values: | - | | | | | - | | | | - **ecs** (ECS) | - | | | | - **eni** (NIC) | - | | | | - **vip** (Virtual IP address) | - | | | | - **nat** (NAT gateway) | - | | | | - **peering** (VPC peering connection) | - | | | | - **vpn** (VPN) | - | | | | - **dc** (Direct 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. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ - | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | - | | | | - Values: | - | | | | | - | | | | - When **type** is **ecs**, the value is the ECS ID. | - | | | | - When **type** is **eni**, the value is the extension NIC ID. | - | | | | - When **type** is **vip**, the value is the virtual IP address. | - | | | | - When **type** is **nat**, the value is NAT gateway ID. | - | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | - | | | | - When **type** is **vpn**, the value is the VPN ID. | - | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | | - When **type** is 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 >). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+===========================================================================================+ + | type | Yes | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is an ECS ID. | + | | | | - When **type** is **eni**, the value is an extension NIC ID. | + | | | | - When **type** is **vip**, the value is a virtual IP address. | + | | | | - When **type** is **nat**, the value a NAT gateway ID. | + | | | | - When **type** is **peering**, the value is a VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is a VPN ID. | + | | | | - When **type** is **dc**, the value is a Direct Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. | + | | | | - When **type** is set to **er**, the value is the ID of an enterprise router. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ Example Request --------------- @@ -145,11 +145,11 @@ Response Parameters +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | +=======================+============================================================================+========================================================================================================================================+ - | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | id | String | - Specifies the route table ID that uniquely identifies the route table. | | | | - The value must be in standard UUID format. | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | name | String | - Specifies the route table name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | default | Boolean | - Specifies whether the route table is the default one. | | | | - The value can be **true** (default route table) or **false** (custom route table). | @@ -165,7 +165,7 @@ Response Parameters | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | description | String | - Provides supplementary information about the route table. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | created_at | String | - Specifies the time (UTC) when the route table is created. | | | | - Format: *yyyy-MM-ddTHH:mm:ss* | @@ -176,41 +176,41 @@ Response Parameters .. table:: **Table 7** Description of the **route** field - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==================================================================================================+ - | type | String | - Specifies the route type. | - | | | - Values: | - | | | | - | | | - **ecs** (ECS) | - | | | - **eni** (NIC) | - | | | - **vip** (Virtual IP address) | - | | | - **nat** (NAT gateway) | - | | | - **peering** (VPC peering connection) | - | | | - **vpn** (VPN) | - | | | - **dc** (Direct 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. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the ID of the next hop in the route. | - | | | - Values: | - | | | | - | | | - When **type** is **ecs**, the value is the ECS ID. | - | | | - When **type** is **eni**, the value is the extension NIC ID. | - | | | - When **type** is **vip**, the value is the virtual IP address. | - | | | - When **type** is **nat**, the value is NAT gateway ID. | - | | | - When **type** is **peering**, the value is the VPC peering connection ID. | - | | | - When **type** is **vpn**, the value is the VPN ID. | - | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is 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 >). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is an ECS ID. | + | | | - When **type** is **eni**, the value is an extension NIC ID. | + | | | - When **type** is **vip**, the value is a virtual IP address. | + | | | - When **type** is **nat**, the value a NAT gateway ID. | + | | | - When **type** is **peering**, the value is a VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is a VPN ID. | + | | | - When **type** is **dc**, the value is a Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of an enterprise router. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ .. table:: **Table 8** Description of the **subnet** field 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 91c8cce..b7b3b97 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 @@ -135,41 +135,41 @@ Response Parameters .. table:: **Table 7** Description of the **route** field - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==================================================================================================+ - | type | String | - Specifies the route type. | - | | | - Values: | - | | | | - | | | - **ecs** (ECS) | - | | | - **eni** (NIC) | - | | | - **vip** (Virtual IP address) | - | | | - **nat** (NAT gateway) | - | | | - **peering** (VPC peering connection) | - | | | - **vpn** (VPN) | - | | | - **dc** (Direct 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. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the ID of the next hop in the route. | - | | | - Values: | - | | | | - | | | - When **type** is **ecs**, the value is the ECS ID. | - | | | - When **type** is **eni**, the value is the extension NIC ID. | - | | | - When **type** is **vip**, the value is the virtual IP address. | - | | | - When **type** is **nat**, the value is NAT gateway ID. | - | | | - When **type** is **peering**, the value is the VPC peering connection ID. | - | | | - When **type** is **vpn**, the value is the VPN ID. | - | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is 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 >). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is an ECS ID. | + | | | - When **type** is **eni**, the value is an extension NIC ID. | + | | | - When **type** is **vip**, the value is a virtual IP address. | + | | | - When **type** is **nat**, the value a NAT gateway ID. | + | | | - When **type** is **peering**, the value is a VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is a VPN ID. | + | | | - When **type** is **dc**, the value is a Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of an enterprise router. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0007__table17950204203919: 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 8390c05..791b08a 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 @@ -21,13 +21,13 @@ GET /v1/{project_id}/routetables/{routetable_id} .. table:: **Table 1** Parameter description - +---------------+-----------+--------+------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +===============+===========+========+========================================================================+ - | project_id | Yes | String | Specifies the project ID. | - +---------------+-----------+--------+------------------------------------------------------------------------+ - | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | - +---------------+-----------+--------+------------------------------------------------------------------------+ + +---------------+-----------+--------+----------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+======================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+----------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID that uniquely identifies a route table. | + +---------------+-----------+--------+----------------------------------------------------------------------+ Request Parameters ------------------ @@ -59,11 +59,11 @@ Response Parameters +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | +=======================+============================================================================+========================================================================================================================================+ - | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | id | String | - Specifies the route table ID that uniquely identifies the route table. | | | | - The value must be in standard UUID format. | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | name | String | - Specifies the route table name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | default | Boolean | - Specifies whether the route table is the default one. | | | | - The value can be **true** (default route table) or **false** (custom route table). | @@ -79,7 +79,7 @@ Response Parameters | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | description | String | - Provides supplementary information about the route table. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | created_at | String | - Specifies the time (UTC) when the route table is created. | | | | - Format: *yyyy-MM-ddTHH:mm:ss* | @@ -92,41 +92,41 @@ Response Parameters .. table:: **Table 4** Description of the **route** field - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==================================================================================================+ - | type | String | - Specifies the route type. | - | | | - Values: | - | | | | - | | | - **ecs** (ECS) | - | | | - **eni** (NIC) | - | | | - **vip** (Virtual IP address) | - | | | - **nat** (NAT gateway) | - | | | - **peering** (VPC peering connection) | - | | | - **vpn** (VPN) | - | | | - **dc** (Direct 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. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the ID of the next hop in the route. | - | | | - Values: | - | | | | - | | | - When **type** is **ecs**, the value is the ECS ID. | - | | | - When **type** is **eni**, the value is the extension NIC ID. | - | | | - When **type** is **vip**, the value is the virtual IP address. | - | | | - When **type** is **nat**, the value is NAT gateway ID. | - | | | - When **type** is **peering**, the value is the VPC peering connection ID. | - | | | - When **type** is **vpn**, the value is the VPN ID. | - | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is 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 >). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is an ECS ID. | + | | | - When **type** is **eni**, the value is an extension NIC ID. | + | | | - When **type** is **vip**, the value is a virtual IP address. | + | | | - When **type** is **nat**, the value a NAT gateway ID. | + | | | - When **type** is **peering**, the value is a VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is a VPN ID. | + | | | - When **type** is **dc**, the value is a Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of an enterprise router. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0002__table17950204203919: diff --git a/api-ref/source/apis/route_table/querying_route_tables.rst b/api-ref/source/apis/route_table/querying_route_tables.rst index bc1dc28..b4ace83 100644 --- a/api-ref/source/apis/route_table/querying_route_tables.rst +++ b/api-ref/source/apis/route_table/querying_route_tables.rst @@ -8,7 +8,7 @@ Querying Route Tables Function -------- -This API is used to query all route tables of the tenant submitting the request. The route tables are filtered based on the filtering condition. +This API is used to query route tables. URI --- @@ -45,11 +45,11 @@ Example: | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | Specifies the route table ID, which can be used to filter the route table with the corresponding ID. | + | id | No | String | Specifies the route table ID that is used as the filter. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | No | String | Specifies the VPC UUID. | + | vpc_id | No | String | Specifies the VPC UUID that is used as the filter. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | No | String | Specifies the subnet ID. | + | subnet_id | No | String | Specifies the subnet UUID that is used as the filter. | | | | | | | | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -84,11 +84,11 @@ Response Parameters +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | +=======================+===========================================================================+=======================================================================================================================================+ - | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | id | String | - Specifies the route table ID that uniquely identifies a route table. | | | | - The value must be in standard UUID format. | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | name | String | - Specifies the route table name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | default | Boolean | - Specifies whether the route table is the default one. | | | | - The value can be **true** (default route table) or **false** (custom route table). | @@ -101,7 +101,7 @@ Response Parameters | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | description | String | - Provides supplementary information about the route table. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | created_at | String | - Specifies the time (UTC) when the route table is created. | | | | - Format: *yyyy-MM-ddTHH:mm:ss* | 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 c84cbf2..0c5bdf6 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 @@ -21,13 +21,13 @@ PUT /v1/{project_id}/routetables/{routetable_id} .. table:: **Table 1** Parameter description - +---------------+-----------+--------+------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +===============+===========+========+========================================================================+ - | project_id | Yes | String | Specifies the project ID. | - +---------------+-----------+--------+------------------------------------------------------------------------+ - | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | - +---------------+-----------+--------+------------------------------------------------------------------------+ + +---------------+-----------+--------+----------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+======================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+----------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID that uniquely identifies a route table. | + +---------------+-----------+--------+----------------------------------------------------------------------+ Request Parameters ------------------ @@ -51,7 +51,7 @@ Request Parameters | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | description | No | String | - Provides supplementary information about the route. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + | | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | routes | No | :ref:`RouteTableRouteAction ` object | - Specifies the route list. For details, see :ref:`Table 4 `. | | | | | - Constraints: | @@ -70,141 +70,141 @@ Request Parameters .. table:: **Table 4** Description of the **route** field - +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+========================================================================================+=============================================================================================+ - | add | No | Array of :ref:`AddRouteTableRoute ` objects | Add a route. For details, see :ref:`Table 5 `. | - | | | | | - | | | | Parameters **type**, **destination**, and **nexthop** are mandatory. | - +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ - | mod | No | Array of :ref:`ModRouteTableRoute ` objects | Modify a route. For details, see :ref:`Table 6 `. | - | | | | | - | | | | Parameters **type**, **destination**, and **nexthop** are mandatory. | - +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ - | del | No | Array of :ref:`DelRouteTableRoute ` objects | Delete a route. For details, see :ref:`Table 7 `. | - | | | | | - | | | | Parameter **destination** is mandatory. | - +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+========================================================================================+===============================================================================================+ + | add | No | Array of :ref:`AddRouteTableRoute ` objects | Adds a route. For details, see :ref:`Table 5 `. | + | | | | | + | | | | Parameters **type**, **destination**, and **nexthop** are mandatory. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | mod | No | Array of :ref:`ModRouteTableRoute ` objects | Modifies a route. For details, see :ref:`Table 6 `. | + | | | | | + | | | | Parameters **type**, **destination**, and **nexthop** are mandatory. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | del | No | Array of :ref:`DelRouteTableRoute ` objects | Deletes a route. For details, see :ref:`Table 7 `. | + | | | | | + | | | | Parameter **destination** is mandatory. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0004__table11648235202119: .. table:: **Table 5** Field description of adding a route - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================================+ - | type | Yes | String | - Specifies the route type. | - | | | | - Values: | - | | | | | - | | | | - **ecs** (ECS) | - | | | | - **eni** (NIC) | - | | | | - **vip** (Virtual IP address) | - | | | | - **nat** (NAT gateway) | - | | | | - **peering** (VPC peering connection) | - | | | | - **vpn** (VPN) | - | | | | - **dc** (Direct 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. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ - | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | - | | | | - Values: | - | | | | | - | | | | - When **type** is **ecs**, the value is the ECS ID. | - | | | | - When **type** is **eni**, the value is the extension NIC ID. | - | | | | - When **type** is **vip**, the value is the virtual IP address. | - | | | | - When **type** is **nat**, the value is NAT gateway ID. | - | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | - | | | | - When **type** is **vpn**, the value is the VPN ID. | - | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | | - When **type** is 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 >). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===========================================================================================+ + | type | Yes | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is an ECS ID. | + | | | | - When **type** is **eni**, the value is an extension NIC ID. | + | | | | - When **type** is **vip**, the value is a virtual IP address. | + | | | | - When **type** is **nat**, the value a NAT gateway ID. | + | | | | - When **type** is **peering**, the value is a VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is a VPN ID. | + | | | | - When **type** is **dc**, the value is a Direct Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. | + | | | | - When **type** is set to **er**, the value is the ID of an enterprise router. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0004__table1294364718262: .. table:: **Table 6** Field description of modifying a route - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================================+ - | type | Yes | String | - Specifies the route type. | - | | | | - Values: | - | | | | | - | | | | - **ecs** (ECS) | - | | | | - **eni** (NIC) | - | | | | - **vip** (Virtual IP address) | - | | | | - **nat** (NAT gateway) | - | | | | - **peering** (VPC peering connection) | - | | | | - **vpn** (VPN) | - | | | | - **dc** (Direct 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. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ - | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | - | | | | - Values: | - | | | | | - | | | | - When **type** is **ecs**, the value is the ECS ID. | - | | | | - When **type** is **eni**, the value is the extension NIC ID. | - | | | | - When **type** is **vip**, the value is the virtual IP address. | - | | | | - When **type** is **nat**, the value is NAT gateway ID. | - | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | - | | | | - When **type** is **vpn**, the value is the VPN ID. | - | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | | - When **type** is 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 >). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===========================================================================================+ + | type | Yes | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is an ECS ID. | + | | | | - When **type** is **eni**, the value is an extension NIC ID. | + | | | | - When **type** is **vip**, the value is a virtual IP address. | + | | | | - When **type** is **nat**, the value a NAT gateway ID. | + | | | | - When **type** is **peering**, the value is a VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is a VPN ID. | + | | | | - When **type** is **dc**, the value is a Direct Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. | + | | | | - When **type** is set to **er**, the value is the ID of an enterprise router. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ .. _vpc_apiroutetab_0004__table27171519267: .. table:: **Table 7** Field description of deleting a route - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================================+ - | type | No | String | - Specifies the route type. | - | | | | - Values: | - | | | | | - | | | | - **ecs** (ECS) | - | | | | - **eni** (NIC) | - | | | | - **vip** (Virtual IP address) | - | | | | - **nat** (NAT gateway) | - | | | | - **peering** (VPC peering connection) | - | | | | - **vpn** (VPN) | - | | | | - **dc** (Direct 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. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ - | nexthop | No | String | - Specifies the ID of the next hop in the route. | - | | | | - Values: | - | | | | | - | | | | - When **type** is **ecs**, the value is the ECS ID. | - | | | | - When **type** is **eni**, the value is the extension NIC ID. | - | | | | - When **type** is **vip**, the value is the virtual IP address. | - | | | | - When **type** is **nat**, the value is NAT gateway ID. | - | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | - | | | | - When **type** is **vpn**, the value is the VPN ID. | - | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | | - When **type** is 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 >). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+===========================================================================================+ + | type | No | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **egw**: VPC endpoint node | + | | | | - **er**: enterprise router | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | nexthop | No | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is an ECS ID. | + | | | | - When **type** is **eni**, the value is an extension NIC ID. | + | | | | - When **type** is **vip**, the value is a virtual IP address. | + | | | | - When **type** is **nat**, the value a NAT gateway ID. | + | | | | - When **type** is **peering**, the value is a VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is a VPN ID. | + | | | | - When **type** is **dc**, the value is a Direct Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. | + | | | | - When **type** is set to **er**, the value is the ID of an enterprise router. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ Example Request --------------- @@ -263,11 +263,11 @@ Response Parameters +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | +=======================+============================================================================+========================================================================================================================================+ - | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | id | String | - Specifies the route table ID that uniquely identifies the route table. | | | | - The value must be in standard UUID format. | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | name | String | - Specifies the route table name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | default | Boolean | - Specifies whether the route table is the default one. | | | | - The value can be **true** (default route table) or **false** (custom route table). | @@ -283,7 +283,7 @@ Response Parameters | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | description | String | - Provides supplementary information about the route table. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | created_at | String | - Specifies the time (UTC) when the route table is created. | | | | - Format: *yyyy-MM-ddTHH:mm:ss* | @@ -294,41 +294,41 @@ Response Parameters .. table:: **Table 10** Description of the **route** field - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==================================================================================================+ - | type | String | - Specifies the route type. | - | | | - Values: | - | | | | - | | | - **ecs** (ECS) | - | | | - **eni** (NIC) | - | | | - **vip** (Virtual IP address) | - | | | - **nat** (NAT gateway) | - | | | - **peering** (VPC peering connection) | - | | | - **vpn** (VPN) | - | | | - **dc** (Direct 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. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the ID of the next hop in the route. | - | | | - Values: | - | | | | - | | | - When **type** is **ecs**, the value is the ECS ID. | - | | | - When **type** is **eni**, the value is the extension NIC ID. | - | | | - When **type** is **vip**, the value is the virtual IP address. | - | | | - When **type** is **nat**, the value is NAT gateway ID. | - | | | - When **type** is **peering**, the value is the VPC peering connection ID. | - | | | - When **type** is **vpn**, the value is the VPN ID. | - | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | - | | | - When **type** is 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 >). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **egw**: VPC endpoint node | + | | | - **er**: enterprise router | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - Constraints: The value must be in valid IPv4 or IPv6 CIDR formats. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is an ECS ID. | + | | | - When **type** is **eni**, the value is an extension NIC ID. | + | | | - When **type** is **vip**, the value is a virtual IP address. | + | | | - When **type** is **nat**, the value a NAT gateway ID. | + | | | - When **type** is **peering**, the value is a VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is a VPN ID. | + | | | - When **type** is **dc**, the value is a Direct Connect connection ID. | + | | | - When **type** is set to **egw**, the value is a VPC endpoint ID. | + | | | - When **type** is set to **er**, the value is the ID of an enterprise router. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain up to 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ .. table:: **Table 11** Description of the **subnet** field diff --git a/api-ref/source/apis/security_group/associating_multiple_nic_ports_to_or_disassociating_them_from_a_security_group_at_a_time.rst b/api-ref/source/apis/security_group/associating_multiple_nic_ports_to_or_disassociating_them_from_a_security_group_at_a_time.rst index 5736c8e..edd943c 100644 --- a/api-ref/source/apis/security_group/associating_multiple_nic_ports_to_or_disassociating_them_from_a_security_group_at_a_time.rst +++ b/api-ref/source/apis/security_group/associating_multiple_nic_ports_to_or_disassociating_them_from_a_security_group_at_a_time.rst @@ -53,11 +53,11 @@ Request Message .. table:: **Table 3** Description of field **Port** - +------+-----------+--------+------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +======+===========+========+============================================================+ - | id | Yes | String | Specifies the port ID, which uniquely identifies the port. | - +------+-----------+--------+------------------------------------------------------------+ + +------+-----------+--------+----------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +======+===========+========+==========================================================+ + | id | Yes | String | Specifies the port ID that uniquely identifies the port. | + +------+-----------+--------+----------------------------------------------------------+ - Example request diff --git a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst index 77ebe67..12f0633 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst @@ -65,10 +65,10 @@ Request Parameters | | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_group_id | No | String | - Specifies the ID of the peer security group. | - | | | | - This parameter is mutually exclusive with parameter **remote_ip_prefix**. | + | | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | - | | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + | | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request diff --git a/api-ref/source/apis/security_group/querying_security_groups.rst b/api-ref/source/apis/security_group/querying_security_groups.rst index a1a0816..b036eb6 100644 --- a/api-ref/source/apis/security_group/querying_security_groups.rst +++ b/api-ref/source/apis/security_group/querying_security_groups.rst @@ -87,7 +87,7 @@ Response Parameters +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | id | String | Specifies the security group ID, which uniquely identifies the security group. | +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | + | vpc_id | String | Specifies the ID of the VPC that the security group is associated with. | | | | | | | | .. note:: | | | | | diff --git a/api-ref/source/apis/subnet/creating_a_subnet.rst b/api-ref/source/apis/subnet/creating_a_subnet.rst index 43c0398..8d20eef 100644 --- a/api-ref/source/apis/subnet/creating_a_subnet.rst +++ b/api-ref/source/apis/subnet/creating_a_subnet.rst @@ -59,7 +59,7 @@ Request Parameters | | | | - 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. | + | ipv6_enable | No | Boolean | - Specifies whether IPv6 is enabled. | | | | | - The value can be **true** (enabled) or **false** (disabled). | | | | | - If this parameter is left blank, the system automatically sets it to **false** by default. | +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -67,10 +67,10 @@ Request Parameters | | | | - The value can be **true** (enabled) or **false** (disabled). | | | | | - If this parameter is left blank, the value is set to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. | +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | + | primary_dns | No | String | - Specifies the primary IP address of DNS server on the subnet. | | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | +-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | + | secondary_dns | No | String | - Specifies the standby IP address of DNS server on the subnet. | | | | | | | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | | | | | | @@ -99,7 +99,7 @@ Request Parameters | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. | | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -170,7 +170,7 @@ Response Parameters | | | - The value must be an IP address in the subnet. | | | | - The value must be a valid IP address. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | + | ipv6_enable | Boolean | Specifies whether IPv6 is enabled. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -178,10 +178,10 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | - Specifies the IP address of DNS server 1 on the subnet. | + | primary_dns | String | - Specifies the primary IP address of DNS server on the subnet. | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | - Specifies the IP address of DNS server 2 on the subnet. | + | secondary_dns | String | - Specifies the standby IP address of DNS server on the subnet. | | | | | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | | | | | @@ -216,14 +216,13 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 7 `. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | scope | String | Specifies where the subnet is used in edge cloud scenario. | + | scope | String | - Specifies where the subnet is used in edge cloud scenario. | + | | | - The value can be: | | | | | - | | | Values: | - | | | | - | | | - **center**: The subnet is used in a central AZ. | - | | | - *{azId}*: The subnet is used in an edge AZ. | + | | | - **center**: The subnet is used in a central AZ. | + | | | - *{azId}*: The subnet is used in an edge AZ. | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Project ID | + | tenant_id | String | - Project ID | +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | created_at | String | - Specifies the time (UTC) when the subnet is created. | | | | - Format: *yyyy-MM-ddTHH:mm:ss* | @@ -245,7 +244,7 @@ Response Parameters | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. | | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/subnet/querying_subnet_details.rst b/api-ref/source/apis/subnet/querying_subnet_details.rst index cd1ff03..3c41d29 100644 --- a/api-ref/source/apis/subnet/querying_subnet_details.rst +++ b/api-ref/source/apis/subnet/querying_subnet_details.rst @@ -73,7 +73,7 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | gateway_ip | String | Specifies the subnet gateway address. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | + | ipv6_enable | Boolean | Specifies whether IPv6 is enabled. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -81,9 +81,9 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | + | primary_dns | String | Specifies the primary IP address of DNS server on the subnet. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | + | secondary_dns | String | Specifies the standby IP address of DNS server on the subnet. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -104,12 +104,11 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | scope | String | Specifies where the subnet is used in edge cloud scenario. | + | scope | String | - Specifies where the subnet is used in edge cloud scenario. | + | | | - The value can be: | | | | | - | | | Values: | - | | | | - | | | - **center**: The subnet is used in a central AZ. | - | | | - *{azId}*: The subnet is used in an edge AZ. | + | | | - **center**: The subnet is used in a central AZ. | + | | | - *{azId}*: The subnet is used in an edge AZ. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | tenant_id | String | Project ID | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -133,7 +132,7 @@ Response Parameters | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. | | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/subnet/querying_subnets.rst b/api-ref/source/apis/subnet/querying_subnets.rst index 31a6d1c..d5041ad 100644 --- a/api-ref/source/apis/subnet/querying_subnets.rst +++ b/api-ref/source/apis/subnet/querying_subnets.rst @@ -21,6 +21,10 @@ Example: GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85 +:ref:`Table 1 ` describes the parameters. + +.. _vpc_subnet01_0003__table42526340: + .. table:: **Table 1** Parameter description +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -41,9 +45,9 @@ Example: | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | No | String | Specifies that the VPC ID is used as the filtering condition. | + | vpc_id | No | String | Specifies the VPC ID that is used to query subnets. | | | | | | - | | | | This field is mandatory in the fine-grained authorization scenario based on enterprise projects. | + | | | | This field is mandatory for the fine-grained authorization by enterprise project. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters @@ -63,11 +67,11 @@ Response Parameters .. table:: **Table 2** Response parameter - +---------+-----------------------------------------------------------------------+------------------------+ - | Name | Type | Description | - +=========+=======================================================================+========================+ - | subnets | Array of :ref:`subnet ` objects | Specifies the subnets. | - +---------+-----------------------------------------------------------------------+------------------------+ + +---------+-----------------------------------------------------------------------+-------------------------------+ + | Name | Type | Description | + +=========+=======================================================================+===============================+ + | subnets | Array of :ref:`subnet ` objects | Specifies the subnet objects. | + +---------+-----------------------------------------------------------------------+-------------------------------+ .. _vpc_subnet01_0003__table946390317596: @@ -88,17 +92,17 @@ Response Parameters +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | gateway_ip | String | Specifies the subnet gateway address. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. | + | ipv6_enable | Boolean | Specifies whether IPv6 is enabled. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. | + | gateway_ip_v6 | String | Specifies the IPv6 subnet gateway address. If the subnet is an IPv4 subnet, this parameter is not returned. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | + | primary_dns | String | Specifies the primary IP address of DNS server on the subnet. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | + | secondary_dns | String | Specifies the standby IP address of DNS server on the subnet. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ @@ -111,22 +115,21 @@ Response Parameters | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | | | | - **ERROR**: indicates that the subnet is abnormal. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | + | neutron_network_id | String | Specifies the ID of the network (OpenStack Neutron API). | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | + | neutron_subnet_id | String | Specifies the ID of the subnet (OpenStack Neutron API). | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 `. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | scope | String | Specifies where the subnet is used in edge cloud scenario. | + | scope | String | - Specifies where the subnet is used in edge cloud scenario. | + | | | - The value can be: | | | | | - | | | Values: | - | | | | - | | | - **center**: The subnet is used in a central AZ. | - | | | - *{azId}*: The subnet is used in an edge AZ. | + | | | - **center**: The subnet is used in a central AZ. | + | | | - *{azId}*: The subnet is used in an edge AZ. | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Project ID | + | tenant_id | String | - Project ID | +-----------------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ | created_at | String | - Specifies the time (UTC) when the subnet is created. | | | | - Format: *yyyy-MM-ddTHH:mm:ss* | @@ -148,7 +151,7 @@ Response Parameters | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. | | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/subnet/updating_subnet_information.rst b/api-ref/source/apis/subnet/updating_subnet_information.rst index 261b59b..09d2342 100644 --- a/api-ref/source/apis/subnet/updating_subnet_information.rst +++ b/api-ref/source/apis/subnet/updating_subnet_information.rst @@ -28,7 +28,7 @@ PUT /v1/{project_id}/vpcs/{vpc_id}/subnets/{subnet_id} +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ | vpc_id | Yes | Specifies the VPC ID of the subnet. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | subnet_id | Yes | Specifies the subnet ID, which uniquely identifies the subnet. | + | subnet_id | Yes | Specifies the subnet ID that uniquely identifies the subnet. | | | | | | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ @@ -57,17 +57,17 @@ 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. | + | ipv6_enable | No | Boolean | - Specifies whether IPv6 is enabled. | | | | | - The value can be **true** (enabled) or **false** (disabled). | +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | | | | | - The value can be **true** (enabled) or **false** (disabled). | | | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. | +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | + | primary_dns | No | String | - Specifies the primary IP address of DNS server on the subnet. | | | | | - The value must be a valid IP address. IPv6 addresses are not supported. | +-----------------+-----------------+-------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | + | secondary_dns | No | String | - Specifies the standby IP address of DNS server on the subnet. | | | | | | | | | | - The value must be a valid IP address. IPv6 addresses are not supported. | | | | | | @@ -94,7 +94,7 @@ Request Parameters | | | | | | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. | + | opt_name | Yes | String | - Specifies the NTP server address configured for the subnet. | | | | | - Currently, the value can only be set to **ntp**. | +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ 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 fd4d35f..1a243b0 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 @@ -26,7 +26,7 @@ GET /v2.0/{project_id}/subnets/{subnet_id}/tags +=======================+=======================+=============================================================================================+ | project_id | Yes | Specifies the project ID. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | subnet_id | Yes | Specifies the subnet ID, which uniquely identifies the subnet. | + | subnet_id | Yes | Specifies the subnet ID that uniquely identifies the subnet. | | | | | | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ diff --git a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst index 387c935..f16915e 100644 --- a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst @@ -140,15 +140,15 @@ Response Parameters .. table:: **Table 6** **route** objects - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in CIDR format. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address from the subnet of the VPC. IPv4 and IPv6 addresses are supported. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ Example Response ---------------- diff --git a/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst index dc66cf3..483730f 100644 --- a/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst @@ -21,13 +21,13 @@ DELETE /v1/{project_id}/vpcs/{vpc_id} .. table:: **Table 1** Parameter description - +------------+-----------+----------------------------------------------------------+ - | Name | Mandatory | Description | - +============+===========+==========================================================+ - | project_id | Yes | Specifies the project ID. | - +------------+-----------+----------------------------------------------------------+ - | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | - +------------+-----------+----------------------------------------------------------+ + +------------+-----------+--------------------------------------------------------+ + | Name | Mandatory | Description | + +============+===========+========================================================+ + | project_id | Yes | Specifies the project ID. | + +------------+-----------+--------------------------------------------------------+ + | vpc_id | Yes | Specifies the VPC ID that uniquely identifies the VPC. | + +------------+-----------+--------------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst b/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst index 4cd4b43..3458c56 100644 --- a/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst +++ b/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst @@ -97,15 +97,15 @@ Response Parameters .. table:: **Table 4** **route** objects - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in CIDR format. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================+ + | destination | String | - Specifies the destination network segment of a route. | + | | | - Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address from the subnet of the VPC. IPv4 and IPv6 addresses are supported. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ Example Response ---------------- diff --git a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst index a1e252b..4e8bc37 100644 --- a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst +++ b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst @@ -47,7 +47,7 @@ Example: | | | | | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter out the VPCs associated with a specified enterprise project. | + | enterprise_project_id | No | String | - Specifies the enterprise project ID that is used to filter out the VPCs associated with a specified enterprise project. | | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the VPCs bound to all enterprise projects of the user, set **all_granted_eps**. | | | | | - If this parameter is not specified, VPCs in the default enterprise project are queried and are authenticated based on the default enterprise project. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,66 +69,66 @@ Response Parameters .. table:: **Table 2** Response parameter - +------+--------------------------------------------------------------+---------------------+ - | Name | Type | Description | - +======+==============================================================+=====================+ - | vpcs | Array of :ref:`vpcs ` objects | Specifies the VPCs. | - +------+--------------------------------------------------------------+---------------------+ + +------+-------------------------------------------------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +======+=============================================================+===================================================================+ + | vpcs | Array of :ref:`vpc ` objects | Specifies the :ref:`VPC objects `. | + +------+-------------------------------------------------------------+-------------------------------------------------------------------+ .. _vpc_api01_0003__table65129753: -.. table:: **Table 3** Description of the **vpcs** field +.. table:: **Table 3** VPC objects - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the VPC name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 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**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 (-). Value **0** indicates the default enterprise project. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see :ref:`Table 4 `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+===================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the VPC name. | + | | | - The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 192.168.0.0/16-24 | + | | | | + | | | - If **cidr** is not specified, the value is left blank by default. | + | | | - If **cidr** is specified, the value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 (-). Value **0** indicates the default enterprise project. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see :ref:`Table 4 `. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether to enable the shared SNAT function. **true** indicates that the function is enabled, and **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_api01_0003__table3576833291556: .. table:: **Table 4** **route** objects - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in CIDR format. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address from the subnet of the VPC. IPv4 and IPv6 addresses are supported. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ Example Response ---------------- diff --git a/api-ref/source/apis/virtual_private_cloud/updating_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/updating_a_vpc.rst index 39f198d..8333260 100644 --- a/api-ref/source/apis/virtual_private_cloud/updating_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/updating_a_vpc.rst @@ -44,50 +44,45 @@ Request Parameters .. table:: **Table 3** VPC objects - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +====================+=================+====================================================================+=======================================================================================================================================================================================+ - | name | No | String | - Specifies the VPC name. | - | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the VPC. | - | | | | - 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 | - | | | | - 172.16.0.0/12-24 | - | | | | - 192.168.0.0/16-24 | - | | | | | - | | | | - If **cidr** is not specified, the default value is left blank. | - | | | | | - | | | | - 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 `. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | No | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+====================================================================+=========================================================================================================================+ + | name | No | String | - Specifies the VPC name. | + | | | | - The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------+-----------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the VPC. | + | | | | - 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 | + | | | | - 172.16.0.0/12-24 | + | | | | - 192.168.0.0/16-24 | + | | | | | + | | | | - If **cidr** is not specified, the value is left blank by default. | + | | | | - 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 `. | + +-----------------+-----------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ .. _vpc_api01_0004__table1696324019336: .. table:: **Table 4** **route** objects - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================+ - | destination | No | String | - Specifies the destination network segment of a route. | - | | | | - The value must be in CIDR format. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | No | String | - Specifies the next hop of a route. | - | | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+=======================================================================================================+ + | destination | No | String | - Specifies the destination CIDR block of a route. | + | | | | - Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | nexthop | No | String | - Specifies the next hop of a route. | + | | | | - The value must be an IP address from the subnet of the VPC. IPv4 and IPv6 addresses are supported. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ Example Request --------------- @@ -102,8 +97,7 @@ Example Request "vpc": { "name": "vpc1", "description": "test1", - "cidr": "192.168.0.0/16", - "enable_shared_snat": true + "cidr": "192.168.0.0/16" } } @@ -122,54 +116,54 @@ Response Parameters .. table:: **Table 6** VPC objects - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC name. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 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**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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 (-). Value **0** indicates the default enterprise project. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see the description of the :ref:`route objects `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+===================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC name. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 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**. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created successfully. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 (-). Value **0** indicates the default enterprise project. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see the description of the :ref:`route objects `. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether to enable the shared SNAT function. **true** indicates that the function is enabled, and **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_api01_0004__table3576833291556: .. table:: **Table 7** **route** objects - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in CIDR format. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address from the subnet of the VPC. IPv4 and IPv6 addresses are supported. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ Example Response ---------------- diff --git a/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst b/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst index b9d8179..f04624f 100644 --- a/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst +++ b/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst @@ -109,13 +109,11 @@ Response Parameters +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | description | String | Provides supplementary information about the VPC peering connection. | +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | + | created_at | String | - Specifies the time (UTC) when the VPC peering connection is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | + | updated_at | String | - Specifies the time (UTC) when the VPC peering connection is updated. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ .. _vpc_peering_0001__table1132310347417: diff --git a/api-ref/source/apis/vpc_tag_management/adding_a_tag_to_a_vpc.rst b/api-ref/source/apis/vpc_tag_management/adding_a_tag_to_a_vpc.rst index 134fcf3..7422c70 100644 --- a/api-ref/source/apis/vpc_tag_management/adding_a_tag_to_a_vpc.rst +++ b/api-ref/source/apis/vpc_tag_management/adding_a_tag_to_a_vpc.rst @@ -21,13 +21,13 @@ POST /v2.0/{project_id}/vpcs/{vpc_id}/tags .. table:: **Table 1** Parameter description - +------------+-----------+----------------------------------------------------------+ - | Name | Mandatory | Description | - +============+===========+==========================================================+ - | project_id | Yes | Specifies the project ID. | - +------------+-----------+----------------------------------------------------------+ - | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | - +------------+-----------+----------------------------------------------------------+ + +------------+-----------+--------------------------------------------------------+ + | Name | Mandatory | Description | + +============+===========+========================================================+ + | project_id | Yes | Specifies the project ID. | + +------------+-----------+--------------------------------------------------------+ + | vpc_id | Yes | Specifies the VPC ID that uniquely identifies the VPC. | + +------------+-----------+--------------------------------------------------------+ Request Parameters ------------------ 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 037b718..4d91a0d 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 @@ -21,13 +21,13 @@ GET /v2.0/{project_id}/vpcs/{vpc_id}/tags .. table:: **Table 1** Parameter description - +------------+-----------+----------------------------------------------------------+ - | Name | Mandatory | Description | - +============+===========+==========================================================+ - | project_id | Yes | Specifies the project ID. | - +------------+-----------+----------------------------------------------------------+ - | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | - +------------+-----------+----------------------------------------------------------+ + +------------+-----------+--------------------------------------------------------+ + | Name | Mandatory | Description | + +============+===========+========================================================+ + | project_id | Yes | Specifies the project ID. | + +------------+-----------+--------------------------------------------------------+ + | vpc_id | Yes | Specifies the VPC ID that uniquely identifies the VPC. | + +------------+-----------+--------------------------------------------------------+ Request Parameters ------------------ diff --git a/api-ref/source/appendix/error_codes.rst b/api-ref/source/appendix/error_codes.rst index 568324c..9b51dff 100644 --- a/api-ref/source/appendix/error_codes.rst +++ b/api-ref/source/appendix/error_codes.rst @@ -78,8 +78,6 @@ Error Code Description +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 409 | VPC.0108 | Router is used not allow deleted. | Failed to delete the VPC because it has EIPs associated. | Delete the EIPs of the tenant first. | +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 409 | VPC.0109 | Router is used not allow deleted. | Failed to delete the VPC because one or more VPNs have been created for it. | Delete VPNs of the tenant. | -+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 409 | VPC.0110 | deleteDefaultNetworkFromRouter router status is invalid. | The VPC cannot be deleted because its status is unstable. | Contact technical support. | +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 500 | VPC.0111 | Database Error. | An internal VPC exception occurs. | Contact technical support. | @@ -92,6 +90,8 @@ Error Code Description +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 409 | VPC.0120 | exroutes exists under this router, delete exroutes firstly. | The VPC cannot be deleted because it contains extension routes. | Delete extension routes in the VPC. | +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Deleting a VPC | 409 | VPC.0109 | Router is used not allow deleted. | Failed to delete the VPC because one or more VPNs have been created for it. | Delete VPNs of the tenant. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | Updating a VPC | 400 | VPC.0101 | Update router xx is invalid. | Invalid parameters. | Check whether the parameter values are valid based on the returned error message. | +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 404/500 | VPC.0105 | Neutron Error. | Calling the backend service fails. | Check whether the Neutron service is normal or contact technical support. | @@ -124,8 +124,6 @@ Error Code Description +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. | +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| | 500 | VPC.0206 | Subnet has been used by VPN, please remove the subnet from the VPN and try again. | The subnet cannot be deleted because it is being used by the VPN. | Delete the subnet that is used by the VPN. | -+------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 400 | VPC.0207 | Subnet does not belong to the VPC. | This operation is not allowed because the subnet does not belong to the VPC. | Check whether the subnet is in the VPC. | +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 500 | VPC.0208 | Subnet is used by private IP, can not be deleted. | The subnet cannot be deleted because it is being used by the private IP address. | Delete the private IP address of the subnet. | @@ -136,6 +134,8 @@ Error Code Description +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 500 | VPC.0211 | subnet is still used by LBaas. | The subnet cannot be deleted because it is being used by load balancers. | Delete load balancers in the subnet. | +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| Deleting a subnet | 500 | VPC.0206 | Subnet has been used by VPN, please remove the subnet from the VPN and try again. | The subnet cannot be deleted because it is being used by the VPN. | Delete the subnet that is used by the VPN. | ++------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | Updating a subnet | 400 | VPC.0201 | xx is invalid. | Incorrect subnet parameters. | Check whether the parameter values are valid based on the returned error message. | +------------------------------------------------------------------------------------------+-------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | | 404/500 | VPC.0202 | Neutron Error. | An internal error occurs in the subnet. | Contact technical support. | diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 53c6028..80d9d9f 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,21 @@ Change History +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2024-04-26 | This release incorporates the following changes: | +| | | +| | - Modified descriptions about the response parameter **Tag** in :ref:`Adding a Secondary CIDR Block to a VPC ` and :ref:`Removing a Secondary CIDR Block from a VPC `. | +| | - Modified the UTC time format of parameters **created_at** and **updated_at** in :ref:`Adding a Secondary CIDR Block to a VPC ` and :ref:`Removing a Secondary CIDR Block from a VPC `. | +| | - Deleted response parameter **use_default_subnetpool** in :ref:`Subnet `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2024-04-10 | This release incorporates the following changes: | +| | | +| | - Modified the description about request parameter **extend_cidrs** in :ref:`Adding a Secondary CIDR Block to a VPC `. Added 255.255.255.255/32 as an additional secondary CIDR block that cannot be added to VPCs. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 2024-03-28 | This release incorporates the following changes: | +| | | +| | - Modified the description of request parameter **extend_cidrs** and deleted the description indicating only one secondary CIDR block can be added to each VPC in :ref:`Adding a Secondary CIDR Block to a VPC `. | +| | - Modified the description of request parameter **extend_cidrs** and deleted the description indicating secondary CIDR blocks can only be removed one by one in :ref:`Removing a Secondary CIDR Block from a VPC `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2024-03-11 | This release incorporates the following changes: | | | | | | Added the following sections: | diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst index 39e4b5c..69ca07f 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst @@ -8,7 +8,7 @@ Creating a Firewall Policy Function -------- -This API is used to create a firewall policy. A firewall policy must be associated with a firewall group. You can learn more about the :ref:`relationships among network ACL groups, policies, and rules `. +This API is used to create a firewall policy which must be bound to a firewall group. You can learn more about the :ref:`relationships among firewall groups, policies, and rules `. URI --- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst index e49081b..de27f58 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst @@ -16,15 +16,15 @@ You can use **GET /v2.0/networks?router:external=True** or run the **neutron net Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- @@ -139,7 +139,6 @@ Normal response to POST requests "status": "DOWN", "router_id": null, "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", - "floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "fixed_ip_address": null, "floating_ip_address": "88.88.215.205", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst index 2bc3253..05f4dc9 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst @@ -14,15 +14,15 @@ This API is used to delete a floating IP address. Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst index 23ddc9e..26131b6 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst @@ -14,15 +14,15 @@ This API is used to query details about a specified floating IP address, includi Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst index bdea3b4..c9c15d0 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst @@ -16,15 +16,15 @@ You can query the detailed information about a specified floating IP address usi Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type: - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst index 9032845..540c29e 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst @@ -21,15 +21,15 @@ If **port_id** is left blank, the floating IP address has been unbound from the - If a floating IP address that you are binding is in the **error** state, unbind the IP address first. - Do not associate a port that has a floating IP address associated to another floating IP address. You must first disassociate the port from the IP address and then associate it with another IP address. - This API cannot be used to bind an EIP to or unbind an EIP from a dedicated load balancer. - - In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type. - - Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers. + - In **eu-de**, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (**5_bgp**) type. + - Existing EIPs of this type can be bound to dedicated or shared load balancers. - - The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers. + - Binding or unbinding EIPs of this type to or from dedicated load balancers is not allowed on the EIP console. - You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP `__ and `Unbinding an EIP `__. - - EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs. - - You are advised to bind BGP EIPs to or unbind them from dedicated load balancers. + - EIPs of this type can be bound to or unbound from shared load balancers on the EIP console or through API calls. + - You are advised to bind or unbind BGP EIPs to or from dedicated load balancers. - - Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect. + - **5_gray** EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect. URI --- 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 c9b77a8..d8cab21 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,67 +30,78 @@ 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"}]**. | - | | | | | - | | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | - +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | No | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | | - | | | | 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. | - +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 exist. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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"}]**. | + | | | | | + | | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | No | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | | + | | | | 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. The value of this field is maintained by the system and cannot be changed. 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. | + | | | | | + | | | | - For Consumer Cloud, the values of **udp_srvports** and **tcp_srvports** fields are strings. By default, **udp_srvports** and **tcp_srvports** are not specified. You can set **udp_srvports** and **tcp_srvports** to port numbers, which indicates that the TCP and UDP packets support highly concurrently connections. However, these packets are not protected by network ACLs and security group rules. The **udp_srvports** and **tcp_srvports** fields can be updated concurrently. | + | | | | | + | | | | Format: | + | | | | | + | | | | {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} | + | | | | | + | | | | You can enter a maximum of 15 port numbers for each value. Use a space to separate adjacent port numbers. The port number ranges from 1 to 65535. | + | | | | | + | | | | Example: | + | | | | | + | | | | {"tcp_srvports": "80 443", "udp_srvports": "53"} | + | | | | | + | | | | This example indicates that inbound TCP packets to ports 80 and 443, and inbound UDP packets to port 53 support highly concurrent connections. However, these packets are not controlled by network ACL and security group rules. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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: @@ -168,112 +179,123 @@ 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"}]**. | - | | | | - | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+======================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + | | | | + | | | The status of a HANA SR-IOV VM port is always **DOWN**. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | Object | - Specifies the user-defined settings. This is an extended attribute. | + | | | - Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. The value of this field is maintained by the system and cannot be changed. 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. | + | | | | + | | | - For Consumer Cloud, the values of **udp_srvports** and **tcp_srvports** fields are strings. By default, **udp_srvports** and **tcp_srvports** are not specified. You can set **udp_srvports** and **tcp_srvports** to port numbers, which indicates that the TCP and UDP packets support highly concurrently connections. However, these packets are not protected by network ACLs and security group rules. The **udp_srvports** and **tcp_srvports** fields can be updated concurrently. | + | | | | + | | | Format: | + | | | | + | | | {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} | + | | | | + | | | You can enter a maximum of 15 port numbers for each value. Use a space to separate adjacent port numbers. The port number ranges from 1 to 65535. | + | | | | + | | | Example: | + | | | | + | | | {"tcp_srvports": "80 443", "udp_srvports": "53"} | + | | | | + | | | This example indicates that inbound TCP packets to ports 80 and 443, and inbound UDP packets to port 53 support highly concurrent connections. However, these packets are not controlled by network ACL and security group rules. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0003__table1424105920176: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst index 9727ce3..9cc3382 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst @@ -26,11 +26,11 @@ DELETE /v2.0/ports/{port_id} .. table:: **Table 1** Parameter description - +---------+-----------+------------------------------------------------------------+ - | Name | Mandatory | Description | - +=========+===========+============================================================+ - | port_id | Yes | Specifies the port ID, which uniquely identifies the port. | - +---------+-----------+------------------------------------------------------------+ + +---------+-----------+----------------------------------------------------------+ + | Name | Mandatory | Description | + +=========+===========+==========================================================+ + | port_id | Yes | Specifies the port ID that uniquely identifies the port. | + +---------+-----------+----------------------------------------------------------+ Request Parameters ------------------ 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 34e277f..546f845 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 @@ -21,11 +21,11 @@ GET /v2.0/ports/{port_id} .. table:: **Table 1** Parameter description - +---------+-----------+------------------------------------------------------------+ - | Name | Mandatory | Description | - +=========+===========+============================================================+ - | port_id | Yes | Specifies the port ID, which uniquely identifies the port. | - +---------+-----------+------------------------------------------------------------+ + +---------+-----------+----------------------------------------------------------+ + | Name | Mandatory | Description | + +=========+===========+==========================================================+ + | port_id | Yes | Specifies the port ID that uniquely identifies the port. | + +---------+-----------+----------------------------------------------------------+ Request Parameters ------------------ @@ -54,128 +54,130 @@ 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"}]**. | - | | | | - | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 8 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | binding:profile object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | - Specifies the port ID. The value can contain a maximum of 255 characters. | + | | | - This parameter is not mandatory when you query ports. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network that the port belongs to. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | - Specifies the administrative state of the port. | + | | | - The default value is **true**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | - Specifies the port MAC address, for example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | - The MAC address can only be dynamically assigned by the system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | - Specifies the port IP address. For details, see :ref:`Table 4 `. | + | | | | + | | | For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | **"fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}]**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | - Specifies the device ID. | + | | | - This parameter 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 belonged device, which can be the DHCP server, router, or Nova. | + | | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | - Instructions: | + | | | | + | | | - 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 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 security group UUID, 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. The value of this field is maintained by the system and cannot be changed. 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. | + | | | | + | | | - For Consumer Cloud, the values of **udp_srvports** and **tcp_srvports** fields are strings. By default, **udp_srvports** and **tcp_srvports** are not specified. You can set **udp_srvports** and **tcp_srvports** to port numbers, which indicates that the TCP and UDP packets support highly concurrently connections. However, these packets are not protected by network ACLs and security group rules. The **udp_srvports** and **tcp_srvports** fields can be updated concurrently. | + | | | | + | | | Format: | + | | | | + | | | {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} | + | | | | + | | | You can enter a maximum of 15 port numbers for each value. Use a space to separate adjacent port numbers. The port number ranges from 1 to 65535. | + | | | | + | | | Example: | + | | | | + | | | {"tcp_srvports": "80 443", "udp_srvports": "53"} | + | | | | + | | | This example indicates that inbound TCP packets to ports 80 and 443, and inbound UDP packets to port 53 support highly concurrent connections. However, these packets are not controlled by network ACL and security group rules. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | - Specifies the type of the bound vNIC. | + | | | - The value can be: | + | | | | + | | | - **normal** indicates software switching. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 domain name information of the primary NIC. This is an extended attribute. | + | | | - This parameter is automatically maintained by the system and cannot be set or updated manually. | + | | | - The value can be: | + | | | | + | | | - **hostname**: The same as the value specified for **dns_name**. | + | | | - **ip_address**: Private IPv4 address of the port. | + | | | - **fqdn**: Private network fully qualified domain name (FQDN) of the port. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | - Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | - This parameter is automatically maintained by the system and cannot be set or updated manually. 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: .. table:: **Table 4** **fixed_ip** objects - +-----------------------+-----------------------+-----------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+===========================================================+ - | subnet_id | String | Specifies the ID of the subnet to which the port belongs. | - | | | | - | | | This parameter cannot be updated. | - +-----------------------+-----------------------+-----------------------------------------------------------+ - | ip_address | String | Specifies the port IP address. | - | | | | - | | | This parameter cannot be updated. | - +-----------------------+-----------------------+-----------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+======================================+ + | subnet_id | String | - Specifies the subnet ID. | + | | | - This parameter cannot be updated. | + +-----------------------+-----------------------+--------------------------------------+ + | ip_address | String | - Specifies the port IP address. | + | | | - This parameter cannot be updated. | + +-----------------------+-----------------------+--------------------------------------+ .. _vpc_port02_0002__en-us_topic_0062207355_table57914257: 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 95df59d..b0b05e4 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 @@ -36,31 +36,29 @@ Example of querying ports by page +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Name | Mandatory | Type | Description | +=================+=================+==================+======================================================================================================================================================================================================================================================================================================================+ - | id | No | String | Specifies that the port ID is used as the filtering condition. | + | id | No | String | Specifies the port ID that is used as the filter. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Specifies that the port name is used as the filtering condition. | + | name | No | String | Specifies the port name that is used as the filter. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | admin_state_up | No | Boolean | Specifies that the admin state is used as the filtering condition. | - | | | | | - | | | | The value can be **true** or **false**. | + | admin_state_up | No | Boolean | - Specifies the administrative state of the port that is used as the filter. | + | | | | - The value can be **true** or **false**. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | No | String | Specifies that the network ID is used as the filtering condition. | + | network_id | No | String | Specifies the network ID that is used as the filter. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mac_address | No | String | Specifies that the MAC address is used as the filtering condition. | + | mac_address | No | String | Specifies the MAC address that is used as the filter. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | No | String | Specifies that the device ID is used as the filtering condition. | + | device_id | No | String | Specifies the device ID that is used as the filter. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | No | String | Specifies that the device owner is used as the filtering condition. | + | device_owner | No | String | Specifies the device owner that is used as the filter. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies that the port status is used as the filtering condition. | - | | | | | - | | | | The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + | status | No | String | - Specifies the status of the port that is used as the filter. | + | | | | - 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. | + | security_groups | No | Array of strings | Specifies the ID of the security group that is used as the filter. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | fixed_ips | No | Array of strings | Filter by IP address of the port, that is **fixed_ips=ip_address={ip_address}** or **fixed_ips=subnet_id={subnet_id}**. Set *{ip_address}* to an IP address, for example, 192.168.21.22 or 2a07:b980:4030:14::1. Set *{subnet_id}* to the IPv4 or IPv6 subnet ID, for example, 011fc878-5521-4654-a1ad-f5b0b5820302. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | No | String | Specifies that the project ID is used as the filtering condition. | + | tenant_id | No | String | Specifies the project ID that is used as the filter. | +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | | | | | | @@ -139,126 +137,130 @@ 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"}]**. | - | | | | - | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 5 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 6 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 7 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | - Specifies the port ID. The value can contain a maximum of 255 characters. | + | | | - This parameter is not mandatory when you query ports. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network that the port belongs to. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | - Specifies the administrative state of the port. | + | | | - The default value is **true**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | - Specifies the port MAC address, for example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | - The MAC address can only be dynamically assigned by the system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | - Specifies the port IP address. For details, see :ref:`Table 4 `. | + | | | | + | | | For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | - Specifies the ID of the device that the port belongs to. | + | | | - This parameter 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 belonged device, which can be the DHCP server, router, or Nova. | + | | | - The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | - Instructions: | + | | | | + | | | - 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 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 security group UUID, 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. The value of this field is maintained by the system and cannot be changed. 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. | + | | | | + | | | - For Consumer Cloud, the values of **udp_srvports** and **tcp_srvports** fields are strings. By default, **udp_srvports** and **tcp_srvports** are not specified. You can set **udp_srvports** and **tcp_srvports** to port numbers, which indicates that the TCP and UDP packets support highly concurrently connections. However, these packets are not protected by network ACLs and security group rules. The **udp_srvports** and **tcp_srvports** fields can be updated concurrently. | + | | | | + | | | Format: | + | | | | + | | | {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} | + | | | | + | | | You can enter a maximum of 15 port numbers for each value. Use a space to separate adjacent port numbers. The port number ranges from 1 to 65535. | + | | | | + | | | Example: | + | | | | + | | | {"tcp_srvports": "80 443", "udp_srvports": "53"} | + | | | | + | | | This example indicates that inbound TCP packets to ports 80 and 443, and inbound UDP packets to port 53 support highly concurrent connections. However, these packets are not controlled by network ACL and security group rules. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | - Specifies the type of the bound vNIC. | + | | | - The value can be: | + | | | | + | | | - **normal** indicates software switching. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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 domain name information of the primary NIC. This is an extended attribute. | + | | | - This parameter is automatically maintained by the system and cannot be set or updated manually. | + | | | - The value can be: | + | | | | + | | | - **hostname**: The same as the value specified for **dns_name**. | + | | | - **ip_address**: Private IPv4 address of the port. | + | | | - **fqdn**: Private network fully qualified domain name (FQDN) of the port. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | - Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | - This parameter is automatically maintained by the system and cannot be set or updated manually. 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: .. table:: **Table 4** **fixed_ip** objects - +-----------------------+-----------------------+-----------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+===========================================================+ - | subnet_id | String | Specifies the ID of the subnet to which the port belongs. | - | | | | - | | | This parameter cannot be updated. | - +-----------------------+-----------------------+-----------------------------------------------------------+ - | ip_address | String | Specifies the port IP address. | - | | | | - | | | This parameter cannot be updated. | - +-----------------------+-----------------------+-----------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+======================================+ + | subnet_id | String | - Specifies the subnet ID. | + | | | - This parameter cannot be updated. | + +-----------------------+-----------------------+--------------------------------------+ + | ip_address | String | - Specifies the port IP address. | + | | | - This parameter cannot be updated. | + +-----------------------+-----------------------+--------------------------------------+ .. _vpc_port02_0001__en-us_topic_0062207355_table57914257: 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 d46c6ba..53d4466 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 @@ -21,11 +21,11 @@ PUT /v2.0/ports/{port_id} .. table:: **Table 1** Parameter description - +---------+-----------+------------------------------------------------------------+ - | Name | Mandatory | Description | - +=========+===========+============================================================+ - | port_id | Yes | Specifies the port ID, which uniquely identifies the port. | - +---------+-----------+------------------------------------------------------------+ + +---------+-----------+----------------------------------------------------------+ + | Name | Mandatory | Description | + +=========+===========+==========================================================+ + | port_id | Yes | Specifies the port ID that uniquely identifies the port. | + +---------+-----------+----------------------------------------------------------+ Request Parameters ------------------ @@ -44,52 +44,63 @@ 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:`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. | - +-----------------------+-----------------+-------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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. The value of this field is maintained by the system and cannot be changed. 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. | + | | | | | + | | | | - For Consumer Cloud, the values of **udp_srvports** and **tcp_srvports** fields are strings. By default, **udp_srvports** and **tcp_srvports** are not specified. You can set **udp_srvports** and **tcp_srvports** to port numbers, which indicates that the TCP and UDP packets support highly concurrently connections. However, these packets are not protected by network ACLs and security group rules. The **udp_srvports** and **tcp_srvports** fields can be updated concurrently. | + | | | | | + | | | | Format: | + | | | | | + | | | | {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} | + | | | | | + | | | | You can enter a maximum of 15 port numbers for each value. Use a space to separate adjacent port numbers. The port number ranges from 1 to 65535. | + | | | | | + | | | | Example: | + | | | | | + | | | | {"tcp_srvports": "80 443", "udp_srvports": "53"} | + | | | | | + | | | | This example indicates that inbound TCP packets to ports 80 and 443, and inbound UDP packets to port 53 support highly concurrent connections. However, these packets are not controlled by network ACL and security group rules. | + +-----------------------+-----------------+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | 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: @@ -149,112 +160,123 @@ 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"}]**. | - | | | | - | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_id | String | Specifies the device ID. | - | | | | - | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | - | | | | - | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | - | | | | - | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | - | | | | - | | | The port with this field specified cannot be deleted. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | - | | | | - | | | The status of a HANA SR-IOV VM port is always **DOWN**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | - | | | | - | | | This parameter cannot be left blank. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | - | | | | - | | | Instructions: | - | | | | - | | | - The IP address cannot be **0.0.0.0**. | - | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | - | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | - | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | - | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | - | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | Object | Specifies the user-defined settings. This is an extended attribute. | - | | | | - | | | Instructions: | - | | | | - | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. Common tenants do not have the permission to change the value of this field, which is maintained by the system. | - | | | | - | | | Example: | - | | | | - | | | {"internal_elb": true} | - | | | | - | | | - The **disable_security_groups** field is in boolean type and is available to common tenants. The default value is **false**. In high-performance communication scenarios, you can set the parameter value to **true**, which makes this parameter to be available to common tenants. You can specify this parameter when creating a port. Currently, the value of this parameter can only be set to **true**. | - | | | | - | | | Example: | - | | | | - | | | {"disable_security_groups": true }, | - | | | | - | | | Currently, the value can only be set to **true**. When the value is set to **true**, the FWaaS function does not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:vnic_type | String | Specifies the type of the bound vNIC. | - | | | | - | | | **normal**: Softswitch | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | - | | | | - | | | - **hostname**: **dns_name** value of the NIC | - | | | - **ip_address**: Private IPv4 address of the NIC | - | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | - | | | | - | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the port is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the port is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+-------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================================================================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the port ID. A maximum of 255 characters are allowed. | + | | | | + | | | This parameter is not mandatory when you query ports. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the port name. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the port belongs. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | admin_state_up | Boolean | Specifies the administrative status. | + | | | | + | | | The default value is **true**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | mac_address | String | Specifies the port MAC address. For example, **"mac_address": "fa:16:3e:9e:ff:55"**. | + | | | | + | | | This value can only be dynamically assigned by the system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fixed_ips | Array of :ref:`fixed_ip ` objects | Specifies the port IP address. For details, see :ref:`Table 8 `. For example, the value is **"fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]**. | + | | | | + | | | "fixed_ips": [{"subnet_id": "1fd001aa-6946-4168-86d9-924c7d3ef8fb", "ip_address": "2a07:b980:4030:14::1"}] | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_id | String | Specifies the device ID. | + | | | | + | | | This value is automatically maintained by the system and cannot be set or updated manually. The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | Specifies the DHCP, router or Nova to which a device belongs. | + | | | | + | | | The value can be **network:dhcp**, **network:router_interface_distributed**, **compute:xxx**, **neutron:VIP_PORT**, **neutron:LOADBALANCERV2**, **neutron:LOADBALANCERV3**, **network:endpoint_interface**, **network:nat_gateway**, or **network:ucmp**. (In value **compute:xxx**, **xxx** specifies the AZ name, for example, **compute:aa-bb-cc** indicates that the private IP address is used by an ECS in the **aa-bb-cc** AZ). | + | | | | + | | | This parameter value cannot be updated. You can only set **device_owner** to **neutron:VIP_PORT** for a virtual IP address port during port creation. If this parameter of a port is not left blank, the port can only be deleted when this parameter value is **neutron:VIP_PORT**. | + | | | | + | | | The port with this field specified cannot be deleted. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the port status. The value can be **ACTIVE**, **BUILD**, or **DOWN**. | + | | | | + | | | The status of a HANA SR-IOV VM port is always **DOWN**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_groups | Array of strings | Specifies the UUID of the security group, for example, **"security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]**. This is an extended attribute. | + | | | | + | | | This parameter cannot be left blank. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allowed_address_pairs | Array of :ref:`allowed_address_pairs ` objects | Specifies the IP address and MAC address pair. This is an extended attribute. For details, see :ref:`Table 9 `. | + | | | | + | | | Instructions: | + | | | | + | | | - The IP address cannot be **0.0.0.0**. | + | | | - Configure a dedicated security group for the port if the parameter **allowed_address_pairs** has a large CIDR block (subnet mask less than 24). | + | | | - If the value of **allowed_address_pairs** is **1.1.1.1/0**, the source/destination check is disabled. | + | | | - In the hardware SDN networking plan, the **ip_address** attribute value cannot be in CIDR format. | + | | | - To assign a virtual IP address to an ECS, the IP address configured in **allowed_address_pairs** must be an existing ECS NIC IP address. Otherwise, the virtual IP address cannot be used for communication. | + | | | - Set **allowed_address_pairs** of the cloud server to **1.1.1.1/0**. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the extended DHCP option. This is an extended attribute. For details, see :ref:`Table 10 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vif_details | :ref:`binding:vif_details ` object | For details, see :ref:`Table 11 `. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:profile | Object | - Specifies the user-defined settings. This is an extended attribute. | + | | | - Instructions: | + | | | | + | | | - The **internal_elb** field is in boolean type and is available to common tenants. Set the value of this parameter to **true** only when you assign a virtual IP address to an internal network load balancer. The value of this field is maintained by the system and cannot be changed. 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. | + | | | | + | | | - For Consumer Cloud, the values of **udp_srvports** and **tcp_srvports** fields are strings. By default, **udp_srvports** and **tcp_srvports** are not specified. You can set **udp_srvports** and **tcp_srvports** to port numbers, which indicates that the TCP and UDP packets support highly concurrently connections. However, these packets are not protected by network ACLs and security group rules. The **udp_srvports** and **tcp_srvports** fields can be updated concurrently. | + | | | | + | | | Format: | + | | | | + | | | {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} | + | | | | + | | | You can enter a maximum of 15 port numbers for each value. Use a space to separate adjacent port numbers. The port number ranges from 1 to 65535. | + | | | | + | | | Example: | + | | | | + | | | {"tcp_srvports": "80 443", "udp_srvports": "53"} | + | | | | + | | | This example indicates that inbound TCP packets to ports 80 and 443, and inbound UDP packets to port 53 support highly concurrent connections. However, these packets are not controlled by network ACL and security group rules. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | binding:vnic_type | String | Specifies the type of the bound vNIC. | + | | | | + | | | **normal**: Softswitch | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_security_enabled | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_assignment | Array of :ref:`dns_assignment ` objects | Specifies the default private network domain name information of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. | + | | | | + | | | - **hostname**: **dns_name** value of the NIC | + | | | - **ip_address**: Private IPv4 address of the NIC | + | | | - **fqdn**: Default private network fully qualified domain name (FQDN) of the IP address | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_name | String | Specifies the default private network DNS name of the primary NIC. This is an extended attribute. | + | | | | + | | | The system automatically sets this parameter, and you are not allowed to configure or change the parameter value. Before accessing the default private network domain name, ensure that the subnet uses the DNS provided by the current system. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the port is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the port is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0004__table4290920914597: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst index 3baef80..9fbb0a5 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst @@ -57,10 +57,6 @@ Request Parameters | | | | | | | | | You can use **GET /v2.0/networks?router:external=True** or run the **neutron net-external-list** command to query information about the external network. | +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_snat | No | Boolean | Specifies whether the SNAT function is enabled. | - | | | | | - | | | | The default value is **false**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request --------------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst index e1c350c..cdbdab8 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst @@ -54,17 +54,19 @@ Request Parameters .. table:: **Table 3** **external_gateway_info** objects - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================================================================================+ - | network_id | No | String | Specifies the UUID of the external network. | - | | | | | - | | | | You can use **GET /v2.0/networks?router:external=True** or run the **neutron net-external-list** command to query information about the external network. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_snat | No | Boolean | Specifies whether the SNAT function is enabled. | - | | | | | - | | | | The default value is **false**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=================+=================+=================+=========================================================================================================================================================================+ + | network_id | No | String | Specifies the UUID of the external network. | + | | | | | + | | | | You can use **GET /v2.0/networks?router:external=True** or run the **neutron net-external-list** command to query information about the external network. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_snat | No | Boolean | Specifies whether the SNAT function is enabled. | + | | | | | + | | | | The default value is **false**. | + | | | | | + | | | | Before setting **enable_snat** to **true**, ensure that an interface is added to the router. For details, see :ref:`Adding an Interface to a Router `. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_router_0004__table5893155464718: 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 98bede3..763c420 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst @@ -30,48 +30,42 @@ Request Parameters .. table:: **Table 2** **Security Group Rule** objects - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=========================+=================+=================+=============================================================================================================================================================================================+ - | description | No | String | Provides supplementary information about the security group rule. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | Yes | String | Specifies the ID of the belonged security group. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | No | String | Specifies the peer ID of the belonged security group. | - | | | | | - | | | | This parameter is mutually exclusive with **remote_ip_prefix**. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | Yes | String | Specifies the direction of the traffic for which the security group rule takes effect. | - | | | | | - | | | | The value can be **ingress** or **egress**. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | No | String | Specifies the peer IP address segment. | - | | | | | - | | | | This parameter is mutually exclusive with **remote_group_id**. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Specifies the protocol type or the IP protocol number. | - | | | | | - | | | | The value can be **tcp**, **udp**, **icmp** or an IP protocol number | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | No | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - | | | | | - | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | No | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | | - | | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | | - | | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - | | | | | - | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | No | String | Specifies the network type. | - | | | | | - | | | | The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | - | | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=========================+=================+=================+===================================================================================================================================================================================================+ + | description | No | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | Yes | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | No | String | - Specifies the peer ID of the belonged security group. | + | | | | - This parameter is mutually exclusive with **remote_ip_prefix**. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | Yes | String | - Specifies the direction of a security group rule. | + | | | | - The value can be **ingress** (inbound) or **egress** (outbound). | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | No | String | - Specifies the peer IP address segment. | + | | | | - This parameter is mutually exclusive with **remote_group_id**. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | String | - Specifies the protocol type or the IP protocol number. | + | | | | - The value can be **tcp**, **udp**, **icmp** or an IP protocol number. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | No | Integer | - Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + | | | | - The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | No | Integer | - Specifies the minimum port number. When ICMP is used, the value is the ICMP type. | + | | | | - Constraints: | + | | | | | + | | | | - When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | - When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + | | | | | + | | | | - The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | No | String | - Specifies the network type. | + | | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | + | | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request --------------- @@ -106,52 +100,49 @@ Response Parameters .. table:: **Table 4** **Security Group Rule** objects - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=========================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=========================+=======================+===================================================================================================================================================================================================+ + | id | String | - Specifies the security group rule ID. | + | | | - This parameter is not mandatory when you query security group rules. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of a security group rule. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + | | | - The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the minimum port number. When ICMP is used, the value is the ICMP type. | + | | | - Constraints: | + | | | | + | | | - When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | - When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_address_group_id | String | - Specifies the remote IP address group ID. | + | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the security group rule is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mm:ssZ | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the security group rule is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mm:ssZ | + +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst index 4d0ab64..171af67 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 @@ -172,83 +172,79 @@ Response Parameters .. table:: **Table 6** **subnet** objects - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +========================+=================================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | The value can be **4** (IPv4) or **6** (IPv6). | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. In addition, the subnet mask cannot be greater than 28. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | - | | | | - | | | :ref:`Table 7 ` | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | - | | | | - | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | - | | | | - | | | The value can be set to **true** only when IPv6 is used. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnetpool_id | String | Specifies the subnet pool ID. | - | | | | - | | | Currently, only IPv6 is supported. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +------------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=================================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | The value can be **4** (IPv4) or **6** (IPv6). | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. In addition, the subnet mask cannot be greater than 28. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | + | | | | + | | | :ref:`Table 7 ` | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0003__table1777145918276: 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 6ca36ed..47cfc58 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst @@ -42,81 +42,77 @@ Response Parameters .. table:: **Table 2** **subnet** objects - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +========================+=================================================================================+==========================================================================================================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | The value can be **4** (IPv4) or **6** (IPv6). | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | - | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | - | | | | - | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | - | | | | - | | | The value can be set to **true** only when IPv6 is used. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnetpool_id | String | Specifies the subnet pool ID. | - | | | | - | | | Currently, only IPv6 is supported. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +------------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=================================================================================+==========================================================================================================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | The value can be **4** (IPv4) or **6** (IPv6). | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 `. | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0002__table1777145918276: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst index 1a6bec9..a439b26 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst @@ -107,83 +107,79 @@ Response Parameters .. table:: **Table 3** **subnet** objects - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +========================+=================================================================================+=================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | The value can be **4** (IPv4) or **6** (IPv6). | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies available IP address pools. For details, see :ref:`Table 4 `. | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | - | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | - | | | | - | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | - | | | | - | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 5 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | - | | | | - | | | The value can be set to **true** only when IPv6 is used. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnetpool_id | String | Specifies the subnet pool ID. | - | | | | - | | | Currently, only IPv6 is supported. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=================================================================================+=================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | The value can be **4** (IPv4) or **6** (IPv6). | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies available IP address pools. For details, see :ref:`Table 4 `. | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | + | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 5 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0001__table1777145918276: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst index 426fa2a..bc45c34 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst @@ -36,43 +36,39 @@ Request Parameters .. table:: **Table 2** **subnet** objects - +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +========================+=================+============================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ - | name | No | String | Specifies the subnet name. | - +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details about the **allocation_pool** objects, see :ref:`Table 3 `. | - | | | | | - | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | | - | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | | - | | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | - | | | | | - | | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | - | | | | | - | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | No | Array of strings | Specifies the DNS server address. | - | | | | | - | | | | Instructions: | - | | | | | - | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - | | | | | - | | | | A maximum of five DNS server addresses are supported. | - +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | - | | | | | - | | | | Static routes are not supported, and entered information will be ignored. | - +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | | - | | | | The value can only be **true**. | - +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | use_default_subnetpool | No | Boolean | Specifies whether the default address pool is used. | - | | | | | - | | | | The value can be set to **true** only when IPv6 is used. | - +------------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +==================+=================+============================================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ + | name | No | String | Specifies the subnet name. | + +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | No | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details about the **allocation_pool** objects, see :ref:`Table 3 `. | + | | | | | + | | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | | + | | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in subnet **192.168.1.0/24**, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | | + | | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | | + | | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | | + | | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | No | Array of strings | Specifies the DNS server address. | + | | | | | + | | | | Instructions: | + | | | | | + | | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + | | | | | + | | | | A maximum of five DNS server addresses are supported. | + +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | No | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 4 `. | + | | | | | + | | | | Static routes are not supported, and entered information will be ignored. | + +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | | + | | | | The value can only be **true**. | + +------------------+-----------------+----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0004__table24611730: @@ -138,85 +134,81 @@ Response Parameters .. table:: **Table 6** **subnet** objects - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +========================+=================================================================================+=================================================================================================================================================================================================================================================+ - | id | String | Specifies the subnet ID. | - | | | | - | | | This parameter is not mandatory when you query subnets. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the subnet name. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP address version. | - | | | | - | | | The value can be **4** (IPv4) or **6** (IPv6). | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | - | | | | - | | | Only **dhcpv6-stateful** is supported. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | network_id | String | Specifies the ID of the network to which the subnet belongs. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the CIDR format. | - | | | | - | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | - | | | | - | | | This attribute cannot be modified. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | - | | | | - | | | :ref:`Table 7 ` | - | | | | - | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | - | | | | - | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | - | | | | - | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | - | | | | - | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | - | | | | - | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | - | | | | - | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dns_nameservers | Array of strings | Specifies the DNS server address. | - | | | | - | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | - | | | | - | | | Static routes are not supported, and entered information will be ignored. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | - | | | | - | | | The value can only be **true**. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | use_default_subnetpool | Boolean | Specifies whether the default address pool is used. | - | | | | - | | | The value can be set to **true** only when IPv6 is used. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnetpool_id | String | Specifies the subnet pool ID. | - | | | | - | | | Currently, only IPv6 is supported. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the subnet is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the subnet is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +------------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=================================================================================+=================================================================================================================================================================================================================================================+ + | id | String | Specifies the subnet ID. | + | | | | + | | | This parameter is not mandatory when you query subnets. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the subnet name. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP address version. | + | | | | + | | | The value can be **4** (IPv4) or **6** (IPv6). | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_address_mode | String | Specifies the IPv6 addressing mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. | + | | | | + | | | Only **dhcpv6-stateful** is supported. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | network_id | String | Specifies the ID of the network to which the subnet belongs. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the CIDR format. | + | | | | + | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. | + | | | | + | | | This attribute cannot be modified. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | allocation_pools | Array of :ref:`allocation_pool ` objects | Specifies the available IP address pool. For details, see the **allocation_pool** objects. | + | | | | + | | | :ref:`Table 7 ` | + | | | | + | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] | + | | | | + | | | The last three and the first IP addresses in each subnet are the ones reserved by the system. For example, in IPv4 subnet 192.168.1.0/24, IP addresses 192.168.1.0, 192.168.1.253, 192.168.1.254, and 192.168.1.255 are reserved by the system. | + | | | | + | | | [{"start": "2001:db8:a583:9::2", "end": "2001:db8:a583:9:ffff:ffff:ffff:fffc"}] | + | | | | + | | | In IPv6 subnet 2001:db8:a583:9::/64, IP addresses 2001:db8:a583:9::1, 2001:db8:a583:9:ffff:ffff:ffff:fffd, 2001:db8:a583:9:ffff:ffff:ffff:fffe, and 2001:db8:a583:9:ffff:ffff:ffff:ffff are reserved by the system. | + | | | | + | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. | + | | | | + | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dns_nameservers | Array of strings | Specifies the DNS server address. | + | | | | + | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | host_routes | Array of :ref:`host_route ` objects | Specifies the static VM routes. For details, see :ref:`Table 8 `. | + | | | | + | | | Static routes are not supported, and entered information will be ignored. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_dhcp | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. | + | | | | + | | | The value can only be **true**. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnetpool_id | String | Specifies the subnet pool ID. | + | | | | + | | | Currently, only IPv6 is supported. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the subnet is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the subnet is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_subnet02_0004__table1777145918276: diff --git a/api-ref/source/permissions_policies_and_supported_actions/eip_v3.rst b/api-ref/source/permissions_policies_and_supported_actions/eip_v3.rst index 3800010..9a292b8 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/eip_v3.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/eip_v3.rst @@ -5,26 +5,16 @@ EIP V3 ====== -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Permission | API | Action | -+=======================================+=========================================================================+====================================+ -| Querying all EIPs | GET /v3/{project_id}/eip/publicips | eip:publicIps:list | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Querying the details of an EIP | GET /v3/{project_id}/eip/publicips/{publicip_id} | eip:publicIps:get | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Updating an EIP | PUT /v3/{project_id}/eip/publicips/{publicip_id} | eip:publicIps:update | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Binding an EIP to an instance | POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance | eip:publicIps:associateInstance | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Unbinding an EIP from an instance | POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instance | eip:publicIps:disassociateInstance | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Adding EIPs to a shared bandwidth | POST /v3/{project_id}/eip/publicips/attach-share-bandwidth | eip:publicIps:attachBandwidth | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Querying the number of available EIPs | POST /v3/{project_id}/eip/resources/available | eip:publicIps:count | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Querying common pools | GET /v3/{project_id}/eip/publicip-pools/common-pools | eip:publicipPools:list | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Querying EIP pools | GET /v3/{project_id}/eip/publicip-pools | eip:publicipPools:list | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ -| Querying the details of an EIP pool | GET /v3/{project_id}/eip/publicip-pools/{publicip_pool_id} | eip:publicipPools:get | -+---------------------------------------+-------------------------------------------------------------------------+------------------------------------+ ++-----------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Permission | API | Action | ++===================================+=========================================================================+====================================+ +| Querying all EIPs | GET /v3/{project_id}/eip/publicips | eip:publicIps:list | ++-----------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Querying the details of an EIP | GET /v3/{project_id}/eip/publicips/{publicip_id} | eip:publicIps:get | ++-----------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Binding an EIP to an instance | POST /v3/{project_id}/eip/publicips/{publicip_id}/associate-instance | eip:publicIps:associateInstance | ++-----------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Unbinding an EIP from an instance | POST /v3/{project_id}/eip/publicips/{publicip_id}/disassociate-instance | eip:publicIps:disassociateInstance | ++-----------------------------------+-------------------------------------------------------------------------+------------------------------------+ +| Querying common pools | GET /v3/{project_id}/eip/publicip-pools/common-pools | eip:publicipPools:list | ++-----------------------------------+-------------------------------------------------------------------------+------------------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/introduction.rst b/api-ref/source/permissions_policies_and_supported_actions/introduction.rst index 9cc42a5..a726190 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/introduction.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/introduction.rst @@ -17,7 +17,7 @@ VPC provides system-defined policies that can be directly used in IAM. You can a - Permissions: statements in a policy that allow or deny certain operations - APIs: REST APIs that can be called by a user who has been granted specific permissions - Actions: specific operations that are allowed or denied -- IAM projects/Enterprise projects: the authorization scope of a custom policy. A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions for both IAM and enterprise projects can be used and applied for both IAM and Enterprise Management. Policies that contain actions only for IAM projects can be used and applied to IAM only. +- IAM project/Enterprise project: A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management. .. note::