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

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2023-07-07 03:49:20 +00:00
parent 8899eb38e5
commit 1f49ae13ed
105 changed files with 4349 additions and 4373 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -95,6 +95,8 @@ Response Message
| | | - **ERROR** (Exceptions) |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| profile | :ref:`profile <vpc_eip_0002__table66651219193417>` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 4 <vpc_eip_0002__table66651219193417>`. |
| | | |
| | | 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**. |

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

@ -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 <vpc_eip_0003__table66651219193417>`. |
| | | |
| | | 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**. |

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

@ -121,6 +121,8 @@ Response Message
| | | - **ERROR** (Exceptions) |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| profile | :ref:`profile <vpc_eip_0004__table66651219193417>` object | Specifies the additional parameters, including the order ID and product ID. For details, see :ref:`Table 6 <vpc_eip_0004__table66651219193417>`. |
| | | |
| | | 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**. |

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

@ -27,12 +27,10 @@ POST /v1/{project_id}/privateips
project_id Yes Specifies the project ID.
========== ========= =========================
Request Message
---------------
Request Parameters
------------------
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request parameter
+------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -40,9 +38,9 @@ Request Message
| privateips | Yes | Array of :ref:`privateip <vpc_privateip_0001__table45335391>` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 <vpc_privateip_0001__table45335391>`. |
+------------+-----------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. _vpc_privateip_0001__table45335391:
.. _vpc_privateip_0001__table45335391:
.. table:: **Table 3** Description of the **privateip** field
.. table:: **Table 3** Description of the **privateip** field
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -55,12 +53,15 @@ Request Message
| | | | - 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
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,12 +75,10 @@ Request Message
]
}
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 4** Response parameter
.. table:: **Table 4** Response parameter
+------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -87,9 +86,9 @@ Response Message
| privateips | Array of :ref:`privateip <vpc_privateip_0001__table34571880>` objects | Specifies the private IP address objects. For details, see :ref:`Table 5 <vpc_privateip_0001__table34571880>`. |
+------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. _vpc_privateip_0001__table34571880:
.. _vpc_privateip_0001__table34571880:
.. table:: **Table 5** Description of the **privateip** field
.. table:: **Table 5** Description of the **privateip** field
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -133,9 +132,10 @@ Response Message
| ip_address | String | Specifies the assigned private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"privateips": [

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

@ -29,29 +29,27 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Response Message
Response Parameters
-------------------
None
Example Response
----------------
- Request parameter
None
- Example response
.. code-block:: text
.. code-block:: text
None

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

@ -29,25 +29,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78
Response
--------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -55,9 +52,9 @@ Response
| privateip | :ref:`privateip <vpc_privateip_0002__table23250319>` object | Specifies the private IP address objects. For details, see :ref:`Table 3 <vpc_privateip_0002__table23250319>`. |
+-----------+-------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. _vpc_privateip_0002__table23250319:
.. _vpc_privateip_0002__table23250319:
.. table:: **Table 3** Description of the **privateip** field
.. table:: **Table 3** Description of the **privateip** field
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -101,9 +98,10 @@ Response
| ip_address | String | Specifies the assigned private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"privateip":

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

@ -50,25 +50,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips
Response Message
----------------
Response Parameters
-------------------
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request parameter
+------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -76,9 +73,9 @@ Response Message
| privateips | Array of :ref:`privateip <vpc_privateip_0003__table21538022>` objects | Specifies the private IP address objects. For details, see :ref:`Table 3 <vpc_privateip_0003__table21538022>`. |
+------------+-----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. _vpc_privateip_0003__table21538022:
.. _vpc_privateip_0003__table21538022:
.. table:: **Table 3** Description of the **privateip** field
.. table:: **Table 3** Description of the **privateip** field
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -122,9 +119,10 @@ Response Message
| ip_address | String | Specifies the assigned private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"privateips": [

36
api-ref/source/apis/querying_ip_address_usage/querying_ip_address_usage_on_a_specified_network.rst
View File

@ -35,25 +35,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -61,9 +58,9 @@ Response Message
| network_ip_availability | :ref:`network_ip_availability <vpc_natworkip_0001__table4952133061113>` object | Specifies the **network_ip_availability** objects. For details, see :ref:`Table 3 <vpc_natworkip_0001__table4952133061113>`. |
+-------------------------+--------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_natworkip_0001__table4952133061113:
.. _vpc_natworkip_0001__table4952133061113:
.. table:: **Table 3** **network_ip_availability** objects
.. table:: **Table 3** **network_ip_availability** objects
+------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -81,9 +78,9 @@ Response Message
| subnet_ip_availability | Array of :ref:`subnet_ip_availability <vpc_natworkip_0001__table110015141519>` objects | Specifies the subnet IP address usage objects. For details, see :ref:`Table 4 <vpc_natworkip_0001__table110015141519>`. |
+------------------------+----------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
.. _vpc_natworkip_0001__table110015141519:
.. _vpc_natworkip_0001__table110015141519:
.. table:: **Table 4** Description of the **subnet_ip_availability** field
.. table:: **Table 4** Description of the **subnet_ip_availability** field
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
@ -103,9 +100,10 @@ Response Message
| total_ips | Integer | Specifies the total number of IP addresses on a subnet. (System reserved IP addresses are not included.) |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"network_ip_availability": {

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

@ -54,25 +54,22 @@ Example:
| | | | - **routetableContainRoutes**: Number of routes in a route table |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------+
Request Message
Request Parameters
------------------
None
Example Request
---------------
- Request parameter
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/quotas
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -80,9 +77,9 @@ Response Message
| quotas | :ref:`quotas <vpc_quota_0001__table11308015155544>` object | Specifies the quota object. For details, see :ref:`Table 3 <vpc_quota_0001__table11308015155544>`. |
+--------+------------------------------------------------------------+----------------------------------------------------------------------------------------------------+
.. _vpc_quota_0001__table11308015155544:
.. _vpc_quota_0001__table11308015155544:
.. table:: **Table 3** Description of the **quotas** field
.. table:: **Table 3** Description of the **quotas** field
+-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -90,9 +87,9 @@ Response Message
| resources | Array of :ref:`resource <vpc_quota_0001__table8208684>` objects | Specifies the resource objects. For details, see :ref:`Table 4 <vpc_quota_0001__table8208684>`. |
+-----------+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------+
.. _vpc_quota_0001__table8208684:
.. _vpc_quota_0001__table8208684:
.. table:: **Table 4** Description of the **resource** field
.. table:: **Table 4** Description of the **resource** field
+-----------------------+-----------------------+------------------------------------------------------------------------------+
| Name | Type | Description |
@ -127,13 +124,14 @@ Response Message
| min | Integer | Specifies the minimum quota value allowed. |
+-----------------------+-----------------------+------------------------------------------------------------------------------+
.. note::
.. 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
Example Response
----------------
.. code-block::
.. code-block::
{
"quotas": {

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

@ -27,12 +27,10 @@ POST /v1/{project_id}/security-groups
project_id Yes Specifies the project ID.
========== ========= =========================
Request Message
---------------
Request Parameters
------------------
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request parameter
+----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -40,9 +38,9 @@ Request Message
| security_group | Yes | :ref:`security_group <vpc_sg01_0001__table495783939489>` object | Specifies the security group objects. For details, see :ref:`Table 3 <vpc_sg01_0001__table495783939489>`. |
+----------------+-----------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0001__table495783939489:
.. _vpc_sg01_0001__table495783939489:
.. table:: **Table 3** Description of **security_group** fields
.. table:: **Table 3** Description of **security_group** fields
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -66,12 +64,15 @@ Request Message
| | | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request
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,12 +81,10 @@ Request Message
}
}
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 4** Response parameter
.. table:: **Table 4** Response parameter
+----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -93,9 +92,9 @@ Response Message
| security_group | :ref:`security_group <vpc_sg01_0001__table661472489489>` object | Specifies the security group objects. For details, see :ref:`Table 5 <vpc_sg01_0001__table661472489489>`. |
+----------------+-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0001__table661472489489:
.. _vpc_sg01_0001__table661472489489:
.. table:: **Table 5** Description of **security_group** fields
.. table:: **Table 5** Description of **security_group** fields
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -124,9 +123,9 @@ Response Message
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0001__table210704979489:
.. _vpc_sg01_0001__table210704979489:
.. table:: **Table 6** **security_group_rule** objects
.. table:: **Table 6** **security_group_rule** objects
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -172,9 +171,10 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"security_group": {

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

@ -15,12 +15,10 @@ URI
POST /v1/{project_id}/security-group-rules
Request Message
---------------
Request Parameters
------------------
- Request parameter
.. table:: **Table 1** Request parameter
.. table:: **Table 1** Request parameter
+---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -28,9 +26,9 @@ Request Message
| security_group_rule | Yes | :ref:`security_group_rule <vpc_sg01_0005__table40497645103533>` object | Specifies the security group rule objects. For details, see :ref:`Table 2 <vpc_sg01_0005__table40497645103533>`. |
+---------------------+-----------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0005__table40497645103533:
.. _vpc_sg01_0005__table40497645103533:
.. table:: **Table 2** Description of the **security_group_rule** field
.. table:: **Table 2** Description of the **security_group_rule** field
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -40,7 +38,8 @@ Request Message
| 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: |
| direction | Yes | String | - Access control direction specified in a security group rule. |
| | | | - The value can be: |
| | | | |
| | | | - **egress** |
| | | | - **ingress** |
@ -72,12 +71,15 @@ Request Message
| | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request
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,12 +93,10 @@ Request Message
}
}
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 3** Response parameter
.. table:: **Table 3** Response parameter
+---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -104,9 +104,9 @@ Response Message
| security_group_rule | :ref:`security_group_rule <vpc_sg01_0005__table488727239520>` object | Specifies the security group rule objects. For details, see :ref:`Table 4 <vpc_sg01_0005__table488727239520>`. |
+---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0005__table488727239520:
.. _vpc_sg01_0005__table488727239520:
.. table:: **Table 4** **security_group_rule** objects
.. table:: **Table 4** **security_group_rule** objects
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -152,9 +152,10 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"security_group_rule": {

30
api-ref/source/apis/security_group/deleting_a_security_group.rst
View File

@ -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
None
- Example request
.. code-block:: text
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/security-groups/0c4a2336-b036-4fa2-bc3c-1a291ed4c431
Response Message
Response Parameters
-------------------
None
Example Response
----------------
- Response parameter
None
- Example response
None
None
Status Code
-----------

30
api-ref/source/apis/security_group/deleting_a_security_group_rule.rst
View File

@ -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
None
- Example request
.. code-block:: text
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62
Response Message
Response Parameters
-------------------
None
Example Response
----------------
- Response parameter
None
- Example response
None
None
Status Code
-----------

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

@ -29,25 +29,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/security-groups/16b6e77a-08fa-42c7-aa8b-106c048884e6
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+----------------+-----------------------------------------------------------------+--------------------------------------+
| Name | Type | Description |
@ -55,9 +52,9 @@ Response Message
| security_group | :ref:`security_group <vpc_sg01_0002__table333218689520>` object | Specifies the security group object. |
+----------------+-----------------------------------------------------------------+--------------------------------------+
.. _vpc_sg01_0002__table333218689520:
.. _vpc_sg01_0002__table333218689520:
.. table:: **Table 3** Description of **security_group** fields
.. table:: **Table 3** Description of **security_group** fields
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -86,9 +83,9 @@ Response Message
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0002__table488727239520:
.. _vpc_sg01_0002__table488727239520:
.. table:: **Table 4** **security_group_rule** objects
.. table:: **Table 4** **security_group_rule** objects
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -134,9 +131,10 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"security_group": {

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

@ -29,25 +29,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -55,9 +52,9 @@ Response Message
| security_group_rule | :ref:`security_group_rule <vpc_sg01_0006__table488727239520>` object | Specifies the security group rule objects. For details, see :ref:`Table 3 <vpc_sg01_0006__table488727239520>`. |
+---------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0006__table488727239520:
.. _vpc_sg01_0006__table488727239520:
.. table:: **Table 3** **security_group_rule** objects
.. table:: **Table 3** **security_group_rule** objects
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -103,9 +100,10 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"security_group_rule": {

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

@ -48,33 +48,30 @@ Example:
| security_group_id | No | String | Specifies the security group ID. |
+-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message
Request Parameters
------------------
None
Example Request
---------------
- Request parameter
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/security-group-rules
Response Message
----------------
Response Parameters
-------------------
- Response parameter
+----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+======================+================================================================================+================================================================================================================+
| security_group_rules | Array of :ref:`security_group_rule <vpc_sg01_0007__table488727239520>` objects | Specifies the security group rule objects. For details, see :ref:`Table 2 <vpc_sg01_0007__table488727239520>`. |
+----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
+----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+======================+================================================================================+================================================================================================================+
| security_group_rules | Array of :ref:`security_group_rule <vpc_sg01_0007__table488727239520>` objects | Specifies the security group rule objects. For details, see :ref:`Table 2 <vpc_sg01_0007__table488727239520>`. |
+----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0007__table488727239520:
.. _vpc_sg01_0007__table488727239520:
.. table:: **Table 2** **security_group_rule** objects
.. table:: **Table 2** **security_group_rule** objects
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -120,9 +117,10 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"security_group_rules": [

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

@ -58,25 +58,22 @@ Example:
| | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message
Request Parameters
------------------
None
Example Request
---------------
- Request parameter
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/security-groups
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -84,9 +81,9 @@ Response Message
| security_groups | Array of :ref:`security_group <vpc_sg01_0003__table333218689520>` objects | Specifies the security group objects. For details, see :ref:`Table 3 <vpc_sg01_0003__table333218689520>`. |
+-----------------+---------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0003__table333218689520:
.. _vpc_sg01_0003__table333218689520:
.. table:: **Table 3** Description of **security_group** fields
.. table:: **Table 3** Description of **security_group** fields
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -115,9 +112,9 @@ Response Message
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_sg01_0003__table488727239520:
.. _vpc_sg01_0003__table488727239520:
.. table:: **Table 4** **security_group_rule** objects
.. table:: **Table 4** **security_group_rule** objects
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -163,9 +160,10 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"security_groups": [

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

File diff suppressed because it is too large Load Diff

30
api-ref/source/apis/subnet/deleting_a_subnet.rst
View File

@ -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
None
- Example request
.. code-block:: text
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Response Message
Response Parameters
-------------------
None
Example Response
----------------
- Response parameter
None
- Example response
None
None
Status Code
-----------

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

@ -31,25 +31,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+--------+--------------------------------------------------------------+------------------------------------------------------------------------------+
| Name | Type | Description |
@ -57,9 +54,9 @@ Response Message
| subnet | :ref:`subnet <vpc_subnet01_0002__table6614597017585>` object | Specifies the :ref:`subnet objects <vpc_subnet01_0002__table6614597017585>`. |
+--------+--------------------------------------------------------------+------------------------------------------------------------------------------+
.. _vpc_subnet01_0002__table6614597017585:
.. _vpc_subnet01_0002__table6614597017585:
.. table:: **Table 3** **subnet** objects
.. table:: **Table 3** **subnet** objects
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -102,9 +99,9 @@ Response Message
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0002__table019517383270>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0002__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0002__table019517383270:
.. _vpc_subnet01_0002__table019517383270:
.. table:: **Table 4** **extra_dhcp_opt** object
.. table:: **Table 4** **extra_dhcp_opt** object
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -121,9 +118,10 @@ Response Message
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"subnet": {

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

@ -46,25 +46,22 @@ Example:
| | | | This field is mandatory in the fine-grained authorization scenario based on enterprise projects. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message
Request Parameters
------------------
None
Example Request
---------------
- Request parameter
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/subnets
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+---------+-----------------------------------------------------------------------+------------------------+
| Name | Type | Description |
@ -72,9 +69,9 @@ Response Message
| subnets | Array of :ref:`subnet <vpc_subnet01_0003__table946390317596>` objects | Specifies the subnets. |
+---------+-----------------------------------------------------------------------+------------------------+
.. _vpc_subnet01_0003__table946390317596:
.. _vpc_subnet01_0003__table946390317596:
.. table:: **Table 3** **subnet** objects
.. table:: **Table 3** **subnet** objects
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -117,9 +114,9 @@ Response Message
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0003__table019517383270>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0003__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0003__table019517383270:
.. _vpc_subnet01_0003__table019517383270:
.. table:: **Table 4** **extra_dhcp_opt** object
.. table:: **Table 4** **extra_dhcp_opt** object
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -136,9 +133,10 @@ Response Message
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"subnets": [

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

@ -33,12 +33,10 @@ 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
------------------
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request parameter
+--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -46,9 +44,9 @@ Request Message
| subnet | Yes | :ref:`subnet <vpc_subnet01_0004__table45027976>` object | Specifies the :ref:`subnet objects <vpc_subnet01_0004__table45027976>`. |
+--------+-----------+---------------------------------------------------------+-------------------------------------------------------------------------+
.. _vpc_subnet01_0004__table45027976:
.. _vpc_subnet01_0004__table45027976:
.. table:: **Table 3** **subnet** objects
.. table:: **Table 3** **subnet** objects
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -75,9 +73,9 @@ Request Message
| extra_dhcp_opts | No | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0004__table019517383270>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0004__table019517383270>`. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0004__table019517383270:
.. _vpc_subnet01_0004__table019517383270:
.. table:: **Table 4** **extra_dhcp_opt** object
.. table:: **Table 4** **extra_dhcp_opt** object
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -94,12 +92,15 @@ Request Message
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request
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,12 +121,10 @@ Request Message
}
}
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 5** Response parameter
.. table:: **Table 5** Response parameter
+--------+--------------------------------------------------------+-----------------------------------+
| Name | Type | Description |
@ -133,9 +132,9 @@ Response Message
| subnet | :ref:`subnet <vpc_subnet01_0004__table1210700>` object | Specifies the **subnet** objects. |
+--------+--------------------------------------------------------+-----------------------------------+
.. _vpc_subnet01_0004__table1210700:
.. _vpc_subnet01_0004__table1210700:
.. table:: **Table 6** **subnet** objects
.. table:: **Table 6** **subnet** objects
+-----------------------+-----------------------+----------------------------------------------------------------------------------+
| Name | Type | Description |
@ -150,9 +149,10 @@ Response Message
| | | - **ERROR**: indicates that the subnet is abnormal. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"subnet": {

30
api-ref/source/apis/subnet_tag_management/batch_creating_or_deleting_subnet_tags.rst
View File

@ -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,12 +84,15 @@ 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.
.. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action
Create two tags for a subnet.
{
"action": "create",
"tags": [
@ -106,12 +107,12 @@ Request example 1: Creating tags in batches
]
}
Request example 2: Deleting tags in batches
- Batch delete two tags for a subnet.
.. code-block:: text
.. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/action
Delete two tags for a subnet.
{
"action": "delete",
"tags": [
@ -126,14 +127,13 @@ Request example 2: Deleting tags in batches
]
}
Response Message
----------------
Response parameter
Response Parameters
-------------------
None
Example response
Example Response
----------------
None

28
api-ref/source/apis/subnet_tag_management/creating_a_tag_for_a_subnet.rst
View File

@ -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
-----------

18
api-ref/source/apis/subnet_tag_management/deleting_a_subnet_tag.rst
View File

@ -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

18
api-ref/source/apis/subnet_tag_management/querying_subnet_tags.rst
View File

@ -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::

18
api-ref/source/apis/subnet_tag_management/querying_subnet_tags_in_a_specified_project.rst
View File

@ -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::

38
api-ref/source/apis/subnet_tag_management/querying_subnets_by_tag.rst
View File

@ -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,12 +72,15 @@ 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.
.. code-block:: text
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",
@ -101,12 +102,12 @@ Example request 1: Setting **action** to **filter**
]
}
Example request 2: Setting **action** to **count**
- Count subnets by setting **action** to **count**. Use **matches** and **tags** to filter and count VPCs.
.. code-block:: text
.. code-block:: text
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": [
@ -133,10 +134,8 @@ Example request 2: Setting **action** to **count**
]
}
Response Message
----------------
Response parameter
Response Parameters
-------------------
.. table:: **Table 5** Response parameter
@ -176,9 +175,12 @@ 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**:
.. code-block::
{
"resources": [
@ -202,9 +204,9 @@ Example response 1: Setting **action** to **filter**
}
Example response 2: Setting **action** to **count**
- When **action** is set to **count**:
.. code-block::
.. code-block::
{
"total_count": 1000

40
api-ref/source/apis/virtual_private_cloud/creating_a_vpc.rst
View File

@ -27,12 +27,10 @@ POST /v1/{project_id}/vpcs
project_id Yes Specifies the project ID.
========== ========= =========================
Request Message
---------------
Request Parameters
------------------
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request parameter
+------+-----------+---------------------------------------------------+-------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -40,9 +38,9 @@ Request Message
| vpc | Yes | :ref:`vpc <vpc_api01_0001__table33750194>` object | :ref:`Specifies the VPC objects. <vpc_api01_0001__table33750194>` |
+------+-----------+---------------------------------------------------+-------------------------------------------------------------------+
.. _vpc_api01_0001__table33750194:
.. _vpc_api01_0001__table33750194:
.. table:: **Table 3** VPC objects
.. table:: **Table 3** VPC objects
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -72,12 +70,15 @@ Request Message
| | | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request
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,12 +88,10 @@ Request Message
}
}
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 4** Response parameter
.. table:: **Table 4** Response parameter
+------+---------------------------------------------------+-------------------------------------------------------------------+
| Name | Type | Description |
@ -100,9 +99,9 @@ Response Message
| vpc | :ref:`vpc <vpc_api01_0001__table39714111>` object | :ref:`Specifies the VPC objects. <vpc_api01_0001__table39714111>` |
+------+---------------------------------------------------+-------------------------------------------------------------------+
.. _vpc_api01_0001__table39714111:
.. _vpc_api01_0001__table39714111:
.. table:: **Table 5** VPC objects
.. table:: **Table 5** VPC objects
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -145,9 +144,9 @@ Response Message
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_api01_0001__table3576833291556:
.. _vpc_api01_0001__table3576833291556:
.. table:: **Table 6** **route** objects
.. table:: **Table 6** **route** objects
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -159,9 +158,10 @@ Response Message
| | | - 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
Example Response
----------------
.. code-block::
.. code-block::
{
"vpc":

30
api-ref/source/apis/virtual_private_cloud/deleting_a_vpc.rst
View File

@ -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
None
- Example request
.. code-block:: text
.. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/vpcs/13551d6b-755d-4757-b956-536f674975c0
Response Message
Response Parameters
-------------------
None
Example Response
----------------
- Response parameter
None
- Example response
None
None
Status Code
-----------

36
api-ref/source/apis/virtual_private_cloud/querying_vpc_details.rst
View File

@ -29,25 +29,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+------+--------------------------------------------------------+------------------------------------------------------------------------+
| Name | Type | Description |
@ -55,9 +52,9 @@ Response Message
| vpc | :ref:`vpc <vpc_api01_0002__table1945411214515>` object | :ref:`Specifies the VPC objects. <vpc_api01_0002__table1945411214515>` |
+------+--------------------------------------------------------+------------------------------------------------------------------------+
.. _vpc_api01_0002__table1945411214515:
.. _vpc_api01_0002__table1945411214515:
.. table:: **Table 3** VPC objects
.. table:: **Table 3** VPC objects
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -100,9 +97,9 @@ Response Message
| | | This parameter is unsupported. Do not use it. |
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_api01_0002__table3576833291556:
.. _vpc_api01_0002__table3576833291556:
.. table:: **Table 4** **route** objects
.. table:: **Table 4** **route** objects
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -114,9 +111,10 @@ Response Message
| | | - 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
Example Response
----------------
.. code-block::
.. code-block::
{
"vpc": {

36
api-ref/source/apis/virtual_private_cloud/querying_vpcs.rst
View File

@ -53,25 +53,22 @@ Example:
| | | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message
Request Parameters
------------------
None
Example Request
---------------
- Request parameter
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/{project_id}/vpcs
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+------+--------------------------------------------------------------+---------------------+
| Name | Type | Description |
@ -79,9 +76,9 @@ Response Message
| vpcs | Array of :ref:`vpcs <vpc_api01_0003__table65129753>` objects | Specifies the VPCs. |
+------+--------------------------------------------------------------+---------------------+
.. _vpc_api01_0003__table65129753:
.. _vpc_api01_0003__table65129753:
.. table:: **Table 3** Description of the **vpcs** field
.. table:: **Table 3** Description of the **vpcs** field
+-----------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -124,9 +121,9 @@ Response Message
| 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:
.. _vpc_api01_0003__table3576833291556:
.. table:: **Table 4** **route** objects
.. table:: **Table 4** **route** objects
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -138,9 +135,10 @@ Response Message
| | | - 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
Example Response
----------------
.. code-block::
.. code-block::
{
"vpcs": [

44
api-ref/source/apis/virtual_private_cloud/updating_vpc_information.rst
View File

File diff suppressed because it is too large Load Diff

37
api-ref/source/apis/vpc_flow_log/creating_a_vpc_flow_log.rst
View File

@ -31,12 +31,10 @@ POST /v1/{project_id}/fl/flow_logs
project_id Yes String Project ID.
========== ========= ====== ===========
Request Message
---------------
Request Parameters
------------------
#. Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request parameter
+----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -44,9 +42,9 @@ Request Message
| flow_log | Yes | :ref:`flow_log <vpc_flow_0001__table656165873916>` object | **FlowLog** objects. For details, see :ref:`Table 3 <vpc_flow_0001__table656165873916>`. |
+----------+-----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+
.. _vpc_flow_0001__table656165873916:
.. _vpc_flow_0001__table656165873916:
.. table:: **Table 3** Description of the **FlowLog** field
.. table:: **Table 3** Description of the **FlowLog** field
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -80,13 +78,15 @@ Request Message
| index_enabled | No | Boolean | Whether to enable the log index. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+
#. Example request
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,12 +100,10 @@ Request Message
}
}
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 4** Response parameter
.. table:: **Table 4** Response parameter
+----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -113,9 +111,9 @@ Response Message
| flow_log | :ref:`flow_log <vpc_flow_0001__table763920584395>` object | **FlowLog** objects. For details, see :ref:`Table 5 <vpc_flow_0001__table763920584395>`. |
+----------+-----------------------------------------------------------+------------------------------------------------------------------------------------------+
.. _vpc_flow_0001__table763920584395:
.. _vpc_flow_0001__table763920584395:
.. table:: **Table 5** Description of the **FlowLog** field
.. table:: **Table 5** Description of the **FlowLog** field
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -168,9 +166,10 @@ Response Message
| | | - UTC time in the format of yyyy-MM-ddTHH:mmss |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"flow_log": {

30
api-ref/source/apis/vpc_flow_log/deleting_a_vpc_flow_log.rst
View File

@ -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
None
- Example request
.. code-block:: text
.. code-block:: text
DELETE https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/60c809cb-6731-45d0-ace8-3bf5626421a9
Response Message
Response Parameters
-------------------
None
Example Response
----------------
- Request parameter
None
- Example response
None
None
Status Code
-----------

32
api-ref/source/apis/vpc_flow_log/querying_a_vpc_flow_log.rst
View File

@ -28,25 +28,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/1e10cd9d-742a-4d36-a9fd-aee9784336ff
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -54,9 +51,9 @@ Response Message
| flow_log | :ref:`flow_log <vpc_flow_0003__table17299234185110>` object | **FlowLog** objects. For details, see :ref:`Table 3 <vpc_flow_0003__table17299234185110>`. |
+----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+
.. _vpc_flow_0003__table17299234185110:
.. _vpc_flow_0003__table17299234185110:
.. table:: **Table 3** Description of the **FlowLog** field
.. table:: **Table 3** Description of the **FlowLog** field
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -107,9 +104,10 @@ Response Message
| | | - UTC time in the format of yyyy-MM-ddTHH:mmss |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"flow_log": {

32
api-ref/source/apis/vpc_flow_log/querying_vpc_flow_logs.rst
View File

@ -82,25 +82,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -108,9 +105,9 @@ Response Message
| flow_logs | Array of :ref:`FlowLog <vpc_flow_0002__table34811015184118>` objects | **FlowLog** object list. For details, see :ref:`Table 3 <vpc_flow_0002__table34811015184118>`. |
+-----------+----------------------------------------------------------------------+------------------------------------------------------------------------------------------------+
.. _vpc_flow_0002__table34811015184118:
.. _vpc_flow_0002__table34811015184118:
.. table:: **Table 3** Description of the **FlowLog** field
.. table:: **Table 3** Description of the **FlowLog** field
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -161,9 +158,10 @@ Response Message
| | | - UTC time in the format of yyyy-MM-ddTHH:mmss |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"flow_logs": [

36
api-ref/source/apis/vpc_flow_log/updating_a_vpc_flow_log.rst
View File

@ -28,12 +28,10 @@ PUT /v1/{project_id}/fl/flow_logs/{flowlog_id}
flowlog_id Yes String Flow log ID
========== ========= ====== ===========
Request Message
---------------
Request Parameters
------------------
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request parameter
+----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -41,9 +39,9 @@ Request Message
| flow_log | Yes | :ref:`flow_log <vpc_flow_0004__table13828101864013>` object | **FlowLog** objects. For details, see :ref:`Table 3 <vpc_flow_0004__table13828101864013>`. |
+----------+-----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+
.. _vpc_flow_0004__table13828101864013:
.. _vpc_flow_0004__table13828101864013:
.. table:: **Table 3** Description of the **FlowLog** field
.. table:: **Table 3** Description of the **FlowLog** field
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
@ -57,12 +55,15 @@ Request Message
| admin_state | No | Boolean | - Whether to enable the flow log function |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+
- Example request
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,12 +72,10 @@ Request Message
}
}
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 4** Response parameter
.. table:: **Table 4** Response parameter
+----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -84,9 +83,9 @@ Response Message
| flow_log | :ref:`flow_log <vpc_flow_0004__table17299234185110>` object | **FlowLog** objects. For details, see :ref:`Table 5 <vpc_flow_0004__table17299234185110>`. |
+----------+-------------------------------------------------------------+--------------------------------------------------------------------------------------------+
.. _vpc_flow_0004__table17299234185110:
.. _vpc_flow_0004__table17299234185110:
.. table:: **Table 5** Description of the **FlowLog** field
.. table:: **Table 5** Description of the **FlowLog** field
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
@ -137,9 +136,10 @@ Response Message
| | | - UTC time in the format of yyyy-MM-ddTHH:mmss |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"flow_log": {

31
api-ref/source/apis/vpc_peering_connection/accepting_a_vpc_peering_connection.rst
View File

@ -27,26 +27,24 @@ 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
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -78,9 +76,9 @@ Response Message
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0004__table1125991417114:
.. _vpc_peering_0004__table1125991417114:
.. table:: **Table 3** **vpc_info** objects
.. table:: **Table 3** **vpc_info** objects
+-----------+--------+-----------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -90,9 +88,10 @@ Response Message
| tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. |
+-----------+--------+-----------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"name": "test",

44
api-ref/source/apis/vpc_peering_connection/creating_a_vpc_peering_connection.rst
View File

File diff suppressed because it is too large Load Diff

30
api-ref/source/apis/vpc_peering_connection/deleting_a_vpc_peering_connection.rst
View File

@ -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
None
- Example request
.. code-block:: text
.. code-block:: text
DELETE https://{Endpoint}/v2.0/vpc/peerings/2b098395-046a-4071-b009-312bcee665cb
Response Message
Response Parameters
-------------------
None
Example Response
----------------
- Response parameter
None
- Example response
None
None
Status Code
-----------

36
api-ref/source/apis/vpc_peering_connection/querying_a_vpc_peering_connection.rst
View File

@ -27,25 +27,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
@ -53,9 +50,9 @@ Response Message
| peering | :ref:`peering <vpc_peering_0002__table1026243410414>` object | Specifies the VPC peering connection object list. For details, see :ref:`Table 3 <vpc_peering_0002__table1026243410414>`. |
+-----------+--------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0002__table1026243410414:
.. _vpc_peering_0002__table1026243410414:
.. table:: **Table 3** **peering** objects
.. table:: **Table 3** **peering** objects
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -87,9 +84,9 @@ Response Message
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0002__table1132310347417:
.. _vpc_peering_0002__table1132310347417:
.. table:: **Table 4** **vpc_info** objects
.. table:: **Table 4** **vpc_info** objects
+-----------+--------+------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -99,9 +96,10 @@ Response Message
| tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. |
+-----------+--------+------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"peering": {

40
api-ref/source/apis/vpc_peering_connection/querying_vpc_peering_connections.rst
View File

@ -57,25 +57,22 @@ Example:
| | | | The default value is **2000**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message
Request Parameters
------------------
None
Example Request
---------------
- Request parameter
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v2.0/vpc/peerings
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-----------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
@ -87,9 +84,9 @@ Response Message
| | | 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:
.. _vpc_peering_0001__table1026243410414:
.. table:: **Table 3** **peering** objects
.. table:: **Table 3** **peering** objects
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -121,9 +118,9 @@ Response Message
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0001__table1132310347417:
.. _vpc_peering_0001__table1132310347417:
.. table:: **Table 4** **vpc_info** objects
.. table:: **Table 4** **vpc_info** objects
+-----------+--------+------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -133,9 +130,9 @@ Response Message
| tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. |
+-----------+--------+------------------------------------------------------------------------------------------------+
.. _vpc_peering_0001__table25150247450:
.. _vpc_peering_0001__table25150247450:
.. table:: **Table 5** **peerings_link** object
.. table:: **Table 5** **peerings_link** object
+------+--------+----------------------------------------------------------------------+
| Name | Type | Description |
@ -145,9 +142,10 @@ Response Message
| rel | String | Specifies the relationship between the API link and the API version. |
+------+--------+----------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"peerings": [

31
api-ref/source/apis/vpc_peering_connection/refusing_a_vpc_peering_connection.rst
View File

@ -27,26 +27,24 @@ 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
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -78,9 +76,9 @@ Response Message
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0005__table1125991417114:
.. _vpc_peering_0005__table1125991417114:
.. table:: **Table 3** **vpc_info** objects
.. table:: **Table 3** **vpc_info** objects
+-----------+--------+-----------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -90,9 +88,10 @@ Response Message
| tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. |
+-----------+--------+-----------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"name": "test",

40
api-ref/source/apis/vpc_peering_connection/updating_a_vpc_peering_connection.rst
View File

@ -27,12 +27,10 @@ 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
------------------
- Request parameter
.. table:: **Table 2** Request parameter
.. table:: **Table 2** Request parameter
+-----------------+-----------------+--------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
@ -42,9 +40,9 @@ Request Message
| | | | 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:
.. _vpc_peering_0006__table9931835105819:
.. table:: **Table 3** Description of the **peering** field
.. table:: **Table 3** Description of the **peering** field
+-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
@ -54,24 +52,25 @@ Request Message
| 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
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
-------------------
- Response parameter
.. table:: **Table 4** Response parameter
.. table:: **Table 4** Response parameter
+-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
@ -79,9 +78,9 @@ Response Message
| peering | :ref:`peering <vpc_peering_0006__table14258131481112>` object | Specifies the VPC peering connection. For details, see :ref:`Table 5 <vpc_peering_0006__table14258131481112>`. |
+-----------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0006__table14258131481112:
.. _vpc_peering_0006__table14258131481112:
.. table:: **Table 5** **peering** objects
.. table:: **Table 5** **peering** objects
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -113,9 +112,9 @@ Response Message
| | | Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+---------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+
.. _vpc_peering_0006__table1125991417114:
.. _vpc_peering_0006__table1125991417114:
.. table:: **Table 6** **vpc_info** objects
.. table:: **Table 6** **vpc_info** objects
+-----------+--------+-----------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -125,9 +124,10 @@ Response Message
| tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. |
+-----------+--------+-----------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"peering": {

36
api-ref/source/apis/vpc_route/creating_a_vpc_route.rst
View File

@ -15,12 +15,10 @@ URI
POST /v2.0/vpc/routes
Request Message
---------------
Request Parameters
------------------
- Request parameter
.. table:: **Table 1** Request parameter
.. table:: **Table 1** Request parameter
+-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+
| Parameter | Type | Mandatory | Description |
@ -28,9 +26,9 @@ Request Message
| route | :ref:`route <vpc_route_0003>` object | Yes | Specifies the route. For details, see :ref:`Table 2 <vpc_route_0003__table05001250111>`. |
+-----------+--------------------------------------+-----------+------------------------------------------------------------------------------------------+
.. _vpc_route_0003__table05001250111:
.. _vpc_route_0003__table05001250111:
.. table:: **Table 2** **route** objects
.. table:: **Table 2** **route** objects
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+
| Attribute | Type | Mandatory | Description |
@ -46,12 +44,15 @@ Request Message
| vpc_id | String | Yes | Specifies the ID of the VPC ID requesting for creating a route. |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------+
- Example request
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,12 +62,10 @@ Request Message
}
}
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 3** Response parameter
.. table:: **Table 3** Response parameter
+-----------+--------------------------------------+--------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
@ -74,9 +73,9 @@ Response Message
| route | :ref:`route <vpc_route_0003>` object | Specifies the route. For details, see :ref:`Table 4 <vpc_route_0003__table1163544010410>`. |
+-----------+--------------------------------------+--------------------------------------------------------------------------------------------+
.. _vpc_route_0003__table1163544010410:
.. _vpc_route_0003__table1163544010410:
.. table:: **Table 4** **route** objects
.. table:: **Table 4** **route** objects
+-------------+--------+------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -94,9 +93,10 @@ Response Message
| tenant_id | String | Specifies the project ID. |
+-------------+--------+------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"route": {

30
api-ref/source/apis/vpc_route/deleting_a_vpc_route.rst
View File

@ -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
None
- Example request
.. code-block:: text
.. code-block:: text
DELETE https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9
Response Message
Response Parameters
-------------------
None
Example Response
----------------
- Response parameter
None
- Example response
None
None
Status Code
-----------

32
api-ref/source/apis/vpc_route/querying_a_vpc_route.rst
View File

@ -27,25 +27,22 @@ 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
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-----------+--------------------------------------+------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
@ -53,9 +50,9 @@ Response Message
| route | :ref:`route <vpc_route_0002>` object | Specifies the route. For details, see :ref:`Table 3 <vpc_route_0002__table05001250111>`. |
+-----------+--------------------------------------+------------------------------------------------------------------------------------------+
.. _vpc_route_0002__table05001250111:
.. _vpc_route_0002__table05001250111:
.. table:: **Table 3** **route** objects
.. table:: **Table 3** **route** objects
+-------------+--------+------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -73,9 +70,10 @@ Response Message
| tenant_id | String | Specifies the project ID. |
+-------------+--------+------------------------------------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"route": {

36
api-ref/source/apis/vpc_route/querying_vpc_routes.rst
View File

@ -57,25 +57,22 @@ Example:
| | | | The default value is **2000**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message
Request Parameters
------------------
None
Example Request
---------------
- Request parameter
None
- Example request
.. code-block:: text
.. code-block:: text
GET https://{Endpoint}/v2.0/vpc/routes?vpc_id=ab78be2d-782f-42a5-aa72-35879f6890ff
Response Message
----------------
Response Parameters
-------------------
- Response parameter
.. table:: **Table 2** Response parameter
.. table:: **Table 2** Response parameter
+-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
@ -87,9 +84,9 @@ Response Message
| | | 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:
.. _vpc_route_0001__table05001250111:
.. table:: **Table 3** **route** objects
.. table:: **Table 3** **route** objects
+-------------+--------+------------------------------------------------------------------------------------------------+
| Attribute | Type | Description |
@ -107,9 +104,9 @@ Response Message
| tenant_id | String | Specifies the project ID. |
+-------------+--------+------------------------------------------------------------------------------------------------+
.. _vpc_route_0001__table25150247450:
.. _vpc_route_0001__table25150247450:
.. table:: **Table 4** **routes_link** object
.. table:: **Table 4** **routes_link** object
+------+--------+----------------------------------------------------------------------+
| Name | Type | Description |
@ -119,9 +116,10 @@ Response Message
| rel | String | Specifies the relationship between the API link and the API version. |
+------+--------+----------------------------------------------------------------------+
- Example response
Example Response
----------------
.. code-block::
.. code-block::
{
"routes": [

30
api-ref/source/apis/vpc_tag_management/batch_creating_or_deleting_vpc_tags.rst
View File

@ -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,12 +82,15 @@ 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.
.. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action
Create two tags for a VPC.
{
"action": "create",
"tags": [
@ -104,12 +105,12 @@ Request example 1: Creating tags in batches
]
}
Request example 2: Deleting tags in batches
- Batch delete two tags for a VPC.
.. code-block:: text
.. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action
Delete two tags for a VPC.
{
"action": "delete",
"tags": [
@ -124,14 +125,13 @@ Request example 2: Deleting tags in batches
]
}
Response Message
----------------
Response parameter
Response Parameters
-------------------
None
Example response
Example Response
----------------
None

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