diff --git a/api-ref/source/apis/eip/querying_an_eip.rst b/api-ref/source/apis/eip/querying_an_eip.rst index 2ca14df..e44148b 100644 --- a/api-ref/source/apis/eip/querying_an_eip.rst +++ b/api-ref/source/apis/eip/querying_an_eip.rst @@ -95,6 +95,8 @@ Response Message | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 `. | + | | | | + | | | 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**. | diff --git a/api-ref/source/apis/eip/querying_eips.rst b/api-ref/source/apis/eip/querying_eips.rst index 94bc6f9..7b276f1 100644 --- a/api-ref/source/apis/eip/querying_eips.rst +++ b/api-ref/source/apis/eip/querying_eips.rst @@ -111,6 +111,8 @@ Response Message | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | profile | Object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 `. | + | | | | + | | | 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**. | diff --git a/api-ref/source/apis/eip/updating_an_eip.rst b/api-ref/source/apis/eip/updating_an_eip.rst index 6f667ce..2531a86 100644 --- a/api-ref/source/apis/eip/updating_an_eip.rst +++ b/api-ref/source/apis/eip/updating_an_eip.rst @@ -121,6 +121,8 @@ Response Message | | | - **ERROR** (Exceptions) | +-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | profile | :ref:`profile ` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 6 `. | + | | | | + | | | 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**. | diff --git a/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst b/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst index 158d16e..3d7b866 100644 --- a/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst +++ b/api-ref/source/apis/private_ip_address/assigning_a_private_ip_address.rst @@ -27,40 +27,41 @@ POST /v1/{project_id}/privateips project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +============+===========+=======================================================================+================================================================================================================+ + | privateips | Yes | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | + +------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_privateip_0001__table45335391: + +.. table:: **Table 3** Description of the **privateip** field + + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+====================================================================================================================================+ + | subnet_id | Yes | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | | + | | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | No | String | - Specifies the target IP address. | + | | | | - The value can be an available IP address in the subnet. If it is not specified, the system automatically assigns an IP address. | + +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +============+===========+=======================================================================+================================================================================================================+ - | privateips | Yes | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | - +------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_privateip_0001__table45335391: - - .. table:: **Table 3** Description of the **privateip** field - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+====================================================================================================================================+ - | subnet_id | Yes | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | | - | | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | String | - Specifies the target IP address. | - | | | | - The value can be an available IP address in the subnet. If it is not specified, the system automatically assigns an IP address. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Assign two private IP addresses from the subnet whose ID is 531dec0f-3116-411b-a21b-e612e42349fd. One IP address is automatically assigned, and the other is specified to 192.168.1.17. .. code-block:: text POST https://{Endpoint}/v1/{project_id}/privateips - Assign two private IP addresses from the subnet whose ID is 531dec0f-3116-411b-a21b-e612e42349fd. One IP address is automatically assigned, and the other is specified to 192.168.1.17. + { "privateips": [ @@ -74,89 +75,88 @@ Request Message ] } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+=======================================================================+================================================================================================================+ + | privateips | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 5 `. | + +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_privateip_0001__table34571880: + +.. table:: **Table 5** Description of the **privateip** field + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================+ + | status | String | - Specifies the status of the private IP address. | + | | | - Possible values are as follows: | + | | | | + | | | - **ACTIVE** | + | | | - **DOWN** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | + | | | | + | | | - The value can be: | + | | | | + | | | **network:dhcp**: DHCP service IP address | + | | | | + | | | **network:router_interface_distributed**: Gateway IP address | + | | | | + | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | + | | | | + | | | **neutron:VIP_PORT**: Virtual IP address | + | | | | + | | | **compute:subeni**: IP address of a supplementary network interface | + | | | | + | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | + | | | | + | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | + | | | | + | | | **network:endpoint_interface**: IP address of a VPC endpoint | + | | | | + | | | - The value range specifies only the type of private IP addresses supported by the current service. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | String | Specifies the assigned private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============+=======================================================================+================================================================================================================+ - | privateips | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 5 `. | - +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_privateip_0001__table34571880: - - .. table:: **Table 5** Description of the **privateip** field - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================================================================+ - | status | String | - Specifies the status of the private IP address. | - | | | - Possible values are as follows: | - | | | | - | | | - **ACTIVE** | - | | | - **DOWN** | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | - | | | | - | | | - The value can be: | - | | | | - | | | **network:dhcp**: DHCP service IP address | - | | | | - | | | **network:router_interface_distributed**: Gateway IP address | - | | | | - | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | - | | | | - | | | **neutron:VIP_PORT**: Virtual IP address | - | | | | - | | | **compute:subeni**: IP address of a supplementary network interface | - | | | | - | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | - | | | | - | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | - | | | | - | | | **network:endpoint_interface**: IP address of a VPC endpoint | - | | | | - | | | - The value range specifies only the type of private IP addresses supported by the current service. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | String | Specifies the assigned private IP address. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "privateips": [ - { - "status": "DOWN", - "id": "c60c2ce1-1e73-44bd-bf48-fd688448ff7b", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.10" - }, - { - "status": "DOWN", - "id": "4b123c18-ae92-4dfa-92cd-d44002359aa1", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.17" - } - ] - } + { + "privateips": [ + { + "status": "DOWN", + "id": "c60c2ce1-1e73-44bd-bf48-fd688448ff7b", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.10" + }, + { + "status": "DOWN", + "id": "4b123c18-ae92-4dfa-92cd-d44002359aa1", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.17" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst b/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst index fa7dcdc..2e95333 100644 --- a/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst +++ b/api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst @@ -29,32 +29,30 @@ DELETE /v1/{project_id}/privateips/{privateip_id} | privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | +--------------+-----------+-----------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d - -Response Message +Example Response ---------------- -- Request parameter +.. code-block:: text None -- Example response - - .. code-block:: text - - None - Status Code ----------- diff --git a/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst b/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst index 3315a4e..1939b75 100644 --- a/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst +++ b/api-ref/source/apis/private_ip_address/querying_private_ip_address_details.rst @@ -29,93 +29,91 @@ GET /v1/{project_id}/privateips/{privateip_id} | privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | +--------------+-----------+-----------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78 + +-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +===========+=============================================================+================================================================================================================+ + | privateip | :ref:`privateip ` object | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | + +-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -Response --------- +.. _vpc_privateip_0002__table23250319: -- Response parameter +.. table:: **Table 3** Description of the **privateip** field - .. table:: **Table 2** Response parameter + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================+ + | status | String | - Specifies the status of the private IP address. | + | | | - Possible values are as follows: | + | | | | + | | | - **ACTIVE** | + | | | - **DOWN** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | + | | | | + | | | - The value can be: | + | | | | + | | | **network:dhcp**: DHCP service IP address | + | | | | + | | | **network:router_interface_distributed**: Gateway IP address | + | | | | + | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | + | | | | + | | | **neutron:VIP_PORT**: Virtual IP address | + | | | | + | | | **compute:subeni**: IP address of a supplementary network interface | + | | | | + | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | + | | | | + | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | + | | | | + | | | **network:endpoint_interface**: IP address of a VPC endpoint | + | | | | + | | | - The value range specifies only the type of private IP addresses supported by the current service. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | String | Specifies the assigned private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - +-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +===========+=============================================================+================================================================================================================+ - | privateip | :ref:`privateip ` object | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | - +-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +Example Response +---------------- - .. _vpc_privateip_0002__table23250319: +.. code-block:: - .. table:: **Table 3** Description of the **privateip** field - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================================================================+ - | status | String | - Specifies the status of the private IP address. | - | | | - Possible values are as follows: | - | | | | - | | | - **ACTIVE** | - | | | - **DOWN** | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | - | | | | - | | | - The value can be: | - | | | | - | | | **network:dhcp**: DHCP service IP address | - | | | | - | | | **network:router_interface_distributed**: Gateway IP address | - | | | | - | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | - | | | | - | | | **neutron:VIP_PORT**: Virtual IP address | - | | | | - | | | **compute:subeni**: IP address of a supplementary network interface | - | | | | - | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | - | | | | - | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | - | | | | - | | | **network:endpoint_interface**: IP address of a VPC endpoint | - | | | | - | | | - The value range specifies only the type of private IP addresses supported by the current service. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | String | Specifies the assigned private IP address. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "privateip": - { - "status": "DOWN", - "id": "d600542a-b231-45ed-af05-e9930cb14f78", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.11" - } - } + { + "privateip": + { + "status": "DOWN", + "id": "d600542a-b231-45ed-af05-e9930cb14f78", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.11" + } + } Status Code ----------- diff --git a/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst b/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst index 5a0a795..3c8ac45 100644 --- a/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst +++ b/api-ref/source/apis/private_ip_address/querying_private_ip_addresses.rst @@ -50,102 +50,100 @@ Example: | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Request parameter - GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips + +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +============+=======================================================================+================================================================================================================+ + | privateips | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | + +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_privateip_0003__table21538022: + +.. table:: **Table 3** Description of the **privateip** field + + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+=======================================================================================================================================================================================+ + | status | String | - Specifies the status of the private IP address. | + | | | - Possible values are as follows: | + | | | | + | | | - **ACTIVE** | + | | | - **DOWN** | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | + | | | | + | | | - The value can be: | + | | | | + | | | **network:dhcp**: DHCP service IP address | + | | | | + | | | **network:router_interface_distributed**: Gateway IP address | + | | | | + | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | + | | | | + | | | **neutron:VIP_PORT**: Virtual IP address | + | | | | + | | | **compute:subeni**: IP address of a supplementary network interface | + | | | | + | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | + | | | | + | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | + | | | | + | | | **network:endpoint_interface**: IP address of a VPC endpoint | + | | | | + | | | - The value range specifies only the type of private IP addresses supported by the current service. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | ip_address | String | Specifies the assigned private IP address. | + +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Request parameter +.. code-block:: - .. table:: **Table 2** Request parameter - - +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +============+=======================================================================+================================================================================================================+ - | privateips | Array of :ref:`privateip ` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 `. | - +------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_privateip_0003__table21538022: - - .. table:: **Table 3** Description of the **privateip** field - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+=======================================================================================================================================================================================+ - | status | String | - Specifies the status of the private IP address. | - | | | - Possible values are as follows: | - | | | | - | | | - **ACTIVE** | - | | | - **DOWN** | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ID of the private IP address, which uniquely identifies the private IP address. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the ID of the subnet from which IP addresses are assigned. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_owner | String | - Specifies the resource using the private IP address. The parameter is left blank if it is not used. | - | | | | - | | | - The value can be: | - | | | | - | | | **network:dhcp**: DHCP service IP address | - | | | | - | | | **network:router_interface_distributed**: Gateway IP address | - | | | | - | | | **compute:**\ *xxx* (*xxx* indicates the AZ name. For example, **compute:aa-bb-cc** indicates that the IP address is used by an ECS in the AZ aa-bb-cc.): IP address of an ECS NIC | - | | | | - | | | **neutron:VIP_PORT**: Virtual IP address | - | | | | - | | | **compute:subeni**: IP address of a supplementary network interface | - | | | | - | | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer | - | | | | - | | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer | - | | | | - | | | **network:endpoint_interface**: IP address of a VPC endpoint | - | | | | - | | | - The value range specifies only the type of private IP addresses supported by the current service. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | String | Specifies the assigned private IP address. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "privateips": [ - { - "status": "DOWN", - "id": "d600542a-b231-45ed-af05-e9930cb14f78", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.11" - }, - { - "status": "DOWN", - "id": "d600542a-b231-45ed-af05-e9930cb14f79", - "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", - "device_owner": "", - "ip_address": "192.168.1.12" - } - ] - } + { + "privateips": [ + { + "status": "DOWN", + "id": "d600542a-b231-45ed-af05-e9930cb14f78", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.11" + }, + { + "status": "DOWN", + "id": "d600542a-b231-45ed-af05-e9930cb14f79", + "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", + "device_owner": "", + "ip_address": "192.168.1.12" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst b/api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst index 579a24b..44355e4 100644 --- a/api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst +++ b/api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst @@ -35,97 +35,95 @@ GET /v2.0/network-ip-availabilities/{network_id} network_id String Yes Specifies the network ID. ========== ====== ========= ========================= -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043 + +-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=========================+================================================================================+==============================================================================================================================+ + | network_ip_availability | :ref:`network_ip_availability ` object | Specifies the **network_ip_availability** objects. For details, see :ref:`Table 3 `. | + +-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_natworkip_0001__table4952133061113: + +.. table:: **Table 3** **network_ip_availability** objects + + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +========================+========================================================================================+=========================================================================================================================+ + | network_id | String | Specifies the network ID. | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | network_name | String | Specifies the network name. | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | total_ips | Integer | Specifies the total number of IP addresses on a network. (System reserved IP addresses are not included.) | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | used_ips | Integer | Specifies the number of in-use IP addresses on a network. (Reserved IP addresses are not included.) | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + | subnet_ip_availability | Array of :ref:`subnet_ip_availability ` objects | Specifies the subnet IP address usage objects. For details, see :ref:`Table 4 `. | + +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_natworkip_0001__table110015141519: + +.. table:: **Table 4** Description of the **subnet_ip_availability** field + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===========================================================================================================+ + | used_ips | Integer | Specifies the number of in-use IP addresses on a subnet. (System reserved IP addresses are not included.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | subnet_id | String | Specifies the subnet ID. | + | | | | + | | | If you use the management console, the value of this parameter is the **Network ID** value. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | subnet_name | String | Specifies the subnet name. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | ip_version | Integer | Specifies the IP version of the subnet. Only IPv4 is supported. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the subnet CIDR block. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + | total_ips | Integer | Specifies the total number of IP addresses on a subnet. (System reserved IP addresses are not included.) | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=========================+================================================================================+==============================================================================================================================+ - | network_ip_availability | :ref:`network_ip_availability ` object | Specifies the **network_ip_availability** objects. For details, see :ref:`Table 3 `. | - +-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_natworkip_0001__table4952133061113: - - .. table:: **Table 3** **network_ip_availability** objects - - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +========================+========================================================================================+=========================================================================================================================+ - | network_id | String | Specifies the network ID. | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | network_name | String | Specifies the network name. | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | total_ips | Integer | Specifies the total number of IP addresses on a network. (System reserved IP addresses are not included.) | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | used_ips | Integer | Specifies the number of in-use IP addresses on a network. (Reserved IP addresses are not included.) | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - | subnet_ip_availability | Array of :ref:`subnet_ip_availability ` objects | Specifies the subnet IP address usage objects. For details, see :ref:`Table 4 `. | - +------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_natworkip_0001__table110015141519: - - .. table:: **Table 4** Description of the **subnet_ip_availability** field - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================================+ - | used_ips | Integer | Specifies the number of in-use IP addresses on a subnet. (System reserved IP addresses are not included.) | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | subnet_id | String | Specifies the subnet ID. | - | | | | - | | | If you use the management console, the value of this parameter is the **Network ID** value. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | subnet_name | String | Specifies the subnet name. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | ip_version | Integer | Specifies the IP version of the subnet. Only IPv4 is supported. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the subnet CIDR block. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - | total_ips | Integer | Specifies the total number of IP addresses on a subnet. (System reserved IP addresses are not included.) | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "network_ip_availability": { - "used_ips": 4, - "subnet_ip_availability": [ - { - "used_ips": 4, - "subnet_id": "98e343d1-3cb8-4f69-9cd1-00569819480f", - "subnet_name": "", - "ip_version": 4, - "cidr": "10.0.0.0/8", - "total_ips": 300 - } - ], - "network_id": "6b50d967-779c-40c9-a157-de1df3c17043", - "tenant_id": "7c4b23cb125d481c95cbe4f91b2c11cd", - "total_ips": 300, - "network_name": "pch_test_003" - } - } + { + "network_ip_availability": { + "used_ips": 4, + "subnet_ip_availability": [ + { + "used_ips": 4, + "subnet_id": "98e343d1-3cb8-4f69-9cd1-00569819480f", + "subnet_name": "", + "ip_version": 4, + "cidr": "10.0.0.0/8", + "total_ips": 300 + } + ], + "network_id": "6b50d967-779c-40c9-a157-de1df3c17043", + "tenant_id": "7c4b23cb125d481c95cbe4f91b2c11cd", + "total_ips": 300, + "network_name": "pch_test_003" + } + } Status Code ----------- diff --git a/api-ref/source/apis/quota/querying_quotas.rst b/api-ref/source/apis/quota/querying_quotas.rst index 29f128a..047ae94 100644 --- a/api-ref/source/apis/quota/querying_quotas.rst +++ b/api-ref/source/apis/quota/querying_quotas.rst @@ -54,165 +54,163 @@ Example: | | | | - **routetableContainRoutes**: Number of routes in a route table | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/quotas -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/quotas + +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +========+============================================================+====================================================================================================+ + | quotas | :ref:`quotas ` object | Specifies the quota object. For details, see :ref:`Table 3 `. | + +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_quota_0001__table11308015155544: + +.. table:: **Table 3** Description of the **quotas** field + + +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +===========+=================================================================+=================================================================================================+ + | resources | Array of :ref:`resource ` objects | Specifies the resource objects. For details, see :ref:`Table 4 `. | + +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ + +.. _vpc_quota_0001__table8208684: + +.. table:: **Table 4** Description of the **resource** field + + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==============================================================================+ + | type | String | - Specifies the resource type. | + | | | - Values: | + | | | | + | | | - **vpc**: VPC | + | | | - **subnet**: Subnet | + | | | - **securityGroup**: Security group | + | | | - **securityGroupRule**: Security group rule | + | | | - **publicIp**: EIP | + | | | - **vpn**: VPN | + | | | - **vpcPeer**: VPC peering connection | + | | | - **loadbalancer**: Load balancer | + | | | - **listener**: Listener | + | | | - **physicalConnect**: Direct Connect connection | + | | | - **virtualInterface**: Virtual interface | + | | | - **firewall**: Firewall | + | | | - **shareBandwidthIP**: IP address added to a shared bandwidth | + | | | - **shareBandwidth**: Shared bandwidth | + | | | - **flow_log**: VPC fow log | + | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC | + | | | - **routetableContainRoutes**: Number of routes in a route table | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | used | Integer | - Specifies the number of created network resources. | + | | | - The value ranges from **0** to the value of **quota**. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | quota | Integer | - Specifies the maximum quota values for the resources. | + | | | - The value ranges from the default quota value to the maximum quota value. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + | min | Integer | Specifies the minimum quota value allowed. | + +-----------------------+-----------------------+------------------------------------------------------------------------------+ + +.. note:: + + If value **-1** is returned when you use an API to query your VPC quota, this indicates that the VPC quota is not limited. + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +========+============================================================+====================================================================================================+ - | quotas | :ref:`quotas ` object | Specifies the quota object. For details, see :ref:`Table 3 `. | - +--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+ - - .. _vpc_quota_0001__table11308015155544: - - .. table:: **Table 3** Description of the **quotas** field - - +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +===========+=================================================================+=================================================================================================+ - | resources | Array of :ref:`resource ` objects | Specifies the resource objects. For details, see :ref:`Table 4 `. | - +-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+ - - .. _vpc_quota_0001__table8208684: - - .. table:: **Table 4** Description of the **resource** field - - +-----------------------+-----------------------+------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==============================================================================+ - | type | String | - Specifies the resource type. | - | | | - Values: | - | | | | - | | | - **vpc**: VPC | - | | | - **subnet**: Subnet | - | | | - **securityGroup**: Security group | - | | | - **securityGroupRule**: Security group rule | - | | | - **publicIp**: EIP | - | | | - **vpn**: VPN | - | | | - **vpcPeer**: VPC peering connection | - | | | - **loadbalancer**: Load balancer | - | | | - **listener**: Listener | - | | | - **physicalConnect**: Direct Connect connection | - | | | - **virtualInterface**: Virtual interface | - | | | - **firewall**: Firewall | - | | | - **shareBandwidthIP**: IP address added to a shared bandwidth | - | | | - **shareBandwidth**: Shared bandwidth | - | | | - **flow_log**: VPC fow log | - | | | - **vpcContainRoutetable**: Number of route tables associated with a VPC | - | | | - **routetableContainRoutes**: Number of routes in a route table | - +-----------------------+-----------------------+------------------------------------------------------------------------------+ - | used | Integer | - Specifies the number of created network resources. | - | | | - The value ranges from **0** to the value of **quota**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------+ - | quota | Integer | - Specifies the maximum quota values for the resources. | - | | | - The value ranges from the default quota value to the maximum quota value. | - +-----------------------+-----------------------+------------------------------------------------------------------------------+ - | min | Integer | Specifies the minimum quota value allowed. | - +-----------------------+-----------------------+------------------------------------------------------------------------------+ - - .. note:: - - If value **-1** is returned when you use an API to query your VPC quota, this indicates that the VPC quota is not limited. - -- Example response - - .. code-block:: - - { - "quotas": { - "resources": [ - { - "type": "vpc", - "used": 4, - "quota": 150, - "min": 0 - }, - { - "type": "subnet", - "used": 5, - "quota": 400, - "min": 0 - }, - { - "type": "securityGroup", - "used": 1, - "quota": 100, - "min": 0 - }, - { - "type": "securityGroupRule", - "used": 6, - "quota": 5000, - "min": 0 - }, - { - "type": "publicIp", - "used": 2, - "quota": 10, - "min": 0 - }, - { - "type": "vpn", - "used": 0, - "quota": 5, - "min": 0 - }, - { - "type": "vpcPeer", - "used": 0, - "quota": 50, - "min": 0 - }, - { - "type": "firewall", - "used": 0, - "quota": 200, - "min": 0 - }, - { - "type": "shareBandwidth", - "used": 0, - "quota": 5, - "min": 0 - }, - { - "type": "shareBandwidthIP", - "used": 0, - "quota": 20, - "min": 0 - }, - { - "type": "loadbalancer", - "used": 0, - "quota": 10, - "min": 0 - }, - { - "type": "listener", - "used": 0, - "quota": 10, - "min": 0 - } - ] - } - } + { + "quotas": { + "resources": [ + { + "type": "vpc", + "used": 4, + "quota": 150, + "min": 0 + }, + { + "type": "subnet", + "used": 5, + "quota": 400, + "min": 0 + }, + { + "type": "securityGroup", + "used": 1, + "quota": 100, + "min": 0 + }, + { + "type": "securityGroupRule", + "used": 6, + "quota": 5000, + "min": 0 + }, + { + "type": "publicIp", + "used": 2, + "quota": 10, + "min": 0 + }, + { + "type": "vpn", + "used": 0, + "quota": 5, + "min": 0 + }, + { + "type": "vpcPeer", + "used": 0, + "quota": 50, + "min": 0 + }, + { + "type": "firewall", + "used": 0, + "quota": 200, + "min": 0 + }, + { + "type": "shareBandwidth", + "used": 0, + "quota": 5, + "min": 0 + }, + { + "type": "shareBandwidthIP", + "used": 0, + "quota": 20, + "min": 0 + }, + { + "type": "loadbalancer", + "used": 0, + "quota": 10, + "min": 0 + }, + { + "type": "listener", + "used": 0, + "quota": 10, + "min": 0 + } + ] + } + } Status Code ----------- 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 79ef98d..9449e4a 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 @@ -27,51 +27,52 @@ POST /v1/{project_id}/security-groups project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +================+===========+=================================================================+===========================================================================================================+ + | security_group | Yes | :ref:`security_group ` object | Specifies the security group objects. For details, see :ref:`Table 3 `. | + +----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0001__table495783939489: + +.. table:: **Table 3** Description of **security_group** fields + + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=======================+=================+=================+===================================================================================================================================================================+ + | name | Yes | String | - Specifies the security group name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | No | String | Specifies the resource ID of the VPC to which the security group belongs. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This parameter has been discarded. Do not use it. | + | | | | | + | | | | Currently, this parameter is used only as a prompt. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | + | | | | - 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. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This parameter is unsupported. Do not use it. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +================+===========+=================================================================+===========================================================================================================+ - | security_group | Yes | :ref:`security_group ` object | Specifies the security group objects. For details, see :ref:`Table 3 `. | - +----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0001__table495783939489: - - .. table:: **Table 3** Description of **security_group** fields - - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=======================+=================+=================+===================================================================================================================================================================+ - | name | Yes | String | - Specifies the security group name. | - | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | No | String | Specifies the resource ID of the VPC to which the security group belongs. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter has been discarded. Do not use it. | - | | | | | - | | | | Currently, this parameter is used only as a prompt. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | - | | | | - 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. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a security group named **sg-01** in the VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85. .. code-block:: text POST https://{Endpoint}/v1/{project_id}/security-groups - Create a security group named sg-01 in VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85. + { "security_group": { "name": "sg-01", @@ -80,129 +81,128 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +================+=================================================================+===========================================================================================================+ + | security_group | :ref:`security_group ` object | Specifies the security group objects. For details, see :ref:`Table 5 `. | + +----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0001__table661472489489: + +.. table:: **Table 5** Description of **security_group** fields + + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+================================================================================+===================================================================================================================================================================+ + | name | String | Specifies the security group name. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the security group ID, which uniquely identifies the security group. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter has been discarded. Do not use it. | + | | | | + | | | Currently, this parameter is used only as a prompt. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | + | | | - 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. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0001__table210704979489: + +.. 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. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +================+=================================================================+===========================================================================================================+ - | security_group | :ref:`security_group ` object | Specifies the security group objects. For details, see :ref:`Table 5 `. | - +----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0001__table661472489489: - - .. table:: **Table 5** Description of **security_group** fields - - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+================================================================================+===================================================================================================================================================================+ - | name | String | Specifies the security group name. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group ID, which uniquely identifies the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter has been discarded. Do not use it. | - | | | | - | | | Currently, this parameter is used only as a prompt. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | - | | | - 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. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0001__table210704979489: - - .. 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_group": { - "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "name": "qq", - "description": "", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "369e6499-b2cb-4126-972a-97e589692c62", - "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", - "description": "", - "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "remote_address_group_id": null - } - ] - } - } + { + "security_group": { + "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "name": "qq", + "description": "", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", + "security_group_rules": [ + { + "direction": "egress", + "ethertype": "IPv4", + "id": "369e6499-b2cb-4126-972a-97e589692c62", + "description": "", + "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" + }, + { + "direction": "ingress", + "ethertype": "IPv4", + "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", + "description": "", + "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "remote_address_group_id": null + } + ] + } + } Status Code ----------- 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 53dd18e..0df825d 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 @@ -15,69 +15,71 @@ URI POST /v1/{project_id}/security-group-rules -Request Message +Request Parameters +------------------ + +.. table:: **Table 1** Request parameter + + +---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=====================+===========+========================================================================+==================================================================================================================+ + | security_group_rule | Yes | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 2 `. | + +---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0005__table40497645103533: + +.. 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**. | + +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 1** Request parameter - - +---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=====================+===========+========================================================================+==================================================================================================================+ - | security_group_rule | Yes | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 2 `. | - +---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0005__table40497645103533: - - .. 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 | - The value can be: | - | | | | | - | | | | - **egress** | - | | | | - **ingress** | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ethertype | No | String | - Specifies the IP protocol version. | - | | | | - The value can be **IPv4** or **IPv6**. | - | | | | - If you do not set this parameter, **IPv4** is used by default. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | - Specifies the protocol type. | - | | | | - The value can be **tcp**, **udp**, **icmp** or an IP protocol number (0 to 255). | - | | | | - If the parameter is left blank, all protocols are supported. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_min | No | Integer | - Specifies the start port number. | - | | | | - The value ranges from 1 to 65535. | - | | | | - The value cannot be greater than the **port_range_max** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | port_range_max | No | Integer | - Specifies the end port number. | - | | | | - The value ranges from 1 to 65535. | - | | | | - If the protocol is not **icmp**, the value cannot be smaller than the **port_range_min** value. An empty value indicates all ports. If the protocol is **icmp**, the value range is shown in :ref:`ICMP-Port Range Relationship Table `. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_ip_prefix | No | String | - Specifies the remote IP address. If the access control direction is set to **egress**, the parameter specifies the source IP address. If the access control direction is set to **ingress**, the parameter specifies the destination IP address. | - | | | | - The value can be in the CIDR format or IP addresses. | - | | | | - The parameter is mutually exclusive with parameter **remote_group_id**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_group_id | No | String | - Specifies the ID of the peer security group. | - | | | | - The value is mutually exclusive with parameter **remote_ip_prefix**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remote_address_group_id | No | String | - Specifies the remote IP address group ID. You can log in to the management console and view the ID on the IP address group page. | - | | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Create an inbound rule in the security group whose ID is a7734e61-b545-452d-a3cd-0189cbd9747a. .. code-block:: text POST https://{Endpoint}/v1/{project_id}/security-group-rules - Create an inbound rule in the security group whose ID is a7734e61-b545-452d-a3cd-0189cbd9747a. + { "security_group_rule": { "direction": "ingress", @@ -91,87 +93,86 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 3** Response parameter + + +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=====================+======================================================================+================================================================================================================+ + | security_group_rule | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 4 `. | + +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0005__table488727239520: + +.. 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. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 3** Response parameter - - +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=====================+======================================================================+================================================================================================================+ - | security_group_rule | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 4 `. | - +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0005__table488727239520: - - .. 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_group_rule": { - "direction": "ingress", - "ethertype": "IPv4", - "id": "2bc0accf-312e-429a-956e-e4407625eb62", - "description": "", - "port_range_max": 80, - "port_range_min": 80, - "protocol": "tcp", - "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 - } - } + { + "security_group_rule": { + "direction": "ingress", + "ethertype": "IPv4", + "id": "2bc0accf-312e-429a-956e-e4407625eb62", + "description": "", + "port_range_max": 80, + "port_range_min": 80, + "protocol": "tcp", + "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 + } + } Status Code ----------- diff --git a/api-ref/source/apis/security_group/deleting_a_security_group.rst b/api-ref/source/apis/security_group/deleting_a_security_group.rst index e1be1fc..b0709b8 100644 --- a/api-ref/source/apis/security_group/deleting_a_security_group.rst +++ b/api-ref/source/apis/security_group/deleting_a_security_group.rst @@ -29,29 +29,27 @@ DELETE /v1/{project_id}/security-groups/{security_group_id} | project_id | No | Specifies the project ID. | +-------------------+-----------+--------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/security-groups/0c4a2336-b036-4fa2-bc3c-1a291ed4c431 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/security-groups/0c4a2336-b036-4fa2-bc3c-1a291ed4c431 - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/security_group/deleting_a_security_group_rule.rst b/api-ref/source/apis/security_group/deleting_a_security_group_rule.rst index 6db5701..c57ad5f 100644 --- a/api-ref/source/apis/security_group/deleting_a_security_group_rule.rst +++ b/api-ref/source/apis/security_group/deleting_a_security_group_rule.rst @@ -29,29 +29,27 @@ DELETE /v1/{project_id}/security-group-rules/{security_group_rule_id} | project_id | Yes | Specifies the project ID. | +------------------------+-----------+------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- 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 d12c813..fb4630c 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 @@ -29,142 +29,140 @@ GET /v1/{project_id}/security-groups/{security_group_id} | security_group_id | Yes | Specifies the security group ID, which uniquely identifies the security group. | +-------------------+-----------+--------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/security-groups/16b6e77a-08fa-42c7-aa8b-106c048884e6 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/security-groups/16b6e77a-08fa-42c7-aa8b-106c048884e6 + +----------------+-----------------------------------------------------------------+--------------------------------------+ + | Name | Type | Description | + +================+=================================================================+======================================+ + | security_group | :ref:`security_group ` object | Specifies the security group object. | + +----------------+-----------------------------------------------------------------+--------------------------------------+ -Response Message +.. _vpc_sg01_0002__table333218689520: + +.. table:: **Table 3** Description of **security_group** fields + + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+================================================================================+===================================================================================================================================================================+ + | name | String | Specifies the security group name. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the security group ID, which uniquely identifies the security group. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter has been discarded. Do not use it. | + | | | | + | | | Currently, this parameter is used only as a prompt. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | + | | | - 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. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0002__table488727239520: + +.. 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. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +----------------+-----------------------------------------------------------------+--------------------------------------+ - | Name | Type | Description | - +================+=================================================================+======================================+ - | security_group | :ref:`security_group ` object | Specifies the security group object. | - +----------------+-----------------------------------------------------------------+--------------------------------------+ - - .. _vpc_sg01_0002__table333218689520: - - .. table:: **Table 3** Description of **security_group** fields - - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+================================================================================+===================================================================================================================================================================+ - | name | String | Specifies the security group name. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group ID, which uniquely identifies the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter has been discarded. Do not use it. | - | | | | - | | | Currently, this parameter is used only as a prompt. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | - | | | - 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. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0002__table488727239520: - - .. 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_group": { - "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "name": "qq", - "description": "qq", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "369e6499-b2cb-4126-972a-97e589692c62", - "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "remote_address_group_id": null - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", - "description": "", - "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" - } - ] - } - } + { + "security_group": { + "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "name": "qq", + "description": "qq", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", + "security_group_rules": [ + { + "direction": "egress", + "ethertype": "IPv4", + "id": "369e6499-b2cb-4126-972a-97e589692c62", + "description": "", + "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "remote_address_group_id": null + }, + { + "direction": "ingress", + "ethertype": "IPv4", + "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", + "description": "", + "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" + } + ] + } + } Status Code ----------- 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 209bbf5..91da481 100644 --- a/api-ref/source/apis/security_group/querying_security_group_rule_details.rst +++ b/api-ref/source/apis/security_group/querying_security_group_rule_details.rst @@ -29,100 +29,98 @@ GET /v1/{project_id}/security-group-rules/{security_group_rule_id} | security_group_rule_id | Yes | Specifies the security group rule ID, which uniquely identifies the security group rule. | +------------------------+-----------+------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 + +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=====================+======================================================================+================================================================================================================+ + | security_group_rule | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 3 `. | + +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_sg01_0006__table488727239520: + +.. 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. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=====================+======================================================================+================================================================================================================+ - | security_group_rule | :ref:`security_group_rule ` object | Specifies the security group rule objects. For details, see :ref:`Table 3 `. | - +---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0006__table488727239520: - - .. 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_group_rule": { - "direction": "ingress", - "ethertype": "IPv4", - "id": "2bc0accf-312e-429a-956e-e4407625eb62", - "description":"", - "port_range_max": 80, - "port_range_min": 80, - "protocol": "tcp", - "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 - } - } + { + "security_group_rule": { + "direction": "ingress", + "ethertype": "IPv4", + "id": "2bc0accf-312e-429a-956e-e4407625eb62", + "description":"", + "port_range_max": 80, + "port_range_min": 80, + "protocol": "tcp", + "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 + } + } Status Code ----------- 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 aae1fc9..b370154 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 @@ -48,142 +48,140 @@ Example: | security_group_id | No | String | Specifies the security group ID. | +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/security-group-rules -- Example request +Response Parameters +------------------- - .. code-block:: text ++----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +| Name | Type | Description | ++======================+================================================================================+================================================================================================================+ +| security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the security group rule objects. For details, see :ref:`Table 2 `. | ++----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - GET https://{Endpoint}/v1/{project_id}/security-group-rules +.. _vpc_sg01_0007__table488727239520: -Response Message +.. 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. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - +----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +======================+================================================================================+================================================================================================================+ - | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the security group rule objects. For details, see :ref:`Table 2 `. | - +----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0007__table488727239520: - - .. 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv6", - "id": "3c0e45ff-adaf-4124-b083-bf390e5482ff", - "description": "", - "port_range_max": null, - "port_range_min": null, - "protocol": null, - "remote_group_id": null, - "remote_ip_prefix": null, - "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null - }, - { - "direction": "egress", - "ethertype": "IPv4", - "id": "93aa42e5-80db-4581-9391-3a608bd0e448", - "description": "", - "port_range_max": null, - "port_range_min": null, - "protocol": null, - "remote_group_id": null, - "remote_ip_prefix": null, - "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", - "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", - "remote_address_group_id": null - }, - { - "direction": "ingress", - "ethertype": "IPv6", - "id": "c0b09f00-1d49-4e64-a0a7-8a186d928138", - "description": "", - "port_range_max": null, - "port_range_min": null, - "protocol": null, - "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 - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "f7d45c89-008e-4bab-88ad-d6811724c51c", - "description": "", - "port_range_max": null, - "port_range_min": null, - "protocol": null, - "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 - } - ] - } + { + "security_group_rules": [ + { + "direction": "egress", + "ethertype": "IPv6", + "id": "3c0e45ff-adaf-4124-b083-bf390e5482ff", + "description": "", + "port_range_max": null, + "port_range_min": null, + "protocol": null, + "remote_group_id": null, + "remote_ip_prefix": null, + "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null + }, + { + "direction": "egress", + "ethertype": "IPv4", + "id": "93aa42e5-80db-4581-9391-3a608bd0e448", + "description": "", + "port_range_max": null, + "port_range_min": null, + "protocol": null, + "remote_group_id": null, + "remote_ip_prefix": null, + "security_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", + "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550", + "remote_address_group_id": null + }, + { + "direction": "ingress", + "ethertype": "IPv6", + "id": "c0b09f00-1d49-4e64-a0a7-8a186d928138", + "description": "", + "port_range_max": null, + "port_range_min": null, + "protocol": null, + "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 + }, + { + "direction": "ingress", + "ethertype": "IPv4", + "id": "f7d45c89-008e-4bab-88ad-d6811724c51c", + "description": "", + "port_range_max": null, + "port_range_min": null, + "protocol": null, + "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 + } + ] + } Status Code ----------- 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 8afff24..1240a3f 100644 --- a/api-ref/source/apis/security_group/querying_security_groups.rst +++ b/api-ref/source/apis/security_group/querying_security_groups.rst @@ -58,168 +58,166 @@ Example: | | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/security-groups -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/security-groups + +-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=================+===========================================================================+===========================================================================================================+ + | security_groups | Array of :ref:`security_group ` objects | Specifies the security group objects. For details, see :ref:`Table 3 `. | + +-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_sg01_0003__table333218689520: + +.. table:: **Table 3** Description of **security_group** fields + + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+================================================================================+===================================================================================================================================================================+ + | name | String | Specifies the security group name. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the security group. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | id | String | Specifies the security group ID, which uniquely identifies the security group. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter has been discarded. Do not use it. | + | | | | + | | | Currently, this parameter is used only as a prompt. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | + | | | - 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. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_sg01_0003__table488727239520: + +.. 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. | + +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=================+===========================================================================+===========================================================================================================+ - | security_groups | Array of :ref:`security_group ` objects | Specifies the security group objects. For details, see :ref:`Table 3 `. | - +-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0003__table333218689520: - - .. table:: **Table 3** Description of **security_group** fields - - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+================================================================================+===================================================================================================================================================================+ - | name | String | Specifies the security group name. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group ID, which uniquely identifies the security group. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the resource ID of the VPC to which the security group belongs. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter has been discarded. Do not use it. | - | | | | - | | | Currently, this parameter is used only as a prompt. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_rules | Array of :ref:`security_group_rule ` objects | Specifies the default security group rules, which ensure that resources in the security group can communicate with one another. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group. | - | | | - 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. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_sg01_0003__table488727239520: - - .. 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. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "security_groups": [ - { - "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "name": "qq", - "description": "qq", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "369e6499-b2cb-4126-972a-97e589692c62", - "description": "", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "remote_address_group_id": null - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", - "description": "", - "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", - "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" - } - ] - }, - { - "id": "9c0f56be-a9ac-438c-8c57-fce62de19419", - "name": "default", - "description": "qq", - "vpc_id": "13551d6b-755d-4757-b956-536f674975c0", - "enterprise_project_id": "0", - "security_group_rules": [ - { - "direction": "egress", - "ethertype": "IPv4", - "id": "95479e0a-e312-4844-b53d-a5e4541b783f", - "description": "", - "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419" - }, - { - "direction": "ingress", - "ethertype": "IPv4", - "id": "0c4a2336-b036-4fa2-bc3c-1a291ed4c431", - "description": "", - "remote_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419", - "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419" - } - ] - } - ] - } + { + "security_groups": [ + { + "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "name": "qq", + "description": "qq", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", + "security_group_rules": [ + { + "direction": "egress", + "ethertype": "IPv4", + "id": "369e6499-b2cb-4126-972a-97e589692c62", + "description": "", + "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "remote_address_group_id": null + }, + { + "direction": "ingress", + "ethertype": "IPv4", + "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", + "description": "", + "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", + "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6" + } + ] + }, + { + "id": "9c0f56be-a9ac-438c-8c57-fce62de19419", + "name": "default", + "description": "qq", + "vpc_id": "13551d6b-755d-4757-b956-536f674975c0", + "enterprise_project_id": "0", + "security_group_rules": [ + { + "direction": "egress", + "ethertype": "IPv4", + "id": "95479e0a-e312-4844-b53d-a5e4541b783f", + "description": "", + "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419" + }, + { + "direction": "ingress", + "ethertype": "IPv4", + "id": "0c4a2336-b036-4fa2-bc3c-1a291ed4c431", + "description": "", + "remote_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419", + "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419" + } + ] + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/subnet/creating_a_subnet.rst b/api-ref/source/apis/subnet/creating_a_subnet.rst index 0ab5fe0..d13ba38 100644 --- a/api-ref/source/apis/subnet/creating_a_subnet.rst +++ b/api-ref/source/apis/subnet/creating_a_subnet.rst @@ -27,86 +27,87 @@ POST /v1/{project_id}/subnets project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +========+===========+=========================================================+=========================================================================+ + | subnet | Yes | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | + +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ + +.. _vpc_subnet01_0001__table45596481: + +.. table:: **Table 3** **subnet** objects + + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +===================+=================+================================================================================+=====================================================================================================================================================================================================================================+ + | name | Yes | String | - Specifies the subnet name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the subnet. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | Yes | String | - Specifies the subnet CIDR block. | + | | | | - The value must be within the VPC CIDR block. | + | | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | Yes | String | - Specifies the gateway of the subnet. | + | | | | - The value must be an IP address in the subnet. | + | | | | - The value must be a valid IP address. | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + | | | | - If this parameter is left blank, the value is set to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | + | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | + | | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank. | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone | No | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | + | | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | Yes | String | Specifies the ID of the VPC to which the subnet belongs. | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | + +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0001__table1805181451016: + +.. table:: **Table 4** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + | | | | | + | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +========+===========+=========================================================+=========================================================================+ - | subnet | Yes | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | - +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ - - .. _vpc_subnet01_0001__table45596481: - - .. table:: **Table 3** **subnet** objects - - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +===================+=================+================================================================================+=====================================================================================================================================================================================================================================+ - | name | Yes | String | - Specifies the subnet name. | - | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the subnet. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | Yes | String | - Specifies the subnet CIDR block. | - | | | | - The value must be within the VPC CIDR block. | - | | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | Yes | String | - Specifies the gateway of the subnet. | - | | | | - The value must be an IP address in the subnet. | - | | | | - The value must be a valid IP address. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | - | | | | - The value can be **true** (enabled) or **false** (disabled). | - | | | | - If this parameter is left blank, the value is set to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | - | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | - | | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | - | | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | No | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | - | | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | Yes | String | Specifies the ID of the VPC to which the subnet belongs. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | - +-------------------+-----------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0001__table1805181451016: - - .. table:: **Table 4** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a subnet with name set to **subnet**, CIDR block set to 192.168.20.0/24, and gateway IP address set to 192.168.20.1 in the VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85. .. code-block:: text POST https://{Endpoint}/v1/{project_id}/subnets - Create a subnet with name set to subnet, CIDR block set to 192.168.20.0/24, and gateway IP address set to 192.168.20.1 in the VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85. + { "subnet": { "name": "subnet", @@ -135,133 +136,132 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +--------+---------------------------------------------------------+-------------------------------------------------------------------------+ + | Name | Type | Description | + +========+=========================================================+=========================================================================+ + | subnet | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | + +--------+---------------------------------------------------------+-------------------------------------------------------------------------+ + +.. _vpc_subnet01_0001__table54041329: + +.. table:: **Table 6** **subnet** objects + + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===============================================================================+==================================================================================================================================================================================================================================================+ + | id | String | Specifies the resource identifier in the form of UUID. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the subnet name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the subnet. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the subnet CIDR block. | + | | | - The value must be within the VPC CIDR block. | + | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | - Specifies the gateway of the subnet. | + | | | - The value must be an IP address in the subnet. | + | | | - The value must be a valid IP address. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | String | - Specifies the IP address of DNS server 1 on the subnet. | + | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | + | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | + | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + | | | | + | | | - The system creates a subnet and then associates the subnet with a VPC in the threads. | + | | | | + | | | In the concurrent scenario, if the CIDR block of the created subnet is the same as that of an existing subnet, the created subnet fails to associate with a VPC after underlying system verification. As a result, the subnet creation fails. | + | | | | + | | | In this scenario, the returned value of **status** is **UNKNOWN**. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 7 `. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0001__table019517383270: + +.. table:: **Table 7** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + | | | | | + | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 5** Response parameter - - +--------+---------------------------------------------------------+-------------------------------------------------------------------------+ - | Name | Type | Description | - +========+=========================================================+=========================================================================+ - | subnet | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | - +--------+---------------------------------------------------------+-------------------------------------------------------------------------+ - - .. _vpc_subnet01_0001__table54041329: - - .. table:: **Table 6** **subnet** objects - - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+===============================================================================+==================================================================================================================================================================================================================================================+ - | id | String | Specifies the resource identifier in the form of UUID. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the subnet name. | - | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the subnet. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the subnet CIDR block. | - | | | - The value must be within the VPC CIDR block. | - | | | - The value must be in CIDR format. The subnet mask cannot be greater than 28. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | - Specifies the gateway of the subnet. | - | | | - The value must be an IP address in the subnet. | - | | | - The value must be a valid IP address. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | - Specifies the IP address of DNS server 1 on the subnet. | - | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | - Specifies the IP address of DNS server 2 on the subnet. | - | | | - The value must be an IP address. If the value is not specified, the default value will be left blank. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | - | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | String | - Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. | - | | | - The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - | | | | - | | | - The system creates a subnet and then associates the subnet with a VPC in the threads. | - | | | | - | | | In the concurrent scenario, if the CIDR block of the created subnet is the same as that of an existing subnet, the created subnet fails to associate with a VPC after underlying system verification. As a result, the subnet creation fails. | - | | | | - | | | In this scenario, the returned value of **status** is **UNKNOWN**. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 7 `. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0001__table019517383270: - - .. table:: **Table 7** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "subnet": { - "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "name": "subnet", - "description": "", - "cidr": "192.168.20.0/24", - "dnsList": [ - "114.xx.xx.114", - "114.xx.xx.115" - ], - "status": "UNKNOWN", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "gateway_ip": "192.168.20.1", - "dhcp_enable": true, - "primary_dns": "114.xx.xx.114", - "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc", - "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12" - "extra_dhcp_opts": [ - { - "opt_value": "10.100.0.33,10.100.0.34", - "opt_name": "ntp" - }, - { - "opt_value": "24h", - "opt_name": "addresstime" - } - ] - } - } + { + "subnet": { + "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "name": "subnet", + "description": "", + "cidr": "192.168.20.0/24", + "dnsList": [ + "114.xx.xx.114", + "114.xx.xx.115" + ], + "status": "UNKNOWN", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "gateway_ip": "192.168.20.1", + "dhcp_enable": true, + "primary_dns": "114.xx.xx.114", + "secondary_dns": "114.xx.xx.115", + "availability_zone": "aa-bb-cc", + "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12" + "extra_dhcp_opts": [ + { + "opt_value": "10.100.0.33,10.100.0.34", + "opt_name": "ntp" + }, + { + "opt_value": "24h", + "opt_name": "addresstime" + } + ] + } + } Status Code ----------- diff --git a/api-ref/source/apis/subnet/deleting_a_subnet.rst b/api-ref/source/apis/subnet/deleting_a_subnet.rst index e39ea29..9ad611b 100644 --- a/api-ref/source/apis/subnet/deleting_a_subnet.rst +++ b/api-ref/source/apis/subnet/deleting_a_subnet.rst @@ -33,29 +33,27 @@ DELETE /v1/{project_id}/vpcs/{vpc_id}/subnets/{subnet_id} | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/subnet/querying_subnet_details.rst b/api-ref/source/apis/subnet/querying_subnet_details.rst index f7b7e9a..9c9be97 100644 --- a/api-ref/source/apis/subnet/querying_subnet_details.rst +++ b/api-ref/source/apis/subnet/querying_subnet_details.rst @@ -31,131 +31,129 @@ GET /v1/{project_id}/subnets/{subnet_id} | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d + +--------+--------------------------------------------------------------+------------------------------------------------------------------------------+ + | Name | Type | Description | + +========+==============================================================+==============================================================================+ + | subnet | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | + +--------+--------------------------------------------------------------+------------------------------------------------------------------------------+ -Response Message +.. _vpc_subnet01_0002__table6614597017585: + +.. table:: **Table 3** **subnet** objects + + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===============================================================================+========================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the subnet name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the subnet. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the subnet CIDR block. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | Specifies the subnet gateway address. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone | String | Identifies the AZ to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0002__table019517383270: + +.. table:: **Table 4** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + | | | | | + | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +--------+--------------------------------------------------------------+------------------------------------------------------------------------------+ - | Name | Type | Description | - +========+==============================================================+==============================================================================+ - | subnet | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | - +--------+--------------------------------------------------------------+------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0002__table6614597017585: - - .. table:: **Table 3** **subnet** objects - - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+===============================================================================+========================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the subnet name. | - | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the subnet. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the subnet CIDR block. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | Specifies the subnet gateway address. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | String | Identifies the AZ to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0002__table019517383270: - - .. table:: **Table 4** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "subnet": { - "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "name": "subnet", - "description": "", - "cidr": "192.168.20.0/24", - "dnsList": [ - "114.xx.xx.114", - "114.xx.xx.115" - ], - "status": "ACTIVE", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "gateway_ip": "192.168.20.1", - "dhcp_enable": true, - "primary_dns": "114.xx.xx.114", - "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc", - "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", - "extra_dhcp_opts": [ - { - "opt_value": "10.100.0.33,10.100.0.34", - "opt_name": "ntp" - }, - { - "opt_value": "24h", - "opt_name": "addresstime" - } - ] - } - } + { + "subnet": { + "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "name": "subnet", + "description": "", + "cidr": "192.168.20.0/24", + "dnsList": [ + "114.xx.xx.114", + "114.xx.xx.115" + ], + "status": "ACTIVE", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "gateway_ip": "192.168.20.1", + "dhcp_enable": true, + "primary_dns": "114.xx.xx.114", + "secondary_dns": "114.xx.xx.115", + "availability_zone": "aa-bb-cc", + "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", + "extra_dhcp_opts": [ + { + "opt_value": "10.100.0.33,10.100.0.34", + "opt_name": "ntp" + }, + { + "opt_value": "24h", + "opt_name": "addresstime" + } + ] + } + } Status Code ----------- diff --git a/api-ref/source/apis/subnet/querying_subnets.rst b/api-ref/source/apis/subnet/querying_subnets.rst index 7d5e970..df8505f 100644 --- a/api-ref/source/apis/subnet/querying_subnets.rst +++ b/api-ref/source/apis/subnet/querying_subnets.rst @@ -46,162 +46,160 @@ Example: | | | | This field is mandatory in the fine-grained authorization scenario based on enterprise projects. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/subnets -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/subnets + +---------+-----------------------------------------------------------------------+------------------------+ + | Name | Type | Description | + +=========+=======================================================================+========================+ + | subnets | Array of :ref:`subnet ` objects | Specifies the subnets. | + +---------+-----------------------------------------------------------------------+------------------------+ -Response Message +.. _vpc_subnet01_0003__table946390317596: + +.. table:: **Table 3** **subnet** objects + + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+===============================================================================+========================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the subnet name. | + | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the subnet. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | Specifies the subnet CIDR block. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | gateway_ip | String | Specifies the subnet gateway address. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | availability_zone | String | Identifies the AZ to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0003__table019517383270: + +.. table:: **Table 4** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + | | | | | + | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +---------+-----------------------------------------------------------------------+------------------------+ - | Name | Type | Description | - +=========+=======================================================================+========================+ - | subnets | Array of :ref:`subnet ` objects | Specifies the subnets. | - +---------+-----------------------------------------------------------------------+------------------------+ - - .. _vpc_subnet01_0003__table946390317596: - - .. table:: **Table 3** **subnet** objects - - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+===============================================================================+========================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the subnet name. | - | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the subnet. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | Specifies the subnet CIDR block. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gateway_ip | String | Specifies the subnet gateway address. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | String | Specifies the IP address of DNS server 2 on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | String | Identifies the AZ to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_network_id | String | Specifies the ID of the corresponding network (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0003__table019517383270: - - .. table:: **Table 4** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "subnets": [ - { - "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "name": "subnet", - "description": "", - "cidr": "192.168.20.0/24", - "dnsList": [ - "114.xx.xx.114", - "114.xx.xx.115" - ], - "status": "ACTIVE", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "gateway_ip": "192.168.20.1", - "dhcp_enable": true, - "primary_dns": "114.xx.xx.114", - "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc", - "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", - "extra_dhcp_opts": [ - { - "opt_value": "10.100.0.33,10.100.0.34", - "opt_name": "ntp" - }, - { - "opt_value": "24h", - "opt_name": "addresstime" - } - ] - }, - { - "id": "531dec0f-3116-411b-a21b-e612e42349fd", - "name": "Subnet1", - "description": "", - "cidr": "192.168.1.0/24", - "dnsList": [ - "114.xx.xx.114", - "114.xx.xx.115" - ], - "status": "ACTIVE", - "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "gateway_ip": "192.168.1.1", - "dhcp_enable": true, - "primary_dns": "114.xx.xx.114", - "secondary_dns": "114.xx.xx.115", - "availability_zone": "aa-bb-cc", - "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd", - "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", - "extra_dhcp_opts": [ - { - "opt_value": "10.100.0.33,10.100.0.34", - "opt_name": "ntp" - }, - { - "opt_value": "24h", - "opt_name": "addresstime" - } - ], - } - ] - } + { + "subnets": [ + { + "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "name": "subnet", + "description": "", + "cidr": "192.168.20.0/24", + "dnsList": [ + "114.xx.xx.114", + "114.xx.xx.115" + ], + "status": "ACTIVE", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "gateway_ip": "192.168.20.1", + "dhcp_enable": true, + "primary_dns": "114.xx.xx.114", + "secondary_dns": "114.xx.xx.115", + "availability_zone": "aa-bb-cc", + "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", + "extra_dhcp_opts": [ + { + "opt_value": "10.100.0.33,10.100.0.34", + "opt_name": "ntp" + }, + { + "opt_value": "24h", + "opt_name": "addresstime" + } + ] + }, + { + "id": "531dec0f-3116-411b-a21b-e612e42349fd", + "name": "Subnet1", + "description": "", + "cidr": "192.168.1.0/24", + "dnsList": [ + "114.xx.xx.114", + "114.xx.xx.115" + ], + "status": "ACTIVE", + "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "gateway_ip": "192.168.1.1", + "dhcp_enable": true, + "primary_dns": "114.xx.xx.114", + "secondary_dns": "114.xx.xx.115", + "availability_zone": "aa-bb-cc", + "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd", + "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", + "extra_dhcp_opts": [ + { + "opt_value": "10.100.0.33,10.100.0.34", + "opt_name": "ntp" + }, + { + "opt_value": "24h", + "opt_name": "addresstime" + } + ], + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/subnet/updating_subnet_information.rst b/api-ref/source/apis/subnet/updating_subnet_information.rst index 31dcf91..e573af9 100644 --- a/api-ref/source/apis/subnet/updating_subnet_information.rst +++ b/api-ref/source/apis/subnet/updating_subnet_information.rst @@ -33,73 +33,74 @@ PUT /v1/{project_id}/vpcs/{vpc_id}/subnets/{subnet_id} | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +========+===========+=========================================================+=========================================================================+ + | subnet | Yes | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | + +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ + +.. _vpc_subnet01_0004__table45027976: + +.. table:: **Table 3** **subnet** objects + + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+===============================================================================+======================================================================================================================================================================================================================================================================================================+ + | name | Yes | String | - Specifies the subnet name. | + | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the subnet. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | + | | | | - The value can be **true** (enabled) or **false** (disabled). | + | | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | + | | | | - The value must be a valid IP address. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | + | | | | - The value must be a valid IP address. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | + | | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | + +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_subnet01_0004__table019517383270: + +.. table:: **Table 4** **extra_dhcp_opt** object + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ + | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | + | | | | | + | | | | - Constraints: | + | | | | | + | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | + | | | | | + | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | + | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +========+===========+=========================================================+=========================================================================+ - | subnet | Yes | :ref:`subnet ` object | Specifies the :ref:`subnet objects `. | - +--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+ - - .. _vpc_subnet01_0004__table45027976: - - .. table:: **Table 3** **subnet** objects - - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+===============================================================================+======================================================================================================================================================================================================================================================================================================+ - | name | Yes | String | - Specifies the subnet name. | - | | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the subnet. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. | - | | | | - The value can be **true** (enabled) or **false** (disabled). | - | | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | primary_dns | No | String | - Specifies the IP address of DNS server 1 on the subnet. | - | | | | - The value must be a valid IP address. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. | - | | | | - The value must be a valid IP address. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. | - | | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt ` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 `. | - +-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_subnet01_0004__table019517383270: - - .. table:: **Table 4** **extra_dhcp_opt** object - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | opt_value | No | String | - Specifies the NTP server address or DHCP lease expiration time configured for the subnet. | - | | | | | - | | | | - Constraints: | - | | | | | - | | | | The option **ntp** for **opt_name** indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option **null** for **opt_name** indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string. | - | | | | | - | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. | - | | | | - Currently, the value can only be set to **ntp** or **addresstime**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Change the name of the subnet whose ID is 4779ab1c-7c1a-44b1-a02e-93dfc361b32d to **subnet02**, and also change its DNS and DHCP configurations. .. code-block:: text PUT https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d - Change the name of the subnet whose ID is 4779ab1c-7c1a-44b1-a02e-93dfc361b32d to subnet02, and also change its DNS and DHCP configurations. + { "subnet": { "name": "subnet02", @@ -120,46 +121,45 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +--------+--------------------------------------------------------+-----------------------------------+ + | Name | Type | Description | + +========+========================================================+===================================+ + | subnet | :ref:`subnet ` object | Specifies the **subnet** objects. | + +--------+--------------------------------------------------------+-----------------------------------+ + +.. _vpc_subnet01_0004__table1210700: + +.. table:: **Table 6** **subnet** objects + + +-----------------------+-----------------------+----------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------+ + | status | String | - Specifies the status of the subnet. | + | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | + | | | | + | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | + | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | + | | | - **ERROR**: indicates that the subnet is abnormal. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 5** Response parameter - - +--------+--------------------------------------------------------+-----------------------------------+ - | Name | Type | Description | - +========+========================================================+===================================+ - | subnet | :ref:`subnet ` object | Specifies the **subnet** objects. | - +--------+--------------------------------------------------------+-----------------------------------+ - - .. _vpc_subnet01_0004__table1210700: - - .. table:: **Table 6** **subnet** objects - - +-----------------------+-----------------------+----------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------+ - | status | String | - Specifies the status of the subnet. | - | | | - The value can be **ACTIVE**, **UNKNOWN**, or **ERROR**. | - | | | | - | | | - **ACTIVE**: indicates that the subnet has been associated with a VPC. | - | | | - **UNKNOWN**: indicates that the subnet has not been associated with a VPC. | - | | | - **ERROR**: indicates that the subnet is abnormal. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "subnet": { - "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", - "status": "ACTIVE" - } - } + { + "subnet": { + "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst b/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst index debbeee..d435d42 100644 --- a/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst +++ b/api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst @@ -39,10 +39,8 @@ POST /v2.0/{project_id}/subnets/{subnet_id}/tags/action | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -86,54 +84,56 @@ Request parameter | | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ -Request example 1: Creating tags in batches +Example Request +--------------- -.. code-block:: text +- Batch create two tags for a subnet. - POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action - Create two tags for a subnet. - { - "action": "create", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } + .. code-block:: text -Request example 2: Deleting tags in batches + POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action -.. code-block:: text + { + "action": "create", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } - POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action - Delete two tags for a subnet. - { - "action": "delete", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } +- Batch delete two tags for a subnet. -Response Message ----------------- + .. code-block:: text -Response parameter + POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action + + { + "action": "delete", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } + +Response Parameters +------------------- None -Example response +Example Response +---------------- None diff --git a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst b/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst index a390467..f6e622b 100644 --- a/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst +++ b/api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst @@ -31,10 +31,8 @@ POST /v2.0/{project_id}/subnets/{subnet_id}/tags | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message ---------------- - -- Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -73,12 +71,15 @@ Request Message | | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ -- Example request +Example Request +--------------- + +- Create a tag for a subnet. The key is **key1**, and the value is **value1**. .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags - Create a tag for a subnet. The key is key1, and the value is value1. + { "tag": { "key": "key1", @@ -86,16 +87,15 @@ Request Message } } -Response Message +Response Parameters +------------------- + +None + +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst b/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst index 025b98b..9002e41 100644 --- a/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst +++ b/api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst @@ -33,27 +33,25 @@ DELETE /v2.0/{project_id}/subnets/{subnet_id}/tags/{key} | key | Yes | Specifies the tag key. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text DELETE https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/{key} -Response Message ----------------- - -Response parameter +Response Parameters +------------------- None -Example response +Example Response +---------------- None diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst index d443d25..f67640c 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst @@ -31,23 +31,20 @@ GET /v2.0/{project_id}/subnets/{subnet_id}/tags | | | If you use the management console, the value of this parameter is the **Network ID** value. | +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags -Response Message ----------------- - -Response parameter +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -86,7 +83,8 @@ Response parameter | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------------+-----------------------+---------------------------------------------------------------------+ -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst index 5e18e72..20ed72e 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst @@ -27,23 +27,20 @@ GET /v2.0/{project_id}/subnets/tags project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/{project_id}/subnets/tags -Response Message ----------------- - -Response parameter +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -82,7 +79,8 @@ Response parameter | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------------+-----------------------+---------------------------------------------------------------------+ -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst index 0531862..0feee9c 100644 --- a/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst +++ b/api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst @@ -27,10 +27,8 @@ POST /v2.0/{project_id}/subnets/resource_instances/action project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -74,69 +72,70 @@ Request parameter | value | Yes | String | Specifies the tag value. Each value can contain a maximum of 255 Unicode characters. | +-------+-----------+--------+--------------------------------------------------------------------------------------+ -Example request 1: Setting **action** to **filter** +Example Request +--------------- -.. code-block:: text +- Filter subnets by setting **action** to **filter**. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use **matches** and **tags** to filter subnets. - POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action - Filter subnets by setting action to filter. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use matches and tags to filter subnets. - { - "offset": "0", - "limit": "100", - "action": "filter", - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ], - "tags": [ - { - "key": "key1", - "values": [ - "*value1", - "value2" - ] - } - ] - } + .. code-block:: text -Example request 2: Setting **action** to **count** + POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action -.. code-block:: text + { + "offset": "0", + "limit": "100", + "action": "filter", + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ], + "tags": [ + { + "key": "key1", + "values": [ + "*value1", + "value2" + ] + } + ] + } - POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action - Count subnets by setting action to count. Use matches and tags to filter and count VPCs. - { - "action": "count", - "tags": [ - { - "key": "key1", - "values": [ - "value1", - "value2" - ] - }, - { - "key": "key2", - "values": [ - "value1", - "value2" - ] - } - ], - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ] - } +- Count subnets by setting **action** to **count**. Use **matches** and **tags** to filter and count VPCs. -Response Message ----------------- + .. code-block:: text -Response parameter + POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action + + { + "action": "count", + "tags": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ], + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ] + } + +Response Parameters +------------------- .. table:: **Table 5** Response parameter @@ -176,39 +175,42 @@ Response parameter | value | Yes | String | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. The values are in the OR relationship. | +-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example response 1: Setting **action** to **filter** +Example Response +---------------- -.. code-block:: +- When **action** is set to **filter**: - { - "resources": [ - { - "resource_detail": null, - "resource_id": "cdfs_cefs_wesas_12_dsad", - "resource_name": "resouece1", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value1" - } - ] - } - ], - "total_count": 1000 - } + .. code-block:: + + { + "resources": [ + { + "resource_detail": null, + "resource_id": "cdfs_cefs_wesas_12_dsad", + "resource_name": "resouece1", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value1" + } + ] + } + ], + "total_count": 1000 + } -Example response 2: Setting **action** to **count** +- When **action** is set to **count**: -.. code-block:: + .. code-block:: - { - "total_count": 1000 - } + { + "total_count": 1000 + } Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst index 1d9799a..78b9791 100644 --- a/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst @@ -27,57 +27,58 @@ POST /v1/{project_id}/vpcs project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +======+===========+===================================================+===================================================================+ + | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ + +.. _vpc_api01_0001__table33750194: + +.. table:: **Table 3** VPC objects + + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=======================+=================+=================+===================================================================================================================================================================+ + | name | No | String | - Specifies the VPC name. | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the VPC. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | | - Possible values are as follows: | + | | | | | + | | | | - 10.0.0.0/8-24 | + | | | | - 172.16.0.0/12-24 | + | | | | - 192.168.0.0/16-24 | + | | | | | + | | | | - If **cidr** is not specified, the default value is left blank. | + | | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a VPC, you can associate an enterprise project ID with the VPC. | + | | | | - 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. | + | | | | | + | | | | .. note:: | + | | | | | + | | | | This parameter is unsupported. Do not use it. | + +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +======+===========+===================================================+===================================================================+ - | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ - - .. _vpc_api01_0001__table33750194: - - .. table:: **Table 3** VPC objects - - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=======================+=================+=================+===================================================================================================================================================================+ - | name | No | String | - Specifies the VPC name. | - | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the VPC. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | | - Possible values are as follows: | - | | | | | - | | | | - 10.0.0.0/8-24 | - | | | | - 172.16.0.0/12-24 | - | | | | - 192.168.0.0/16-24 | - | | | | | - | | | | - If **cidr** is not specified, the default value is left blank. | - | | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | - Specifies the enterprise project ID. When creating a VPC, you can associate an enterprise project ID with the VPC. | - | | | | - 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. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is unsupported. Do not use it. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a VPC named **vpc** and set its CIDR block to 192.168.0.0/16. .. code-block:: text POST https://{Endpoint}/v1/{project_id}/vpcs - Create a VPC named vpc and set its CIDR block to 192.168.0.0/16. + { "vpc": { "name": "vpc", @@ -87,94 +88,93 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +======+===================================================+===================================================================+ + | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+---------------------------------------------------+-------------------------------------------------------------------+ + +.. _vpc_api01_0001__table39714111: + +.. table:: **Table 5** VPC objects + + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+=======================================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the VPC name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 192.168.0.0/16-24 | + | | | | + | | | - If **cidr** is not specified, the default value is left blank. | + | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created successfully. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see the description of the :ref:`route objects `. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0001__table3576833291556: + +.. table:: **Table 6** **route** objects + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==========================================================================================================================+ + | destination | String | - Specifies the destination network segment of a route. | + | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +------+---------------------------------------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +======+===================================================+===================================================================+ - | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+---------------------------------------------------+-------------------------------------------------------------------+ - - .. _vpc_api01_0001__table39714111: - - .. table:: **Table 5** VPC objects - - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the VPC name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 192.168.0.0/16-24 | - | | | | - | | | - If **cidr** is not specified, the default value is left blank. | - | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see the description of the :ref:`route objects `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0001__table3576833291556: - - .. table:: **Table 6** **route** objects - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "vpc": - { - "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", - "name": "vpc", - "description": "test", - "cidr": "192.168.0.0/16", - "status": "CREATING", - "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", - "routes": [] - } - } + { + "vpc": + { + "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", + "name": "vpc", + "description": "test", + "cidr": "192.168.0.0/16", + "status": "CREATING", + "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", + "routes": [] + } + } Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst b/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst index 81f02d9..dc66cf3 100644 --- a/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst +++ b/api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst @@ -29,29 +29,27 @@ DELETE /v1/{project_id}/vpcs/{vpc_id} | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/{project_id}/vpcs/13551d6b-755d-4757-b956-536f674975c0 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/{project_id}/vpcs/13551d6b-755d-4757-b956-536f674975c0 - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst b/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst index ffb3c49..9aef1e8 100644 --- a/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst +++ b/api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst @@ -29,107 +29,105 @@ GET /v1/{project_id}/vpcs/{vpc_id} | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3 + +------+--------------------------------------------------------+------------------------------------------------------------------------+ + | Name | Type | Description | + +======+========================================================+========================================================================+ + | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+--------------------------------------------------------+------------------------------------------------------------------------+ -Response Message +.. _vpc_api01_0002__table1945411214515: + +.. table:: **Table 3** VPC objects + + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+=======================================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the VPC name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 192.168.0.0/16-24 | + | | | | + | | | - If **cidr** is not specified, the default value is left blank. | + | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created successfully. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see the description of the :ref:`route objects `. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Enterprise project ID | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0002__table3576833291556: + +.. table:: **Table 4** **route** objects + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==========================================================================================================================+ + | destination | String | - Specifies the destination network segment of a route. | + | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +------+--------------------------------------------------------+------------------------------------------------------------------------+ - | Name | Type | Description | - +======+========================================================+========================================================================+ - | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+--------------------------------------------------------+------------------------------------------------------------------------+ - - .. _vpc_api01_0002__table1945411214515: - - .. table:: **Table 3** VPC objects - - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the VPC name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 192.168.0.0/16-24 | - | | | | - | | | - If **cidr** is not specified, the default value is left blank. | - | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see the description of the :ref:`route objects `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Enterprise project ID | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0002__table3576833291556: - - .. table:: **Table 4** **route** objects - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "vpc": { - "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", - "name": "vpc", - "description": "test", - "cidr": "192.168.0.0/16", - "status": "OK", - "enterprise_project_id": "0" - "routes": [], - "enable_shared_snat": false - } - } + { + "vpc": { + "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", + "name": "vpc", + "description": "test", + "cidr": "192.168.0.0/16", + "status": "OK", + "enterprise_project_id": "0" + "routes": [], + "enable_shared_snat": false + } + } Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst index 6d72d9c..9075020 100644 --- a/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst +++ b/api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst @@ -53,129 +53,127 @@ Example: | | | | This parameter is unsupported. Do not use it. | +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/{project_id}/vpcs -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/{project_id}/vpcs + +------+--------------------------------------------------------------+---------------------+ + | Name | Type | Description | + +======+==============================================================+=====================+ + | vpcs | Array of :ref:`vpcs ` objects | Specifies the VPCs. | + +------+--------------------------------------------------------------+---------------------+ -Response Message +.. _vpc_api01_0003__table65129753: + +.. table:: **Table 3** Description of the **vpcs** field + + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+=======================================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Specifies the VPC name. | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 192.168.0.0/16-24 | + | | | | + | | | - If **cidr** is not specified, the default value is left blank. | + | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created successfully. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see :ref:`Table 4 `. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0003__table3576833291556: + +.. table:: **Table 4** **route** objects + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==========================================================================================================================+ + | destination | String | - Specifies the destination network segment of a route. | + | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +------+--------------------------------------------------------------+---------------------+ - | Name | Type | Description | - +======+==============================================================+=====================+ - | vpcs | Array of :ref:`vpcs ` objects | Specifies the VPCs. | - +------+--------------------------------------------------------------+---------------------+ - - .. _vpc_api01_0003__table65129753: - - .. table:: **Table 3** Description of the **vpcs** field - - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Specifies the VPC name. | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 192.168.0.0/16-24 | - | | | | - | | | - If **cidr** is not specified, the default value is left blank. | - | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see :ref:`Table 4 `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0003__table3576833291556: - - .. table:: **Table 4** **route** objects - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "vpcs": [ - { - "id": "13551d6b-755d-4757-b956-536f674975c0", - "name": "default", - "description": "test", - "cidr": "172.16.0.0/16", - "status": "OK", - "enterprise_project_id": "0", - "routes": [], - "enable_shared_snat": false - }, - { - "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", - "name": "222", - "description": "test", - "cidr": "192.168.0.0/16", - "status": "OK", - "enterprise_project_id": "0635d733-c12d-4308-ba5a-4dc27ec21038", - "routes": [], - "enable_shared_snat": false - }, - { - "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", - "name": "vpc", - "description": "test", - "cidr": "192.168.0.0/16", - "status": "OK", - "enterprise_project_id": "0", - "routes": [], - "enable_shared_snat": false - } - ] - } + { + "vpcs": [ + { + "id": "13551d6b-755d-4757-b956-536f674975c0", + "name": "default", + "description": "test", + "cidr": "172.16.0.0/16", + "status": "OK", + "enterprise_project_id": "0", + "routes": [], + "enable_shared_snat": false + }, + { + "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", + "name": "222", + "description": "test", + "cidr": "192.168.0.0/16", + "status": "OK", + "enterprise_project_id": "0635d733-c12d-4308-ba5a-4dc27ec21038", + "routes": [], + "enable_shared_snat": false + }, + { + "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", + "name": "vpc", + "description": "test", + "cidr": "192.168.0.0/16", + "status": "OK", + "enterprise_project_id": "0", + "routes": [], + "enable_shared_snat": false + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst b/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst index 8645799..346dccf 100644 --- a/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst +++ b/api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst @@ -29,68 +29,69 @@ PUT /v1/{project_id}/vpcs/{vpc_id} | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +======+===========+===================================================+===================================================================+ + | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ + +.. _vpc_api01_0004__table34290771: + +.. table:: **Table 3** VPC objects + + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +====================+=================+====================================================================+=======================================================================================================================================================================================+ + | name | No | String | - Specifies the VPC name. | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Provides supplementary information about the VPC. | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | | - Possible values are as follows: | + | | | | | + | | | | - 10.0.0.0/8-24 | + | | | | - 172.16.0.0/12-24 | + | | | | - 192.168.0.0/16-24 | + | | | | | + | | | | - If **cidr** is not specified, the default value is left blank. | + | | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | No | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | No | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0004__table1696324019336: + +.. table:: **Table 4** **route** objects + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================================+ + | destination | No | String | - Specifies the destination network segment of a route. | + | | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | No | String | - Specifies the next hop of a route. | + | | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +======+===========+===================================================+===================================================================+ - | vpc | Yes | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+-----------+---------------------------------------------------+-------------------------------------------------------------------+ - - .. _vpc_api01_0004__table34290771: - - .. table:: **Table 3** VPC objects - - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +====================+=================+====================================================================+=======================================================================================================================================================================================+ - | name | No | String | - Specifies the VPC name. | - | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - | | | | - Each VPC name of a tenant must be unique if the VPC name is not left blank. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Provides supplementary information about the VPC. | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | | - Possible values are as follows: | - | | | | | - | | | | - 10.0.0.0/8-24 | - | | | | - 172.16.0.0/12-24 | - | | | | - 192.168.0.0/16-24 | - | | | | | - | | | | - If **cidr** is not specified, the default value is left blank. | - | | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | No | Array of :ref:`route ` objects | - Specifies the route list. For details, see :ref:`Table 4 `. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | No | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0004__table1696324019336: - - .. table:: **Table 4** **route** objects - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================+ - | destination | No | String | - Specifies the destination network segment of a route. | - | | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | No | String | - Specifies the next hop of a route. | - | | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Change the name, description, and CIDR block of the VPC whose ID is 99d9d709-8478-4b46-9f3f-2206b1023fd3 to **vpc1**, **test1**, and **192.168.0.0/16**, respectively. .. code-block:: text PUT https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3 - Change the name, description, and CIDR block of the VPC whose ID is 99d9d709-8478-4b46-9f3f-2206b1023fd3 to vpc1, test1, and 192.168.0.0/16, respectively. + { "vpc": { "name": "vpc1", @@ -100,92 +101,91 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 5** Response parameter + + +------+---------------------------------------------------+-------------------------------------------------------------------+ + | Name | Type | Description | + +======+===================================================+===================================================================+ + | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | + +------+---------------------------------------------------+-------------------------------------------------------------------+ + +.. _vpc_api01_0004__table22527411: + +.. table:: **Table 6** VPC objects + + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+====================================================================+=======================================================================================================================================================================================+ + | id | String | Specifies a resource ID in UUID format. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC name. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Provides supplementary information about the VPC. | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | + | | | - Possible values are as follows: | + | | | | + | | | - 10.0.0.0/8-24 | + | | | - 172.16.0.0/12-24 | + | | | - 192.168.0.0/16-24 | + | | | | + | | | - If **cidr** is not specified, the default value is left blank. | + | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Specifies the VPC status. | + | | | - Possible values are as follows: | + | | | | + | | | - **CREATING**: The VPC is being created. | + | | | - **OK**: The VPC is created successfully. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enterprise_project_id | String | - Specifies the enterprise project ID. | + | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | + | | | | + | | | .. note:: | + | | | | + | | | This parameter is unsupported. Do not use it. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes | Array of :ref:`route ` objects | - Specifies the route information. | + | | | - For details, see the description of the :ref:`route objects `. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | + +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_api01_0004__table3576833291556: + +.. table:: **Table 7** **route** objects + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+==========================================================================================================================+ + | destination | String | - Specifies the destination network segment of a route. | + | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + | nexthop | String | - Specifies the next hop of a route. | + | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 5** Response parameter - - +------+---------------------------------------------------+-------------------------------------------------------------------+ - | Name | Type | Description | - +======+===================================================+===================================================================+ - | vpc | :ref:`vpc ` object | :ref:`Specifies the VPC objects. ` | - +------+---------------------------------------------------+-------------------------------------------------------------------+ - - .. _vpc_api01_0004__table22527411: - - .. table:: **Table 6** VPC objects - - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+====================================================================+=======================================================================================================================================================================================+ - | id | String | Specifies a resource ID in UUID format. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC name. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Provides supplementary information about the VPC. | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | String | - Specifies the available IP address ranges for subnets in the VPC. | - | | | - Possible values are as follows: | - | | | | - | | | - 10.0.0.0/8-24 | - | | | - 172.16.0.0/12-24 | - | | | - 192.168.0.0/16-24 | - | | | | - | | | - If **cidr** is not specified, the default value is left blank. | - | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Specifies the VPC status. | - | | | - Possible values are as follows: | - | | | | - | | | - **CREATING**: The VPC is being created. | - | | | - **OK**: The VPC is created successfully. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | - Specifies the enterprise project ID. | - | | | - The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value **0** indicates the default enterprise project. | - | | | | - | | | .. note:: | - | | | | - | | | This parameter is unsupported. Do not use it. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes | Array of :ref:`route ` objects | - Specifies the route information. | - | | | - For details, see the description of the :ref:`route objects `. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enable_shared_snat | Boolean | Specifies whether the shared SNAT function is enabled. The value **true** indicates that the function is enabled, and the value **false** indicates that the function is not enabled. | - +-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_api01_0004__table3576833291556: - - .. table:: **Table 7** **route** objects - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+==========================================================================================================================+ - | destination | String | - Specifies the destination network segment of a route. | - | | | - The value must be in the CIDR format. Currently, only the value **0.0.0.0/0** is supported. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | nexthop | String | - Specifies the next hop of a route. | - | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "vpc": { - "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", - "name": "vpc1", - "description": "test1", - "cidr": "192.168.0.0/16", - "status": "OK", - "enterprise_project_id": "0", - "routes": [], - "enable_shared_snat": true - } - } + { + "vpc": { + "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", + "name": "vpc1", + "description": "test1", + "cidr": "192.168.0.0/16", + "status": "OK", + "enterprise_project_id": "0", + "routes": [], + "enable_shared_snat": true + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst index 07897f9..82dfd57 100644 --- a/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst @@ -31,62 +31,62 @@ POST /v1/{project_id}/fl/flow_logs project_id Yes String Project ID. ========== ========= ====== =========== -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==========+===========+===========================================================+==========================================================================================+ + | flow_log | Yes | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | + +----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + +.. _vpc_flow_0001__table656165873916: + +.. table:: **Table 3** Description of the **FlowLog** field + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+================================================================================================================================+ + | name | No | String | - Flow log name. | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Flow log description | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | Yes | String | - Type of the resource for which that the logs to be collected. | + | | | | - The value can be: | + | | | | | + | | | | - **port**: NIC | + | | | | - **vpc**: All NICs in a VPC | + | | | | - **network**: All NICs in a subnet | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | Yes | String | - ID of the resource for which that the logs to be collected. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | Yes | String | - Type of the traffic for which that the logs to be collected. | + | | | | - The value can be: | + | | | | | + | | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | Yes | String | - Log group ID | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | Yes | String | - Log topic ID | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | index_enabled | No | Boolean | Whether to enable the log index. | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -#. Request parameter - - .. table:: **Table 2** Request parameter - - +----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +==========+===========+===========================================================+==========================================================================================+ - | flow_log | Yes | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | - +----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0001__table656165873916: - - .. table:: **Table 3** Description of the **FlowLog** field - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================================+ - | name | No | String | - Flow log name. | - | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Flow log description | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | Yes | String | - Type of the resource for which that the logs to be collected. | - | | | | - The value can be: | - | | | | | - | | | | - **port**: NIC | - | | | | - **vpc**: All NICs in a VPC | - | | | | - **network**: All NICs in a subnet | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | Yes | String | - ID of the resource for which that the logs to be collected. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | traffic_type | Yes | String | - Type of the traffic for which that the logs to be collected. | - | | | | - The value can be: | - | | | | | - | | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | - | | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | - | | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | Yes | String | - Log group ID | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_topic_id | Yes | String | - Log topic ID | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | index_enabled | No | Boolean | Whether to enable the log index. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - -#. Example request +- Create a VPC flow log. Set the resource type to port, resource ID to 05c4052d-8d14-488f-aa00-19fea5a25fde, traffic type to reject, log group ID to 05c4052d-8d14-488f-aa00-19fea5a25fdd, and log topic ID to a9d7dee7-37d2-4cba-a208-a016252aaa63. .. code-block:: text POST https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs - Create a VPC flow log. Set the resource type to port, resource ID to 05c4052d-8d14-488f-aa00-19fea5a25fde, traffic type to reject, and log group ID to 05c4052d-8d14-488f-aa00-19fea5a25fdd. - The log topic ID is a9d7dee7-37d2-4cba-a208-a016252aaa63. + { "flow_log": { "name": "flowlog", @@ -100,96 +100,95 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+===========================================================+==========================================================================================+ + | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 5 `. | + +----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ + +.. _vpc_flow_0001__table763920584395: + +.. table:: **Table 5** Description of the **FlowLog** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | index_enabled | Boolean | - Whether to enable the log index function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+===========================================================+==========================================================================================+ - | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 5 `. | - +----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0001__table763920584395: - - .. table:: **Table 5** Description of the **FlowLog** field - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+================================================================================================================================+ - | id | String | - Flow log ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Flow log name | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Project ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Flow log description | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | - Type of the resource for which that the logs to be collected. | - | | | - The value can be: | - | | | | - | | | - **port**: NIC | - | | | - **vpc**: All NICs in a VPC | - | | | - **network**: All NICs in a subnet | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | - ID of the resource for which that the logs to be collected. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | traffic_type | String | - Type of the traffic for which that the logs to be collected. | - | | | - The value can be: | - | | | | - | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | - | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | - | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | - Log group ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_topic_id | String | - Log topic ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | index_enabled | Boolean | - Whether to enable the log index function | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | admin_state | Boolean | - Whether to enable the flow log function | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Flow log status | - | | | - The value can be: | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | - Time when the flow log is created | - | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | - Time when the flow log is updated | - | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "flow_log": { - "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d", - "name": "flowlog", - "description": "just a test", - "tenant_id": "b2782e6708b8475c993e6064bc456bf8", - "resource_type": "port", - "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", - "traffic_type": "reject", - "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", - "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", - "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T11:03:02", - "index_enabled": false, - "admin_state": true, - "status": "ACTIVE" - } - } + { + "flow_log": { + "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d", + "name": "flowlog", + "description": "just a test", + "tenant_id": "b2782e6708b8475c993e6064bc456bf8", + "resource_type": "port", + "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", + "traffic_type": "reject", + "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", + "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "created_at": "2019-01-14T11:03:02", + "updated_at": "2019-01-14T11:03:02", + "index_enabled": false, + "admin_state": true, + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst index 9c0cb83..4889f38 100644 --- a/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst @@ -28,29 +28,27 @@ DELETE /v1/{project_id}/fl/flow_logs/{flowlog_id} flowlog_id Yes String Flow log ID ========== ========= ====== =========== -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/60c809cb-6731-45d0-ace8-3bf5626421a9 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/60c809cb-6731-45d0-ace8-3bf5626421a9 - -Response Message +Example Response ---------------- -- Request parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst index 4e797c0..f71a3a1 100644 --- a/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst @@ -28,106 +28,104 @@ GET /v1/{project_id}/fl/flow_logs/{flowlog_id} flowlog_id Yes String Flow log ID ========== ========= ====== =========== -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/1e10cd9d-742a-4d36-a9fd-aee9784336ff -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/1e10cd9d-742a-4d36-a9fd-aee9784336ff + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+=============================================================+============================================================================================+ + | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_flow_0003__table17299234185110: + +.. table:: **Table 3** Description of the **FlowLog** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+=============================================================+============================================================================================+ - | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | - +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0003__table17299234185110: - - .. table:: **Table 3** Description of the **FlowLog** field - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+================================================================================================================================+ - | id | String | - Flow log ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Flow log name | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Project ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Flow log description | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | - Type of the resource for which that the logs to be collected. | - | | | - The value can be: | - | | | | - | | | - **port**: NIC | - | | | - **vpc**: All NICs in a VPC | - | | | - **network**: All NICs in a subnet | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | - ID of the resource for which that the logs to be collected. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | traffic_type | String | - Type of the traffic for which that the logs to be collected. | - | | | - The value can be: | - | | | | - | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | - | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | - | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | - Log group ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_topic_id | String | - Log topic ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | admin_state | Boolean | - Whether to enable the flow log function | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Flow log status | - | | | - The value can be: | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | - Time when the flow log is created | - | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | - Time when the flow log is updated | - | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "flow_log": { - "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a", - "name": "flow", - "description": "just a test", - "tenant_id": "b2782e6708b8475c993e6064bc456bf8", - "resource_type": "port", - "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", - "traffic_type": "reject", - "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", - "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", - "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T11:03:02", - "status": "ACTIVE", - "admin_state": true - } - } + { + "flow_log": { + "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a", + "name": "flow", + "description": "just a test", + "tenant_id": "b2782e6708b8475c993e6064bc456bf8", + "resource_type": "port", + "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", + "traffic_type": "reject", + "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", + "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "created_at": "2019-01-14T11:03:02", + "updated_at": "2019-01-14T11:03:02", + "status": "ACTIVE", + "admin_state": true + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst b/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst index 54fa4f8..2c8a5ca 100644 --- a/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst +++ b/api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst @@ -82,108 +82,106 @@ Example: | | | | - 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. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog + +-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +===========+======================================================================+================================================================================================+ + | flow_logs | Array of :ref:`FlowLog ` objects | **FlowLog** object list. For details, see :ref:`Table 3 `. | + +-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_flow_0002__table34811015184118: + +.. table:: **Table 3** Description of the **FlowLog** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +===========+======================================================================+================================================================================================+ - | flow_logs | Array of :ref:`FlowLog ` objects | **FlowLog** object list. For details, see :ref:`Table 3 `. | - +-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0002__table34811015184118: - - .. table:: **Table 3** Description of the **FlowLog** field - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+================================================================================================================================+ - | id | String | - Flow log ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Flow log name | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Project ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Flow log description | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | - Type of the resource for which that the logs to be collected. | - | | | - The value can be: | - | | | | - | | | - **port**: NIC | - | | | - **vpc**: All NICs in a VPC | - | | | - **network**: All NICs in a subnet | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | - ID of the resource for which that the logs to be collected. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | traffic_type | String | - Type of the traffic for which that the logs to be collected. | - | | | - The value can be: | - | | | | - | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | - | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | - | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | - Log group ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_topic_id | String | - Log topic ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | admin_state | Boolean | - Whether to enable the flow log function | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Flow log status | - | | | - The value can be: | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | - Time when the flow log is created | - | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | - Time when the flow log is updated | - | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "flow_logs": [ - { - "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a", - "name": "flowlog", - "description": "just a test", - "tenant_id": "b2782e6708b8475c993e6064bc456bf8", - "resource_type": "port", - "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", - "traffic_type": "reject", - "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", - "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", - "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T11:03:02", - "status": "ACTIVE", - "admin_state": true - } - ] - } + { + "flow_logs": [ + { + "id": "35868d55-443e-4d5c-90a4-ac618dc45c1a", + "name": "flowlog", + "description": "just a test", + "tenant_id": "b2782e6708b8475c993e6064bc456bf8", + "resource_type": "port", + "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", + "traffic_type": "reject", + "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fff", + "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "created_at": "2019-01-14T11:03:02", + "updated_at": "2019-01-14T11:03:02", + "status": "ACTIVE", + "admin_state": true + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst b/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst index 9258855..d8402bc 100644 --- a/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst +++ b/api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst @@ -28,41 +28,42 @@ PUT /v1/{project_id}/fl/flow_logs/{flowlog_id} flowlog_id Yes String Flow log ID ========== ========= ====== =========== -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +==========+===========+=============================================================+============================================================================================+ + | flow_log | Yes | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | + +----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + +.. _vpc_flow_0004__table13828101864013: + +.. table:: **Table 3** Description of the **FlowLog** field + + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Mandatory | Type | Description | + +=================+=================+=================+================================================================================================================================+ + | name | No | String | - Flow log name | + | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | - Flow log description | + | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | No | Boolean | - Whether to enable the flow log function | + +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +==========+===========+=============================================================+============================================================================================+ - | flow_log | Yes | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 3 `. | - +----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0004__table13828101864013: - - .. table:: **Table 3** Description of the **FlowLog** field - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Name | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================================+ - | name | No | String | - Flow log name | - | | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | - Flow log description | - | | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | admin_state | No | Boolean | - Whether to enable the flow log function | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Change the name of the VPC flow log whose ID is f49f00f1-0f15-470a-a8c5-4e879e461c8d to **flow-log-update**. .. code-block:: text PUT https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/f49f00f1-0f15-470a-a8c5-4e879e461c8d - Change the name of the VPC flow log whose ID is f49f00f1-0f15-470a-a8c5-4e879e461c8d to flow-log-update. + { "flow_log": { "name": "flow-log-update", @@ -71,93 +72,92 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +==========+=============================================================+============================================================================================+ + | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 5 `. | + +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ + +.. _vpc_flow_0004__table17299234185110: + +.. table:: **Table 5** Description of the **FlowLog** field + + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | Name | Type | Description | + +=======================+=======================+================================================================================================================================+ + | id | String | - Flow log ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | name | String | - Flow log name | + | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | tenant_id | String | - Project ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | description | String | - Flow log description | + | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_type | String | - Type of the resource for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **port**: NIC | + | | | - **vpc**: All NICs in a VPC | + | | | - **network**: All NICs in a subnet | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | resource_id | String | - ID of the resource for which that the logs to be collected. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | traffic_type | String | - Type of the traffic for which that the logs to be collected. | + | | | - The value can be: | + | | | | + | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | + | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | + | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_group_id | String | - Log group ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | log_topic_id | String | - Log topic ID | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | admin_state | Boolean | - Whether to enable the flow log function | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | status | String | - Flow log status | + | | | - The value can be: | + | | | | + | | | - **ACTIVE**: Enabled | + | | | - **DOWN**: Disabled | + | | | - **ERROR**: Abnormal | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | created_at | String | - Time when the flow log is created | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | - Time when the flow log is updated | + | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | + +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +==========+=============================================================+============================================================================================+ - | flow_log | :ref:`flow_log ` object | **FlowLog** objects. For details, see :ref:`Table 5 `. | - +----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+ - - .. _vpc_flow_0004__table17299234185110: - - .. table:: **Table 5** Description of the **FlowLog** field - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Name | Type | Description | - +=======================+=======================+================================================================================================================================+ - | id | String | - Flow log ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | name | String | - Flow log name | - | | | - The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | - Project ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | description | String | - Flow log description | - | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | - Type of the resource for which that the logs to be collected. | - | | | - The value can be: | - | | | | - | | | - **port**: NIC | - | | | - **vpc**: All NICs in a VPC | - | | | - **network**: All NICs in a subnet | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | - ID of the resource for which that the logs to be collected. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | traffic_type | String | - Type of the traffic for which that the logs to be collected. | - | | | - The value can be: | - | | | | - | | | - **all**: specifies that both accepted and rejected traffic of the specified resource will be logged. | - | | | - **accept**: specifies that only accepted inbound and outbound traffic of the specified resource will be logged. | - | | | - **reject**: specifies that only rejected inbound and outbound traffic of the specified resource will be logged. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_group_id | String | - Log group ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | log_topic_id | String | - Log topic ID | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | admin_state | Boolean | - Whether to enable the flow log function | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | status | String | - Flow log status | - | | | - The value can be: | - | | | | - | | | - **ACTIVE**: Enabled | - | | | - **DOWN**: Disabled | - | | | - **ERROR**: Abnormal | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | created_at | String | - Time when the flow log is created | - | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | - Time when the flow log is updated | - | | | - UTC time in the format of yyyy-MM-ddTHH:mmss | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "flow_log": { - "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d", - "name": " flow-log-update", - "description": "update", - "tenant_id": "b2782e6708b8475c993e6064bc456bf8", - "resource_type": "port", - "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", - "traffic_type": "reject", - "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", - "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", - "created_at": "2019-01-14T11:03:02", - "updated_at": "2019-01-14T12:03:02", - "status": "DOWN", - "admin_state": false - } - } + { + "flow_log": { + "id": "f49f00f1-0f15-470a-a8c5-4e879e461c8d", + "name": " flow-log-update", + "description": "update", + "tenant_id": "b2782e6708b8475c993e6064bc456bf8", + "resource_type": "port", + "resource_id": "05c4052d-8d14-488f-aa00-19fea5a25fde", + "traffic_type": "reject", + "log_group_id": "05c4052d-8d14-488f-aa00-19fea5a25fdd", + "log_topic_id": "a9d7dee7-37d2-4cba-a208-a016252aaa63", + "created_at": "2019-01-14T11:03:02", + "updated_at": "2019-01-14T12:03:02", + "status": "DOWN", + "admin_state": false + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst index fc39f7d..e110084 100644 --- a/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst @@ -27,86 +27,85 @@ PUT /v2.0/vpc/peerings/{peering_id}/accept | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | +------------+-----------+--------+------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter - - None - -- Example request +- Accept the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1. .. code-block:: text PUT https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1/accept - Accept the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1. -Response Message +Response Parameters +------------------- + +.. table:: **Table 2** Response parameter + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0004__table1125991417114: + +.. table:: **Table 3** **vpc_info** objects + + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+===============================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0004__table1125991417114: - - .. table:: **Table 3** **vpc_info** objects - - +-----------+--------+-----------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+===============================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+-----------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | - +-----------+--------+-----------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "name": "test", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "059a737356594b41b447b557bf0aae56" - }, - "status": "ACTIVE" - } + { + "name": "test", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "059a737356594b41b447b557bf0aae56" + }, + "status": "ACTIVE" + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst index 7dc0116..0c46482 100644 --- a/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst @@ -19,57 +19,58 @@ URI POST /v2.0/vpc/peerings -Request Message +Request Parameters +------------------ + +.. table:: **Table 1** Request parameter + + +-----------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +===========+===========+==============================================================+===============================================================================================================+ + | peering | Yes | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 2 `. | + +-----------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0003__table1026243410414: + +.. table:: **Table 2** Description of the **peering** field + + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +==================+=================+===============================================================+====================================================================================================================+ + | name | Yes | String | Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. | + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Provides supplementary information about the VPC peering connection. | + | | | | | + | | | | The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | Yes | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | Yes | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | + +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0003__table1132310347417: + +.. table:: **Table 3** Description of the **vpc_info** field + + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ + | Attribute | Mandatory | Type | Description | + +=================+=================+=================+==========================================================================================================+ + | vpc_id | Yes | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ + | tenant_id | No | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | + | | | | | + | | | | This parameter is mandatory if the VPC peering connection is created between VPCs in different accounts. | + +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 1** Request parameter - - +-----------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==============================================================+===============================================================================================================+ - | peering | Yes | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 2 `. | - +-----------+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0003__table1026243410414: - - .. table:: **Table 2** Description of the **peering** field - - +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +==================+=================+===============================================================+====================================================================================================================+ - | name | Yes | String | Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. | - +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Provides supplementary information about the VPC peering connection. | - | | | | | - | | | | The value can contain no more than 255 characters and cannot contain angle brackets (< or >). | - +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | Yes | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | - +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | Yes | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | - +------------------+-----------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0003__table1132310347417: - - .. table:: **Table 3** Description of the **vpc_info** field - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ - | Attribute | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================+ - | vpc_id | Yes | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ - | tenant_id | No | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - | | | | | - | | | | This parameter is mandatory if the VPC peering connection is created between VPCs in different accounts. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a VPC peering connection. The VPC ID of the requester is 9daeac7c-a98f-430f-8e38-67f9c044e299, the VPC ID of the receiver is f583c072-0bb8-4e19-afb2-afb7c1693be5, and the VPC peering connection is named **test**. .. code-block:: text POST https://{Endpoint}/v2.0/vpc/peerings - Create a VPC peering connection. The VPC ID of the requester is 9daeac7c-a98f-430f-8e38-67f9c044e299, the VPC ID of the receiver is f583c072-0bb8-4e19-afb2-afb7c1693be5, and the VPC peering connection is named test. + { "peering": { "name": "test", @@ -82,84 +83,83 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================+================================================================================================================+ + | peering | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 5 `. | + +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0003__table14258131481112: + +.. table:: **Table 5** **peering** objects + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 6 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 6 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0003__table1125991417114: + +.. table:: **Table 6** **vpc_info** objects + + +-----------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+================================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================+================================================================================================================+ - | peering | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 5 `. | - +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0003__table14258131481112: - - .. table:: **Table 5** **peering** objects - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 6 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 6 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0003__table1125991417114: - - .. table:: **Table 6** **vpc_info** objects - - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "peering": { - "name": "test", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "status": "ACTIVE" - } - } + { + "peering": { + "name": "test", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/deleting_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/deleting_a_vpc_peering_connection.rst index ebcaa2b..ad1e0e6 100644 --- a/api-ref/source/apis/vpc_peering_connection/deleting_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/deleting_a_vpc_peering_connection.rst @@ -29,29 +29,27 @@ DELETE /v2.0/vpc/peerings/{peering_id} | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | +------------+-----------+--------+------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v2.0/vpc/peerings/2b098395-046a-4071-b009-312bcee665cb -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v2.0/vpc/peerings/2b098395-046a-4071-b009-312bcee665cb - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/querying_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/querying_a_vpc_peering_connection.rst index fc825f1..3153828 100644 --- a/api-ref/source/apis/vpc_peering_connection/querying_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/querying_a_vpc_peering_connection.rst @@ -27,97 +27,95 @@ GET /v2.0/vpc/peerings/{peering_id} | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. The **peering_id** value is used as the filter. | +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1 + +-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+==============================================================+===========================================================================================================================+ + | peering | :ref:`peering ` object | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | + +-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_peering_0002__table1026243410414: + +.. table:: **Table 3** **peering** objects + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 4 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 4 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0002__table1132310347417: + +.. table:: **Table 4** **vpc_info** objects + + +-----------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+================================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==============================================================+===========================================================================================================================+ - | peering | :ref:`peering ` object | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | - +-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0002__table1026243410414: - - .. table:: **Table 3** **peering** objects - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 4 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 4 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0002__table1132310347417: - - .. table:: **Table 4** **vpc_info** objects - - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "peering": { - "name": "test", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "status": "ACTIVE" - } - } + { + "peering": { + "name": "test", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst b/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst index 10225bf..b9d8179 100644 --- a/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst +++ b/api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst @@ -57,115 +57,113 @@ Example: | | | | The default value is **2000**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/vpc/peerings -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/vpc/peerings + +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+============================================================================+=================================================================================================================================================================================================================+ + | peerings | Array of :ref:`peering ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | + +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | peerings_links | Array of :ref:`peerings_link ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 5 `. | + | | | | + | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | + +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_peering_0001__table1026243410414: + +.. table:: **Table 3** **peering** objects + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 4 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 4 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0001__table1132310347417: + +.. table:: **Table 4** **vpc_info** objects + + +-----------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+================================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | + +-----------+--------+------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0001__table25150247450: + +.. table:: **Table 5** **peerings_link** object + + +------+--------+----------------------------------------------------------------------+ + | Name | 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 | - +=======================+============================================================================+=================================================================================================================================================================================================================+ - | peerings | Array of :ref:`peering ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 `. | - +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | peerings_links | Array of :ref:`peerings_link ` objects | Specifies the VPC peering connection object list. For details, see :ref:`Table 5 `. | - | | | | - | | | Only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**), value **next** will be returned for **rel** and a link for **href**. | - +-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0001__table1026243410414: - - .. table:: **Table 3** **peering** objects - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 4 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 4 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0001__table1132310347417: - - .. table:: **Table 4** **vpc_info** objects - - +-----------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+================================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | - +-----------+--------+------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0001__table25150247450: - - .. table:: **Table 5** **peerings_link** object - - +------+--------+----------------------------------------------------------------------+ - | Name | 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:: - - { - "peerings": [ - { - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "name": "test", - "id": "b147a74b-39bb-4c7a-aed5-19cac4c2df13", - "status": "ACTIVE" - } - ] - } + { + "peerings": [ + { + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "name": "test", + "id": "b147a74b-39bb-4c7a-aed5-19cac4c2df13", + "status": "ACTIVE" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst index bd7d66a..3c78282 100644 --- a/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst @@ -27,86 +27,85 @@ PUT /v2.0/vpc/peerings/{peering_id}/reject | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | +------------+-----------+--------+------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter - - None - -- Example request +- Reject the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1. .. code-block:: text PUT https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1/reject - Reject the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1. -Response Message +Response Parameters +------------------- + +.. table:: **Table 2** Response parameter + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0005__table1125991417114: + +.. table:: **Table 3** **vpc_info** objects + + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+===============================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 3 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 3 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0005__table1125991417114: - - .. table:: **Table 3** **vpc_info** objects - - +-----------+--------+-----------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+===============================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+-----------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | - +-----------+--------+-----------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "name": "test", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "status": "REJECTED" - } + { + "name": "test", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "status": "REJECTED" + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst b/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst index be299e3..8686121 100644 --- a/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst +++ b/api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst @@ -27,123 +27,123 @@ PUT /v2.0/vpc/peerings/{peering_id} | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | +------------+-----------+--------+------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=================+=================+==============================================================+==================================================================================================================================================================+ + | peering | Yes | :ref:`peering ` object | Updates a VPC peering connection. For details, see :ref:`Table 3 `. | + | | | | | + | | | | When updating a VPC peering connection, you must specify at least one attribute. Currently, only the VPC peering connection name and description can be updated. | + +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0006__table9931835105819: + +.. table:: **Table 3** Description of the **peering** field + + +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +=============+===========+========+=======================================================================================================================================================+ + | name | No | String | Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. | + +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | No | String | Provides supplementary information about the VPC peering connection. The value can contain no more than 255 characters, including letters and digits. | + +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==============================================================+==================================================================================================================================================================+ - | peering | Yes | :ref:`peering ` object | Updates a VPC peering connection. For details, see :ref:`Table 3 `. | - | | | | | - | | | | When updating a VPC peering connection, you must specify at least one attribute. Currently, only the VPC peering connection name and description can be updated. | - +-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0006__table9931835105819: - - .. table:: **Table 3** Description of the **peering** field - - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=======================================================================================================================================================+ - | name | No | String | Specifies the name of the VPC peering connection. The value can contain 1 to 64 characters. | - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Provides supplementary information about the VPC peering connection. The value can contain no more than 255 characters, including letters and digits. | - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Example request +- Change the name of the VPC peering connection whose ID is 7a9a954a-eb41-4954-a300-11ab17a361a2 to **test2**. .. code-block:: text PUT https://{Endpoint}/v2.0/vpc/peerings/7a9a954a-eb41-4954-a300-11ab17a361a2 - Change the name of the VPC peering connection whose ID is 7a9a954a-eb41-4954-a300-11ab17a361a2 to test2. + { "peering": { "name": "test2" } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 4** Response parameter + + +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+===============================================================+================================================================================================================+ + | peering | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 5 `. | + +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0006__table14258131481112: + +.. table:: **Table 5** **peering** objects + + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+===============================================================+====================================================================================================================+ + | id | String | Specifies the VPC peering connection ID. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | name | String | Specifies the VPC peering connection name. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | status | String | Specifies the VPC peering connection status. Possible values are as follows: | + | | | | + | | | - **PENDING_ACCEPTANCE** | + | | | - **REJECTED** | + | | | - **EXPIRED** | + | | | - **DELETED** | + | | | - **ACTIVE** | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 6 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 6 `. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | description | String | Provides supplementary information about the VPC peering connection. | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | + | | | | + | | | Format: *yyyy-MM-ddTHH:mm:ss* | + +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +.. _vpc_peering_0006__table1125991417114: + +.. table:: **Table 6** **vpc_info** objects + + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +===========+========+===============================================================================================+ + | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | + +-----------+--------+-----------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 4** Response parameter - - +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+===============================================================+================================================================================================================+ - | peering | :ref:`peering ` object | Specifies the VPC peering connection. For details, see :ref:`Table 5 `. | - +-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0006__table14258131481112: - - .. table:: **Table 5** **peering** objects - - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+===============================================================+====================================================================================================================+ - | id | String | Specifies the VPC peering connection ID. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the VPC peering connection name. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the VPC peering connection status. Possible values are as follows: | - | | | | - | | | - **PENDING_ACCEPTANCE** | - | | | - **REJECTED** | - | | | - **EXPIRED** | - | | | - **DELETED** | - | | | - **ACTIVE** | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | request_vpc_info | :ref:`vpc_info ` object | Specifies information about the local VPC. For details, see :ref:`Table 6 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | accept_vpc_info | :ref:`vpc_info ` object | Specifies information about the peer VPC. For details, see :ref:`Table 6 `. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | description | String | Provides supplementary information about the VPC peering connection. | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | created_at | String | Specifies the time (UTC) when the VPC peering connection is created. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Specifies the time (UTC) when the VPC peering connection is updated. | - | | | | - | | | Format: *yyyy-MM-ddTHH:mm:ss* | - +-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_peering_0006__table1125991417114: - - .. table:: **Table 6** **vpc_info** objects - - +-----------+--------+-----------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +===========+========+===============================================================================================+ - | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | - +-----------+--------+-----------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | - +-----------+--------+-----------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "peering": { - "name": "test2", - "id": "22b76469-08e3-4937-8c1d-7aad34892be1", - "request_vpc_info": { - "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", - "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" - }, - "accept_vpc_info": { - "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", - "tenant_id": "059a737356594b41b447b557bf0aae56" - }, - "status": "ACTIVE" - } - } + { + "peering": { + "name": "test2", + "id": "22b76469-08e3-4937-8c1d-7aad34892be1", + "request_vpc_info": { + "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", + "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" + }, + "accept_vpc_info": { + "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", + "tenant_id": "059a737356594b41b447b557bf0aae56" + }, + "status": "ACTIVE" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst b/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst index 4d2596c..150ff23 100644 --- a/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst +++ b/api-ref/source/apis/vpc_route/creating_a_vpc_route.rst @@ -15,43 +15,44 @@ URI POST /v2.0/vpc/routes -Request Message +Request Parameters +------------------ + +.. table:: **Table 1** Request parameter + + +-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +===========+======================================+===========+==========================================================================================+ + | route | :ref:`route ` object | Yes | Specifies the route. For details, see :ref:`Table 2 `. | + +-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+ + +.. _vpc_route_0003__table05001250111: + +.. table:: **Table 2** **route** objects + + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | Attribute | Type | Mandatory | Description | + +=================+=================+=================+=======================================================================================================+ + | destination | String | Yes | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | nexthop | String | Yes | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | type | String | Yes | Specifies the route type. | + | | | | | + | | | | Currently, only the **peering** type is supported, that is, the next hop is a VPC peering connection. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + | vpc_id | String | Yes | Specifies the ID of the VPC ID requesting for creating a route. | + +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 1** Request parameter - - +-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +===========+======================================+===========+==========================================================================================+ - | route | :ref:`route ` object | Yes | Specifies the route. For details, see :ref:`Table 2 `. | - +-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+ - - .. _vpc_route_0003__table05001250111: - - .. table:: **Table 2** **route** objects - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ - | Attribute | Type | Mandatory | Description | - +=================+=================+=================+=======================================================================================================+ - | destination | String | Yes | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ - | nexthop | String | Yes | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ - | type | String | Yes | Specifies the route type. | - | | | | | - | | | | Currently, only the **peering** type is supported, that is, the next hop is a VPC peering connection. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Yes | Specifies the ID of the VPC ID requesting for creating a route. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+ - -- Example request +- Create a route in the route table of the VPC whose ID is ab78be2d-782f-42a5-aa72-35879f6890ff for the VPC peering connection. The next hop is the peering connection whose ID is 60c809cb-6731-45d0-ace8-3bf5626421a9, and the destination is 192.168.200.0/24. .. code-block:: text POST https://{Endpoint}/v2.0/vpc/routes - Create a route in the route table of VPC whose ID is ab78be2d-782f-42a5-aa72-35879f6890ff for the VPC peering connection. The next hop is the peering connection whose ID is 60c809cb-6731-45d0-ace8-3bf5626421a9, and the destination is 192.168.200.0/24. + { "route": { "type": "peering", @@ -61,53 +62,52 @@ Request Message } } -Response Message +Response Parameters +------------------- + +.. table:: **Table 3** Response parameter + + +-----------+--------------------------------------+--------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+======================================+============================================================================================+ + | route | :ref:`route ` object | Specifies the route. For details, see :ref:`Table 4 `. | + +-----------+--------------------------------------+--------------------------------------------------------------------------------------------+ + +.. _vpc_route_0003__table1163544010410: + +.. table:: **Table 4** **route** objects + + +-------------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=============+========+================================================================================================+ + | id | String | Specifies the route ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | type | String | Specifies the route type. Currently, the value can only be **peering**. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 3** Response parameter - - +-----------+--------------------------------------+--------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+======================================+============================================================================================+ - | route | :ref:`route ` object | Specifies the route. For details, see :ref:`Table 4 `. | - +-----------+--------------------------------------+--------------------------------------------------------------------------------------------+ - - .. _vpc_route_0003__table1163544010410: - - .. table:: **Table 4** **route** objects - - +-------------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=============+========+================================================================================================+ - | id | String | Specifies the route ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | type | String | Specifies the route type. Currently, the value can only be **peering**. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "route": { - "type": "peering", - "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", - "destination": "192.168.200.0/24", - "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", - "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", - "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" - } - } + { + "route": { + "type": "peering", + "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", + "destination": "192.168.200.0/24", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_route/deleting_a_vpc_route.rst b/api-ref/source/apis/vpc_route/deleting_a_vpc_route.rst index 4a16842..ae99eb0 100644 --- a/api-ref/source/apis/vpc_route/deleting_a_vpc_route.rst +++ b/api-ref/source/apis/vpc_route/deleting_a_vpc_route.rst @@ -27,29 +27,27 @@ DELETE /v2.0/vpc/routes/{route_id} | route_id | Yes | String | Specifies the route ID, which uniquely identifies the route. | +----------+-----------+--------+--------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_route/querying_a_vpc_route.rst b/api-ref/source/apis/vpc_route/querying_a_vpc_route.rst index a906775..229882a 100644 --- a/api-ref/source/apis/vpc_route/querying_a_vpc_route.rst +++ b/api-ref/source/apis/vpc_route/querying_a_vpc_route.rst @@ -27,66 +27,64 @@ GET /v2.0/vpc/routes/{route_id} | route_id | Yes | String | Specifies the route ID, which uniquely identifies the route. | +----------+-----------+--------+--------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 + +-----------+--------------------------------------+------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+======================================+==========================================================================================+ + | route | :ref:`route ` object | Specifies the route. For details, see :ref:`Table 3 `. | + +-----------+--------------------------------------+------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_route_0002__table05001250111: + +.. table:: **Table 3** **route** objects + + +-------------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=============+========+================================================================================================+ + | id | String | Specifies the route ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | type | String | Specifies the route type. Currently, the value can only be **peering**. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+--------------------------------------+------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+======================================+==========================================================================================+ - | route | :ref:`route ` object | Specifies the route. For details, see :ref:`Table 3 `. | - +-----------+--------------------------------------+------------------------------------------------------------------------------------------+ - - .. _vpc_route_0002__table05001250111: - - .. table:: **Table 3** **route** objects - - +-------------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=============+========+================================================================================================+ - | id | String | Specifies the route ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | type | String | Specifies the route type. Currently, the value can only be **peering**. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "route": { - "type": "peering", - "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", - "destination": "192.168.200.0/24", - "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", - "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", - "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" - } - } + { + "route": { + "type": "peering", + "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", + "destination": "192.168.200.0/24", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" + } + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_route/querying_vpc_routes.rst b/api-ref/source/apis/vpc_route/querying_vpc_routes.rst index 92a8fc4..d27500e 100644 --- a/api-ref/source/apis/vpc_route/querying_vpc_routes.rst +++ b/api-ref/source/apis/vpc_route/querying_vpc_routes.rst @@ -57,84 +57,82 @@ Example: | | | | The default value is **2000**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/vpc/routes?vpc_id=ab78be2d-782f-42a5-aa72-35879f6890ff -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/vpc/routes?vpc_id=ab78be2d-782f-42a5-aa72-35879f6890ff + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+========================================================================+======================================================================================================================================================================================================================+ + | routes | Array of :ref:`route ` objects | Specifies the route object list. For details, see :ref:`Table 3 `. | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | routes_links | Array of :ref:`routes_link ` objects | Specifies the route object list. For details, see :ref:`Table 4 `. | + | | | | + | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | + +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_route_0001__table05001250111: + +.. table:: **Table 3** **route** objects + + +-------------+--------+------------------------------------------------------------------------------------------------+ + | Attribute | Type | Description | + +=============+========+================================================================================================+ + | id | String | Specifies the route ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | type | String | Specifies the route type. Currently, the value can only be **peering**. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + | tenant_id | String | Specifies the project ID. | + +-------------+--------+------------------------------------------------------------------------------------------------+ + +.. _vpc_route_0001__table25150247450: + +.. table:: **Table 4** **routes_link** object + + +------+--------+----------------------------------------------------------------------+ + | Name | 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 | - +=======================+========================================================================+======================================================================================================================================================================================================================+ - | routes | Array of :ref:`route ` objects | Specifies the route object list. For details, see :ref:`Table 3 `. | - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | routes_links | Array of :ref:`routes_link ` objects | Specifies the route object list. For details, see :ref:`Table 4 `. | - | | | | - | | | The value of **rel** will be **next** and that of **href** will be a link only when **limit** is used for filtering and the number of resources exceeds the value of **limit** or 2000 (default value of **limit**). | - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _vpc_route_0001__table05001250111: - - .. table:: **Table 3** **route** objects - - +-------------+--------+------------------------------------------------------------------------------------------------+ - | Attribute | Type | Description | - +=============+========+================================================================================================+ - | id | String | Specifies the route ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | destination | String | Specifies the destination address in the CIDR notation format, for example, 192.168.200.0/24. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | nexthop | String | Specifies the next hop. If the route type is **peering**, enter the VPC peering connection ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | type | String | Specifies the route type. Currently, the value can only be **peering**. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the VPC of the route. Set this parameter to the existing VPC ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the project ID. | - +-------------+--------+------------------------------------------------------------------------------------------------+ - - .. _vpc_route_0001__table25150247450: - - .. table:: **Table 4** **routes_link** object - - +------+--------+----------------------------------------------------------------------+ - | Name | 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:: - - { - "routes": [ - { - "type": "peering", - "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", - "destination": "192.168.200.0/24", - "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", - "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", - "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" - } - ] - } + { + "routes": [ + { + "type": "peering", + "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", + "destination": "192.168.200.0/24", + "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", + "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", + "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst b/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst index ff9c48f..365ef31 100644 --- a/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst +++ b/api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst @@ -37,10 +37,8 @@ POST /v2.0/{project_id}/vpcs/{vpc_id}/tags/action | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -84,54 +82,56 @@ Request parameter | | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ -Request example 1: Creating tags in batches +Example Request +--------------- -.. code-block:: text +- Batch create two tags for a VPC. - POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action - Create two tags for a VPC. - { - "action": "create", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } + .. code-block:: text -Request example 2: Deleting tags in batches + POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action -.. code-block:: text + { + "action": "create", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } - POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action - Delete two tags for a VPC. - { - "action": "delete", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } +- Batch delete two tags for a VPC. -Response Message ----------------- + .. code-block:: text -Response parameter + POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action + + { + "action": "delete", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } + +Response Parameters +------------------- None -Example response +Example Response +---------------- None diff --git a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst b/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst index 3f840ee..0683a99 100644 --- a/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst +++ b/api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst @@ -29,54 +29,55 @@ POST /v2.0/{project_id}/vpcs/{vpc_id}/tags | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +.. table:: **Table 2** Request parameter + + +-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Mandatory | Description | + +===========+=======================================================+===========+=====================================================================================================+ + | tag | :ref:`tag ` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 3 `. | + +-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+ + +.. _vpc_tag_0001__table13242848193719: + +.. table:: **Table 3** **tag** objects + + +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ + | Attribute | Type | Mandatory | Description | + +=================+=================+=================+=====================================================================+ + | key | String | Yes | - Specifies the tag key. | + | | | | - Cannot be left blank. | + | | | | - Can contain a maximum of 36 characters. | + | | | | - Can contain only the following character types: | + | | | | | + | | | | - Uppercase letters | + | | | | - Lowercase letters | + | | | | - Digits | + | | | | - Special characters, including hyphens (-) and underscores (_) | + | | | | | + | | | | - The tag key of a VPC must be unique. | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ + | value | String | Yes | - Specifies the tag value. | + | | | | - Can contain a maximum of 43 characters. | + | | | | - Can contain only the following character types: | + | | | | | + | | | | - Uppercase letters | + | | | | - Lowercase letters | + | | | | - Digits | + | | | | - Special characters, including hyphens (-) and underscores (_) | + +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ + +Example Request --------------- -- Request parameter - - .. table:: **Table 2** Request parameter - - +-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +===========+=======================================================+===========+=====================================================================================================+ - | tag | :ref:`tag ` object | Yes | Specifies the **tag** objects. For details, see :ref:`Table 3 `. | - +-----------+-------------------------------------------------------+-----------+-----------------------------------------------------------------------------------------------------+ - - .. _vpc_tag_0001__table13242848193719: - - .. table:: **Table 3** **tag** objects - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | Attribute | Type | Mandatory | Description | - +=================+=================+=================+=====================================================================+ - | key | String | Yes | - Specifies the tag key. | - | | | | - Cannot be left blank. | - | | | | - Can contain a maximum of 36 characters. | - | | | | - Can contain only the following character types: | - | | | | | - | | | | - Uppercase letters | - | | | | - Lowercase letters | - | | | | - Digits | - | | | | - Special characters, including hyphens (-) and underscores (_) | - | | | | | - | | | | - The tag key of a VPC must be unique. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | value | String | Yes | - Specifies the tag value. | - | | | | - Can contain a maximum of 43 characters. | - | | | | - Can contain only the following character types: | - | | | | | - | | | | - Uppercase letters | - | | | | - Lowercase letters | - | | | | - Digits | - | | | | - Special characters, including hyphens (-) and underscores (_) | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - -- Example request +- Create a tag for a VPC. The key is **key1**, and the value is **value1**. .. code-block:: text POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags - Create a tag for a VPC. The key is key1, and the value is value1. + { "tag": { "key": "key1", @@ -84,16 +85,15 @@ Request Message } } -Response Message +Response Parameters +------------------- + +None + +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst b/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst index 1337115..39000b1 100644 --- a/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst +++ b/api-ref/source/apis/vpc_tag_management/deleting_a_vpc_tag.rst @@ -31,29 +31,27 @@ DELETE /v2.0/{project_id}/vpcs/{vpc_id}/tags/{key} | key | Yes | Specifies the tag key. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + DELETE https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/{key} -- Example request +Response Parameters +------------------- - .. code-block:: text +None - DELETE https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/{key} - -Response Message +Example Response ---------------- -- Response parameter - - None - -- Example response - - None +None Status Code ----------- diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst index 04cf142..bbb8065 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags.rst @@ -29,77 +29,75 @@ GET /v2.0/{project_id}/vpcs/{vpc_id}/tags | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | +------------+-----------+----------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Example Request --------------- -- Request parameter +.. code-block:: text - None + GET https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags -- Example request +Response Parameters +------------------- - .. code-block:: text +.. table:: **Table 2** Response parameter - GET https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags + +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+=================================================================+=========================================================================================================+ + | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 `. | + +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ -Response Message +.. _vpc_tag_0002__table13242848193719: + +.. table:: **Table 3** **tag** objects + + +-----------------------+-----------------------+---------------------------------------------------------------------+ + | Attribute | Type | Description | + +=======================+=======================+=====================================================================+ + | key | String | - Specifies the tag key. | + | | | - Cannot be left blank. | + | | | - Can contain a maximum of 36 characters. | + | | | - Can contain only the following character types: | + | | | | + | | | - Uppercase letters | + | | | - Lowercase letters | + | | | - Digits | + | | | - Special characters, including hyphens (-) and underscores (_) | + | | | | + | | | - The tag key of a VPC must be unique. | + +-----------------------+-----------------------+---------------------------------------------------------------------+ + | value | String | - Specifies the tag value. | + | | | - Can contain a maximum of 43 characters. | + | | | - Can contain only the following character types: | + | | | | + | | | - Uppercase letters | + | | | - Lowercase letters | + | | | - Digits | + | | | - Special characters, including hyphens (-) and underscores (_) | + +-----------------------+-----------------------+---------------------------------------------------------------------+ + +Example Response ---------------- -- Response parameter +.. code-block:: - .. table:: **Table 2** Response parameter - - +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=================================================================+=========================================================================================================+ - | tags | Array of :ref:`tag ` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 `. | - +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ - - .. _vpc_tag_0002__table13242848193719: - - .. table:: **Table 3** **tag** objects - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Attribute | Type | Description | - +=======================+=======================+=====================================================================+ - | key | String | - Specifies the tag key. | - | | | - Cannot be left blank. | - | | | - Can contain a maximum of 36 characters. | - | | | - Can contain only the following character types: | - | | | | - | | | - Uppercase letters | - | | | - Lowercase letters | - | | | - Digits | - | | | - Special characters, including hyphens (-) and underscores (_) | - | | | | - | | | - The tag key of a VPC must be unique. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | value | String | - Specifies the tag value. | - | | | - Can contain a maximum of 43 characters. | - | | | - Can contain only the following character types: | - | | | | - | | | - Uppercase letters | - | | | - Lowercase letters | - | | | - Digits | - | | | - Special characters, including hyphens (-) and underscores (_) | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -- Example response - - .. code-block:: - - { - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } + { + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value3" + } + ] + } Status Code ----------- diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst index f9d4f66..06f0ae4 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpc_tags_in_a_specified_project.rst @@ -27,23 +27,20 @@ GET /v2.0/{project_id}/vpcs/tags project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/v2.0/{project_id}/vpcs/tags -Response Message ----------------- - -Response parameter +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -82,7 +79,8 @@ Response parameter | | | - Special characters, including hyphens (-) and underscores (_) | +-----------------------+-----------------------+---------------------------------------------------------------------+ -Example response +Example Response +---------------- .. code-block:: diff --git a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst index 404a71f..7173414 100644 --- a/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst +++ b/api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst @@ -27,10 +27,8 @@ POST /v2.0/{project_id}/vpcs/resource_instances/action project_id Yes Specifies the project ID. ========== ========= ========================= -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -78,69 +76,70 @@ Request parameter | value | Yes | String | Specifies the tag value. Each value can contain a maximum of 255 Unicode characters. | +-------+-----------+--------+--------------------------------------------------------------------------------------+ -Example request 1: Setting **action** to **filter** +Example Request +--------------- -.. code-block:: text +- Filter VPCs by setting **action** to **filter**. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use **matches** and **tags** to filter VPCs. - POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action - Filter VPCs by setting action to filter. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use matches and tags to filter VPCs. - { - "offset": "0", - "limit": "100", - "action": "filter", - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ], - "tags": [ - { - "key": "key1", - "values": [ - "*value1", - "value2" - ] - } - ] - } + .. code-block:: text -Example request 2: Setting **action** to **count** + POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action -.. code-block:: text + { + "offset": "0", + "limit": "100", + "action": "filter", + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ], + "tags": [ + { + "key": "key1", + "values": [ + "*value1", + "value2" + ] + } + ] + } - POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action - Count VPCs by setting action to count. Use matches and tags to filter and count VPCs. - { - "action": "count", - "tags": [ - { - "key": "key1", - "values": [ - "value1", - "value2" - ] - }, - { - "key": "key2", - "values": [ - "value1", - "value2" - ] - } - ], - "matches": [ - { - "key": "resource_name", - "value": "resource1" - } - ] - } +- Count VPCs by setting **action** to **count**. Use **matches** and **tags** to filter and count VPCs. -Response Message ----------------- + .. code-block:: text -Response parameter + POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action + + { + "action": "count", + "tags": [ + { + "key": "key1", + "values": [ + "value1", + "value2" + ] + }, + { + "key": "key2", + "values": [ + "value1", + "value2" + ] + } + ], + "matches": [ + { + "key": "resource_name", + "value": "resource1" + } + ] + } + +Response Parameters +------------------- .. table:: **Table 5** Response parameter @@ -184,39 +183,42 @@ Response parameter | | | | Resources that match any value can be found. For example, if resource A has a tag value of **val1** and resource B has a tag value of **val2**, resources A and B can be found by using **values={val1,val2}**. | +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Example response 1: Setting **action** to **filter** +Example Response +---------------- -.. code-block:: +- When **action** is set to **filter**: - { - "resources": [ - { - "resource_detail": null, - "resource_id": "cdfs_cefs_wesas_12_dsad", - "resource_name": "resouece1", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value1" - } - ] - } - ], - "total_count": 1000 - } + .. code-block:: + + { + "resources": [ + { + "resource_detail": null, + "resource_id": "cdfs_cefs_wesas_12_dsad", + "resource_name": "resouece1", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value1" + } + ] + } + ], + "total_count": 1000 + } -Example response 2: Setting **action** to **count** +- When **action** is set to **count**: -.. code-block:: + .. code-block:: - { - "total_count": 1000 - } + { + "total_count": 1000 + } Status Code ----------- diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/pagination.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/pagination.rst index 05ba1d1..922544a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/pagination.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/api_version_information/pagination.rst @@ -20,10 +20,8 @@ Neutron APIs v2.0 provides the pagination function. You can set parameters **lim - Replace the value of **marker** in the original access request URL. Replace the value of **marker** to the value of **marker** in the value of **herf** if the value of **rel** in the response is **previous**. - Set the value of **page_reverse** to **True**. -Request Message ---------------- - -Request parameter +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -37,26 +35,30 @@ Request parameter | page_reverse | Boolean | No | Specifies the page direction. The value can be **True** or **False**. | +--------------+---------+-----------+--------------------------------------------------------------------------------------------------------------------------+ -Example request 1 +Example Request +--------------- + +- When **page_reverse** is set to **False**: .. code-block:: text GET https://{Endpoint}/v2.0/networks?limit=2&marker=3d42a0d4-a980-4613-ae76-a2cddecff054&page_reverse=False -Example request 2 +- When **page_reverse** is set to **True**: .. code-block:: text GET https://{Endpoint}/v2.0/vpc/peerings?limit=2&marker=e5a0c88e-228e-4e62-a8b0-90825b1b7958&page_reverse=True -Response Message ----------------- - -Response parameter +Response Parameters +------------------- None -Example response 1 +Example Response +---------------- + +- When **page_reverse** is set to **False**: .. code-block:: @@ -93,7 +95,7 @@ Example response 1 ] } -Example response 2 +- When **page_reverse** is set to **True**: .. code-block:: 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 9ce7c19..2e8ffcc 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 @@ -15,23 +15,20 @@ URI GET / -Request Message ---------------- - -Request parameter +Request Parameters +------------------ None -Example request +Example Request +--------------- .. code-block:: text GET https://{Endpoint}/ -Response Message ----------------- - -Response parameter +Response Parameters +------------------- .. table:: **Table 1** Response parameter @@ -71,7 +68,8 @@ Response parameter | rel | String | Specifies the relationship between the API link and the API version. | +-----------+--------+----------------------------------------------------------------------+ -Example response +Example Response +---------------- .. code-block:: 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 211d758..f07ae66 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 @@ -15,8 +15,8 @@ URI POST /v2.0/fwaas/firewall_groups -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -69,10 +69,12 @@ Request Message Example Request --------------- +Create an ACL group, associate it with the inbound ACL policy afc52ce9-5305-4ec9-9feb-44feb8330341, and set the port ID to c133f2bf-6937-4416-bb17-012e1be5cd2d. + .. code-block:: text POST https://{Endpoint}/v2.0/fwaas/firewall_groups - Create an ACL group, associate it with the inbound ACL policy afc52ce9-5305-4ec9-9feb-44feb8330341, and set the port ID to c133f2bf-6937-4416-bb17-012e1be5cd2d. + { "firewall_group": { "ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341", @@ -82,8 +84,8 @@ Example Request } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst index 450918e..39e4b5c 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst @@ -15,8 +15,8 @@ URI POST /v2.0/fwaas/firewall_policies -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -51,10 +51,12 @@ Request Message Example Request --------------- +Create an ACL policy named **test-policy** and associate it with the ACL rule whose ID is b8243448-cb3c-496e-851c-dadade4c161b. + .. code-block:: text POST https://{Endpoint}/v2.0/fwaas/firewall_policies - Create an ACL policy named test-policy and associate it with the ACL rule whose ID is b8243448-cb3c-496e-851c-dadade4c161b. + { "firewall_policy": { "name": "test-policy", @@ -64,8 +66,8 @@ Example Request } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst index c59f8b8..8a88cc2 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst @@ -15,8 +15,8 @@ URI POST /v2.0/fwaas/firewall_rules -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -73,10 +73,12 @@ Request Message Example Request --------------- +Create an ACL rule with **action** set to **allow**, **protocol** set to **tcp**, and destination port set to 80. + .. code-block:: text POST https://{Endpoint}/v2.0/fwaas/firewall_rules - Create an ACL rule with action set to allow, protocol set to tcp, and destination port set to 80. + { "firewall_rule": { "action": "allow", @@ -87,8 +89,8 @@ Example Request } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_group.rst index 6d29bb6..8dedadf 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_group.rst @@ -27,26 +27,25 @@ DELETE /v2.0/fwaas/firewall_groups/{firewall_group_id} | firewall_group_id | Yes | String | Specifies the firewall group ID, which uniquely identifies the firewall group. | +-------------------+-----------+--------+--------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/fwaas/firewall_groups/0415f554-26ed-44e7-a881-bdf4e6216e38 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_policy.rst index 8b170e9..b03a8dc 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_policy.rst @@ -27,26 +27,25 @@ DELETE /v2.0/fwaas/firewall_policies/{firewall_policy_id} | firewall_policy_id | Yes | String | Specifies the firewall policy ID, which uniquely identifies the firewall policy. | +--------------------+-----------+--------+----------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_rule.rst index 7425e19..f580495 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/deleting_a_firewall_rule.rst @@ -31,26 +31,25 @@ DELETE /v2.0/fwaas/firewall_rules/{firewall_rule_id} | firewall_rule_id | Yes | String | Specifies the firewall rule ID, which uniquely identifies the firewall rule. | +------------------+-----------+--------+------------------------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst index cf9181a..2f8a9c4 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst @@ -27,8 +27,8 @@ PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id}/insert_rule | firewall_policy_id | Yes | String | Specifies the firewall policy ID, which uniquely identifies the firewall policy. | +--------------------+-----------+--------+----------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -49,18 +49,20 @@ Request Message Example Request --------------- +Insert rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 below rule b8243448-cb3c-496e-851c-dadade4c161b in the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341. + .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule - Insert rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 below rule b8243448-cb3c-496e-851c-dadade4c161b in the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341. + { "insert_after": "b8243448-cb3c-496e-851c-dadade4c161b", "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1", "insert_before": "" } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst index cc81f65..5008274 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_group.rst @@ -27,8 +27,8 @@ GET /v2.0/fwaas/firewall_groups/{firewall_group_id} | firewall_group_id | Yes | String | Specifies the firewall group ID, which uniquely identifies the firewall group. The **fire_group_id** value is used as the filter. | +-------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -39,8 +39,8 @@ Example Request GET https://{Endpoint}/v2.0/fwaas/firewall_groups/a504a4cf-9300-40e0-b2d4-649bd157c55a -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst index 024bdc1..1e1a54b 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_policy.rst @@ -27,8 +27,8 @@ GET /v2.0/fwaas/firewall_policies/{firewall_policy_id} | firewall_policy_id | Yes | String | Specifies the firewall policy ID, which uniquely identifies the firewall policy. The **firewall_policy_id** value is used as the filter. | +--------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -39,8 +39,8 @@ Example Request GET https://{Endpoint}/v2.0/fwaas/firewall_policies/fed2d88f-d0e7-4cc5-bd7e-c495f67037b6 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst index dd879c7..fe33743 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/querying_a_firewall_rule.rst @@ -27,8 +27,8 @@ GET /v2.0/fwaas/firewall_rules/{firewall_rule_id} | firewall_rule_id | Yes | String | Specifies the firewall rule ID, which uniquely identifies the firewall rule. The **firewall_rule_id** value is used as the filter. | +------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -39,8 +39,8 @@ Example Request GET https://{Endpoint}/v2.0/fwaas/firewall_rules/514e6776-162a-4b5d-ab8b-aa36b86655ef -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter 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 5b1995b..c3e93c8 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 @@ -56,8 +56,8 @@ Example of querying groups by page | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -68,8 +68,8 @@ Example Request GET https://{Endpoint}/v2.0/fwaas/firewall_groups -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter 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 2c39ab8..5a22e6f 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 @@ -52,8 +52,8 @@ Example of querying policies by page | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -64,8 +64,8 @@ Example Request GET https://{Endpoint}/v2.0/fwaas/firewall_policies -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter 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 9d66890..f7208da 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 @@ -70,8 +70,8 @@ Example of querying rules by page | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -82,8 +82,8 @@ Example Request GET https://{Endpoint}/v2.0/fwaas/firewall_rules -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst index 2d41013..3cad3f7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id}/remove_rule -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -29,16 +29,18 @@ Request Message Example Request --------------- +Remove ACL rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 from the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341. + .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/remove_rule - Remove ACL rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 from the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341. + { "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst index de86d83..4c125ad 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/fwaas/firewall_groups/{firewall_group_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -69,18 +69,20 @@ Request Message Example Request --------------- +Associate the ACL group whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a with the outbound ACL policy 53f36c32-db25-4856-a0ba-e605fd88c5e9. + .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_groups/2fb0e81f-9f63-44b2-9894-c13a3284594a - Associate the ACL group whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a with the outbound ACL policy 53f36c32-db25-4856-a0ba-e605fd88c5e9. + { "firewall_group": { "egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9" } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst index 25de44a..8a4a074 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/fwaas/firewall_policies/{firewall_policy_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -51,10 +51,12 @@ Request Message Example Request --------------- +Associate the ACL policy whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a to the ACL rule whose ID is 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1. + .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a - Associate the ACL policy whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a to the ACL rule whose ID is 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1. + { "firewall_policy": { "firewall_rules": [ @@ -63,8 +65,8 @@ Example Request } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst index 2cb9701..060b39b 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/fwaas/firewall_rules/{firewall_rule_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -73,18 +73,20 @@ Request Message Example Request --------------- +Change the **action** of the ACL rule whose ID is b94acf06-efc2-485d-ba67-a61acf2a7e28 to **deny**. + .. code-block:: text PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28 - Change the action of the ACL rule whose ID is b94acf06-efc2-485d-ba67-a61acf2a7e28 to deny. + { "firewall_rule": { "action": "deny" } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst index 217c109..8a82344 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/creating_a_network.rst @@ -15,8 +15,8 @@ URI POST /v2.0/networks -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -53,10 +53,12 @@ Request Message Example Request --------------- +Create a network named **network-test**. + .. code-block:: text POST https://{Endpoint}/v2.0/networks - Create a network named network-test. + { "network": { "name": "network-test", @@ -65,8 +67,8 @@ Example Request } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/deleting_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/deleting_a_network.rst index 97cc5aa..3f513a7 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/deleting_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/deleting_a_network.rst @@ -27,26 +27,25 @@ DELETE /v2.0/networks/{network_id} network_id Yes Specifies the network ID. ========== ========= ========================= -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/networks/60c809cb-6731-45d0-ace8-3bf5626421a9 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst index affd0f4..d794922 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/querying_network_details.rst @@ -27,8 +27,8 @@ GET /v2.0/networks/{network_id} network_id Yes Specifies the network ID. ========== ========= ========================= -Request Message ---------------- +Request Parameters +------------------ None @@ -39,8 +39,8 @@ Example Request GET https://{Endpoint}/v2.0/networks/0133cd73-34d4-4d4c-bf1f-e65b24603206 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter 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 9a42709..f32c187 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 @@ -74,8 +74,8 @@ Example of querying ports by page | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -86,8 +86,8 @@ Example Request GET https://{Endpoint}/v2.0/networks?limit=1 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst index 37c3b3b..9a39c4a 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/network/updating_a_network.rst @@ -27,8 +27,8 @@ PUT /v2.0/networks/{network_id} network_id Yes Specifies the network ID. ========== ========= ========================= -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -61,18 +61,20 @@ Request Message Example Request --------------- +Change the name of the network whose ID is c360322d-5315-45d7-b7d2-481f98c56edb to **network-test02**. + .. code-block:: text PUT https://{Endpoint}/v2.0/networks/c360322d-5315-45d7-b7d2-481f98c56edb - Change the name of the network whose ID is c360322d-5315-45d7-b7d2-481f98c56edb to network-test02. + { "network": { "name": "network-test02" } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 4** Response parameter 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 788b08c..6d4990d 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 @@ -15,8 +15,8 @@ URI POST /v2.0/ports -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -135,10 +135,12 @@ Request Message Example Request --------------- +Create a port named **port-test** on network whose ID is 00ae08c5-f727-49ab-ad4b-b069398aa171. + .. code-block:: text POST https://{Endpoint}/v2.0/ports - Create a port named port-test on network whose ID is 00ae08c5-f727-49ab-ad4b-b069398aa171. + { "port": { "admin_state_up": true, @@ -147,8 +149,8 @@ Example Request } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 6** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst index 9aa1c55..9727ce3 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/deleting_a_port.rst @@ -32,26 +32,25 @@ DELETE /v2.0/ports/{port_id} | port_id | Yes | Specifies the port ID, which uniquely identifies the port. | +---------+-----------+------------------------------------------------------------+ -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/ports/2b098395-046a-4071-b009-312bcee665cb -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst index b89ec94..9410df0 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst @@ -27,8 +27,8 @@ GET /v2.0/ports/{port_id} | port_id | Yes | Specifies the port ID, which uniquely identifies the port. | +---------+-----------+------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -39,8 +39,8 @@ Example Request GET https://{Endpoint}/v2.0/ports/791870bd-36a7-4d9b-b015-a78e9b06af08 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst index d9fdc4f..8785d31 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst @@ -84,37 +84,37 @@ None Example Request --------------- -[Example 1] +Example 1 .. code-block:: text GET https://{Endpoint}/v2.0/ports?limit=1 -[Example 2] +Example 2 .. code-block:: text GET https://{Endpoint}/v2.0/ports?mac_address=fa:16:3e:f1:0b:09 -[Example 3] +Example 3 .. code-block:: text GET https://{Endpoint}/v2.0/ports?admin_state_up=False -[Example 4] +Example 4 .. code-block:: text GET https://{Endpoint}/v2.0/ports?device_id=e6c05704-c907-4cc1-8106-69b0996c43b9 -[Example 5] +Example 5 .. code-block:: text GET https://{Endpoint}/v2.0/ports?tenant_id=6c9298ec8c874f7f99688489ab65f90e&name=port_vm_50_3 -[Example 6] +Example 6 .. code-block:: text @@ -329,7 +329,7 @@ Response Parameter Example Response ---------------- -[Example 1] +Example 1 .. code-block:: @@ -367,7 +367,7 @@ Example Response ] } -[Example 2] +Example 2 .. code-block:: @@ -416,7 +416,7 @@ Example Response ] } -[Example 3] +Example 3 .. code-block:: @@ -459,7 +459,7 @@ Example Response ] } -[Example 4] +Example 4 .. code-block:: @@ -508,7 +508,7 @@ Example Response ] } -[Example 5] +Example 5 .. code-block:: @@ -557,7 +557,7 @@ Example Response ] } -[Example 6] +Example 6 .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst index 6aa8c2e..a0f256e 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/port/updating_a_port.rst @@ -27,8 +27,8 @@ PUT /v2.0/ports/{port_id} | port_id | Yes | Specifies the port ID, which uniquely identifies the port. | +---------+-----------+------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 2** Request parameter @@ -122,18 +122,20 @@ Request Message Example Request --------------- +Change the name of the port whose ID is 7a9a954a-eb41-4954-a300-11ab17a361a2 to **port-test02**. + .. code-block:: text PUT https://{Endpoint}/v2.0/ports/7a9a954a-eb41-4954-a300-11ab17a361a2 - Change the name of the port whose ID is 7a9a954a-eb41-4954-a300-11ab17a361a2 to port-test02. + { "port": { "name": "port-test02" } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 6** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst index 3d5c9ec..699ab10 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst @@ -22,8 +22,8 @@ URI PUT /v2.0/routers/{router_id}/add_router_interface -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -40,14 +40,16 @@ Request Message Example Request --------------- +Add an interface to the router. The router ID is i5b8e885c-1347-4ac2-baf9-2249c8ed1270, and the subnet ID is ab78be2d-782f-42a5-aa72-35879f6890ff. + .. code-block:: text PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface - Add an interface to the router. The router ID is i5b8e885c-1347-4ac2-baf9-2249c8ed1270, and the subnet ID is ab78be2d-782f-42a5-aa72-35879f6890ff. + {"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"} -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst index 9b18d44..3baef80 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst @@ -15,8 +15,8 @@ URI POST /v2.0/routers -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -65,10 +65,12 @@ Request Message Example Request --------------- +Create a router named **router-test2**. + .. code-block:: text POST https://{Endpoint}/v2.0/routers - Create a router named router-test2. + { "router": { "name": "router-test2", @@ -76,8 +78,8 @@ Example Request } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 4** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/deleting_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/deleting_a_router.rst index 3061a1b..f614490 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/deleting_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/deleting_a_router.rst @@ -15,26 +15,25 @@ URI DELETE /v2.0/routers/{router_id} -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/routers/0735a367-2caf-48fb-85aa-6082266f342e -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst index 40a634c..5b80697 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_a_router.rst @@ -15,8 +15,8 @@ URI GET /v2.0/routers/{router_id} -Request Message ---------------- +Request Parameters +------------------ None @@ -27,8 +27,8 @@ Example Request GET https://{Endpoint}/v2.0/routers/01ab4be1-4447-45fb-94be-3ee787ed4ebe -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 1** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst index ea0530e..9830afb 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/querying_routers.rst @@ -62,8 +62,8 @@ Example of querying routers by page | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -74,8 +74,8 @@ Example Request GET https://{Endpoint}/v2.0/routers?limit=1 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst index b115704..ad13202 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst @@ -19,8 +19,8 @@ URI PUT /v2.0/routers/{router_id}/remove_router_interface -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -37,14 +37,16 @@ Request Message Example Request --------------- +Remove an interface from a router. The router ID is b625c58c-0cfe-49e0-acc8-f2374f8187ff, and the subnet ID is 4b910a10-0860-428b-b463-d84dbc5e288e. + .. code-block:: text PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface - Remove an interface from a router. The router ID is b625c58c-0cfe-49e0-acc8-f2374f8187ff, and the subnet ID is 4b910a10-0860-428b-b463-d84dbc5e288e. + {"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"} -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst index 98ad77f..e1c350c 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/routers/{router_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -85,18 +85,20 @@ Request Message Example Request --------------- +Change the name of the router whose ID is f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 to **router-220**. + .. code-block:: text PUT https://{Endpoint}/v2.0/routers/f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 - Change the name of the router whose ID is f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 to router-220. + { "router": { "name": "router-220" } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 5** Response parameter 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 381d10d..7f6f260 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 @@ -15,8 +15,8 @@ URI POST /v2.0/security-groups -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -41,18 +41,20 @@ Request Message Example Request --------------- +Create a security group named **sg-test**. + .. code-block:: text POST https://{Endpoint}/v2.0/security-groups - Create a security group named sg-test. + { "security_group": { "name": "sg-test" } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter 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 1f59995..f1eea33 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 @@ -15,8 +15,8 @@ URI POST /v2.0/security-group-rules -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -76,10 +76,12 @@ Request Message Example Request --------------- +Create an outbound rule in the security group whose ID is 5cb9c1ee-00e0-4d0f-9623-55463cd26ff8. Set **protocol** to **tcp**, and **remote_ip_prefix** to 10.10.0.0/24. + .. code-block:: text POST https://{Endpoint}/v2.0/security-group-rules - Create an outbound rule in the security group whose ID is 5cb9c1ee-00e0-4d0f-9623-55463cd26ff8. Set protocol to tcp, and remote IP address to 10.10.0.0/24. + { "security_group_rule": { "security_group_id": "5cb9c1ee-00e0-4d0f-9623-55463cd26ff8", @@ -89,8 +91,8 @@ Example Request } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group.rst index cfd8108..06f9769 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group.rst @@ -15,26 +15,25 @@ URI DELETE /v2.0/security-groups/{security_group_id} -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/security-groups/a7ebb1d8-71e5-42e5-9030-4e0fca059d50 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group_rule.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group_rule.rst index 354d539..b612b63 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group_rule.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/deleting_a_security_group_rule.rst @@ -15,26 +15,25 @@ URI DELETE /v2.0/security-group-rules/{security_group_rule_id} -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/security-group-rules/07adc044-3f21-4eeb-bd57-5e5eb6024b7f -Example response +Example Response +---------------- None 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 fbc514a..fe06eac 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 @@ -15,8 +15,8 @@ URI GET /v2.0/security-groups/{security_group_id} -Request Message ---------------- +Request Parameters +------------------ None @@ -27,8 +27,8 @@ Example Request GET https://{Endpoint}/v2.0/security-groups/0431c9c5-1660-42e0-8a00-134bec7f03e2 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 1** Response parameter 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 33f881f..99e7fbc 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 @@ -15,8 +15,8 @@ URI GET /v2.0/security-group-rules/{security_group_rule_id} -Request Message ---------------- +Request Parameters +------------------ None @@ -27,8 +27,8 @@ Example Request GET https://{Endpoint}/v2.0/security-group-rules/1755bc80-cf3a-4f57-8ae9-d9796482ddc0 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 1** Response parameter 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 3f52f4a..48dde4b 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 @@ -72,8 +72,8 @@ Example of querying security group rules by page | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -84,8 +84,8 @@ Example Request GET https://{Endpoint}/v2.0/security-group-rules -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter 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 e420ff5..4467a24 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/querying_security_groups.rst @@ -52,8 +52,8 @@ Example of querying security groups by page | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None @@ -64,8 +64,8 @@ Example Request GET https://{Endpoint}/v2.0/security-groups?limit=1 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter 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 6143d0b..8553b07 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst @@ -15,8 +15,8 @@ URI PUT /v2.0/security-groups/{security_group_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -43,18 +43,20 @@ Request Message Example Request --------------- +Change the name of the security group whose ID is d29ae17d-f355-4992-8747-1fb66cc9afd2 to **sg-test02**. + .. code-block:: text PUT https://{Endpoint}/v2.0/security-groups/d29ae17d-f355-4992-8747-1fb66cc9afd2 - Change the name of the security group whose ID is d29ae17d-f355-4992-8747-1fb66cc9afd2 to sg-test02. + { "security_group": { "name": "sg-test02" } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 3** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst index 78b8a05..01774d1 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst @@ -15,8 +15,8 @@ URI POST /v2.0/subnets -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -103,10 +103,12 @@ Request Message Example Request --------------- +Create a subnet named **subnet-test**, set its network ID to 0133cd73-34d4-4d4c-bf1f-e65b24603206, and CIDR block to 172.16.2.0/24. + .. code-block:: text POST https://{Endpoint}/v2.0/subnets - Create a subnet named subnet-test, set its network ID to 0133cd73-34d4-4d4c-bf1f-e65b24603206, and CIDR block to 172.16.2.0/24. + { "subnet": { "name": "subnet-test", @@ -116,8 +118,8 @@ Example Request } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 5** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/deleting_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/deleting_a_subnet.rst index 1a09dbe..56a8617 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/deleting_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/deleting_a_subnet.rst @@ -15,26 +15,25 @@ URI DELETE /v2.0/subnets/{subnet_id} -Request Message +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +None + +Example Request --------------- -None - -Response Message ----------------- - -None - -Example: --------- - -Example request - .. code-block:: text DELETE https://{Endpoint}/v2.0/subnets/74259164-e63a-4ad9-9c77-a1bd2c9aa187 -Example response +Example Response +---------------- None diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst index 027160a..592ce21 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst @@ -15,8 +15,8 @@ URI GET /v2.0/subnets/{subnet_id} -Request Message ---------------- +Request Parameters +------------------ None @@ -27,8 +27,8 @@ Example Request GET https://{Endpoint}/v2.0/subnets/011fc878-5521-4654-a1ad-f5b0b5820302 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 1** Response parameter diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst index 023ae6d..ec1bdbc 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst @@ -68,28 +68,28 @@ Example of querying networks by page | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -Request Message ---------------- +Request Parameters +------------------ None Example Request --------------- -[Example 1] +Example 1 .. code-block:: text GET https://{Endpoint}/v2.0/subnets?limit=1 -[Example 2] +Example 2 .. code-block:: text GET https://{Endpoint}/v2.0/subnets?id=011fc878-5521-4654-a1ad-f5b0b5820322 -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 2** Response parameter @@ -202,7 +202,7 @@ Response Message Example Response ---------------- -[Example 1] +Example 1 .. code-block:: @@ -241,7 +241,7 @@ Example Response ] } -[Example 2] +Example 2 .. code-block:: diff --git a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst index b03e605..97c1147 100644 --- a/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst +++ b/api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst @@ -19,8 +19,8 @@ URI PUT /v2.0/subnets/{subnet_id} -Request Message ---------------- +Request Parameters +------------------ .. table:: **Table 1** Request parameter @@ -93,18 +93,19 @@ Request Message Example Request --------------- +Change the name of the subnet whose ID is 98bac90c-0ba7-4a63-8995-097da9bead1c to **subnet-test**. + .. code-block:: text PUT https://{Endpoint}/v2.0/subnets/98bac90c-0ba7-4a63-8995-097da9bead1c - Change the name of the subnet whose ID is 98bac90c-0ba7-4a63-8995-097da9bead1c to subnet-test. { "subnet": { "name": "subnet-test" } } -Response Message ----------------- +Response Parameters +------------------- .. table:: **Table 5** Response parameter