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-06-21 11:47:29 +00:00
parent 91a6e04e62
commit 8899eb38e5
51 changed files with 747 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/apis/eip/index.rst
View File

@ -6,6 +6,9 @@ EIP
=== ===
- :ref:`Assigning an EIP <en-us_topic_0020090596>` - :ref:`Assigning an EIP <en-us_topic_0020090596>`
- :ref:`Querying an EIP <vpc_eip_0002>`
- :ref:`Querying EIPs <vpc_eip_0003>`
- :ref:`Updating an EIP <vpc_eip_0004>`
- :ref:`Releasing an EIP <vpc_eip_0005>` - :ref:`Releasing an EIP <vpc_eip_0005>`
.. toctree:: .. toctree::
@ -13,4 +16,7 @@ EIP
:hidden: :hidden:
assigning_an_eip assigning_an_eip
querying_an_eip
querying_eips
updating_an_eip
releasing_an_eip releasing_an_eip

196
api-ref/source/apis/eip/querying_an_eip.rst Normal file
View File

File diff suppressed because it is too large Load Diff

230
api-ref/source/apis/eip/querying_eips.rst Normal file
View File

File diff suppressed because it is too large Load Diff

221
api-ref/source/apis/eip/updating_an_eip.rst Normal file
View File

File diff suppressed because it is too large Load Diff

16
api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst
View File

@ -15,7 +15,9 @@ URI
DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key} DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}
:ref:`Table 2 <eip_tag_0003__table27380479>` describes the parameters. :ref:`Table 1 <eip_tag_0003__table5716115334>` describes the parameters.
.. _eip_tag_0003__table5716115334:
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
@ -32,17 +34,7 @@ Request Message
- Request parameter - Request parameter
.. _eip_tag_0003__table27380479: None
.. table:: **Table 2** Request parameters
=========== ========= ==========================================
Name Mandatory Description
=========== ========= ==========================================
project_id Yes Specifies the project ID.
publicip_id Yes Specifies the unique identifier of an EIP.
key Yes Specifies the tag key.
=========== ========= ==========================================
- Example request - Example request

21
api-ref/source/apis/eip_tag_management/querying_eip_tags.rst
View File

@ -15,7 +15,9 @@ URI
GET /v2.0/{project_id}/publicips/{publicip_id}/tags GET /v2.0/{project_id}/publicips/{publicip_id}/tags
:ref:`Table 2 <eip_tag_0002__table27380479>` describes the parameters. :ref:`Table 1 <eip_tag_0002__table450964213214>` describes the parameters.
.. _eip_tag_0002__table450964213214:
.. table:: **Table 1** Parameter description .. table:: **Table 1** Parameter description
@ -31,16 +33,7 @@ Request Message
- Request parameter - Request parameter
.. _eip_tag_0002__table27380479: None
.. table:: **Table 2** Request parameters
=========== ========= ==========================================
Name Mandatory Description
=========== ========= ==========================================
project_id Yes Specifies the project ID.
publicip_id Yes Specifies the unique identifier of an EIP.
=========== ========= ==========================================
- Example request - Example request
@ -53,17 +46,17 @@ Response Message
- Response parameter - Response parameter
.. table:: **Table 3** Response parameter .. table:: **Table 2** Response parameter
+-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+===========+=================================================================+=========================================================================================================+ +===========+=================================================================+=========================================================================================================+
| tags | Array of :ref:`tag <eip_tag_0002__table13242848193719>` objects | Specifies the **tag** object list. For details, see :ref:`Table 4 <eip_tag_0002__table13242848193719>`. | | tags | Array of :ref:`tag <eip_tag_0002__table13242848193719>` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 <eip_tag_0002__table13242848193719>`. |
+-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ +-----------+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+
.. _eip_tag_0002__table13242848193719: .. _eip_tag_0002__table13242848193719:
.. table:: **Table 4** **tag** objects .. table:: **Table 3** **tag** objects
+-----------------------+-----------------------+---------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------+
| Attribute | Type | Description | | Attribute | Type | Description |

14
api-ref/source/apis/eip_tag_management/querying_eip_tags_in_a_specified_project.rst
View File

@ -32,13 +32,7 @@ Request Message
- Request parameter - Request parameter
.. table:: **Table 2** Request parameter None
========== ========= ===========
Parameter Mandatory Description
========== ========= ===========
project_id Yes Project ID.
========== ========= ===========
- Example request - Example request
@ -51,17 +45,17 @@ Response Message
- Response parameter - Response parameter
.. table:: **Table 3** Response parameter .. table:: **Table 2** Response parameter
+-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+===========+===============================================================+=======================================================================================================+ +===========+===============================================================+=======================================================================================================+
| tags | Array of :ref:`tag <eip_tag_0006__table043062842515>` objects | Specifies the **tag** object list. For details, see :ref:`Table 4 <eip_tag_0006__table043062842515>`. | | tags | Array of :ref:`tag <eip_tag_0006__table043062842515>` objects | Specifies the **tag** object list. For details, see :ref:`Table 3 <eip_tag_0006__table043062842515>`. |
+-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +-----------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+
.. _eip_tag_0006__table043062842515: .. _eip_tag_0006__table043062842515:
.. table:: **Table 4** Description of the **tag** field .. table:: **Table 3** Description of the **tag** field
+-----------------------+-----------------------+---------------------------------------------------------------------+ +-----------------------+-----------------------+---------------------------------------------------------------------+
| Name | Type | Description | | Name | Type | Description |

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

@ -60,7 +60,7 @@ Request Message
.. 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":
[ [

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

@ -71,10 +71,10 @@ Request Message
.. 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": "qq", "name": "sg-01",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85" "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85"
"enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2"
} }

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

@ -77,7 +77,7 @@ Request Message
.. 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",

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

@ -97,7 +97,7 @@ Request Message
| | | | | | | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -106,7 +106,7 @@ Request Message
.. 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",
@ -223,7 +223,7 @@ Response Message
| | | | | | | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -117,7 +117,7 @@ Response Message
| | | | | | | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -132,7 +132,7 @@ Response Message
| | | | | | | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -90,7 +90,7 @@ Request Message
| | | | | | | | | |
| | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. | | | | | The option **addresstime** for **opt_name** indicates the DHCP lease expiration time. The value can be **-1**, which indicates unlimited lease time, or *Number*\ **+h**. The number ranges from 1 to 30,000. For example, the value can be **5h**. The default value is **24h**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time name configured for the subnet. | | opt_name | Yes | String | - Specifies the NTP server address name or DHCP lease expiration time configured for the subnet. |
| | | | - Currently, the value can only be set to **ntp** or **addresstime**. | | | | | - Currently, the value can only be set to **ntp** or **addresstime**. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -99,10 +99,10 @@ Request Message
.. 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": "subnetqq", "name": "subnet02",
"ipv6_enable": true, "ipv6_enable": true,
"dhcp_enable": false, "dhcp_enable": false,
"primary_dns": "114.xx.xx.115", "primary_dns": "114.xx.xx.115",

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

@ -91,7 +91,7 @@ Request example 1: Creating tags in batches
.. 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": [
@ -111,7 +111,7 @@ Request example 2: Deleting tags in batches
.. 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": [

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

@ -78,7 +78,7 @@ Request Message
.. 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",

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

@ -79,7 +79,7 @@ Example request 1: Setting **action** to **filter**
.. 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",
@ -106,7 +106,7 @@ Example request 2: Setting **action** to **count**
.. 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": [

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

@ -77,7 +77,7 @@ Request Message
.. 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",

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

@ -90,7 +90,7 @@ Request Message
.. 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",

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

@ -85,7 +85,8 @@ Request Message
.. 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",

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

@ -62,7 +62,7 @@ Request Message
.. 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",

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

@ -39,6 +39,7 @@ Request Message
.. 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 Message
---------------- ----------------
@ -81,13 +82,13 @@ Response Message
.. table:: **Table 3** **vpc_info** objects .. table:: **Table 3** **vpc_info** objects
+-----------+--------+------------------------------------------------------------------------------------------------+ +-----------+--------+-----------------------------------------------------------------------------------------------+
| Attribute | Type | Description | | Attribute | Type | Description |
+===========+========+================================================================================================+ +===========+========+===============================================================================================+
| vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. |
+-----------+--------+------------------------------------------------------------------------------------------------+ +-----------+--------+-----------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. |
+-----------+--------+------------------------------------------------------------------------------------------------+ +-----------+--------+-----------------------------------------------------------------------------------------------+
- Example response - Example response

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

@ -69,7 +69,7 @@ Request Message
.. 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",

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

@ -39,6 +39,7 @@ Request Message
.. 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 Message
---------------- ----------------
@ -81,13 +82,13 @@ Response Message
.. table:: **Table 3** **vpc_info** objects .. table:: **Table 3** **vpc_info** objects
+-----------+--------+------------------------------------------------------------------------------------------------+ +-----------+--------+-----------------------------------------------------------------------------------------------+
| Attribute | Type | Description | | Attribute | Type | Description |
+===========+========+================================================================================================+ +===========+========+===============================================================================================+
| vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. |
+-----------+--------+------------------------------------------------------------------------------------------------+ +-----------+--------+-----------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. |
+-----------+--------+------------------------------------------------------------------------------------------------+ +-----------+--------+-----------------------------------------------------------------------------------------------+
- Example response - Example response

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

@ -59,6 +59,7 @@ Request Message
.. 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"
@ -116,13 +117,13 @@ Response Message
.. table:: **Table 6** **vpc_info** objects .. table:: **Table 6** **vpc_info** objects
+-----------+--------+------------------------------------------------------------------------------------------------+ +-----------+--------+-----------------------------------------------------------------------------------------------+
| Attribute | Type | Description | | Attribute | Type | Description |
+===========+========+================================================================================================+ +===========+========+===============================================================================================+
| vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. | | vpc_id | String | Specifies the ID of a VPC involved in a VPC peering connection. |
+-----------+--------+------------------------------------------------------------------------------------------------+ +-----------+--------+-----------------------------------------------------------------------------------------------+
| tenant_id | String | Specifies the ID of the project to which a VPC involved in the VPC peering connection belongs. | | tenant_id | String | Specifies the ID of the project that a VPC involved in the VPC peering connection belongs to. |
+-----------+--------+------------------------------------------------------------------------------------------------+ +-----------+--------+-----------------------------------------------------------------------------------------------+
- Example response - Example response

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

@ -51,7 +51,7 @@ Request Message
.. 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",

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

@ -89,7 +89,7 @@ Request example 1: Creating tags in batches
.. 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": [
@ -109,7 +109,7 @@ Request example 2: Deleting tags in batches
.. 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": [

2
api-ref/source/apis/vpc_tag_management/creating_a_tag_for_a_vpc.rst
View File

@ -76,7 +76,7 @@ Request Message
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags POST https://{Endpoint}/v2.0/{project_id}/vpcs/{vpc_id}/tags
Create a tag for a VPC. The key is key1, and the value is value1.
{ {
"tag": { "tag": {
"key": "key1", "key": "key1",

4
api-ref/source/apis/vpc_tag_management/querying_vpcs_by_tag.rst
View File

@ -83,7 +83,7 @@ Example request 1: Setting **action** to **filter**
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action
Filter VPCs by setting action to filter. The query starts from the first record. A maximum of 100 records can be returned for each query. You can use matches and tags to filter VPCs.
{ {
"offset": "0", "offset": "0",
"limit": "100", "limit": "100",
@ -110,7 +110,7 @@ Example request 2: Setting **action** to **count**
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action POST https://{Endpoint}/v2.0/{project_id}/vpcs/resource_instances/action
Count VPCs by setting action to count. Use matches and tags to filter and count VPCs.
{ {
"action": "count", "action": "count",
"tags": [ "tags": [

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

@ -8,9 +8,13 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description | | Released On | Description |
+===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| 2023-06-20 | This release incorporates the following changes: |
| | |
| | Modified parameters in :ref:`Deleting an EIP Tag <eip_tag_0003>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-06-06 | This release incorporates the following changes: | | 2023-06-06 | This release incorporates the following changes: |
| | | | | |
| | - Changed the value of **size** in :ref:`Assigning a Shared Bandwidth <vpc_sharebandwidth_0001>` and :ref:`Adding an EIP to a Shared Bandwidth <vpc_sharebandwidth_0004>`. | | | Changed the value of **size** in :ref:`Assigning a Shared Bandwidth <vpc_sharebandwidth_0001>` and :ref:`Adding an EIP to a Shared Bandwidth <vpc_sharebandwidth_0004>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-05-15 | This release incorporates the following changes: | | 2023-05-15 | This release incorporates the following changes: |
| | | | | |

2
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_group.rst
View File

@ -72,7 +72,7 @@ Example Request
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/fwaas/firewall_groups POST https://{Endpoint}/v2.0/fwaas/firewall_groups
Create an ACL group, associate it with the inbound ACL policy afc52ce9-5305-4ec9-9feb-44feb8330341, and set the port ID to c133f2bf-6937-4416-bb17-012e1be5cd2d.
{ {
"firewall_group": { "firewall_group": {
"ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341", "ingress_firewall_policy_id": "afc52ce9-5305-4ec9-9feb-44feb8330341",

2
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_policy.rst
View File

@ -54,7 +54,7 @@ Example Request
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/fwaas/firewall_policies POST https://{Endpoint}/v2.0/fwaas/firewall_policies
Create an ACL policy named test-policy and associate it with the ACL rule whose ID is b8243448-cb3c-496e-851c-dadade4c161b.
{ {
"firewall_policy": { "firewall_policy": {
"name": "test-policy", "name": "test-policy",

2
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/creating_a_firewall_rule.rst
View File

@ -76,7 +76,7 @@ Example Request
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/fwaas/firewall_rules POST https://{Endpoint}/v2.0/fwaas/firewall_rules
Create an ACL rule with action set to allow, protocol set to tcp, and destination port set to 80.
{ {
"firewall_rule": { "firewall_rule": {
"action": "allow", "action": "allow",

2
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/inserting_a_firewall_rule.rst
View File

@ -52,7 +52,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/insert_rule
Insert rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 below rule b8243448-cb3c-496e-851c-dadade4c161b in the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341.
{ {
"insert_after": "b8243448-cb3c-496e-851c-dadade4c161b", "insert_after": "b8243448-cb3c-496e-851c-dadade4c161b",
"firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1", "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1",

2
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/removing_a_firewall_rule.rst
View File

@ -32,7 +32,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/remove_rule PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/remove_rule
Remove ACL rule 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1 from the ACL policy whose ID is afc52ce9-5305-4ec9-9feb-44feb8330341.
{ {
"firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1" "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1"
} }

2
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_group.rst
View File

@ -72,7 +72,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/fwaas/firewall_groups/2fb0e81f-9f63-44b2-9894-c13a3284594a PUT https://{Endpoint}/v2.0/fwaas/firewall_groups/2fb0e81f-9f63-44b2-9894-c13a3284594a
Associate the ACL group whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a with the outbound ACL policy 53f36c32-db25-4856-a0ba-e605fd88c5e9.
{ {
"firewall_group": { "firewall_group": {
"egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9" "egress_firewall_policy_id": "53f36c32-db25-4856-a0ba-e605fd88c5e9"

2
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_policy.rst
View File

@ -54,7 +54,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/2fb0e81f-9f63-44b2-9894-c13a3284594a
Associate the ACL policy whose ID is 2fb0e81f-9f63-44b2-9894-c13a3284594a to the ACL rule whose ID is 0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1.
{ {
"firewall_policy": { "firewall_policy": {
"firewall_rules": [ "firewall_rules": [

2
api-ref/source/native_openstack_neutron_apis_v2.0/firewall/updating_a_firewall_rule.rst
View File

@ -76,7 +76,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28 PUT https://{Endpoint}/v2.0/fwaas/firewall_rules/b94acf06-efc2-485d-ba67-a61acf2a7e28
Change the action of the ACL rule whose ID is b94acf06-efc2-485d-ba67-a61acf2a7e28 to deny.
{ {
"firewall_rule": { "firewall_rule": {
"action": "deny" "action": "deny"

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

@ -56,7 +56,7 @@ Example Request
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/networks POST https://{Endpoint}/v2.0/networks
Create a network named network-test.
{ {
"network": { "network": {
"name": "network-test", "name": "network-test",

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

@ -64,7 +64,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/networks/c360322d-5315-45d7-b7d2-481f98c56edb PUT https://{Endpoint}/v2.0/networks/c360322d-5315-45d7-b7d2-481f98c56edb
Change the name of the network whose ID is c360322d-5315-45d7-b7d2-481f98c56edb to network-test02.
{ {
"network": { "network": {
"name": "network-test02" "name": "network-test02"

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

@ -138,7 +138,7 @@ Example Request
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/ports POST https://{Endpoint}/v2.0/ports
Create a port named port-test on network whose ID is 00ae08c5-f727-49ab-ad4b-b069398aa171.
{ {
"port": { "port": {
"admin_state_up": true, "admin_state_up": true,

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

@ -125,7 +125,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/ports/7a9a954a-eb41-4954-a300-11ab17a361a2 PUT https://{Endpoint}/v2.0/ports/7a9a954a-eb41-4954-a300-11ab17a361a2
Change the name of the port whose ID is 7a9a954a-eb41-4954-a300-11ab17a361a2 to port-test02.
{ {
"port": { "port": {
"name": "port-test02" "name": "port-test02"

2
api-ref/source/native_openstack_neutron_apis_v2.0/router/adding_an_interface_to_a_router.rst
View File

@ -43,7 +43,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface
Add an interface to the router. The router ID is i5b8e885c-1347-4ac2-baf9-2249c8ed1270, and the subnet ID is ab78be2d-782f-42a5-aa72-35879f6890ff.
{"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"} {"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"}
Response Message Response Message

1
api-ref/source/native_openstack_neutron_apis_v2.0/router/creating_a_router.rst
View File

@ -68,6 +68,7 @@ Example Request
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/routers POST https://{Endpoint}/v2.0/routers
Create a router named router-test2.
{ {
"router": { "router": {
"name": "router-test2", "name": "router-test2",

2
api-ref/source/native_openstack_neutron_apis_v2.0/router/removing_an_interface_from_a_router.rst
View File

@ -40,7 +40,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface
Remove an interface from a router. The router ID is b625c58c-0cfe-49e0-acc8-f2374f8187ff, and the subnet ID is 4b910a10-0860-428b-b463-d84dbc5e288e.
{"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"} {"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"}
Response Message Response Message

1
api-ref/source/native_openstack_neutron_apis_v2.0/router/updating_a_router.rst
View File

@ -88,6 +88,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/routers/f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 PUT https://{Endpoint}/v2.0/routers/f5dbdfe0-86f9-4b0a-9a32-6be143f0a076
Change the name of the router whose ID is f5dbdfe0-86f9-4b0a-9a32-6be143f0a076 to router-220.
{ {
"router": { "router": {
"name": "router-220" "name": "router-220"

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

@ -44,7 +44,7 @@ Example Request
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/security-groups POST https://{Endpoint}/v2.0/security-groups
Create a security group named sg-test.
{ {
"security_group": { "security_group": {
"name": "sg-test" "name": "sg-test"

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

@ -79,7 +79,7 @@ Example Request
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/security-group-rules POST https://{Endpoint}/v2.0/security-group-rules
Create an outbound rule in the security group whose ID is 5cb9c1ee-00e0-4d0f-9623-55463cd26ff8. Set protocol to tcp, and remote IP address to 10.10.0.0/24.
{ {
"security_group_rule": { "security_group_rule": {
"security_group_id": "5cb9c1ee-00e0-4d0f-9623-55463cd26ff8", "security_group_id": "5cb9c1ee-00e0-4d0f-9623-55463cd26ff8",

2
api-ref/source/native_openstack_neutron_apis_v2.0/security_group/updating_a_security_group.rst
View File

@ -46,7 +46,7 @@ Example Request
.. code-block:: text .. code-block:: text
PUT https://{Endpoint}/v2.0/security-groups/d29ae17d-f355-4992-8747-1fb66cc9afd2 PUT https://{Endpoint}/v2.0/security-groups/d29ae17d-f355-4992-8747-1fb66cc9afd2
Change the name of the security group whose ID is d29ae17d-f355-4992-8747-1fb66cc9afd2 to sg-test02.
{ {
"security_group": { "security_group": {
"name": "sg-test02" "name": "sg-test02"

2
api-ref/source/native_openstack_neutron_apis_v2.0/subnet/creating_a_subnet.rst
View File

@ -106,7 +106,7 @@ Example Request
.. code-block:: text .. code-block:: text
POST https://{Endpoint}/v2.0/subnets POST https://{Endpoint}/v2.0/subnets
Create a subnet named subnet-test, set its network ID to 0133cd73-34d4-4d4c-bf1f-e65b24603206, and CIDR block to 172.16.2.0/24.
{ {
"subnet": { "subnet": {
"name": "subnet-test", "name": "subnet-test",

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