sgode/virtual-private-cloud
1
0
Fork 0
forked from docs/virtual-private-cloud
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-12-20 12:06:36 +00:00
parent 4ee7d13e19
commit b91e1f97fd
55 changed files with 2333 additions and 1896 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
api-ref/source/apis/bandwidth/querying_a_bandwidth.rst
View File

@ -117,26 +117,26 @@ Response Message
.. table:: **Table 4** **publicip_info** object
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===============================================================================================================+
+=======================+=======================+=================================================================================================================+
| publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| ip_version | Integer | - Specifies the IP address version. |
| | | - Possible values are as follows: |
| | | |
| | | - **4**: IPv4 |
| | | - **6**: IPv6 (IPv6 is not supported currently.) |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
- Example response

16
api-ref/source/apis/bandwidth/querying_bandwidths.rst
View File

@ -20,11 +20,11 @@ GET /v1/{project_id}/bandwidths
Request Message
---------------
- Request parameter
- Query parameters
.. _vpc_bandwidth_0002__table62833603:
.. table:: **Table 1** Request parameters
.. table:: **Table 1** Query parameters
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -134,20 +134,20 @@ Response Message
.. table:: **Table 4** **publicip_info** object
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===============================================================================================================+
+=======================+=======================+=================================================================================================================+
| publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
- Example response

12
api-ref/source/apis/bandwidth/updating_a_bandwidth.rst
View File

@ -150,20 +150,20 @@ Response Message
.. table:: **Table 6** **publicip_info** objects
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===============================================================================================================+
+=======================+=======================+=================================================================================================================+
| publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
- Example response

24
api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst
View File

@ -57,18 +57,18 @@ Request Message
.. table:: **Table 4** **publicip_info** object
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+===============================================================================================================+
+=================+=================+=================+=================================================================================================================+
| publicip_id | Yes | String | Specifies the ID of the EIP that uses the bandwidth. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_type | No | String | - Specifies the EIP type. |
| | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | | - Constraints: |
| | | | |
| | | | - The configured value must be supported by the system. |
| | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------+
- Example request
@ -153,26 +153,26 @@ Response Message
.. table:: **Table 7** **publicip_info** objects
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===============================================================================================================+
+=======================+=======================+=================================================================================================================+
| publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| ip_version | Integer | - Specifies the IP address version. |
| | | - Possible values are as follows: |
| | | |
| | | - **4**: IPv4 |
| | | - **6**: IPv6 (IPv6 is not supported currently.) |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
- Example response

12
api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst
View File

@ -153,20 +153,20 @@ Response Message
.. table:: **Table 6** **publicip_info** object
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===============================================================================================================+
+=======================+=======================+=================================================================================================================+
| publicip_id | String | Specifies the ID of the EIP that uses the bandwidth. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
| publicip_type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |
| | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+
- Example response

20
api-ref/source/apis/eip/assigning_an_eip.rst
View File

@ -48,21 +48,13 @@ Request Parameters
.. table:: **Table 2** Request body parameter
+-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------+-----------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=======================+=================+=================================================================+==================================================================================================================================================+
+===========+===========+=================================================================+==========================================================================================================+
| publicip | Yes | :ref:`publicip <en-us_topic_0020090596__table4491214>` object | Specifies the EIP object. For details, see :ref:`Table 3 <en-us_topic_0020090596__table4491214>`. |
+-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------+-----------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
| bandwidth | Yes | :ref:`bandwidth <en-us_topic_0020090596__table11041789>` object | Specifies the bandwidth object. For details, see :ref:`Table 4 <en-us_topic_0020090596__table11041789>`. |
+-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | No | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). |
| | | | - When you assign an EIP, associate an enterprise project ID with the EIP. |
| | | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. |
| | | | |
| | | | .. note:: |
| | | | |
| | | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------+-----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------+-----------+-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+
.. _en-us_topic_0020090596__table4491214:
@ -72,7 +64,7 @@ Request Parameters
| Name | Mandatory | Type | Description |
+=================+=================+=================+===============================================================================================================================+
| type | Yes | String | - Specifies the EIP type. |
| | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | | - Constraints: |
| | | | |
| | | | - The configured value must be supported by the system. |
@ -182,7 +174,7 @@ Response Message
| | | - **ERROR** (Exceptions) |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |

11
api-ref/source/apis/eip/querying_an_eip.rst
View File

@ -99,7 +99,7 @@ Response Message
| | | This parameter is not supported currently. |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |
@ -152,6 +152,15 @@ Response Message
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| public_border_group | String | Specifies whether it is in a central site or an edge site. |
| | | |
| | | The value can be: |
| | | |
| | | - center |
| | | - *Edge site name* |
| | | |
| | | An EIP can only be bound to a resource of the same region. |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_eip_0002__table66651219193417:

11
api-ref/source/apis/eip/querying_eips.rst
View File

@ -115,7 +115,7 @@ Response Message
| | | This parameter is not supported currently. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |
@ -168,6 +168,15 @@ Response Message
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| public_border_group | String | Specifies whether it is in a central site or an edge site. |
| | | |
| | | The value can be: |
| | | |
| | | - center |
| | | - *Edge site name* |
| | | |
| | | An EIP can only be bound to a resource of the same region. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_eip_0003__table66651219193417:

11
api-ref/source/apis/eip/updating_an_eip.rst
View File

@ -128,7 +128,7 @@ Response Message
| | | This parameter is not supported currently. |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray** (Dedicated Load Balancer). |
| | | - Constraints: |
| | | |
| | | - The configured value must be supported by the system. |
@ -179,6 +179,15 @@ Response Message
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| public_border_group | String | Specifies whether it is in a central site or an edge site. |
| | | |
| | | The value can be: |
| | | |
| | | - center |
| | | - *Edge site name* |
| | | |
| | | An EIP can only be bound to a resource of the same region. |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_eip_0004__table66651219193417:

2
api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst
View File

@ -125,7 +125,7 @@ Response Parameters
| | | |
| | | **network:endpoint_interface**: IP address of a VPC endpoint |
| | | |
| | | **network: nat_gateway**: IP address used by a NAT gateway |
| | | **network:nat_gateway**: IP address used by a NAT gateway |
| | | |
| | | - The value range specifies only the type of private IP addresses supported by the current service. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

4
api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst
View File

@ -49,9 +49,7 @@ None
Example Response
----------------
.. code-block:: text
None
None
Status Code
-----------

2
api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst
View File

@ -91,7 +91,7 @@ Response Parameters
| | | |
| | | **network:endpoint_interface**: IP address of a VPC endpoint |
| | | |
| | | **network: nat_gateway**: IP address used by a NAT gateway |
| | | **network:nat_gateway**: IP address used by a NAT gateway |
| | | |
| | | - The value range specifies only the type of private IP addresses supported by the current service. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst
View File

@ -112,7 +112,7 @@ Response Parameters
| | | |
| | | **network:endpoint_interface**: IP address of a VPC endpoint |
| | | |
| | | **network: nat_gateway**: IP address used by a NAT gateway |
| | | **network:nat_gateway**: IP address used by a NAT gateway |
| | | |
| | | - The value range specifies only the type of private IP addresses supported by the current service. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

4
api-ref/source/apis/quota/querying_quotas.rst
View File

@ -43,7 +43,7 @@ Example:
| | | | - **vpn**: VPN |
| | | | - **vpcPeer**: VPC peering connection |
| | | | - **loadbalancer**: Load balancer |
| | | | - **listener**: Listener |
| | | | - **listener**: Load balancer listener |
| | | | - **physicalConnect**: Direct Connect connection |
| | | | - **virtualInterface**: Virtual interface |
| | | | - **firewall**: Firewall |
@ -105,7 +105,7 @@ Response Parameters
| | | - **vpn**: VPN |
| | | - **vpcPeer**: VPC peering connection |
| | | - **loadbalancer**: Load balancer |
| | | - **listener**: Listener |
| | | - **listener**: Load balancer listener |
| | | - **physicalConnect**: Direct Connect connection |
| | | - **virtualInterface**: Virtual interface |
| | | - **firewall**: Firewall |

10
api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst
View File

@ -46,12 +46,12 @@ Request Parameters
.. table:: **Table 3** Description of the **routetable** field
+-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
+-----------------+-----------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+==================================================================+=====================================================================================================+
+=================+=================+==================================================================+==================================================================================================================+
| subnets | Yes | :ref:`subnet <vpc_apiroutetab_0005__table12518142212468>` object | - Specifies the subnets associated with the route table. |
| | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. |
+-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
| | | | - Only subnets (network IDs) in the VPC that the route table belongs to can be associated with the route table. |
+-----------------+-----------------+------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
.. _vpc_apiroutetab_0005__table12518142212468:
@ -142,7 +142,6 @@ Response Parameters
| | | - **peering** (VPC peering connection) |
| | | - **vpn** (VPN) |
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
@ -159,7 +158,6 @@ Response Parameters
| | | - When **type** is **peering**, the value is the VPC peering connection ID. |
| | | - When **type** is **vpn**, the value is the VPN ID. |
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+

10
api-ref/source/apis/route_table/creating_a_route_table.rst
View File

@ -80,7 +80,6 @@ Request Parameters
| | | | - **peering** (VPC peering connection) |
| | | | - **vpn** (VPN) |
| | | | - **dc** (Direct Connect connection) |
| | | | - **cc** (Cloud Connect connection) |
| | | | - **egw**: VPC endpoint node |
| | | | - **er**: enterprise router |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
@ -97,7 +96,6 @@ Request Parameters
| | | | - When **type** is **peering**, the value is the VPC peering connection ID. |
| | | | - When **type** is **vpn**, the value is the VPN ID. |
| | | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
@ -169,6 +167,12 @@ Response Parameters
| description | String | - Provides supplementary information about the route table. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | - Specifies the time (UTC) when the route table is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | - Specifies the time (UTC) when the route table is updated. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 7** Description of the **route** field
@ -185,7 +189,6 @@ Response Parameters
| | | - **peering** (VPC peering connection) |
| | | - **vpn** (VPN) |
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
@ -202,7 +205,6 @@ Response Parameters
| | | - When **type** is **peering**, the value is the VPC peering connection ID. |
| | | - When **type** is **vpn**, the value is the VPN ID. |
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+

2
api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst
View File

@ -146,7 +146,6 @@ Response Parameters
| | | - **peering** (VPC peering connection) |
| | | - **vpn** (VPN) |
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
@ -163,7 +162,6 @@ Response Parameters
| | | - When **type** is **peering**, the value is the VPC peering connection ID. |
| | | - When **type** is **vpn**, the value is the VPN ID. |
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+

12
api-ref/source/apis/route_table/querying_a_route_table.rst
View File

@ -81,6 +81,12 @@ Response Parameters
| description | String | - Provides supplementary information about the route table. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | - Specifies the time (UTC) when the route table is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | - Specifies the time (UTC) when the route table is updated. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_apiroutetab_0002__table1687317463915:
@ -99,7 +105,6 @@ Response Parameters
| | | - **peering** (VPC peering connection) |
| | | - **vpn** (VPN) |
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
@ -116,7 +121,6 @@ Response Parameters
| | | - When **type** is **peering**, the value is the VPC peering connection ID. |
| | | - When **type** is **vpn**, the value is the VPN ID. |
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
@ -180,7 +184,9 @@ Example Response
],
"vpc_id": "7978e43c-f892-49d8-9fab-9bb90a51709b",
"default": true,
"tenant_id": "05e369f07a800f802f41c002632ba5f9"
"tenant_id": "05e369f07a800f802f41c002632ba5f9",
"created_at": "2022-12-15T02:56:40",
"updated_at": "2022-12-15T02:56:40"
}
}

14
api-ref/source/apis/route_table/querying_route_tables.rst
View File

@ -103,6 +103,12 @@ Response Parameters
| description | String | - Provides supplementary information about the route table. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | - Specifies the time (UTC) when the route table is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | - Specifies the time (UTC) when the route table is updated. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_apiroutetab_0001__table4856530131313:
@ -131,7 +137,9 @@ Example Response
}
],
"tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
"description": "abc"
"description": "abc",
"created_at": "2022-12-15T02:56:40",
"updated_at": "2022-12-15T02:56:40"
},
{
"id": "3d42a0d4-a980-4613-ae76-a2cddecfff89",
@ -143,7 +151,9 @@ Example Response
}
],
"tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
"description": "abc"
"description": "abc",
"created_at": "2022-12-15T02:59:03",
"updated_at": "2022-12-15T02:59:03"
}
]
}

19
api-ref/source/apis/route_table/updating_a_route_table.rst
View File

@ -103,7 +103,6 @@ Request Parameters
| | | | - **peering** (VPC peering connection) |
| | | | - **vpn** (VPN) |
| | | | - **dc** (Direct Connect connection) |
| | | | - **cc** (Cloud Connect connection) |
| | | | - **egw**: VPC endpoint node |
| | | | - **er**: enterprise router |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
@ -120,7 +119,6 @@ Request Parameters
| | | | - When **type** is **peering**, the value is the VPC peering connection ID. |
| | | | - When **type** is **vpn**, the value is the VPN ID. |
| | | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
@ -145,7 +143,6 @@ Request Parameters
| | | | - **peering** (VPC peering connection) |
| | | | - **vpn** (VPN) |
| | | | - **dc** (Direct Connect connection) |
| | | | - **cc** (Cloud Connect connection) |
| | | | - **egw**: VPC endpoint node |
| | | | - **er**: enterprise router |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
@ -162,7 +159,6 @@ Request Parameters
| | | | - When **type** is **peering**, the value is the VPC peering connection ID. |
| | | | - When **type** is **vpn**, the value is the VPN ID. |
| | | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
@ -187,7 +183,6 @@ Request Parameters
| | | | - **peering** (VPC peering connection) |
| | | | - **vpn** (VPN) |
| | | | - **dc** (Direct Connect connection) |
| | | | - **cc** (Cloud Connect connection) |
| | | | - **egw**: VPC endpoint node |
| | | | - **er**: enterprise router |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
@ -204,7 +199,6 @@ Request Parameters
| | | | - When **type** is **peering**, the value is the VPC peering connection ID. |
| | | | - When **type** is **vpn**, the value is the VPN ID. |
| | | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
@ -291,6 +285,12 @@ Response Parameters
| description | String | - Provides supplementary information about the route table. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | - Specifies the time (UTC) when the route table is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | - Specifies the time (UTC) when the route table is updated. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
.. table:: **Table 10** Description of the **route** field
@ -307,7 +307,6 @@ Response Parameters
| | | - **peering** (VPC peering connection) |
| | | - **vpn** (VPN) |
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
@ -324,7 +323,6 @@ Response Parameters
| | | - When **type** is **peering**, the value is the VPC peering connection ID. |
| | | - When **type** is **vpn**, the value is the VPN ID. |
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
@ -350,6 +348,7 @@ Example Response
"id": "3d42a0d4-a980-4613-ae76-a2cddecff054",
"vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff",
"description": "abc",
"default": false,
"routes": [
{
"type": "ecs",
@ -363,7 +362,9 @@ Example Response
"id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f"
}
],
"tenant_id": "6fbe9263116a4b68818cf1edce16bc4f"
"tenant_id": "6fbe9263116a4b68818cf1edce16bc4f",
"created_at": "2022-12-15T02:56:40",
"updated_at": "2022-12-15T03:03:42"
}
}

90
api-ref/source/apis/security_group/creating_a_security_group.rst
View File

File diff suppressed because it is too large Load Diff

72
api-ref/source/apis/security_group/creating_a_security_group_rule.rst
View File

File diff suppressed because it is too large Load Diff

90
api-ref/source/apis/security_group/querying_security_group_details.rst
View File

File diff suppressed because it is too large Load Diff

32
api-ref/source/apis/security_group/querying_security_group_rule_details.rst
View File

@ -56,46 +56,49 @@ Response Parameters
.. table:: **Table 3** **security_group_rule** objects
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===========================================================================================================================================================================================================================================================+
+=========================+=======================+===========================================================================================================================================================================================================================================================+
| id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the security group rule. |
| | | - The value can contain no more than 255 characters, including letters and digits. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | - Specifies the direction of access control. |
| | | - Possible values are as follows: |
| | | |
| | | - **egress** |
| | | - **ingress** |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | - Specifies the IP protocol version. |
| | | - The value can be **IPv4** or **IPv6**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | - Specifies the protocol type. |
| | | - The value can be **icmp**, **tcp**, or **udp**. |
| | | - If the parameter is left blank, all protocols are supported. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | - Specifies the start port number. |
| | | - The value ranges from 1 to 65535. |
| | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | - Specifies the end port number. |
| | | - The value ranges from 1 to 65535. |
| | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
| | | - The value can be in the CIDR format or IP addresses. |
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | - Specifies the ID of the peer security group. |
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
@ -114,7 +117,8 @@ Example Response
"remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"remote_ip_prefix": null,
"security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"remote_address_group_id": null
}
}

41
api-ref/source/apis/security_group/querying_security_group_rules.rst
View File

@ -73,46 +73,49 @@ Response Parameters
.. table:: **Table 2** **security_group_rule** objects
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===========================================================================================================================================================================================================================================================+
+=========================+=======================+===========================================================================================================================================================================================================================================================+
| id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the security group rule. |
| | | - The value can contain no more than 255 characters, including letters and digits. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | - Specifies the direction of access control. |
| | | - Possible values are as follows: |
| | | |
| | | - **egress** |
| | | - **ingress** |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | - Specifies the IP protocol version. |
| | | - The value can be **IPv4** or **IPv6**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | - Specifies the protocol type. |
| | | - The value can be **icmp**, **tcp**, or **udp**. |
| | | - If the parameter is left blank, all protocols are supported. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | - Specifies the start port number. |
| | | - The value ranges from 1 to 65535. |
| | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | - Specifies the end port number. |
| | | - The value ranges from 1 to 65535. |
| | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table <vpc_api_0009>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. |
| | | - The value can be in the CIDR format or IP addresses. |
| | | - The parameter is mutually exclusive with parameter **remote_group_id**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | - Specifies the ID of the peer security group. |
| | | - The value is mutually exclusive with parameter **remote_ip_prefix**. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
@ -132,7 +135,8 @@ Example Response
"remote_group_id": null,
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"remote_address_group_id": null
},
{
"direction": "egress",
@ -145,7 +149,8 @@ Example Response
"remote_group_id": null,
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"remote_address_group_id": null
},
{
"direction": "ingress",
@ -158,7 +163,8 @@ Example Response
"remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"remote_address_group_id": null
},
{
"direction": "ingress",
@ -171,7 +177,8 @@ Example Response
"remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"remote_ip_prefix": null,
"security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550"
"tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
"remote_address_group_id": null
}
]
}

90
api-ref/source/apis/security_group/querying_security_groups.rst
View File

File diff suppressed because it is too large Load Diff

24
api-ref/source/apis/subnet/creating_a_subnet.rst
View File

@ -83,7 +83,7 @@ Request Parameters
+-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | Yes | String | Specifies the ID of the VPC to which the subnet belongs. |
+-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0001__table1805181451016>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0001__table1805181451016>`. |
| extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0001__table1805181451016>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0001__table1805181451016>`. |
+-----------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0001__table1805181451016:
@ -93,16 +93,14 @@ Request Parameters
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+
| opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. |
| opt_value | No | String | - Specifies the NTP server address configured for the subnet. |
| | | | |
| | | | - Constraints: |
| | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
| | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Request
@ -134,10 +132,6 @@ Example Request
"opt_value": "10.100.0.33,10.100.0.34",
"opt_name": "ntp"
},
{
"opt_value": "24h",
"opt_name": "addresstime"
}
]
}
}
@ -220,7 +214,7 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0001__table019517383270>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 7 <vpc_subnet01_0001__table019517383270>`. |
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0001__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 7 <vpc_subnet01_0001__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| scope | String | Specifies where the subnet is used. |
| | | |
@ -245,16 +239,14 @@ Response Parameters
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+
| opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. |
| opt_value | No | String | - Specifies the NTP server address configured for the subnet. |
| | | | |
| | | | - Constraints: |
| | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
| | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response

62
api-ref/source/apis/subnet/querying_subnet_details.rst
View File

File diff suppressed because it is too large Load Diff

66
api-ref/source/apis/subnet/querying_subnets.rst
View File

File diff suppressed because it is too large Load Diff

24
api-ref/source/apis/subnet/updating_subnet_information.rst
View File

@ -65,22 +65,20 @@ Request Parameters
| | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. |
| | | | - The value must be a valid IP address. |
| | | | - The value must be a valid IP address. IPv6 addresses are not supported. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. |
| | | | |
| | | | - The value must be a valid IP address. |
| | | | - The value must be a valid IP address. IPv6 addresses are not supported. |
| | | | |
| | | | If the value of **primary_dns** is left blank, the value of **secondary_dns** has to be updated together with that of **primary_dns**. |
| | | | |
| | | | The value of **secondary_dns** to be updated must be different from that of **primary_dns**. |
| | | | The value of **secondary_dns** must be different from that of **primary_dns**. |
| | | | |
| | | | If there is only one DNS server address, only **primary_dns** is displayed. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. |
| | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. |
| | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. IPv6 addresses are not supported. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0004__table019517383270>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0004__table019517383270>`. |
| extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0004__table019517383270>` objects | Specifies the NTP server address configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0004__table019517383270>`. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0004__table019517383270:
@ -90,16 +88,14 @@ Request Parameters
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+
| opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. |
| opt_value | No | String | - Specifies the NTP server address configured for the subnet. |
| | | | |
| | | | - Constraints: |
| | | | |
| | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. |
| | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
| opt_name | Yes | String | - Specifies the NTP server address name configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Request
@ -122,10 +118,6 @@ Example Request
{
"opt_value": "10.100.0.33,10.100.0.34",
"opt_name": "ntp"
},
{
"opt_value": "24h",
"opt_name": "addresstime"
}
]
}

10
api-ref/source/change_history.rst
View File

@ -8,6 +8,16 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| 2023-12-15 | This release incorporates the following changes: |
| | |
| | Fixed known issues. |
| | |
| | Added parameters **address-group** and **ipv6**. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-12-11 | This release incorporates the following changes: |
| | |
| | Deleted the content about lease time of **extra_dhcp_opts** from :ref:`Subnet <vpc_subnet01_0000>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-11-15 | This release incorporates the following changes: |
| | |
| | Modified the alias information in the response body in :ref:`Querying an EIP <vpc_eip_0002>`. |

13
api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/assigning_a_floating_ip_address.rst
View File

@ -109,10 +109,10 @@ Response Message
| dns_domain | String | Specifies the DNS domain. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
Example:
--------
Example Request
---------------
Example request
Create a floating IP address whose network is **0a2228f2-7f8a-45f1-8e09-9039e1d09975**.
.. code-block:: text
@ -124,7 +124,12 @@ Example request
}
}
Example response
Example Response
----------------
**Status code: 201**
Normal response to POST requests
.. code-block::

9
api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/deleting_a_floating_ip_address.rst
View File

@ -51,16 +51,17 @@ Response Message
None
Example:
--------
Example Request
---------------
Example request
Delete the floating IP address whose ID is a95ec431-8473-463b-aede-34fb048ee3a7.
.. code-block:: text
DELETE https://{Endpoint}/v2.0/floatingips/a95ec431-8473-463b-aede-34fb048ee3a7
Example response
Example Response
----------------
None

11
api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_a_floating_ip_address.rst
View File

@ -95,16 +95,17 @@ Response Message
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
Example:
--------
Example request
Example Request
---------------
.. code-block:: text
GET https://{Endpoint}/v2.0/floatingips/1a3a2818-d9b4-4a9c-8a19-5252c499d1cd
Example response
Example Response
----------------
**Status code: 200**
.. code-block::

52
api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/querying_floating_ip_addresses.rst
View File

@ -148,37 +148,45 @@ Response Message
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------------+
Example:
--------
Example request
Example Request
---------------
.. code-block:: text
GET https://{Endpoint}/v2.0/floatingips?limit=1
Example response
Example Response
----------------
**Status code: 200**
Normal response to the GET operation
.. code-block::
{
"floatingips": [
{
"id": "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd",
"status": "DOWN",
"router_id": null,
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"floating_network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
"fixed_ip_address": null,
"floating_ip_address": "99.99.99.84",
"port_id": null,
"dns_name": "ecs-80-158-78-239",
"dns_domain": "reverse.domain-name.com",
"created_at": "2017-10-19T12:21:28",
"updated_at": "2018-07-30T12:52:13"
}
]
"floatingips" : [ {
"id" : "1a3a2818-d9b4-4a9c-8a19-5252c499d1cd",
"status" : "DOWN",
"router_id" : null,
"tenant_id" : "bbfe8c41dd034a07bebd592bf03b4b0c",
"project_id" : "bbfe8c41dd034a07bebd592bf03b4b0c",
"floating_network_id" : "0a2228f2-7f8a-45f1-8e09-9039e1d09975",
"fixed_ip_address" : null,
"floating_ip_address" : "99.99.99.84",
"port_id" : null,
"dns_name" : "ecs-88-99-103-61",
"dns_domain" : "compute.clouds-dns.com.",
"created_at" : "2017-10-19T12:21:28",
"updated_at" : "2018-07-30T12:52:13"
} ],
"floatingips_links" : [ {
"href" : "https://network.region.cn-test-2.clouds.com/v2.0/floatingips.json?limit=2000&marker=000a6144-5010-46f2-bf06-6a1c94477ea3&page_reverse=true",
"rel" : "previous"
}, {
"href" : "https://network.region.cn-test-2.clouds.com/v2.0/floatingips.json?limit=2000&marker=d445e537-bc81-4039-9c7b-f9c1f5c73c78",
"rel" : "next"
} ]
}
Status Code

83
api-ref/source/native_openstack_neutron_apis_v2.0/floating_ip_address/updating_a_floating_ip_address.rst
View File

File diff suppressed because it is too large Load Diff

18
api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst
View File

@ -30,25 +30,25 @@ Request Parameters
.. table:: **Table 2** **network** objects
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Mandatory | Type | Description |
+=======================+=================+=================+==========================================================================================================================================================================================+
+=======================+=================+=================+==================================================================================================================================================================================================================+
| name | No | String | Specifies the network name. |
| | | | |
| | | | The name cannot be the same as the **admin_external_net** value (preset network name and cannot be used). |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| admin_state_up | No | Boolean | Specifies the administrative status. |
| | | | |
| | | | The value can only be **true**. |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| shared | No | Boolean | Specifies whether the network can be shared by different tenants. |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| provider:network_type | No | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. |
| | | | |
| | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. If the network is **admin_external_net**, set this parameter to **vlan**. |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping settings of all VMs in the network do not take effect. |
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Request
---------------
@ -112,6 +112,8 @@ Response Parameters
| provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. |
| | | |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. |
| | | |
| | | If the network is **admin_external_net**, set this parameter to **vlan**. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst
View File

@ -84,6 +84,8 @@ Response Parameters
| provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. |
| | | |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. |
| | | |
| | | If the network is **admin_external_net**, set this parameter to **vlan**. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst
View File

@ -133,6 +133,8 @@ Response Parameters
| provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. |
| | | |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. |
| | | |
| | | If the network is **admin_external_net**, set this parameter to **vlan**. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst
View File

@ -118,6 +118,8 @@ Response Parameters
| provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. |
| | | |
| | | Tenants can only set this parameter to **geneve**. If this parameter is not specified, the network type is automatically set to VXLAN. |
| | | |
| | | If the network is **admin_external_net**, set this parameter to **vlan**. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone_hints | Array of strings | Specifies the availability zones available to this network. The current version does not support cross-availability-zone network scheduling. |
+-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

54
api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst
View File

File diff suppressed because it is too large Load Diff

52
api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst
View File

File diff suppressed because it is too large Load Diff

118
api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst
View File

File diff suppressed because it is too large Load Diff

52
api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst
View File

File diff suppressed because it is too large Load Diff

41
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst
View File

@ -98,49 +98,52 @@ Response Parameters
.. table:: **Table 5** **Security Group Rule** objects
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================+
+=========================+=======================+=============================================================================================================================================================================================+
| id | String | Specifies the security group rule ID. |
| | | |
| | | This parameter is not mandatory when you query security group rules. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the security group rule. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | Specifies the peer ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | Specifies the direction of the traffic for which the security group rule takes effect. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | Specifies the peer IP address segment. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | Specifies the protocol type or the IP protocol number. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. |
| | | |
| | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. |
| | | |
| | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | Specifies the network type. |
| | | |
| | | IPv4 and IPv6 are supported. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the security group rule is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the security group rule is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
@ -166,7 +169,8 @@ Example Response
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"port_range_max": null,
"port_range_min": null,
"security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2"
"security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2",
"remote_address_group_id": null
},
{
"id": "6332de3e-98fb-4f8c-b44a-fcb8ff09881e",
@ -179,7 +183,8 @@ Example Response
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"port_range_max": null,
"port_range_min": null,
"security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2"
"security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2",
"remote_address_group_id": null
}
],
"created_at": "2018-09-20T02:15:34",

63
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst
View File

File diff suppressed because it is too large Load Diff

41
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst
View File

@ -72,49 +72,52 @@ Response Parameters
.. table:: **Table 3** **Security Group Rule** objects
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================+
+=========================+=======================+=============================================================================================================================================================================================+
| id | String | Specifies the security group rule ID. |
| | | |
| | | This parameter is not mandatory when you query security group rules. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the security group rule. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | Specifies the peer ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | Specifies the direction of the traffic for which the security group rule takes effect. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | Specifies the peer IP address segment. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | Specifies the protocol type or the IP protocol number. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. |
| | | |
| | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. |
| | | |
| | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | Specifies the network type. |
| | | |
| | | IPv4 and IPv6 are supported. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the security group rule is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the security group rule is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
@ -140,7 +143,8 @@ Example Response
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"port_range_max": null,
"port_range_min": null,
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2"
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
"remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249"
},
{
"id": "aecff4d4-9ce9-489c-86a3-803aedec65f7",
@ -153,7 +157,8 @@ Example Response
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"port_range_max": null,
"port_range_min": null,
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2"
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
"remote_address_group_id": null
}
],
"created_at": "2018-09-12T08:24:14",

38
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst
View File

@ -42,49 +42,52 @@ Response Parameters
.. table:: **Table 2** **Security Group Rule** objects
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================+
+=========================+=======================+=============================================================================================================================================================================================+
| id | String | Specifies the security group rule ID. |
| | | |
| | | This parameter is not mandatory when you query security group rules. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the security group rule. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | Specifies the peer ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | Specifies the direction of the traffic for which the security group rule takes effect. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | Specifies the peer IP address segment. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | Specifies the protocol type or the IP protocol number. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. |
| | | |
| | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. |
| | | |
| | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | Specifies the network type. |
| | | |
| | | IPv4 and IPv6 are supported. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the security group rule is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the security group rule is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Response
----------------
@ -106,7 +109,8 @@ Example Response
"id": "1755bc80-cf3a-4f57-8ae9-d9796482ddc0",
"project_id": "6fbe9263116a4b68818cf1edce16bc4f",
"created_at": "2018-09-20T02:15:34",
"updated_at": "2018-09-20T02:15:34"
"updated_at": "2018-09-20T02:15:34",
"remote_address_group_id": null
}
}

44
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst
View File

@ -103,49 +103,52 @@ Response Parameters
.. table:: **Table 3** **Security Group Rule** objects
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================+
+=========================+=======================+=============================================================================================================================================================================================+
| id | String | Specifies the security group rule ID. |
| | | |
| | | This parameter is not mandatory when you query security group rules. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the security group rule. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | Specifies the peer ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | Specifies the direction of the traffic for which the security group rule takes effect. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | Specifies the peer IP address segment. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | Specifies the protocol type or the IP protocol number. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. |
| | | |
| | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. |
| | | |
| | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | Specifies the network type. |
| | | |
| | | IPv4 and IPv6 are supported. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the security group rule is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the security group rule is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_sg02_0006__table1318194661915:
@ -180,7 +183,8 @@ Example Response
"id": "07adc044-3f21-4eeb-bd57-5e5eb6024b7f",
"project_id": "6c9298ec8c874f7f99688489ab65f90e",
"created_at": "2018-09-20T02:15:34",
"updated_at": "2018-09-20T02:15:34"
"updated_at": "2018-09-20T02:15:34",
"remote_address_group_id": null
},
{
"remote_group_id": null,
@ -196,7 +200,8 @@ Example Response
"id": "09358f83-f4a5-4386-9563-a1e3c373d655",
"project_id": "6c9298ec8c874f7f99688489ab65f90e",
"created_at": "2018-09-20T02:15:34",
"updated_at": "2018-09-20T02:15:34"
"updated_at": "2018-09-20T02:15:34",
"remote_address_group_id": null
},
{
"remote_group_id": "4c763030-366e-428c-be2b-d48f6baf5297",
@ -212,7 +217,8 @@ Example Response
"id": "219a6f56-1069-458b-bec0-df9270e7a074",
"project_id": "6c9298ec8c874f7f99688489ab65f90e",
"created_at": "2018-09-20T02:15:34",
"updated_at": "2018-09-20T02:15:34"
"updated_at": "2018-09-20T02:15:34",
"remote_address_group_id": null
}
],
"security_group_rules_links": [

41
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst
View File

@ -113,49 +113,52 @@ Response Parameters
.. table:: **Table 4** **Security Group Rule** objects
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================+
+=========================+=======================+=============================================================================================================================================================================================+
| id | String | Specifies the security group rule ID. |
| | | |
| | | This parameter is not mandatory when you query security group rules. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| description | String | Provides supplementary information about the security group rule. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| security_group_id | String | Specifies the ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | String | Specifies the peer ID of the belonged security group. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | String | Specifies the direction of the traffic for which the security group rule takes effect. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | String | Specifies the peer IP address segment. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | String | Specifies the protocol type or the IP protocol number. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. |
| | | |
| | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. |
| | | |
| | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ethertype | String | Specifies the network type. |
| | | |
| | | IPv4 and IPv6 are supported. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_address_group_id | String | - Specifies the remote IP address group ID. |
| | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| project_id | String | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | Specifies the time (UTC) when the security group rule is created. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | Specifies the time (UTC) when the security group rule is updated. |
| | | |
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_sg02_0001__table1318194661915:
@ -194,7 +197,8 @@ Example Response
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"port_range_max": null,
"port_range_min": null,
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2"
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
"remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249"
},
{
"id": "aecff4d4-9ce9-489c-86a3-803aedec65f7",
@ -207,7 +211,8 @@ Example Response
"tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
"port_range_max": null,
"port_range_min": null,
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2"
"security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
"remote_address_group_id": null
}
],
"created_at": "2018-09-12T08:24:14",

Some files were not shown because too many files have changed in this diff Show More