From cd0947f8ca4aa709eeffc463a7c2241d870646ce Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Tue, 8 Aug 2023 09:40:16 +0000 Subject: [PATCH] Update content --- .../apis/bandwidth/querying_a_bandwidth.rst | 2 +- .../apis/bandwidth/querying_bandwidths.rst | 2 +- .../apis/bandwidth/updating_a_bandwidth.rst | 2 +- .../adding_an_eip_to_a_shared_bandwidth.rst | 4 +- .../assigning_a_shared_bandwidth.rst | 2 +- api-ref/source/apis/eip/assigning_an_eip.rst | 4 +- api-ref/source/apis/eip/querying_an_eip.rst | 2 +- api-ref/source/apis/eip/querying_eips.rst | 2 +- api-ref/source/apis/eip/updating_an_eip.rst | 4 +- api-ref/source/apis/index.rst | 2 + api-ref/source/apis/quota/querying_quotas.rst | 12 + ...associating_subnets_with_a_route_table.rst | 213 ++++++++++ .../route_table/creating_a_route_table.rst | 252 ++++++++++++ .../route_table/deleting_a_route_table.rst | 66 ++++ ...associating_subnets_from_a_route_table.rst | 217 ++++++++++ api-ref/source/apis/route_table/index.rst | 26 ++ .../route_table/querying_a_route_table.rst | 193 +++++++++ .../route_table/querying_route_tables.rst | 159 ++++++++ .../route_table/updating_a_route_table.rst | 370 ++++++++++++++++++ .../creating_a_security_group.rst | 86 ++-- .../creating_a_security_group_rule.rst | 166 ++++---- .../querying_security_group_details.rst | 86 ++-- .../querying_security_group_rule_details.rst | 86 ++-- .../querying_security_group_rules.rst | 95 +++-- .../querying_security_groups.rst | 143 ++++--- api-ref/source/change_history.rst | 4 + .../querying_a_specified_api_version.rst | 158 ++++---- .../querying_api_versions.rst | 2 +- .../firewall/creating_a_firewall_group.rst | 3 +- .../firewall/querying_firewall_groups.rst | 5 +- .../firewall/querying_firewall_policies.rst | 3 +- .../firewall/querying_firewall_rules.rst | 3 +- .../network/querying_networks.rst | 2 - .../port/creating_a_port.rst | 4 +- .../creating_a_security_group.rst | 95 +++-- .../creating_a_security_group_rule.rst | 170 ++++---- .../querying_a_security_group.rst | 95 +++-- .../querying_a_security_group_rule.rst | 89 ++--- .../querying_security_group_rules.rst | 89 ++--- .../querying_security_groups.rst | 95 +++-- .../updating_a_security_group.rst | 95 +++-- .../subnet_pool/creating_a_subnet_pool.rst | 5 - .../subnet_pool/querying_a_subnet_pool.rst | 3 - .../subnet_pool/querying_subnet_pools.rst | 4 - .../subnet_pool/updating_a_subnet_pool.rst | 5 - .../index.rst | 8 + .../introduction.rst | 28 ++ .../security_group.rst | 20 +- .../security_group_rule.rst | 18 + .../subnet_tags.rst | 24 ++ .../vpc_tags.rst | 24 ++ 51 files changed, 2389 insertions(+), 858 deletions(-) create mode 100644 api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/creating_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/deleting_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/index.rst create mode 100644 api-ref/source/apis/route_table/querying_a_route_table.rst create mode 100644 api-ref/source/apis/route_table/querying_route_tables.rst create mode 100644 api-ref/source/apis/route_table/updating_a_route_table.rst create mode 100644 api-ref/source/permissions_policies_and_supported_actions/introduction.rst create mode 100644 api-ref/source/permissions_policies_and_supported_actions/security_group_rule.rst create mode 100644 api-ref/source/permissions_policies_and_supported_actions/subnet_tags.rst create mode 100644 api-ref/source/permissions_policies_and_supported_actions/vpc_tags.rst diff --git a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst index bed8c5a..2f7ed03 100644 --- a/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/querying_a_bandwidth.rst @@ -131,7 +131,7 @@ Response Message | | | - **6**: IPv6 (IPv6 is not supported currently.) | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/bandwidth/querying_bandwidths.rst b/api-ref/source/apis/bandwidth/querying_bandwidths.rst index c8b9e0a..9a0f4f9 100644 --- a/api-ref/source/apis/bandwidth/querying_bandwidths.rst +++ b/api-ref/source/apis/bandwidth/querying_bandwidths.rst @@ -142,7 +142,7 @@ Response Message | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst index c63298d..9f01c78 100644 --- a/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst +++ b/api-ref/source/apis/bandwidth/updating_a_bandwidth.rst @@ -158,7 +158,7 @@ Response Message | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst index 5428a5f..79ce6ed 100644 --- a/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/adding_an_eip_to_a_shared_bandwidth.rst @@ -63,7 +63,7 @@ Request Message | publicip_id | Yes | String | Specifies the ID of the EIP that uses the bandwidth. | +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ | publicip_type | No | String | - Specifies the EIP type. | - | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | | - Constraints: | | | | | | | | | | - The configured value must be supported by the system. | @@ -167,7 +167,7 @@ Response Message | | | - **6**: IPv6 (IPv6 is not supported currently.) | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst b/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst index 5177751..2a3076b 100644 --- a/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst +++ b/api-ref/source/apis/bandwidth_v2.0/assigning_a_shared_bandwidth.rst @@ -161,7 +161,7 @@ Response Message | publicip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ | publicip_type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/eip/assigning_an_eip.rst b/api-ref/source/apis/eip/assigning_an_eip.rst index 4e3433d..1f5f9e8 100644 --- a/api-ref/source/apis/eip/assigning_an_eip.rst +++ b/api-ref/source/apis/eip/assigning_an_eip.rst @@ -72,7 +72,7 @@ Request Parameters | Name | Mandatory | Type | Description | +=================+=================+=================+===============================================================================================================================+ | type | Yes | String | - Specifies the EIP type. | - | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | | - Constraints: | | | | | | | | | | - The configured value must be supported by the system. | @@ -179,7 +179,7 @@ Response Message | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/eip/querying_an_eip.rst b/api-ref/source/apis/eip/querying_an_eip.rst index e44148b..4e662eb 100644 --- a/api-ref/source/apis/eip/querying_an_eip.rst +++ b/api-ref/source/apis/eip/querying_an_eip.rst @@ -99,7 +99,7 @@ Response Message | | | This parameter is not supported currently. | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/eip/querying_eips.rst b/api-ref/source/apis/eip/querying_eips.rst index 7b276f1..5f2a67c 100644 --- a/api-ref/source/apis/eip/querying_eips.rst +++ b/api-ref/source/apis/eip/querying_eips.rst @@ -115,7 +115,7 @@ Response Message | | | This parameter is not supported currently. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | diff --git a/api-ref/source/apis/eip/updating_an_eip.rst b/api-ref/source/apis/eip/updating_an_eip.rst index 2531a86..e7e6411 100644 --- a/api-ref/source/apis/eip/updating_an_eip.rst +++ b/api-ref/source/apis/eip/updating_an_eip.rst @@ -125,13 +125,13 @@ Response Message | | | This parameter is not supported currently. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | type | String | - Specifies the EIP type. | - | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | + | | | - The value can be **5_bgp** (Dynamic BGP) or **5_mailbgp** (Mail BGP). | | | | - Constraints: | | | | | | | | - The configured value must be supported by the system. | | | | - **publicip_id** is an IPv4 port. If **publicip_type** is not specified, the default value is **5_bgp**. | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | public_ip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. | + | public_ip_address | String | Specifies the obtained EIP if only IPv4 EIPs are available. (IPv6 is not supported currently.) | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | ip_version | Integer | Specifies the IP address version. The value can be **4** or **6**. | | | | | diff --git a/api-ref/source/apis/index.rst b/api-ref/source/apis/index.rst index b9a4329..69eb276 100644 --- a/api-ref/source/apis/index.rst +++ b/api-ref/source/apis/index.rst @@ -16,6 +16,7 @@ APIs - :ref:`Security Group ` - :ref:`VPC Peering Connection ` - :ref:`VPC Route ` +- :ref:`Route Table ` - :ref:`VPC Tag Management ` - :ref:`Subnet Tag Management ` - :ref:`EIP Tag Management ` @@ -37,6 +38,7 @@ APIs security_group/index vpc_peering_connection/index vpc_route/index + route_table/index vpc_tag_management/index subnet_tag_management/index eip_tag_management/index diff --git a/api-ref/source/apis/quota/querying_quotas.rst b/api-ref/source/apis/quota/querying_quotas.rst index 047ae94..7b3bb32 100644 --- a/api-ref/source/apis/quota/querying_quotas.rst +++ b/api-ref/source/apis/quota/querying_quotas.rst @@ -207,6 +207,18 @@ Example Response "used": 0, "quota": 10, "min": 0 + }, + { + "type": "vpcContainRoutetable", + "used": 0, + "quota": 1, + "min": 0 + }, + { + "type": "routetableContainRoutes", + "used": 0, + "quota": 200, + "min": 0 } ] } diff --git a/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst b/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst new file mode 100644 index 0000000..6bc36cc --- /dev/null +++ b/api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst @@ -0,0 +1,213 @@ +:original_name: vpc_apiroutetab_0005.html + +.. _vpc_apiroutetab_0005: + +Associating Subnets with a Route Table +====================================== + +Function +-------- + +This API is used to associate a subnet with a route table. + +If a subnet has already been associated with route table A, you can associate the subnet with route table B directly without disassociating it from route table A first. + +URI +--- + +POST /v1/{project_id}/routetables/{routetable_id}/action + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0005__table125312228469: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+====================================================================+=======================================================================================================+ + | routetable | Yes | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table104243226461: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------+-----------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+============================================================================+=====================================================================================================+ + | subnets | Yes | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. | + | | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------+-----------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table12518142212468: + +.. table:: **Table 4** Description of the **subnet** field + + +--------------+-----------+------------------+----------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==============+===========+==================+==================================================================================+ + | associate | No | Array of strings | Specifies a list of IDs of the subnets to be associated with the route table. | + +--------------+-----------+------------------+----------------------------------------------------------------------------------+ + | disassociate | No | Array of strings | Specifies a list of IDs of the subnets to be disassociated from the route table. | + +--------------+-----------+------------------+----------------------------------------------------------------------------------+ + +Example Request +--------------- + +- Associate route table 3d42a0d4-a980-4613-ae76-a2cddecff054 with subnet 1a8b8c98-3976-401b-a735-8b058109268c. + + .. code-block:: text + + POST https://{Endpoint}/v1/6fbe9263116a4b68818cf1edce16bc4f/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054/action + + { + "routetable": { + "subnets": { + "associate": [ + "1a8b8c98-3976-401b-a735-8b058109268c" + ] + } + } + } + +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 6 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table884119412392: + +.. table:: **Table 6** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 7 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 8 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table1687317463915: + +.. table:: **Table 7** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **cc** (Cloud Connect connection) | + | | | - **egw**: VPC endpoint node | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0005__table17950204203919: + +.. table:: **Table 8** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "description": "abc", + "routes": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/creating_a_route_table.rst b/api-ref/source/apis/route_table/creating_a_route_table.rst new file mode 100644 index 0000000..ca0875f --- /dev/null +++ b/api-ref/source/apis/route_table/creating_a_route_table.rst @@ -0,0 +1,252 @@ +:original_name: vpc_apiroutetab_0003.html + +.. _vpc_apiroutetab_0003: + +Creating a Route Table +====================== + +Function +-------- + +This API is used to create a route table. + +Notes and Constraints + +- The destination CIDR block of a custom route table cannot be included in the CIDR blocks of the local route. +- Each destination CIDR block of a route in the same route table must be unique. +- No more than five routes can be created at a time. + +URI +--- + +POST /v1/{project_id}/routetables + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0003__table1211341604611: + +.. table:: **Table 1** Parameter description + + ========== ========= ====== ========================= + Name Mandatory Type Description + ========== ========= ====== ========================= + project_id Yes String Specifies the project ID. + ========== ========= ====== ========================= + +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+======================================================================+=========================================================================================================+ + | routetable | Yes | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0003__table18269181620462: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==========================================================================+================================================================================================================================+ + | name | No | String | - Specifies the route table name. | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | routes | No | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | | - Each route table can have a maximum of 200 routes. | + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route table. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+--------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0003__table1539412169467: + +.. table:: **Table 4** Description of the **route** field + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+==================================================================================================+ + | type | Yes | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **cc** (Cloud Connect connection) | + | | | | - **egw**: VPC endpoint node | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - The value must be in the valid CIDR format. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +Example Request +--------------- + +- Create a route table named **routetable-1234** for the VPC whose ID is 60c809cb-6731-45d0-ace8-3bf5626421a9 and create a route with next hop type of ECS. + + .. code-block:: text + + POST https://{Endpoint}/v1/6fbe9263116a4b68818cf1edce16bc4f/routetables + + { + "routetable": { + "name": "routetable-1234", + "vpc_id": "60c809cb-6731-45d0-ace8-3bf5626421a9", + "routes":[ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop":"7c50463d-d36c-4417-aa85-cc11fa10f341" + } + ], + "description":"abc" + } + } + +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 6 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0003__table884119412392: + +.. table:: **Table 6** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 5 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 7** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **cc** (Cloud Connect connection) | + | | | - **egw**: VPC endpoint node | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. table:: **Table 8** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "description": "abc", + "routes": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/deleting_a_route_table.rst b/api-ref/source/apis/route_table/deleting_a_route_table.rst new file mode 100644 index 0000000..6bbe21f --- /dev/null +++ b/api-ref/source/apis/route_table/deleting_a_route_table.rst @@ -0,0 +1,66 @@ +:original_name: vpc_apiroutetab_0006.html + +.. _vpc_apiroutetab_0006: + +Deleting a Route Table +====================== + +Function +-------- + +This API is used to delete a custom route table. + +Constraints: + +Only custom route tables can be deleted. If a custom route table has subnets associated, disassociate the subnets with the route table and then delete the route table. + +URI +--- + +DELETE /v1/{project_id}/routetables/{routetable_id} + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0006__table13893430173220: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Example Request +--------------- + +.. code-block:: text + + DELETE https://{Endpoint}/v1/{project_id}/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054 + +Response Parameters +------------------- + +None + +Example Response +---------------- + +None + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst b/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst new file mode 100644 index 0000000..c4bc278 --- /dev/null +++ b/api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst @@ -0,0 +1,217 @@ +:original_name: vpc_apiroutetab_0007.html + +.. _vpc_apiroutetab_0007: + +Disassociating Subnets from a Route Table +========================================= + +Function +-------- + +This API is used to disassociate subnets from a route table. + +URI +--- + +POST /v1/{project_id}/routetables/{routetable_id}/action + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0007__table125312228469: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+====================================================================+=======================================================================================================+ + | routetable | Yes | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table104243226461: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+==================================================================+=====================================================================================================+ + | subnets | Yes | :ref:`subnet ` object | - Specifies the subnets associated with the route table. | + | | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table12518142212468: + +.. table:: **Table 4** Description of the **subnet** field + + +--------------+-----------+------------------+----------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==============+===========+==================+============================================================================+ + | associate | No | Array of strings | Specifies the IDs of the subnets to be associated with the route table. | + +--------------+-----------+------------------+----------------------------------------------------------------------------+ + | disassociate | No | Array of strings | Specifies the IDs of the subnets to be disassociated from the route table. | + +--------------+-----------+------------------+----------------------------------------------------------------------------+ + +Example Request +--------------- + +- Disassociate route table 3d42a0d4-a980-4613-ae76-a2cddecff054 from subnet 815a6b9e-f766-48eb-967c-0ada72d85435. + + .. code-block:: text + + POST https://{Endpoint}/v1/6fbe9263116a4b68818cf1edce16bc4f/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054/action + + { + "routetable": { + "subnets": { + "disassociate": [ + "815a6b9e-f766-48eb-967c-0ada72d85435" + ] + } + } + } + +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 6 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table884119412392: + +.. table:: **Table 6** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 7 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 8 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Specifies the time (UTC) when the route table is created. | + | | | - Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table1687317463915: + +.. table:: **Table 7** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **cc** (Cloud Connect connection) | + | | | - **egw**: VPC endpoint node | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0007__table17950204203919: + +.. table:: **Table 8** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "description": "abc", + "routes": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/index.rst b/api-ref/source/apis/route_table/index.rst new file mode 100644 index 0000000..4f107d2 --- /dev/null +++ b/api-ref/source/apis/route_table/index.rst @@ -0,0 +1,26 @@ +:original_name: vpc_apiroutetab_0000.html + +.. _vpc_apiroutetab_0000: + +Route Table +=========== + +- :ref:`Querying Route Tables ` +- :ref:`Querying a Route Table ` +- :ref:`Creating a Route Table ` +- :ref:`Updating a Route Table ` +- :ref:`Associating Subnets with a Route Table ` +- :ref:`Disassociating Subnets from a Route Table ` +- :ref:`Deleting a Route Table ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + querying_route_tables + querying_a_route_table + creating_a_route_table + updating_a_route_table + associating_subnets_with_a_route_table + disassociating_subnets_from_a_route_table + deleting_a_route_table diff --git a/api-ref/source/apis/route_table/querying_a_route_table.rst b/api-ref/source/apis/route_table/querying_a_route_table.rst new file mode 100644 index 0000000..e4952f9 --- /dev/null +++ b/api-ref/source/apis/route_table/querying_a_route_table.rst @@ -0,0 +1,193 @@ +:original_name: vpc_apiroutetab_0002.html + +.. _vpc_apiroutetab_0002: + +Querying a Route Table +====================== + +Function +-------- + +This API is used to query details about a route table. + +URI +--- + +GET /v1/{project_id}/routetables/{routetable_id} + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0002__table12826134133917: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v1/26ae5181a416420998eb2093aaed84d9/routetables/66df8c1f-d4f6-4a63-9abb-09701fe27b39 + +Response Parameters +------------------- + +.. table:: **Table 2** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0002__table884119412392: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 5 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0002__table1687317463915: + +.. table:: **Table 4** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **cc** (Cloud Connect connection) | + | | | - **egw**: VPC endpoint node | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0002__table17950204203919: + +.. table:: **Table 5** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "05250d7e-0396-4fc9-9c9c-e4d5594784e4", + "name": "rtb-vpc-l2cg-1", + "routes": [ + { + "type": "local", + "destination": "192.168.4.0/24", + "nexthop": "-" + }, + { + "type": "local", + "destination": "192.168.1.0/24", + "nexthop": "-" + }, + { + "type": "local", + "destination": "198.19.128.0/20", + "nexthop": "-" + }, + { + "type": "local", + "destination": "127.0.0.0/8", + "nexthop": "-" + }, + { + "type": "local", + "destination": "100.64.0.0/10", + "nexthop": "-" + } + ], + "subnets": [ + { + "id": "0e0faa8f-ea73-47aa-b919-8c133e98d5ac" + }, + { + "id": "e007e005-10aa-4614-b439-c9a14e55130e" + } + ], + "vpc_id": "7978e43c-f892-49d8-9fab-9bb90a51709b", + "default": true, + "tenant_id": "05e369f07a800f802f41c002632ba5f9" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/querying_route_tables.rst b/api-ref/source/apis/route_table/querying_route_tables.rst new file mode 100644 index 0000000..434c102 --- /dev/null +++ b/api-ref/source/apis/route_table/querying_route_tables.rst @@ -0,0 +1,159 @@ +:original_name: vpc_apiroutetab_0001.html + +.. _vpc_apiroutetab_0001: + +Querying Route Tables +===================== + +Function +-------- + +This API is used to query all route tables of the tenant submitting the request. The route tables are filtered based on the filtering condition. + +URI +--- + +GET /v1/{project_id}/routetables + +Example: + +.. code-block:: text + + GET https://{Endpoint}/v1/{project_id}/routetables?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85&subnet_id=9873b33f-ac1c-4630-ad1c-7dba1ed79r78 + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0001__table135921530121310: + +.. table:: **Table 1** Parameter description + + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+========================================================================================================================================================================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | + | | | | | + | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | + | | | | | + | | | | This parameter can work together with the parameter **limit**. | + | | | | | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | + | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | No | String | Specifies the route table ID, which can be used to filter the route table with the corresponding ID. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | No | String | Specifies the VPC UUID. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | No | String | Specifies the subnet ID. | + | | | | | + | | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Example Request +--------------- + +.. code-block:: text + + GET https://{Endpoint}/v1/{project_id}/routetables?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85&subnet_id=9873b33f-ac1c-4630-ad1c-7dba1ed79r78 + +Response Parameters +------------------- + +.. table:: **Table 2** Response parameter + + +-------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=============+===============================================================================+=============================================================================================================+ + | routetables | Array of :ref:`routetable ` objects | Specifies the route table list. For details, see :ref:`Table 3 `. | + +-------------+-------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0001__table5685153016131: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===========================================================================+=======================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 4 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+---------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0001__table4856530131313: + +.. table:: **Table 4** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetables": [ + { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "name": "routetable-1234", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "description": "abc" + }, + { + "id": "3d42a0d4-a980-4613-ae76-a2cddecfff89", + "name": "routetable-5678", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f667809", + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "description": "abc" + } + ] + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/route_table/updating_a_route_table.rst b/api-ref/source/apis/route_table/updating_a_route_table.rst new file mode 100644 index 0000000..490d039 --- /dev/null +++ b/api-ref/source/apis/route_table/updating_a_route_table.rst @@ -0,0 +1,370 @@ +:original_name: vpc_apiroutetab_0004.html + +.. _vpc_apiroutetab_0004: + +Updating a Route Table +====================== + +Function +-------- + +This API is used to update a route table. + +URI +--- + +PUT /v1/{project_id}/routetables/{routetable_id} + +:ref:`Table 1 ` describes the parameters. + +.. _vpc_apiroutetab_0004__table13791152173213: + +.. table:: **Table 1** Parameter description + + +---------------+-----------+--------+------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===============+===========+========+========================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + | routetable_id | Yes | String | Specifies the route table ID, which uniquely identifies a route table. | + +---------------+-----------+--------+------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+====================================================================+=======================================================================================================+ + | routetable | Yes | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 3 `. | + +------------+-----------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table188071229326: + +.. table:: **Table 3** Description of the **routetable** field + + +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+===========================================================================================+===========================================================================================================================================================================================+ + | name | No | String | - Specifies the route table name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | No | :ref:`RouteTableRouteAction ` object | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | | - Constraints: | + | | | | | + | | | | - Each route table can have a maximum of 200 routes. | + | | | | - The destination cannot be modified directly. To modify the destination, run the **del** command to delete the corresponding route, and then run the **add** command to add a route. | + | | | | | + | | | | - Specifies the operation to perform. Possible values are as follows: | + | | | | | + | | | | - **add**: Adds a route. Parameters **type**, **destination**, and **nexthop** are mandatory. | + | | | | - **mod**: Modifies a route. Parameters **type**, **destination**, and **nexthop** are mandatory. | + | | | | - **del**: Deletes a route. Parameter **destination** is mandatory. | + +-----------------+-----------------+-------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__request_routetablerouteaction: + +.. table:: **Table 4** Description of the **route** field + + +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+========================================================================================+=============================================================================================+ + | add | No | Array of :ref:`AddRouteTableRoute ` objects | Add a route. For details, see :ref:`Table 5 `. | + | | | | | + | | | | Parameters **type**, **destination**, and **nexthop** are mandatory. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | mod | No | Array of :ref:`ModRouteTableRoute ` objects | Modify a route. For details, see :ref:`Table 6 `. | + | | | | | + | | | | Parameters **type**, **destination**, and **nexthop** are mandatory. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + | del | No | Array of :ref:`DelRouteTableRoute ` objects | Delete a route. For details, see :ref:`Table 7 `. | + | | | | | + | | | | Parameter **destination** is mandatory. | + +-----------------+-----------------+----------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table11648235202119: + +.. table:: **Table 5** Field description of adding a route + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==================================================================================================+ + | type | Yes | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **cc** (Cloud Connect connection) | + | | | | - **egw**: VPC endpoint node | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - The value must be in the valid CIDR format. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table1294364718262: + +.. table:: **Table 6** Field description of modifying a route + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==================================================================================================+ + | type | Yes | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **cc** (Cloud Connect connection) | + | | | | - **egw**: VPC endpoint node | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - The value must be in the valid CIDR format. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | nexthop | Yes | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table27171519267: + +.. table:: **Table 7** Field description of deleting a route + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+=================+==================================================================================================+ + | type | No | String | - Specifies the route type. | + | | | | - Values: | + | | | | | + | | | | - **ecs** (ECS) | + | | | | - **eni** (NIC) | + | | | | - **vip** (Virtual IP address) | + | | | | - **nat** (NAT gateway) | + | | | | - **peering** (VPC peering connection) | + | | | | - **vpn** (VPN) | + | | | | - **dc** (Direct Connect connection) | + | | | | - **cc** (Cloud Connect connection) | + | | | | - **egw**: VPC endpoint node | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | destination | Yes | String | - Specifies the destination CIDR block of a route. | + | | | | - The value must be in the valid CIDR format. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | nexthop | No | String | - Specifies the ID of the next hop in the route. | + | | | | - Values: | + | | | | | + | | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | + | | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the route. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+ + +Example Request +--------------- + +- Change the route table whose ID is 3d42a0d4-a980-4613-ae76-a2cddecff054, add a route with next hop type of ECS, modify the route with next hop type of ECS, and delete the route whose destination is 20.20.10.0/24. + + .. code-block:: text + + PUT https://{Endpoint}/v1/6fbe9263116a4b68818cf1edce16bc4f/routetables/3d42a0d4-a980-4613-ae76-a2cddecff054 + + { + "routetable": { + "name": "routertable-789", + "description": "abc", + "routes": { + "add": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "mod": [ + { + "type": "ecs", + "destination": "20.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "del": [ + { + "destination": "20.20.10.0/24" + } + ] + } + } + } + +Response Parameters +------------------- + +.. table:: **Table 8** Response parameter + + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+====================================================================+=======================================================================================================+ + | routetable | :ref:`routetable ` object | Specifies the route table. For details, see :ref:`Table 9 `. | + +------------+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ + +.. _vpc_apiroutetab_0004__table884119412392: + +.. table:: **Table 9** Description of the **routetable** field + + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+============================================================================+========================================================================================================================================+ + | id | String | - Specifies the route table ID, which uniquely identifies the route table. | + | | | - The value must be in standard UUID format. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the route table name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | default | Boolean | - Specifies whether the route table is the default one. | + | | | - The value can be **true** (default route table) or **false** (custom route table). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + | | | - Each route table can have a maximum of 200 routes. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | subnets | Array of :ref:`subnet ` objects | - Specifies the subnets associated with the route table. For details, see :ref:`Table 5 `. | + | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the project ID. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | - Specifies the ID of the VPC associated with the route table. | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route table. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ + +.. table:: **Table 10** Description of the **route** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================================+ + | type | String | - Specifies the route type. | + | | | - Values: | + | | | | + | | | - **ecs** (ECS) | + | | | - **eni** (NIC) | + | | | - **vip** (Virtual IP address) | + | | | - **nat** (NAT gateway) | + | | | - **peering** (VPC peering connection) | + | | | - **vpn** (VPN) | + | | | - **dc** (Direct Connect connection) | + | | | - **cc** (Cloud Connect connection) | + | | | - **egw**: VPC endpoint node | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | destination | String | - Specifies the destination CIDR block of a route. | + | | | - The value must be in the valid CIDR format. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the ID of the next hop in the route. | + | | | - Values: | + | | | | + | | | - When **type** is **ecs**, the value is the ECS ID. | + | | | - When **type** is **eni**, the value is the extension NIC ID. | + | | | - When **type** is **vip**, the value is the virtual IP address. | + | | | - When **type** is **nat**, the value is NAT gateway ID. | + | | | - When **type** is **peering**, the value is the VPC peering connection ID. | + | | | - When **type** is **vpn**, the value is the VPN ID. | + | | | - When **type** is **dc**, the value is the Direct Connect connection ID. | + | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. | + | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the route. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+ + +.. table:: **Table 11** Description of the **subnet** field + + +------+--------+-----------------------------------------------------------------+ + | Name | Type | Description | + +======+========+=================================================================+ + | id | String | Specifies the ID of the subnet associated with the route table. | + +------+--------+-----------------------------------------------------------------+ + +Example Response +---------------- + +.. code-block:: + + { + "routetable": { + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "description": "abc", + "routes": [ + { + "type": "ecs", + "destination": "10.10.10.0/24", + "nexthop": "7c50463d-d36c-4417-aa85-cc11fa10f341", + "description": "abc" + } + ], + "subnets": [ + { + "id": "8d4ce32f-d68a-4c4c-9f18-c68d8a5c7f2f" + } + ], + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f" + } + } + +Status Code +----------- + +See :ref:`Status Codes `. + +Error Code +---------- + +See :ref:`Error Codes `. diff --git a/api-ref/source/apis/security_group/creating_a_security_group.rst b/api-ref/source/apis/security_group/creating_a_security_group.rst index 9449e4a..6613b3a 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group.rst @@ -127,49 +127,46 @@ Response Parameters .. table:: **Table 6** **security_group_rule** objects - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -197,8 +194,7 @@ Example Response "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", "description": "", "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "remote_address_group_id": null + "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" } ] } diff --git a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst index 0df825d..6f91abc 100644 --- a/api-ref/source/apis/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/apis/security_group/creating_a_security_group_rule.rst @@ -30,46 +30,43 @@ Request Parameters .. table:: **Table 2** Description of the **security_group_rule** field - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=========================+=================+=================+===========================================================================================================================================================================================================================================================+ - | security_group_id | Yes | String | Specifies the security group ID. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the security group rule. | - | | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | Yes | String | - Access control direction specified in a security group rule. | - | | | | - The value can be: | - | | | | | - | | | | - **egress** | - | | | | - **ingress** | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | No | String | - Specifies the IP protocol version. | - | | | | - The value can be **IPv4** or **IPv6**. | - | | | | - If you do not set this parameter, **IPv4** is used by default. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | - Specifies the protocol type. | - | | | | - The value can be **tcp**, **udp**, **icmp** or an IP protocol number (0 to 255). | - | | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | No | Integer | - Specifies the start port number. | - | | | | - The value ranges from 1 to 65535. | - | | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | No | Integer | - Specifies the end port number. | - | | | | - The value ranges from 1 to 65535. | - | | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | No | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | | - The value can be in the CIDR format or IP addresses. | - | | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | No | String | - Specifies the ID of the peer security group. | - | | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | - | | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===================+=================+=================+===========================================================================================================================================================================================================================================================+ + | security_group_id | Yes | String | Specifies the security group ID. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the security group rule. | + | | | | - The value can contain no more than 255 characters, including letters and digits. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | Yes | String | - Access control direction specified in a security group rule. | + | | | | - The value can be: | + | | | | | + | | | | - **egress** | + | | | | - **ingress** | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | No | String | - Specifies the IP protocol version. | + | | | | - The value can be **IPv4** or **IPv6**. | + | | | | - If you do not set this parameter, **IPv4** is used by default. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | String | - Specifies the protocol type. | + | | | | - The value can be **tcp**, **udp**, **icmp** or an IP protocol number (0 to 255). | + | | | | - If the parameter is left blank, all protocols are supported. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | No | Integer | - Specifies the start port number. | + | | | | - The value ranges from 1 to 65535. | + | | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | No | Integer | - Specifies the end port number. | + | | | | - The value ranges from 1 to 65535. | + | | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | No | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | | - The value can be in the CIDR format or IP addresses. | + | | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | No | String | - Specifies the ID of the peer security group. | + | | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request --------------- @@ -88,8 +85,7 @@ Example Request "port_range_max": "80", "protocol": "tcp", "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a", - "remote_address_group_id": null + "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a" } } @@ -108,49 +104,46 @@ Response Parameters .. table:: **Table 4** **security_group_rule** objects - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -169,8 +162,7 @@ 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", - "remote_address_group_id": null + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" } } diff --git a/api-ref/source/apis/security_group/querying_security_group_details.rst b/api-ref/source/apis/security_group/querying_security_group_details.rst index fb4630c..f57f71b 100644 --- a/api-ref/source/apis/security_group/querying_security_group_details.rst +++ b/api-ref/source/apis/security_group/querying_security_group_details.rst @@ -87,49 +87,46 @@ Response Parameters .. table:: **Table 4** **security_group_rule** objects - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -149,8 +146,7 @@ Example Response "ethertype": "IPv4", "id": "369e6499-b2cb-4126-972a-97e589692c62", "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "remote_address_group_id": null + "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" }, { "direction": "ingress", diff --git a/api-ref/source/apis/security_group/querying_security_group_rule_details.rst b/api-ref/source/apis/security_group/querying_security_group_rule_details.rst index 91da481..fc3896b 100644 --- a/api-ref/source/apis/security_group/querying_security_group_rule_details.rst +++ b/api-ref/source/apis/security_group/querying_security_group_rule_details.rst @@ -56,49 +56,46 @@ Response Parameters .. table:: **Table 3** **security_group_rule** objects - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -117,8 +114,7 @@ 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", - "remote_address_group_id": null + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" } } diff --git a/api-ref/source/apis/security_group/querying_security_group_rules.rst b/api-ref/source/apis/security_group/querying_security_group_rules.rst index b370154..21cad90 100644 --- a/api-ref/source/apis/security_group/querying_security_group_rules.rst +++ b/api-ref/source/apis/security_group/querying_security_group_rules.rst @@ -73,49 +73,46 @@ Response Parameters .. table:: **Table 2** **security_group_rule** objects - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -135,8 +132,7 @@ Example Response "remote_group_id": null, "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" }, { "direction": "egress", @@ -149,8 +145,7 @@ Example Response "remote_group_id": null, "remote_ip_prefix": null, "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" }, { "direction": "ingress", @@ -163,8 +158,7 @@ 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", - "remote_address_group_id": null + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" }, { "direction": "ingress", @@ -177,8 +171,7 @@ 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", - "remote_address_group_id": null + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550" } ] } diff --git a/api-ref/source/apis/security_group/querying_security_groups.rst b/api-ref/source/apis/security_group/querying_security_groups.rst index 1240a3f..2d8b124 100644 --- a/api-ref/source/apis/security_group/querying_security_groups.rst +++ b/api-ref/source/apis/security_group/querying_security_groups.rst @@ -27,36 +27,33 @@ Example: .. table:: **Table 1** Parameter description - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=========================+=================+=================+=====================================================================================================================================================================================================================================================================================================================================================+ - | project_id | Yes | String | Specifies the project ID. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | - | | | | | - | | | | This parameter can work together with the parameter **limit**. | - | | | | | - | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | - | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | - | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | - | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | - | | | | | - | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | No | String | Specifies that the VPC ID is used as the filtering condition. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter the security groups of an enterprise project. | - | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the security groups bound to all enterprise projects of the user or to display the security group list for enterprise project member accounts, set **all_granted_eps**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | - | | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=======================+=================+=================+=====================================================================================================================================================================================================================================================================================================================================================+ + | project_id | Yes | String | Specifies the project ID. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | marker | No | String | Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID. | + | | | | | + | | | | This parameter can work together with the parameter **limit**. | + | | | | | + | | | | - If parameters **marker** and **limit** are not passed, resource records on the first page will be returned. | + | | | | - If the parameter **marker** is not passed and the value of parameter **limit** is set to **10**, the first 10 resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the value of parameter **limit** is set to **10**, the 11th to 20th resource records will be returned. | + | | | | - If the value of the parameter **marker** is set to the resource ID of the 10th record and the parameter **limit** is not passed, resource records starting from the 11th records (including 11th) will be returned. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | limit | No | Integer | Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. | + | | | | | + | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | No | String | Specifies that the VPC ID is used as the filtering condition. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | - Specifies the enterprise project ID. This field can be used to filter the security groups of an enterprise project. | + | | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. To obtain the security groups bound to all enterprise projects of the user or to display the security group list for enterprise project member accounts, set **all_granted_eps**. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This parameter is unsupported. Do not use it. | + +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Request Parameters ------------------ @@ -116,49 +113,46 @@ Response Parameters .. table:: **Table 4** **security_group_rule** objects - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+=======================+===========================================================================================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the security group rule. | - | | | - The value can contain no more than 255 characters, including letters and digits. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | - Specifies the direction of access control. | - | | | - Possible values are as follows: | - | | | | - | | | - **egress** | - | | | - **ingress** | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | - Specifies the IP protocol version. | - | | | - The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | - Specifies the protocol type. | - | | | - The value can be **icmp**, **tcp**, or **udp**. | - | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | - Specifies the start port number. | - | | | - The value ranges from 1 to 65535. | - | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | - Specifies the end port number. | - | | | - The value ranges from 1 to 65535. | - | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | - The value can be in the CIDR format or IP addresses. | - | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | - Specifies the ID of the peer security group. | - | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+===========================================================================================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the security group rule. | + | | | - The value can contain no more than 255 characters, including letters and digits. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the security group rule ID, which uniquely identifies the security group rule. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | - Specifies the direction of access control. | + | | | - Possible values are as follows: | + | | | | + | | | - **egress** | + | | | - **ingress** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | - Specifies the IP protocol version. | + | | | - The value can be **IPv4** or **IPv6**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | - Specifies the protocol type. | + | | | - The value can be **icmp**, **tcp**, or **udp**. | + | | | - If the parameter is left blank, all protocols are supported. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | - Specifies the start port number. | + | | | - The value ranges from 1 to 65535. | + | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | - Specifies the end port number. | + | | | - The value ranges from 1 to 65535. | + | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | + | | | - The value can be in the CIDR format or IP addresses. | + | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | - Specifies the ID of the peer security group. | + | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -179,8 +173,7 @@ Example Response "ethertype": "IPv4", "id": "369e6499-b2cb-4126-972a-97e589692c62", "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "remote_address_group_id": null + "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" }, { "direction": "ingress", diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 6932193..2f01682 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,10 @@ Change History +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Released On | Description | +===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| 2023-08-07 | This release incorporates the following changes: | +| | | +| | Added description about interconnection with IAM fine-grained authorization in :ref:`Permissions Policies and Supported Actions `. | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-06-20 | This release incorporates the following changes: | | | | | | Modified parameters in :ref:`Deleting an EIP Tag `. | diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_a_specified_api_version.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_a_specified_api_version.rst index 85a403b..a8dd88d 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_a_specified_api_version.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_a_specified_api_version.rst @@ -27,96 +27,94 @@ GET /{api_version} api_version String Specifies the version number, for example **v2.0**. =========== ====== =================================================== -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0 + +-----------+-------------------------------------------------------------------------+-----------------------------------------+ + | Parameter | Type | Description | + +===========+=========================================================================+=========================================+ + | resources | Array of :ref:`resource ` objects | Specifies the **resource** object list. | + +-----------+-------------------------------------------------------------------------+-----------------------------------------+ -Response Message +.. _vpc_version_0002__table1195920258372: + +.. table:: **Table 3** **resource** object + + +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +============+=====================================================================+==================================================================================================+ + | name | String | Specifies the resource name. | + +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | collection | String | Specifies the resource collection name. | + +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | links | Array of :ref:`link ` objects | Specifies the link list. For details, see :ref:`Table 4 `. | + +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + +.. _vpc_version_0002__table4442151110172: + +.. table:: **Table 4** **link** objects + + +-----------+--------+----------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+======================================================================+ + | href | String | Specifies the API link. | + +-----------+--------+----------------------------------------------------------------------+ + | rel | String | Specifies the relationship between the API link and the API version. | + +-----------+--------+----------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+-------------------------------------------------------------------------+-----------------------------------------+ - | Parameter | Type | Description | - +===========+=========================================================================+=========================================+ - | resources | Array of :ref:`resource ` objects | Specifies the **resource** object list. | - +-----------+-------------------------------------------------------------------------+-----------------------------------------+ - - .. _vpc_version_0002__table1195920258372: - - .. table:: **Table 3** **resource** object - - +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+=====================================================================+==================================================================================================+ - | name | String | Specifies the resource name. | - +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | collection | String | Specifies the resource collection name. | - +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | links | Array of :ref:`link ` objects | Specifies the link list. For details, see :ref:`Table 4 `. | - +------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - - .. _vpc_version_0002__table4442151110172: - - .. table:: **Table 4** **link** objects - - +-----------+--------+----------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+======================================================================+ - | href | String | Specifies the API link. | - +-----------+--------+----------------------------------------------------------------------+ - | rel | String | Specifies the relationship between the API link and the API version. | - +-----------+--------+----------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "resources": [ - { - "links": [ - { - "href": "https://vpc.systems.com/v2.0/subnets", - "rel": "self" - } - ], - "name": "subnet", - "collection": "subnets" - }, - { - "links": [ - { - "href": "https://vpc.systems.com/v2.0/networks", - "rel": "self" - } - ], - "name": "network", - "collection": "networks" - }, - { - "links": [ - { - "href": "https://vpc.systems.com/v2.0/ports", - "rel": "self" - } - ], - "name": "port", - "collection": "ports" - } - ] - } + { + "resources": [ + { + "links": [ + { + "href": "https://vpc.systems.com/v2.0/subnets", + "rel": "self" + } + ], + "name": "subnet", + "collection": "subnets" + }, + { + "links": [ + { + "href": "https://vpc.systems.com/v2.0/networks", + "rel": "self" + } + ], + "name": "network", + "collection": "networks" + }, + { + "links": [ + { + "href": "https://vpc.systems.com/v2.0/ports", + "rel": "self" + } + ], + "name": "port", + "collection": "ports" + } + ] + } Status Code ----------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_api_versions.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_api_versions.rst index 2e8ffcc..029ae87 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_api_versions.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/querying_api_versions.rst @@ -80,7 +80,7 @@ Example Response "id": "v2.0", "links": [ { - "href": "https://None/v2.0", + "href": "https://{Endpoint}/v2.0", "rel": "self" } ] diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst index f07ae66..f9cffe9 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst @@ -77,6 +77,7 @@ Create an ACL group, associate it with the inbound ACL policy afc52ce9-5305-4ec9 { "firewall_group": { + "name": "test", "ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341", "ports": [ "c133f2bf-6937-4416-bb17-012e1be5cd2d" @@ -143,7 +144,7 @@ Example Response "status": "PENDING_CREATE", "public": false, "egress_firewall_policy_id": null, - "name": "", + "name": "test", "admin_state_up": true, "ports": [ "c133f2bf-6937-4416-bb17-012e1be5cd2d" diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst index c3e93c8..0de27e0 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_groups.rst @@ -106,7 +106,7 @@ Response Parameters +----------------------------+-----------------------+--------------------------------------------------------------------------+ | public | Boolean | Specifies whether the firewall group can be shared by different tenants. | +----------------------------+-----------------------+--------------------------------------------------------------------------+ - | status | String | Specifies the status of the firewall policy. | + | status | String | Specifies the status of a firewall group. | +----------------------------+-----------------------+--------------------------------------------------------------------------+ | admin_state_up | Boolean | Specifies the administrative status of the firewall. | +----------------------------+-----------------------+--------------------------------------------------------------------------+ @@ -173,8 +173,7 @@ Example Response ], "firewall_groups_links": [ { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ - fwaas/firewall_groups?marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=True" + "href": "https://{Endpoint}/v2.0/fwaas/firewall_groups?marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=True" } ] } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst index 5a22e6f..247eb85 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_policies.rst @@ -149,8 +149,7 @@ Example Response ], "firewall_policies_links": [ { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ - fwaas/firewall_policies?marker=6b70e321-0c21-4b83-bb8a-a886d1414a5f&page_reverse=True" + "href": "https://{Endpoint}/v2.0/fwaas/firewall_policies?marker=6b70e321-0c21-4b83-bb8a-a886d1414a5f&page_reverse=True" } ] } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst index f7208da..6be52e7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_firewall_rules.rst @@ -187,8 +187,7 @@ Example Response ], "firewall_rules_links": [ { "rel": "previous", - "href": "https://{Endpoint}/v2.0/ - fwaas/firewall_rules?marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=True" + "href": "https://{Endpoint}/v2.0/fwaas/firewall_rules?marker=2a193015-4a88-4aa1-84ad-d4955adae707&page_reverse=True" } ] } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst index f32c187..02e85c7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_networks.rst @@ -129,8 +129,6 @@ Response Parameters | shared | Boolean | Specifies whether the network can be shared by different tenants. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | id | String | Specifies the network ID. | - | | | | - | | | This parameter is not mandatory when you query networks. | +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | provider:network_type | String | Specifies the network type. Only the VXLAN and GENEVE networks are supported. This is an extended attribute. | | | | | diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst index 6d4990d..7a93077 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/creating_a_port.rst @@ -85,7 +85,9 @@ Request Parameters +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | port_security_enabled | No | Boolean | Specifies whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect. | +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | No | String | Specifies the device to which the port belongs. Currently, only **""** and **neutron:VIP_PORT** are supported. **neutron:VIP_PORT** indicates the port of a virtual IP address. | + | device_owner | No | String | Specifies the device that the port belongs to. | + | | | | | + | | | | Currently, only **""** and **neutron:VIP_PORT** are supported. **neutron:VIP_PORT** indicates the port of a virtual IP address. | +-----------------------+-----------------+----------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_port02_0003__table335683819394: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst index 7f6f260..fb54c73 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group.rst @@ -98,52 +98,49 @@ 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* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -169,8 +166,7 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2", - "remote_address_group_id": null + "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2" }, { "id": "6332de3e-98fb-4f8c-b44a-fcb8ff09881e", @@ -183,8 +179,7 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2", - "remote_address_group_id": null + "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2" } ], "created_at": "2018-09-20T02:15:34", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst index f1eea33..6fbd33a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/creating_a_security_group_rule.rst @@ -30,48 +30,45 @@ Request Parameters .. table:: **Table 2** **Security Group Rule** objects - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=========================+=================+=================+=============================================================================================================================================================================================+ - | description | No | String | Provides supplementary information about the security group rule. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | Yes | String | Specifies the ID of the belonged security group. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | No | String | Specifies the peer ID of the belonged security group. | - | | | | | - | | | | Either **remote_group_id** or **remote_ip_prefix** is used. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | Yes | String | Specifies the direction of the traffic for which the security group rule takes effect. | - | | | | | - | | | | The value can be **ingress** or **egress**. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | No | String | Specifies the peer IP address segment. | - | | | | | - | | | | Either **remote_ip_prefix** or **remote_group_id** is used. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Specifies the protocol type or the IP protocol number. | - | | | | | - | | | | The value can be **tcp**, **udp**, **icmp** or an IP protocol number | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | No | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - | | | | | - | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | No | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | | - | | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | | - | | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - | | | | | - | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | No | String | Specifies the network type. | - | | | | | - | | | | The value can be **IPv4** or **IPv6**. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | - | | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +===================+=================+=================+=============================================================================================================================================================================================+ + | description | No | String | Provides supplementary information about the security group rule. | + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | Yes | String | Specifies the ID of the belonged security group. | + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | No | String | Specifies the peer ID of the belonged security group. | + | | | | | + | | | | Either **remote_group_id** or **remote_ip_prefix** is used. | + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | Yes | String | Specifies the direction of the traffic for which the security group rule takes effect. | + | | | | | + | | | | The value can be **ingress** or **egress**. | + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | No | String | Specifies the peer IP address segment. | + | | | | | + | | | | Either **remote_ip_prefix** or **remote_group_id** is used. | + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | No | String | Specifies the protocol type or the IP protocol number. | + | | | | | + | | | | The value can be **tcp**, **udp**, **icmp** or an IP protocol number | + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | No | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + | | | | | + | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | No | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | | + | | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | | + | | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + | | | | | + | | | | The value ranges from 1 to 65535. (The value ranges from 0 to 255 when it indicates the code.) | + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | No | String | Specifies the network type. | + | | | | | + | | | | The value can be **IPv4** or **IPv6**. | + +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Request --------------- @@ -106,52 +103,49 @@ Response Parameters .. table:: **Table 4** **Security Group Rule** objects - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=========================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst index fe06eac..6486872 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group.rst @@ -72,52 +72,49 @@ 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* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -143,8 +140,7 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", - "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" + "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2" }, { "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7", @@ -157,8 +153,7 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", - "remote_address_group_id": null + "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2" } ], "created_at": "2018-09-12T08:24:14", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst index 99e7fbc..5f870e1 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_a_security_group_rule.rst @@ -42,52 +42,49 @@ 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* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst index 48dde4b..026ab18 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_group_rules.rst @@ -103,52 +103,49 @@ 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* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_sg02_0006__table1318194661915: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst index 4467a24..4efa855 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst @@ -113,52 +113,49 @@ Response Parameters .. table:: **Table 4** **Security Group Rule** objects - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=========================+=======================+=============================================================================================================================================================================================+ - | id | String | Specifies the security group rule ID. | - | | | | - | | | This parameter is not mandatory when you query security group rules. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group rule. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Specifies the ID of the belonged security group. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | String | Specifies the peer ID of the belonged security group. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | String | Specifies the peer IP address segment. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Specifies the protocol type or the IP protocol number. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | - | | | | - | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | - | | | | - | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | String | Specifies the network type. | - | | | | - | | | IPv4 and IPv6 are supported. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | String | - Specifies the remote IP address group ID. | - | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the project ID. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the security group rule is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _vpc_sg02_0001__table1318194661915: @@ -197,8 +194,7 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", - "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" + "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2" }, { "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7", @@ -211,8 +207,7 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2", - "remote_address_group_id": null + "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2" } ], "created_at": "2018-09-12T08:24:14", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst index 8553b07..ffdc256 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst @@ -100,52 +100,49 @@ 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* | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=============================================================================================================================================================================================+ + | id | String | Specifies the security group rule ID. | + | | | | + | | | This parameter is not mandatory when you query security group rules. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group rule. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_id | String | Specifies the ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_group_id | String | Specifies the peer ID of the belonged security group. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | direction | String | Specifies the direction of the traffic for which the security group rule takes effect. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | remote_ip_prefix | String | Specifies the peer IP address segment. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | protocol | String | Specifies the protocol type or the IP protocol number. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_max | Integer | Specifies the maximum port number. When ICMP is used, the value is the ICMP code. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | port_range_min | Integer | Specifies the minimum port number. If the ICMP protocol is used, this parameter indicates the ICMP type. | + | | | | + | | | When the TCP or UDP protocol is used, both **port_range_max** and **port_range_min** must be specified, and the **port_range_max** value must be greater than the **port_range_min** value. | + | | | | + | | | When the ICMP protocol is used, if you specify the ICMP code (**port_range_max**), you must also specify the ICMP type (**port_range_min**). | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ethertype | String | Specifies the network type. | + | | | | + | | | IPv4 and IPv6 are supported. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | project_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the security group rule is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the security group rule is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example Response ---------------- @@ -171,8 +168,7 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2", - "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" + "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2" }, { "id": "3f51e52c-0e85-40f7-a137-85927392e436", @@ -185,8 +181,7 @@ Example Response "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "port_range_max": null, "port_range_min": null, - "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2", - "remote_address_group_id": null + "security_group_id": "d29ae17d-f355-4992-8747-1fb66cc9afd2" } ], "created_at": "2018-09-20T02:15:34", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/creating_a_subnet_pool.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/creating_a_subnet_pool.rst index e7bde08..dd9c576 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/creating_a_subnet_pool.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/creating_a_subnet_pool.rst @@ -61,8 +61,6 @@ Request Message +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | No | Boolean | Specifies whether this is the default subnet pool. | +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | No | Integer | Specifies the revision number of the subnet pool. | - +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Message ---------------- @@ -124,8 +122,6 @@ Response Message +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | Boolean | Specifies whether this is the default subnet pool. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | Integer | Specifies the revision number of the subnet pool. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of strings | Specifies the tags. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -173,7 +169,6 @@ Example response "192.168.0.0/16" ], "project_id": "9fadcee8aa7c40cdb2114fff7d569c08", - "revision_number": 1, "shared": false, "tenant_id": "9fadcee8aa7c40cdb2114fff7d569c08", "created_at": "2018-09-20T02:15:34", diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_a_subnet_pool.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_a_subnet_pool.rst index 1bdf6a6..c7ca19d 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_a_subnet_pool.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_a_subnet_pool.rst @@ -80,8 +80,6 @@ Response Message +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | Boolean | Specifies whether this is the default subnet pool. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | Integer | Specifies the revision number of the subnet pool. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of strings | Specifies the tags. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,7 +120,6 @@ Example response "ip_version": 6, "shared": false, "description": "", - "revision_number": 2, "tags": [] } } diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst index c1ab8ba..079fe39 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/querying_subnet_pools.rst @@ -96,8 +96,6 @@ Response Message +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | Boolean | Specifies whether this is the default subnet pool. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | Integer | Specifies the revision number of the subnet pool. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of strings | Specifies the tags. | +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -146,7 +144,6 @@ Example response "ip_version": 6, "shared": false, "description": "", - "revision_number": 2, "created_at": "2018-09-20T02:15:34", "updated_at": "2018-09-20T02:15:34", "tags": [] @@ -169,7 +166,6 @@ Example response "ip_version": 4, "shared": false, "description": "", - "revision_number": 2, "created_at": "2018-09-20T02:15:34", "updated_at": "2018-09-20T02:15:34", "tags": [] diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/updating_a_subnet_pool.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/updating_a_subnet_pool.rst index a9a1b7e..53bc50d 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/updating_a_subnet_pool.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet_pool/updating_a_subnet_pool.rst @@ -61,8 +61,6 @@ Request Message +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | No | Boolean | Specifies whether this is the default subnet pool. | +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | No | Integer | Specifies the revision number of the subnet pool. | - +-------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response Message ---------------- @@ -124,8 +122,6 @@ Response Message +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | is_default | Boolean | Specifies whether this is the default subnet pool. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | revision_number | Integer | Specifies the revision number of the subnet pool. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | tags | Array of strings | Specifies the tags. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -175,7 +171,6 @@ Example response "id": "03f761e6-eee0-43fc-a921-8acf64c14988", "max_prefixlen": 64, "description": "", - "revision_number": 2, "created_at": "2018-09-20T02:15:34", "updated_at": "2018-09-20T02:15:34", "tags": [] diff --git a/api-ref/source/permissions_policies_and_supported_actions/index.rst b/api-ref/source/permissions_policies_and_supported_actions/index.rst index 442821b..23c0b0c 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/index.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/index.rst @@ -5,6 +5,7 @@ Permissions Policies and Supported Actions ========================================== +- :ref:`Introduction ` - :ref:`VPC ` - :ref:`Subnet ` - :ref:`EIP ` @@ -16,6 +17,9 @@ Permissions Policies and Supported Actions - :ref:`Quota ` - :ref:`Private IP Address ` - :ref:`Security Group ` +- :ref:`Security Group Rule ` +- :ref:`VPC Tags ` +- :ref:`Subnet Tags ` - :ref:`VPC Flow Log ` - :ref:`Port (OpenStack Neutron API) ` - :ref:`Network (OpenStack Neutron API) ` @@ -30,6 +34,7 @@ Permissions Policies and Supported Actions :maxdepth: 1 :hidden: + introduction vpc subnet eip @@ -41,6 +46,9 @@ Permissions Policies and Supported Actions quota private_ip_address security_group + security_group_rule + vpc_tags + subnet_tags vpc_flow_log port_openstack_neutron_api network_openstack_neutron_api diff --git a/api-ref/source/permissions_policies_and_supported_actions/introduction.rst b/api-ref/source/permissions_policies_and_supported_actions/introduction.rst new file mode 100644 index 0000000..f032713 --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/introduction.rst @@ -0,0 +1,28 @@ +:original_name: permission_0001.html + +.. _permission_0001: + +Introduction +============ + +By default, new IAM users do not have permissions assigned. You need to add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups. This way, they can perform specified operations on cloud services based on the permissions. + +Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query VPCs using an API, the user must have been granted permissions that allow the **vpc:vpcs:list** action. + +Supported Actions +----------------- + +VPC provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies: + +- Permissions: statements in a policy that allow or deny certain operations +- APIs: REST APIs that can be called by a user who has been granted specific permissions +- Actions: specific operations that are allowed or denied +- IAM projects/Enterprise projects: the authorization scope of a custom policy. A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions for both IAM and enterprise projects can be used and applied for both IAM and Enterprise Management. Policies that contain actions only for IAM projects can be used and applied to IAM only. + + .. note:: + + Y: supported; x: not supported + +VPC supports the following actions in custom policies: + +[Example] :ref:`VPC ` actions that supported by VPC APIs include creating a VPC, querying a VPC, querying VPCs, updating a VPC, and deleting a VPC. diff --git a/api-ref/source/permissions_policies_and_supported_actions/security_group.rst b/api-ref/source/permissions_policies_and_supported_actions/security_group.rst index 24c7dc5..25bc355 100644 --- a/api-ref/source/permissions_policies_and_supported_actions/security_group.rst +++ b/api-ref/source/permissions_policies_and_supported_actions/security_group.rst @@ -5,12 +5,14 @@ Security Group ============== -+---------------------------+----------------------------------------------------------+---------------------------+ -| Permission | API | Action | -+===========================+==========================================================+===========================+ -| Creates a security group. | POST /v1/{project_id}/security-groups | vpc:securityGroups:create | -+---------------------------+----------------------------------------------------------+---------------------------+ -| Queries a security group. | GET /v1/{project_id}/security-groups/{security_group_id} | vpc:securityGroups:get | -+---------------------------+----------------------------------------------------------+---------------------------+ -| Queries security groups. | GET /v1/{project_id}/security-groups | vpc:securityGroups:get | -+---------------------------+----------------------------------------------------------+---------------------------+ ++---------------------------+-------------------------------------------------------------+---------------------------+ +| Permission | API | Action | ++===========================+=============================================================+===========================+ +| Creates a security group. | POST /v1/{project_id}/security-groups | vpc:securityGroups:create | ++---------------------------+-------------------------------------------------------------+---------------------------+ +| Queries a security group. | GET /v1/{project_id}/security-groups/{security_group_id} | vpc:securityGroups:get | ++---------------------------+-------------------------------------------------------------+---------------------------+ +| Queries security groups. | GET /v1/{project_id}/security-groups | vpc:securityGroups:get | ++---------------------------+-------------------------------------------------------------+---------------------------+ +| Deletes a security group. | DELETE /v1/{project_id}/security-groups/{security_group_id} | vpc:securityGroups:delete | ++---------------------------+-------------------------------------------------------------+---------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/security_group_rule.rst b/api-ref/source/permissions_policies_and_supported_actions/security_group_rule.rst new file mode 100644 index 0000000..99f390f --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/security_group_rule.rst @@ -0,0 +1,18 @@ +:original_name: vpc_permission_0009.html + +.. _vpc_permission_0009: + +Security Group Rule +=================== + ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ +| Permission | API | Action | ++================================+=========================================================================+===============================+ +| Creates a security group rule. | POST /v1/{project_id}/security-group-rules | vpc:securityGroupRules:create | ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ +| Queries a security group rule. | GET /v1/{project_id}/security-group-rules/{rules_security_groups_id} | vpc:securityGroupRules:get | ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ +| Queries security group rules. | GET /v1/{project_id}/security-group-rules | vpc:securityGroupRules:get | ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ +| Deletes a security group rule. | DELETE /v1/{project_id}/security-group-rules/{rules_security_groups_id} | vpc:securityGroupRules:delete | ++--------------------------------+-------------------------------------------------------------------------+-------------------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/subnet_tags.rst b/api-ref/source/permissions_policies_and_supported_actions/subnet_tags.rst new file mode 100644 index 0000000..c30e21b --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/subnet_tags.rst @@ -0,0 +1,24 @@ +:original_name: vpc_permission_0019.html + +.. _vpc_permission_0019: + +Subnet Tags +=========== + ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Permission | API | Action | ++=============================================+===========================================================+=======================+ +| Creating a Tag for a Subnet | POST /v2.0/{project_id}/subnets/{subnet_id}/tags | vpc:subnetTags:create | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Querying Subnet Tags | GET /v2.0/{project_id}/subnets/{subnet_id}/tags | vpc:subnetTags:get | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Deleting a Subnet Tag | DELETE /v2.0/{project_id}/subnets/{subnet_id}/tags/{key} | vpc:subnetTags:delete | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Batch Creating or Deleting Subnet Tags | POST /v2.0/{project_id}/subnets/{subnet_id}/tags/action | vpc:subnetTags:create | +| | | | +| | | vpc:subnetTags:delete | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Querying Subnets by Tag | POST /v2.0/{project_id}/subnets/resource_instances/action | vpc:subnetTags:get | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ +| Querying Subnet Tags in a Specified Project | GET /v2.0/{project_id}/subnets/tags | vpc:subnetTags:get | ++---------------------------------------------+-----------------------------------------------------------+-----------------------+ diff --git a/api-ref/source/permissions_policies_and_supported_actions/vpc_tags.rst b/api-ref/source/permissions_policies_and_supported_actions/vpc_tags.rst new file mode 100644 index 0000000..1b6798d --- /dev/null +++ b/api-ref/source/permissions_policies_and_supported_actions/vpc_tags.rst @@ -0,0 +1,24 @@ +:original_name: vpc_permission_0021.html + +.. _vpc_permission_0021: + +VPC Tags +======== + ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Permission | API | Action | ++==========================================+========================================================+=======================+ +| Creating a Tag for a VPC | POST /v2.0/{project_id}/vpcs/{vpc_id}/tags | vpc:vpcTags:create | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Querying VPC Tags | GET /v2.0/{project_id}/vpcs/{vpc_id}/tags | vpc:vpcTags:get | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Deleting a VPC Tag | DELETE /v2.0/{project_id}/vpcs/{vpc_id}/tags/{key} | vpc:vpcTags:delete | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Batch Creating or Deleting VPC Tags | POST /v2.0/{project_id}/vpcs/{vpc_id}/tags/action | vpc:vpcTags:create | +| | | | +| | | vpc:vpcTags:delete | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Querying VPCs by Tag | POST /v2.0/{project_id}/vpcs/resource_instances/action | vpc:vpcTags:get | ++------------------------------------------+--------------------------------------------------------+-----------------------+ +| Querying VPC Tags in a Specified Project | GET /v2.0/{project_id}/vpcs/tags | vpc:vpcTags:get | ++------------------------------------------+--------------------------------------------------------+-----------------------+