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) | | | | - **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>`. | | 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. | | type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | | | | - The value can be **5_bgp** (Dynamic BGP), **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) | | | | - **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>`. | | 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. | | type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | | | | - The value can be **5_bgp** (Dynamic BGP), **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) | | | | - **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>`. | | 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. | | type | String | - Specifies the EIP type. |
| | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. | | | | - The value can be **5_bgp** (Dynamic BGP), **5_mailbgp** (Mail BGP), or **5_gray**. |

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

@ -27,10 +27,8 @@ POST /v1/{project_id}/privateips
project_id Yes Specifies the project ID. project_id Yes Specifies the project ID.
========== ========= ========================= ========== ========= =========================
Request Message Request Parameters
--------------- ------------------
- Request parameter
.. table:: **Table 2** Request parameter .. table:: **Table 2** Request parameter
@ -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. | | | | | - 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 .. code-block:: text
POST https://{Endpoint}/v1/{project_id}/privateips 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": "privateips":
[ [
@ -74,10 +75,8 @@ Request Message
] ]
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 4** Response parameter .. table:: **Table 4** Response parameter
@ -133,7 +132,8 @@ Response Message
| ip_address | String | Specifies the assigned private IP address. | | ip_address | String | Specifies the assigned private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -29,27 +29,25 @@ 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. | | privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
+--------------+-----------+-----------------------------------------------------------------------------------------------+ +--------------+-----------+-----------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Response Message Response Parameters
---------------- -------------------
- Request parameter
None None
- Example response Example Response
----------------
.. code-block:: text .. code-block:: text

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

@ -29,23 +29,20 @@ 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. | | privateip_id | Yes | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
+--------------+-----------+-----------------------------------------------------------------------------------------------+ +--------------+-----------+-----------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/privateips/d600542a-b231-45ed-af05-e9930cb14f78 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
@ -101,7 +98,8 @@ Response
| ip_address | String | Specifies the assigned private IP address. | | ip_address | String | Specifies the assigned private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -50,23 +50,20 @@ Example:
| | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. | | | | | **limit** can be used together with **marker**. For details, see the parameter description of **marker**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips 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
@ -122,7 +119,8 @@ Response Message
| ip_address | String | Specifies the assigned private IP address. | | ip_address | String | Specifies the assigned private IP address. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -35,23 +35,20 @@ GET /v2.0/network-ip-availabilities/{network_id}
network_id String Yes Specifies the network ID. network_id String Yes Specifies the network ID.
========== ====== ========= ========================= ========== ====== ========= =========================
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043 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
@ -103,7 +100,8 @@ Response Message
| total_ips | Integer | Specifies the total number of IP addresses on a subnet. (System reserved IP addresses are not included.) | | 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::

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

@ -54,23 +54,20 @@ Example:
| | | | - **routetableContainRoutes**: Number of routes in a route table | | | | | - **routetableContainRoutes**: Number of routes in a route table |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/quotas GET https://{Endpoint}/v1/{project_id}/quotas
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 2** Response parameter .. table:: **Table 2** Response parameter
@ -131,7 +128,8 @@ Response Message
If value **-1** is returned when you use an API to query your VPC quota, this indicates that the VPC quota is not limited. 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::

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

@ -27,10 +27,8 @@ POST /v1/{project_id}/security-groups
project_id Yes Specifies the project ID. project_id Yes Specifies the project ID.
========== ========= ========================= ========== ========= =========================
Request Message Request Parameters
--------------- ------------------
- Request parameter
.. table:: **Table 2** Request parameter .. table:: **Table 2** Request parameter
@ -66,12 +64,15 @@ Request Message
| | | | This parameter is unsupported. Do not use it. | | | | | 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 .. code-block:: text
POST https://{Endpoint}/v1/{project_id}/security-groups 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": { "security_group": {
"name": "sg-01", "name": "sg-01",
@ -80,10 +81,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 4** Response parameter .. table:: **Table 4** Response parameter
@ -172,7 +171,8 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -15,10 +15,8 @@ URI
POST /v1/{project_id}/security-group-rules POST /v1/{project_id}/security-group-rules
Request Message Request Parameters
--------------- ------------------
- Request parameter
.. table:: **Table 1** Request parameter .. table:: **Table 1** Request parameter
@ -40,7 +38,8 @@ Request Message
| description | No | String | - Provides supplementary information about the security group rule. | | description | No | String | - Provides supplementary information about the security group rule. |
| | | | - The value can contain no more than 255 characters, including letters and digits. | | | | | - 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** | | | | | - **egress** |
| | | | - **ingress** | | | | | - **ingress** |
@ -72,12 +71,15 @@ Request Message
| | | | - This parameter is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | | | | | - 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 .. code-block:: text
POST https://{Endpoint}/v1/{project_id}/security-group-rules 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": { "security_group_rule": {
"direction": "ingress", "direction": "ingress",
@ -91,10 +93,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 3** Response parameter .. table:: **Table 3** Response parameter
@ -152,7 +152,8 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -29,27 +29,25 @@ DELETE /v1/{project_id}/security-groups/{security_group_id}
| project_id | No | Specifies the project ID. | | project_id | No | Specifies the project ID. |
+-------------------+-----------+--------------------------------------------------------------------------------+ +-------------------+-----------+--------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/security-groups/0c4a2336-b036-4fa2-bc3c-1a291ed4c431 DELETE https://{Endpoint}/v1/{project_id}/security-groups/0c4a2336-b036-4fa2-bc3c-1a291ed4c431
Response Message Response Parameters
---------------- -------------------
- Response parameter
None None
- Example response Example Response
----------------
None None

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

@ -29,27 +29,25 @@ DELETE /v1/{project_id}/security-group-rules/{security_group_rule_id}
| project_id | Yes | Specifies the project ID. | | project_id | Yes | Specifies the project ID. |
+------------------------+-----------+------------------------------------------------------------------------------------------+ +------------------------+-----------+------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 DELETE https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62
Response Message Response Parameters
---------------- -------------------
- Response parameter
None None
- Example response Example Response
----------------
None None

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

@ -29,23 +29,20 @@ GET /v1/{project_id}/security-groups/{security_group_id}
| security_group_id | Yes | Specifies the security group ID, which uniquely identifies the security group. | | security_group_id | Yes | Specifies the security group ID, which uniquely identifies the security group. |
+-------------------+-----------+--------------------------------------------------------------------------------+ +-------------------+-----------+--------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/security-groups/16b6e77a-08fa-42c7-aa8b-106c048884e6 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
@ -134,7 +131,8 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -29,23 +29,20 @@ 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. | | security_group_rule_id | Yes | Specifies the security group rule ID, which uniquely identifies the security group rule. |
+------------------------+-----------+------------------------------------------------------------------------------------------+ +------------------------+-----------+------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/security-group-rules/2bc0accf-312e-429a-956e-e4407625eb62 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
@ -103,7 +100,8 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -48,23 +48,20 @@ Example:
| security_group_id | No | String | Specifies the security group ID. | | security_group_id | No | String | Specifies the security group ID. |
+-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/security-group-rules GET https://{Endpoint}/v1/{project_id}/security-group-rules
Response Message Response Parameters
---------------- -------------------
- Response parameter
+----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ +----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |
@ -120,7 +117,8 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -58,23 +58,20 @@ Example:
| | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. | | | | | - The value is mutually exclusive with parameters **remote_ip_prefix** and **remote_group_id**. |
+-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/security-groups GET https://{Endpoint}/v1/{project_id}/security-groups
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 2** Response parameter .. table:: **Table 2** Response parameter
@ -163,7 +160,8 @@ Response Message
| tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. | | tenant_id | String | - Specifies the ID of the project to which the security group rule belongs. |
+-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -27,10 +27,8 @@ POST /v1/{project_id}/subnets
project_id Yes Specifies the project ID. project_id Yes Specifies the project ID.
========== ========= ========================= ========== ========= =========================
Request Message Request Parameters
--------------- ------------------
- Request parameter
.. table:: **Table 2** Request parameter .. table:: **Table 2** Request parameter
@ -101,12 +99,15 @@ Request Message
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request Example Request
---------------
- Create a subnet with name set to **subnet**, CIDR block set to 192.168.20.0/24, and gateway IP address set to 192.168.20.1 in the VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85.
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v1/{project_id}/subnets POST https://{Endpoint}/v1/{project_id}/subnets
Create a subnet with name set to subnet, CIDR block set to 192.168.20.0/24, and gateway IP address set to 192.168.20.1 in the VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85.
{ {
"subnet": { "subnet": {
"name": "subnet", "name": "subnet",
@ -135,10 +136,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 5** Response parameter .. table:: **Table 5** Response parameter
@ -227,7 +226,8 @@ Response Message
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -33,27 +33,25 @@ 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. | | | | If you use the management console, the value of this parameter is the **Network ID** value. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d DELETE https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
Response Message Response Parameters
---------------- -------------------
- Response parameter
None None
- Example response Example Response
----------------
None None

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

@ -31,23 +31,20 @@ GET /v1/{project_id}/subnets/{subnet_id}
| | | If you use the management console, the value of this parameter is the **Network ID** value. | | | | If you use the management console, the value of this parameter is the **Network ID** value. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d 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
@ -121,7 +118,8 @@ Response Message
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -46,23 +46,20 @@ Example:
| | | | This field is mandatory in the fine-grained authorization scenario based on enterprise projects. | | | | | This field is mandatory in the fine-grained authorization scenario based on enterprise projects. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/subnets GET https://{Endpoint}/v1/{project_id}/subnets
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 2** Response parameter .. table:: **Table 2** Response parameter
@ -136,7 +133,8 @@ Response Message
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -33,10 +33,8 @@ 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. | | | | 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
@ -94,12 +92,15 @@ Request Message
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - 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 .. code-block:: text
PUT https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d 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": { "subnet": {
"name": "subnet02", "name": "subnet02",
@ -120,10 +121,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 5** Response parameter .. table:: **Table 5** Response parameter
@ -150,7 +149,8 @@ Response Message
| | | - **ERROR**: indicates that the subnet is abnormal. | | | | - **ERROR**: indicates that the subnet is abnormal. |
+-----------------------+-----------------------+----------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

22
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. | | | | 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
@ -73,12 +71,15 @@ Request Message
| | | | - Special characters, including hyphens (-) and underscores (_) | | | | | - 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 .. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags 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": { "tag": {
"key": "key1", "key": "key1",
@ -86,14 +87,13 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
None None
- Example response Example Response
----------------
None None

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. | | key | Yes | Specifies the tag key. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
Request parameter
None None
Example request Example Request
---------------
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/{key} DELETE https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags/{key}
Response Message Response Parameters
---------------- -------------------
Response parameter
None None
Example response Example Response
----------------
None 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. | | | | If you use the management console, the value of this parameter is the **Network ID** value. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
Request parameter
None None
Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags GET https://{Endpoint}/v2.0/{project_id}/subnets/{subnet_id}/tags
Response Message Response Parameters
---------------- -------------------
Response parameter
.. table:: **Table 2** Response parameter .. table:: **Table 2** Response parameter
@ -86,7 +83,8 @@ Response parameter
| | | - Special characters, including hyphens (-) and underscores (_) | | | | - Special characters, including hyphens (-) and underscores (_) |
+-----------------------+-----------------------+---------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------+
Example response Example Response
----------------
.. code-block:: .. 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. project_id Yes Specifies the project ID.
========== ========= ========================= ========== ========= =========================
Request Message Request Parameters
--------------- ------------------
Request parameter
None None
Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v2.0/{project_id}/subnets/tags GET https://{Endpoint}/v2.0/{project_id}/subnets/tags
Response Message Response Parameters
---------------- -------------------
Response parameter
.. table:: **Table 2** Response parameter .. table:: **Table 2** Response parameter
@ -82,7 +79,8 @@ Response parameter
| | | - Special characters, including hyphens (-) and underscores (_) | | | | - Special characters, including hyphens (-) and underscores (_) |
+-----------------------+-----------------------+---------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------+
Example response Example Response
----------------
.. code-block:: .. code-block::

30
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. project_id Yes Specifies the project ID.
========== ========= ========================= ========== ========= =========================
Request Message Request Parameters
--------------- ------------------
Request parameter
.. table:: **Table 2** Request parameter .. 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. | | 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
---------------
- 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 .. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/subnets/resource_instances/action 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", "offset": "0",
"limit": "100", "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 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", "action": "count",
"tags": [ "tags": [
@ -133,10 +134,8 @@ Example request 2: Setting **action** to **count**
] ]
} }
Response Message Response Parameters
---------------- -------------------
Response parameter
.. table:: **Table 5** Response parameter .. table:: **Table 5** Response parameter
@ -176,7 +175,10 @@ 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. | | 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
----------------
- When **action** is set to **filter**:
.. code-block:: .. code-block::
@ -202,7 +204,7 @@ Example response 1: Setting **action** to **filter**
} }
Example response 2: Setting **action** to **count** - When **action** is set to **count**:
.. code-block:: .. code-block::

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

@ -27,10 +27,8 @@ POST /v1/{project_id}/vpcs
project_id Yes Specifies the project ID. project_id Yes Specifies the project ID.
========== ========= ========================= ========== ========= =========================
Request Message Request Parameters
--------------- ------------------
- Request parameter
.. table:: **Table 2** Request parameter .. table:: **Table 2** Request parameter
@ -72,12 +70,15 @@ Request Message
| | | | This parameter is unsupported. Do not use it. | | | | | 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 .. code-block:: text
POST https://{Endpoint}/v1/{project_id}/vpcs POST https://{Endpoint}/v1/{project_id}/vpcs
Create a VPC named vpc and set its CIDR block to 192.168.0.0/16.
{ {
"vpc": { "vpc": {
"name": "vpc", "name": "vpc",
@ -87,10 +88,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 4** Response parameter .. table:: **Table 4** Response parameter
@ -159,7 +158,8 @@ 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. | | | | - 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::

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

@ -29,27 +29,25 @@ DELETE /v1/{project_id}/vpcs/{vpc_id}
| vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+----------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v1/{project_id}/vpcs/13551d6b-755d-4757-b956-536f674975c0 DELETE https://{Endpoint}/v1/{project_id}/vpcs/13551d6b-755d-4757-b956-536f674975c0
Response Message Response Parameters
---------------- -------------------
- Response parameter
None None
- Example response Example Response
----------------
None None

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

@ -29,23 +29,20 @@ GET /v1/{project_id}/vpcs/{vpc_id}
| vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+----------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3 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
@ -114,7 +111,8 @@ 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. | | | | - 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::

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

@ -53,23 +53,20 @@ Example:
| | | | This parameter is unsupported. Do not use it. | | | | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/{project_id}/vpcs GET https://{Endpoint}/v1/{project_id}/vpcs
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 2** Response parameter .. table:: **Table 2** Response parameter
@ -138,7 +135,8 @@ 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. | | | | - 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::

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

@ -29,10 +29,8 @@ PUT /v1/{project_id}/vpcs/{vpc_id}
| vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. | | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+----------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
.. table:: **Table 2** Request parameter .. table:: **Table 2** Request parameter
@ -85,12 +83,15 @@ Request Message
| | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. | | | | | - The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------+
- Example request Example Request
---------------
- Change the name, description, and CIDR block of the VPC whose ID is 99d9d709-8478-4b46-9f3f-2206b1023fd3 to **vpc1**, **test1**, and **192.168.0.0/16**, respectively.
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3 PUT https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3
Change the name, description, and CIDR block of the VPC whose ID is 99d9d709-8478-4b46-9f3f-2206b1023fd3 to vpc1, test1, and 192.168.0.0/16, respectively.
{ {
"vpc": { "vpc": {
"name": "vpc1", "name": "vpc1",
@ -100,10 +101,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 5** Response parameter .. table:: **Table 5** Response parameter
@ -170,7 +169,8 @@ 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. | | | | - 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::

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

@ -31,10 +31,8 @@ POST /v1/{project_id}/fl/flow_logs
project_id Yes String Project ID. project_id Yes String Project ID.
========== ========= ====== =========== ========== ========= ====== ===========
Request Message Request Parameters
--------------- ------------------
#. Request parameter
.. table:: **Table 2** Request parameter .. table:: **Table 2** Request parameter
@ -80,13 +78,15 @@ Request Message
| index_enabled | No | Boolean | Whether to enable the log index. | | 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 .. code-block:: text
POST https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs 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": { "flow_log": {
"name": "flowlog", "name": "flowlog",
@ -100,10 +100,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 4** Response parameter .. table:: **Table 4** Response parameter
@ -168,7 +166,8 @@ Response Message
| | | - UTC time in the format of yyyy-MM-ddTHH:mmss | | | | - UTC time in the format of yyyy-MM-ddTHH:mmss |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -28,27 +28,25 @@ DELETE /v1/{project_id}/fl/flow_logs/{flowlog_id}
flowlog_id Yes String Flow log ID flowlog_id Yes String Flow log ID
========== ========= ====== =========== ========== ========= ====== ===========
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/60c809cb-6731-45d0-ace8-3bf5626421a9 DELETE https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/60c809cb-6731-45d0-ace8-3bf5626421a9
Response Message Response Parameters
---------------- -------------------
- Request parameter
None None
- Example response Example Response
----------------
None None

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

@ -28,23 +28,20 @@ GET /v1/{project_id}/fl/flow_logs/{flowlog_id}
flowlog_id Yes String Flow log ID flowlog_id Yes String Flow log ID
========== ========= ====== =========== ========== ========= ====== ===========
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/1e10cd9d-742a-4d36-a9fd-aee9784336ff 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
@ -107,7 +104,8 @@ Response Message
| | | - UTC time in the format of yyyy-MM-ddTHH:mmss | | | | - UTC time in the format of yyyy-MM-ddTHH:mmss |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -82,23 +82,20 @@ 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. | | | | | - 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
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs?name=flowlog 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
@ -161,7 +158,8 @@ Response Message
| | | - UTC time in the format of yyyy-MM-ddTHH:mmss | | | | - UTC time in the format of yyyy-MM-ddTHH:mmss |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -28,10 +28,8 @@ PUT /v1/{project_id}/fl/flow_logs/{flowlog_id}
flowlog_id Yes String Flow log ID flowlog_id Yes String Flow log ID
========== ========= ====== =========== ========== ========= ====== ===========
Request Message Request Parameters
--------------- ------------------
- Request parameter
.. table:: **Table 2** Request parameter .. table:: **Table 2** Request parameter
@ -57,12 +55,15 @@ Request Message
| admin_state | No | Boolean | - Whether to enable the flow log function | | 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 .. code-block:: text
PUT https://{Endpoint}/v1/b2782e6708b8475c993e6064bc456bf8/fl/flow_logs/f49f00f1-0f15-470a-a8c5-4e879e461c8d 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": { "flow_log": {
"name": "flow-log-update", "name": "flow-log-update",
@ -71,10 +72,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 4** Response parameter .. table:: **Table 4** Response parameter
@ -137,7 +136,8 @@ Response Message
| | | - UTC time in the format of yyyy-MM-ddTHH:mmss | | | | - UTC time in the format of yyyy-MM-ddTHH:mmss |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -27,24 +27,22 @@ 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. | | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------+ +------------+-----------+--------+------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
- Accept the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1.
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1/accept 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
@ -90,7 +88,8 @@ Response Message
| tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | | 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::

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

@ -19,10 +19,8 @@ URI
POST /v2.0/vpc/peerings POST /v2.0/vpc/peerings
Request Message Request Parameters
--------------- ------------------
- Request parameter
.. table:: **Table 1** Request parameter .. table:: **Table 1** Request parameter
@ -64,12 +62,15 @@ Request Message
| | | | This parameter is mandatory if the VPC peering connection is created between VPCs in different accounts. | | | | | This parameter is mandatory if the VPC peering connection is created between VPCs in different accounts. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+
- Example request Example Request
---------------
- Create a VPC peering connection. The VPC ID of the requester is 9daeac7c-a98f-430f-8e38-67f9c044e299, the VPC ID of the receiver is f583c072-0bb8-4e19-afb2-afb7c1693be5, and the VPC peering connection is named **test**.
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/vpc/peerings POST https://{Endpoint}/v2.0/vpc/peerings
Create a VPC peering connection. The VPC ID of the requester is 9daeac7c-a98f-430f-8e38-67f9c044e299, the VPC ID of the receiver is f583c072-0bb8-4e19-afb2-afb7c1693be5, and the VPC peering connection is named test.
{ {
"peering": { "peering": {
"name": "test", "name": "test",
@ -82,10 +83,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 4** Response parameter .. table:: **Table 4** Response parameter
@ -141,7 +140,8 @@ Response Message
| tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | | 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::

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

@ -29,27 +29,25 @@ DELETE /v2.0/vpc/peerings/{peering_id}
| peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------+ +------------+-----------+--------+------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v2.0/vpc/peerings/2b098395-046a-4071-b009-312bcee665cb DELETE https://{Endpoint}/v2.0/vpc/peerings/2b098395-046a-4071-b009-312bcee665cb
Response Message Response Parameters
---------------- -------------------
- Response parameter
None None
- Example response Example Response
----------------
None None

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

@ -27,23 +27,20 @@ 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. | | 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
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1 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
@ -99,7 +96,8 @@ Response Message
| tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | | 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::

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

@ -57,23 +57,20 @@ Example:
| | | | The default value is **2000**. | | | | | The default value is **2000**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v2.0/vpc/peerings GET https://{Endpoint}/v2.0/vpc/peerings
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 2** Response parameter .. table:: **Table 2** Response parameter
@ -145,7 +142,8 @@ Response Message
| rel | String | Specifies the relationship between the API link and the API version. | | rel | String | Specifies the relationship between the API link and the API version. |
+------+--------+----------------------------------------------------------------------+ +------+--------+----------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -27,24 +27,22 @@ 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. | | peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. |
+------------+-----------+--------+------------------------------------------------------------------------------------------------+ +------------+-----------+--------+------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
- Reject the VPC peering connection request from 22b76469-08e3-4937-8c1d-7aad34892be1.
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/vpc/peerings/22b76469-08e3-4937-8c1d-7aad34892be1/reject 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
@ -90,7 +88,8 @@ Response Message
| tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | | 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::

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

@ -27,10 +27,8 @@ PUT /v2.0/vpc/peerings/{peering_id}
| peering_id | Yes | String | Specifies the VPC peering connection ID, which uniquely identifies the VPC peering connection. | | 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
@ -54,22 +52,23 @@ 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. | | 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 .. code-block:: text
PUT https://{Endpoint}/v2.0/vpc/peerings/7a9a954a-eb41-4954-a300-11ab17a361a2 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": { "peering": {
"name": "test2" "name": "test2"
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 4** Response parameter .. table:: **Table 4** Response parameter
@ -125,7 +124,8 @@ Response Message
| tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. | | 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::

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

@ -15,10 +15,8 @@ URI
POST /v2.0/vpc/routes POST /v2.0/vpc/routes
Request Message Request Parameters
--------------- ------------------
- Request parameter
.. table:: **Table 1** Request parameter .. table:: **Table 1** Request parameter
@ -46,12 +44,15 @@ Request Message
| vpc_id | String | Yes | Specifies the ID of the VPC ID requesting for creating a route. | | 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 .. code-block:: text
POST https://{Endpoint}/v2.0/vpc/routes 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": { "route": {
"type": "peering", "type": "peering",
@ -61,10 +62,8 @@ Request Message
} }
} }
Response Message Response Parameters
---------------- -------------------
- Response parameter
.. table:: **Table 3** Response parameter .. table:: **Table 3** Response parameter
@ -94,7 +93,8 @@ Response Message
| tenant_id | String | Specifies the project ID. | | tenant_id | String | Specifies the project ID. |
+-------------+--------+------------------------------------------------------------------------------------------------+ +-------------+--------+------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -27,27 +27,25 @@ DELETE /v2.0/vpc/routes/{route_id}
| route_id | Yes | String | Specifies the route ID, which uniquely identifies the route. | | route_id | Yes | String | Specifies the route ID, which uniquely identifies the route. |
+----------+-----------+--------+--------------------------------------------------------------+ +----------+-----------+--------+--------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
DELETE https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 DELETE https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9
Response Message Response Parameters
---------------- -------------------
- Response parameter
None None
- Example response Example Response
----------------
None None

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

@ -27,23 +27,20 @@ GET /v2.0/vpc/routes/{route_id}
| route_id | Yes | String | Specifies the route ID, which uniquely identifies the route. | | route_id | Yes | String | Specifies the route ID, which uniquely identifies the route. |
+----------+-----------+--------+--------------------------------------------------------------+ +----------+-----------+--------+--------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v2.0/vpc/routes/60c809cb-6731-45d0-ace8-3bf5626421a9 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
@ -73,7 +70,8 @@ Response Message
| tenant_id | String | Specifies the project ID. | | tenant_id | String | Specifies the project ID. |
+-------------+--------+------------------------------------------------------------------------------------------------+ +-------------+--------+------------------------------------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

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

@ -57,23 +57,20 @@ Example:
| | | | The default value is **2000**. | | | | | The default value is **2000**. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
- Request parameter
None None
- Example request Example Request
---------------
.. code-block:: text .. code-block:: text
GET https://{Endpoint}/v2.0/vpc/routes?vpc_id=ab78be2d-782f-42a5-aa72-35879f6890ff 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
@ -119,7 +116,8 @@ Response Message
| rel | String | Specifies the relationship between the API link and the API version. | | rel | String | Specifies the relationship between the API link and the API version. |
+------+--------+----------------------------------------------------------------------+ +------+--------+----------------------------------------------------------------------+
- Example response Example Response
----------------
.. code-block:: .. code-block::

26
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. | | vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. |
+------------+-----------+----------------------------------------------------------+ +------------+-----------+----------------------------------------------------------+
Request Message Request Parameters
--------------- ------------------
Request parameter
.. table:: **Table 2** Request parameter .. table:: **Table 2** Request parameter
@ -84,12 +82,15 @@ Request parameter
| | | | - Special characters, including hyphens (-) and underscores (_) | | | | | - Special characters, including hyphens (-) and underscores (_) |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------+ +-----------------+-----------------+-----------------+---------------------------------------------------------------------+
Request example 1: Creating tags in batches Example Request
---------------
- Batch create two tags for a VPC.
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action
Create two tags for a VPC.
{ {
"action": "create", "action": "create",
"tags": [ "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 POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags/action
Delete two tags for a VPC.
{ {
"action": "delete", "action": "delete",
"tags": [ "tags": [
@ -124,14 +125,13 @@ Request example 2: Deleting tags in batches
] ]
} }
Response Message Response Parameters
---------------- -------------------
Response parameter
None None
Example response Example Response
----------------
None None

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