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-11-17 07:07:10 +00:00
parent cd0947f8ca
commit 4ee7d13e19
39 changed files with 915 additions and 705 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
api-ref/source/apis/eip/assigning_an_eip.rst
View File

@ -85,6 +85,9 @@ Request Parameters
| | | | - The configured value must be supported by the system. |
| | | | - If this parameter is left blank or is an empty string, IPv4 address is created by default. |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+
| alias | No | String | - Specifies the EIP name. |
| | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------+
.. _en-us_topic_0020090596__table11041789:
@ -198,6 +201,8 @@ Response Message
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| bandwidth_size | Integer | Specifies the bandwidth (Mbit/s). |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| alias | String | Specifies the EIP name. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). |
| | | - When you assign an EIP, associate an enterprise project ID with the EIP. |
| | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. |
@ -206,6 +211,15 @@ Response Message
| | | |
| | | This parameter is unsupported. Do not use it. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| public_border_group | String | Specifies whether it is in a central site or an edge site. |
| | | |
| | | The value can be: |
| | | |
| | | - center |
| | | - *Edge site name* |
| | | |
| | | This resource can only be associated with an EIP of the same region. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
- Example response (IPv4 EIP with dedicated bandwidth)
@ -214,6 +228,8 @@ Response Message
{
"publicip": {
"id": "f588ccfa-8750-4d7c-bf5d-2ede24414706",
"alias": "tom",
"public_border_group": "center",
"status": "PENDING_CREATE",
"type": "5_bgp",
"public_ip_address": "161.xx.xx.7",

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

@ -142,6 +142,8 @@ Response Message
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bandwidth_name | String | Specifies the bandwidth name. |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| alias | String | Specifies the EIP name. |
+-----------------------+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). |
| | | - When assigning an EIP, you need to associate an enterprise project ID with the EIP. |
| | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. |
@ -172,6 +174,7 @@ Response Message
"publicip": {
"id": "2ec9b78d-9368-46f3-8f29-d1a95622a568",
"status": "DOWN",
"alias": "tom",
"profile": {},
"type": "5_bgp",
"public_ip_address": "161.xx.xx.12",

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

@ -158,6 +158,8 @@ Response Message
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| bandwidth_name | String | Specifies the bandwidth name. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| alias | String | Specifies the EIP name. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). |
| | | - When assigning an EIP, you need to associate an enterprise project ID with the EIP. |
| | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. |
@ -189,6 +191,7 @@ Response Message
{
"id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
"status": "DOWN",
"alias": "tom",
"profile": {},
"type": "5_bgp",
"public_ip_address": "161.xx.xx.9",

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

@ -68,6 +68,9 @@ Request Message
| | | | |
| | | | Leaving this parameter blank does not unbind the EIP from the dedicated load balancer. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| alias | No | String | - Specifies the EIP name. |
| | | | - The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Example request 1 (Binding an EIP to a NIC)
@ -166,6 +169,8 @@ Response Message
| | | - **PER**: Dedicated bandwidth |
| | | - **WHOLE**: Shared bandwidth |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| alias | String | Specifies the EIP name. |
+-----------------------+-----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| enterprise_project_id | String | - Specifies the enterprise project ID. The value is **0** or a string that contains a maximum of 36 characters in UUID format with hyphens (-). |
| | | - When you assign an EIP, associate an enterprise project ID with the EIP. |
| | | - If this parameter is not specified, the default value is **0**, which indicates that the default enterprise project is used. |
@ -196,6 +201,7 @@ Response Message
"publicip": {
"id": "f6318bef-6508-4ea5-a48f-6152b6b1a8fb",
"status": "ACTIVE",
"alias": "tom",
"profile": {},
"type": "5_bgp",
"port_id": "a135e9b8-1630-40d2-a6c5-eb534a61efbe",

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

@ -63,7 +63,7 @@ Response Message
| key | String | Specifies the tag key. |
| | | |
| | | - Cannot be left blank. |
| | | - Can contain a maximum of 36 characters. |
| | | - Contain up to 128 characters (36 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |
@ -73,7 +73,7 @@ Response Message
+-----------------------+-----------------------+---------------------------------------------------------------------+
| values | Array of strings | Specifies the tag value list. |
| | | |
| | | - Can contain a maximum of 43 characters. |
| | | - Contain up to 255 characters (43 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |

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

@ -119,14 +119,14 @@ Response Parameters
| | | |
| | | **neutron:VIP_PORT**: Virtual IP address |
| | | |
| | | **compute:subeni**: IP address of a supplementary network interface |
| | | |
| | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer |
| | | |
| | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer |
| | | |
| | | **network:endpoint_interface**: IP address of a VPC endpoint |
| | | |
| | | **network: nat_gateway**: IP address used by a NAT gateway |
| | | |
| | | - The value range specifies only the type of private IP addresses supported by the current service. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_address | String | Specifies the assigned private IP address. |

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

@ -85,14 +85,14 @@ Response Parameters
| | | |
| | | **neutron:VIP_PORT**: Virtual IP address |
| | | |
| | | **compute:subeni**: IP address of a supplementary network interface |
| | | |
| | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer |
| | | |
| | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer |
| | | |
| | | **network:endpoint_interface**: IP address of a VPC endpoint |
| | | |
| | | **network: nat_gateway**: IP address used by a NAT gateway |
| | | |
| | | - The value range specifies only the type of private IP addresses supported by the current service. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_address | String | Specifies the assigned private IP address. |

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

@ -106,14 +106,14 @@ Response Parameters
| | | |
| | | **neutron:VIP_PORT**: Virtual IP address |
| | | |
| | | **compute:subeni**: IP address of a supplementary network interface |
| | | |
| | | **neutron:LOADBALANCERV2**: IP address of a shared load balancer |
| | | |
| | | **neutron:LOADBALANCERV3**: IP address of a dedicated load balancer |
| | | |
| | | **network:endpoint_interface**: IP address of a VPC endpoint |
| | | |
| | | **network: nat_gateway**: IP address used by a NAT gateway |
| | | |
| | | - The value range specifies only the type of private IP addresses supported by the current service. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_address | String | Specifies the assigned private IP address. |

10
api-ref/source/apis/route_table/associating_subnets_with_a_route_table.rst
View File

@ -46,12 +46,12 @@ Request Parameters
.. table:: **Table 3** Description of the **routetable** field
+-----------------+-----------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
+-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+============================================================================+=====================================================================================================+
| subnets | Yes | Array of :ref:`subnet <vpc_apiroutetab_0005__table12518142212468>` objects | - Specifies the subnets associated with the route table. |
+=================+=================+==================================================================+=====================================================================================================+
| subnets | Yes | :ref:`subnet <vpc_apiroutetab_0005__table12518142212468>` object | - Specifies the subnets associated with the route table. |
| | | | - Only subnets in the VPC to which the route table belongs can be associated with the route table. |
+-----------------+-----------------+----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
+-----------------+-----------------+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+
.. _vpc_apiroutetab_0005__table12518142212468:
@ -144,6 +144,7 @@ Response Parameters
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| destination | String | - Specifies the destination CIDR block of a route. |
| | | - The value must be in the valid CIDR format. |
@ -160,6 +161,7 @@ Response Parameters
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the route. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |

4
api-ref/source/apis/route_table/creating_a_route_table.rst
View File

@ -82,6 +82,7 @@ Request Parameters
| | | | - **dc** (Direct Connect connection) |
| | | | - **cc** (Cloud Connect connection) |
| | | | - **egw**: VPC endpoint node |
| | | | - **er**: enterprise router |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
| destination | Yes | String | - Specifies the destination CIDR block of a route. |
| | | | - The value must be in the valid CIDR format. |
@ -98,6 +99,7 @@ Request Parameters
| | | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
| description | No | String | - Provides supplementary information about the route. |
| | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
@ -185,6 +187,7 @@ Response Parameters
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| destination | String | - Specifies the destination CIDR block of a route. |
| | | - The value must be in the valid CIDR format. |
@ -201,6 +204,7 @@ Response Parameters
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the route. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |

4
api-ref/source/apis/route_table/disassociating_subnets_from_a_route_table.rst
View File

@ -125,7 +125,7 @@ Response Parameters
| created_at | String | - Specifies the time (UTC) when the route table is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | - Specifies the time (UTC) when the route table is created. |
| updated_at | String | - Specifies the time (UTC) when the route table is updated. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
@ -148,6 +148,7 @@ Response Parameters
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| destination | String | - Specifies the destination CIDR block of a route. |
| | | - The value must be in the valid CIDR format. |
@ -164,6 +165,7 @@ Response Parameters
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the route. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |

2
api-ref/source/apis/route_table/querying_a_route_table.rst
View File

@ -101,6 +101,7 @@ Response Parameters
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| destination | String | - Specifies the destination CIDR block of a route. |
| | | - The value must be in the valid CIDR format. |
@ -117,6 +118,7 @@ Response Parameters
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the route. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |

8
api-ref/source/apis/route_table/updating_a_route_table.rst
View File

@ -105,6 +105,7 @@ Request Parameters
| | | | - **dc** (Direct Connect connection) |
| | | | - **cc** (Cloud Connect connection) |
| | | | - **egw**: VPC endpoint node |
| | | | - **er**: enterprise router |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
| destination | Yes | String | - Specifies the destination CIDR block of a route. |
| | | | - The value must be in the valid CIDR format. |
@ -121,6 +122,7 @@ Request Parameters
| | | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
| description | No | String | - Provides supplementary information about the route. |
| | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
@ -145,6 +147,7 @@ Request Parameters
| | | | - **dc** (Direct Connect connection) |
| | | | - **cc** (Cloud Connect connection) |
| | | | - **egw**: VPC endpoint node |
| | | | - **er**: enterprise router |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
| destination | Yes | String | - Specifies the destination CIDR block of a route. |
| | | | - The value must be in the valid CIDR format. |
@ -161,6 +164,7 @@ Request Parameters
| | | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
| description | No | String | - Provides supplementary information about the route. |
| | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
@ -185,6 +189,7 @@ Request Parameters
| | | | - **dc** (Direct Connect connection) |
| | | | - **cc** (Cloud Connect connection) |
| | | | - **egw**: VPC endpoint node |
| | | | - **er**: enterprise router |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
| destination | Yes | String | - Specifies the destination CIDR block of a route. |
| | | | - The value must be in the valid CIDR format. |
@ -201,6 +206,7 @@ Request Parameters
| | | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------+
| description | No | String | - Provides supplementary information about the route. |
| | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
@ -303,6 +309,7 @@ Response Parameters
| | | - **dc** (Direct Connect connection) |
| | | - **cc** (Cloud Connect connection) |
| | | - **egw**: VPC endpoint node |
| | | - **er**: enterprise router |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| destination | String | - Specifies the destination CIDR block of a route. |
| | | - The value must be in the valid CIDR format. |
@ -319,6 +326,7 @@ Response Parameters
| | | - When **type** is **dc**, the value is the Direct Connect connection ID. |
| | | - When **type** is **cc**, the value is the Cloud Connect connection ID. |
| | | - When **type** is set to **egw**, the value is the VPC endpoint ID. |
| | | - When **type** is set to **er**, the value is the ID of the enterprise router. |
+-----------------------+-----------------------+--------------------------------------------------------------------------------------------------+
| description | String | - Provides supplementary information about the route. |
| | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |

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

File diff suppressed because it is too large Load Diff

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

@ -73,6 +73,12 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| gateway_ip | String | Specifies the subnet gateway address. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| dhcp_enable | Boolean | Specifies whether DHCP is enabled for the subnet. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. |
@ -81,8 +87,6 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone | String | Identifies the AZ to which the subnet belongs. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | String | - Specifies the status of the subnet. |
@ -96,8 +100,25 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0002__table019517383270>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0002__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| scope | String | Specifies where the subnet is used. |
| | | |
| | | Values: |
| | | |
| | | - **center**: The subnet is used in a central AZ. |
| | | - *{azId}*: The subnet is used in an edge AZ. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Project ID |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | - Specifies the time (UTC) when the subnet is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | - Specifies the time (UTC) when the subnet is updated. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0002__table019517383270:
@ -136,10 +157,10 @@ Example Response
"status": "ACTIVE",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
"gateway_ip": "192.168.20.1",
"ipv6_enable": false,
"dhcp_enable": true,
"primary_dns": "114.xx.xx.114",
"secondary_dns": "114.xx.xx.115",
"availability_zone": "aa-bb-cc",
"neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
"neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12",
"extra_dhcp_opts": [
@ -152,6 +173,9 @@ Example Response
"opt_name": "addresstime"
}
]
"tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
"created_at": "2022-12-15T02:42:07",
"updated_at": "2022-12-15T02:42:07"
}
}

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

@ -88,6 +88,12 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| gateway_ip | String | Specifies the subnet gateway address. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | Boolean | Specifies whether an IPv6 subnet can be created. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| cidr_v6 | String | Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| gateway_ip_v6 | String | Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| dhcp_enable | Boolean | Specifies whether the DHCP function is enabled for the subnet. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| primary_dns | String | Specifies the IP address of DNS server 1 on the subnet. |
@ -96,8 +102,6 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| dnsList | Array of strings | Specifies the IP address list of DNS servers on the subnet. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| availability_zone | String | Identifies the AZ to which the subnet belongs. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| vpc_id | String | Specifies the ID of the VPC to which the subnet belongs. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| status | String | - Specifies the status of the subnet. |
@ -111,8 +115,25 @@ Response Parameters
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| neutron_subnet_id | String | Specifies the ID of the corresponding subnet (OpenStack Neutron API). |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| neutron_subnet_id_v6 | String | Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| extra_dhcp_opts | Array of :ref:`extra_dhcp_opt <vpc_subnet01_0003__table019517383270>` objects | Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see :ref:`Table 4 <vpc_subnet01_0003__table019517383270>`. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| scope | String | Specifies where the subnet is used. |
| | | |
| | | Values: |
| | | |
| | | - **center**: The subnet is used in a central AZ. |
| | | - *{azId}*: The subnet is used in an edge AZ. |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| tenant_id | String | Project ID |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| created_at | String | - Specifies the time (UTC) when the subnet is created. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| updated_at | String | - Specifies the time (UTC) when the subnet is updated. |
| | | - Format: *yyyy-MM-ddTHH:mm:ss* |
+-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet01_0003__table019517383270:
@ -152,12 +173,15 @@ Example Response
"status": "ACTIVE",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
"gateway_ip": "192.168.20.1",
"ipv6_enable": true,
"cidr_v6": "2001:db8:a583::/64",
"gateway_ip_v6": "2001:db8:a583::1",
"dhcp_enable": true,
"primary_dns": "114.xx.xx.114",
"secondary_dns": "114.xx.xx.115",
"availability_zone": "aa-bb-cc",
"neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
"neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12",
"neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4",
"extra_dhcp_opts": [
{
"opt_value": "10.100.0.33,10.100.0.34",
@ -168,6 +192,9 @@ Example Response
"opt_name": "addresstime"
}
]
"tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
"created_at": "2022-12-15T02:42:07",
"updated_at": "2022-12-15T02:42:07"
},
{
"id": "531dec0f-3116-411b-a21b-e612e42349fd",
@ -181,10 +208,10 @@ Example Response
"status": "ACTIVE",
"vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
"gateway_ip": "192.168.1.1",
"ipv6_enable": false,
"dhcp_enable": true,
"primary_dns": "114.xx.xx.114",
"secondary_dns": "114.xx.xx.115",
"availability_zone": "aa-bb-cc",
"neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd",
"neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78",
"extra_dhcp_opts": [
@ -197,6 +224,9 @@ Example Response
"opt_name": "addresstime"
}
],
"tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
"created_at": "2022-12-15T03:41:22",
"updated_at": "2022-12-15T03:41:22"
}
]
}

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

@ -57,6 +57,9 @@ Request Parameters
| description | No | String | - Provides supplementary information about the subnet. |
| | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_enable | No | Boolean | - Specifies whether an IPv6 subnet can be created. |
| | | | - The value can be **true** (enabled) or **false** (disabled). |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dhcp_enable | No | Boolean | - Specifies whether DHCP is enabled for the subnet. |
| | | | - The value can be **true** (enabled) or **false** (disabled). |
| | | | - If this parameter is left blank, the system automatically sets it to **true** by default. If this parameter is set to **false**, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init. Exercise caution when performing this operation. |
@ -65,7 +68,14 @@ Request Parameters
| | | | - The value must be a valid IP address. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| secondary_dns | No | String | - Specifies the IP address of DNS server 2 on the subnet. |
| | | | |
| | | | - The value must be a valid IP address. |
| | | | |
| | | | If the value of **primary_dns** is left blank, the value of **secondary_dns** has to be updated together with that of **primary_dns**. |
| | | | |
| | | | The value of **secondary_dns** to be updated must be different from that of **primary_dns**. |
| | | | |
| | | | If there is only one DNS server address, only **primary_dns** is displayed. |
+-----------------+-----------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dnsList | No | Array of strings | - Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers. |
| | | | - This parameter value is the superset of both DNS server address 1 and DNS server address 2. |

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

@ -64,7 +64,7 @@ Request Parameters
+=================+=================+=================+=====================================================================+
| key | String | Yes | - Specifies the tag key. |
| | | | - Cannot be left blank. |
| | | | - Can contain a maximum of 36 characters. |
| | | | - Contain up to 128 characters (36 characters on the console). |
| | | | - Can contain only the following character types: |
| | | | |
| | | | - Uppercase letters |
@ -75,7 +75,7 @@ Request Parameters
| | | | - The tag key of a VPC must be unique. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------+
| value | String | Yes | - Specifies the tag value. |
| | | | - Can contain a maximum of 43 characters. |
| | | | - Contain up to 255 characters (43 characters on the console). |
| | | | - Can contain only the following character types: |
| | | | |
| | | | - Uppercase letters |

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

@ -51,7 +51,7 @@ Request Parameters
+=================+=================+=================+=====================================================================+
| key | String | Yes | - Specifies the tag key. |
| | | | - Cannot be left blank. |
| | | | - Can contain a maximum of 36 characters. |
| | | | - Contain up to 128 characters (36 characters on the console). |
| | | | - Can contain only the following character types: |
| | | | |
| | | | - Uppercase letters |
@ -62,7 +62,7 @@ Request Parameters
| | | | - The tag key of a VPC must be unique. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------+
| value | String | Yes | - Specifies the tag value. |
| | | | - Can contain a maximum of 43 characters. |
| | | | - Contain up to 255 characters (43 characters on the console). |
| | | | - Can contain only the following character types: |
| | | | |
| | | | - Uppercase letters |

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

@ -63,7 +63,7 @@ Response Parameters
+=======================+=======================+=====================================================================+
| key | String | - Specifies the tag key. |
| | | - Cannot be left blank. |
| | | - Can contain a maximum of 36 characters. |
| | | - Contain up to 128 characters (36 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |
@ -74,7 +74,7 @@ Response Parameters
| | | - The tag key of a VPC must be unique. |
+-----------------------+-----------------------+---------------------------------------------------------------------+
| value | String | - Specifies the tag value. |
| | | - Can contain a maximum of 43 characters. |
| | | - Contain up to 255 characters (43 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |

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

@ -60,7 +60,7 @@ Response Parameters
| key | String | Specifies the tag key. |
| | | |
| | | - Cannot be left blank. |
| | | - Can contain a maximum of 36 characters. |
| | | - Contain up to 128 characters (36 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |
@ -70,7 +70,7 @@ Response Parameters
+-----------------------+-----------------------+---------------------------------------------------------------------+
| values | Array of strings | Specifies the tag value list. |
| | | |
| | | - Can contain a maximum of 43 characters. |
| | | - Contain up to 255 characters (43 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |

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

@ -55,7 +55,7 @@ Request Parameters
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+========+===========+==================+====================================================================================================================================================================================+
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| values | Yes | Array of strings | 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. |
+--------+-----------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -170,7 +170,7 @@ Response Parameters
+-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=======+===========+========+====================================================================================================================================================================================+
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
+-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+-------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -55,6 +55,7 @@ Request Parameters
| | | | - The value can contain no more than 255 characters and cannot contain angle brackets (< or >). |
+--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cidr | No | String | - Specifies the available IP address ranges for subnets in the VPC. |
| | | | |
| | | | - Possible values are as follows: |
| | | | |
| | | | - 10.0.0.0/8-24 |
@ -62,7 +63,12 @@ Request Parameters
| | | | - 192.168.0.0/16-24 |
| | | | |
| | | | - If **cidr** is not specified, the default value is left blank. |
| | | | - The value must be in CIDR format, for example, **192.168.0.0/16**. |
| | | | |
| | | | - Constraints: |
| | | | |
| | | | The value must be in CIDR format, for example, **192.168.0.0/16**. |
| | | | |
| | | | If you want to update the CIDR block of the VPC, the new CIDR block must contain all subnets in the VPC. |
+--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| routes | No | Array of :ref:`route <vpc_api01_0004__table1696324019336>` objects | - Specifies the route list. For details, see :ref:`Table 4 <vpc_api01_0004__table1696324019336>`. |
+--------------------+-----------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

@ -62,7 +62,7 @@ Request Parameters
+=================+=================+=================+=====================================================================+
| key | String | Yes | - Specifies the tag key. |
| | | | - Cannot be left blank. |
| | | | - Can contain a maximum of 36 characters. |
| | | | - Contain up to 128 characters (36 characters on the console). |
| | | | - Can contain only the following character types: |
| | | | |
| | | | - Uppercase letters |
@ -73,7 +73,7 @@ Request Parameters
| | | | - The tag key of a VPC must be unique. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------+
| value | String | Yes | - Specifies the tag value. |
| | | | - Can contain a maximum of 43 characters. |
| | | | - Contain up to 255 characters (43 characters on the console). |
| | | | - Can contain only the following character types: |
| | | | |
| | | | - Uppercase letters |

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

@ -49,7 +49,7 @@ Request Parameters
+=================+=================+=================+=====================================================================+
| key | String | Yes | - Specifies the tag key. |
| | | | - Cannot be left blank. |
| | | | - Can contain a maximum of 36 characters. |
| | | | - Contain up to 128 characters (36 characters on the console). |
| | | | - Can contain only the following character types: |
| | | | |
| | | | - Uppercase letters |
@ -60,7 +60,7 @@ Request Parameters
| | | | - The tag key of a VPC must be unique. |
+-----------------+-----------------+-----------------+---------------------------------------------------------------------+
| value | String | Yes | - Specifies the tag value. |
| | | | - Can contain a maximum of 43 characters. |
| | | | - Contain up to 255 characters (43 characters on the console). |
| | | | - Can contain only the following character types: |
| | | | |
| | | | - Uppercase letters |

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

@ -61,7 +61,7 @@ Response Parameters
+=======================+=======================+=====================================================================+
| key | String | - Specifies the tag key. |
| | | - Cannot be left blank. |
| | | - Can contain a maximum of 36 characters. |
| | | - Contain up to 128 characters (36 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |
@ -72,7 +72,7 @@ Response Parameters
| | | - The tag key of a VPC must be unique. |
+-----------------------+-----------------------+---------------------------------------------------------------------+
| value | String | - Specifies the tag value. |
| | | - Can contain a maximum of 43 characters. |
| | | - Contain up to 255 characters (43 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |

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

@ -60,7 +60,7 @@ Response Parameters
| key | String | Specifies the tag key. |
| | | |
| | | - Cannot be left blank. |
| | | - Can contain a maximum of 36 characters. |
| | | - Contain up to 128 characters (36 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |
@ -70,7 +70,7 @@ Response Parameters
+-----------------------+-----------------------+---------------------------------------------------------------------+
| values | Array of strings | Specifies the tag value list. |
| | | |
| | | - Can contain a maximum of 43 characters. |
| | | - Contain up to 255 characters (43 characters on the console). |
| | | - Can contain only the following character types: |
| | | |
| | | - Uppercase letters |

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

@ -55,7 +55,7 @@ Request Parameters
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+==================+=================================================================================================================================================================================================================+
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| values | Yes | Array of strings | Specifies the tag values. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. |
| | | | |
@ -174,7 +174,7 @@ Response Parameters
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Mandatory | Type | Description |
+=================+=================+==================+=================================================================================================================================================================================================================+
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
| key | Yes | String | Specifies the tag key. The value can contain a maximum of 128 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.) |
+-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| values | Yes | Array of strings | Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for **values** indicates any value. |
| | | | |

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

@ -8,6 +8,12 @@ Change History
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Released On | Description |
+===================================+=========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| 2023-11-15 | This release incorporates the following changes: |
| | |
| | Modified the alias information in the response body in :ref:`Querying an EIP <vpc_eip_0002>`. |
| | |
| | Modified IPv6-related fields in :ref:`Subnet <vpc_subnet01_0000>`. |
+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 2023-08-07 | This release incorporates the following changes: |
| | |
| | Added description about interconnection with IAM fine-grained authorization in :ref:`Permissions Policies and Supported Actions <vpc_permission_0000>`. |

11
api-ref/source/conf.py
View File

@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/virtual-private-cloud'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = 'internal'
otcdocs_doc_link = '/virtual-private-cloud/api-ref/'
otcdocs_doc_title = 'API Reference'
otcdocs_doc_type = 'api-ref'
otcdocs_service_category = 'network'
otcdocs_service_title = 'Virtual Private Cloud'
otcdocs_service_type = 'vpc'
otcdocs_search_environment = 'hc_de'
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.

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

File diff suppressed because it is too large Load Diff

54
api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_a_port.rst
View File

File diff suppressed because it is too large Load Diff

86
api-ref/source/native_openstack_neutron_apis_v2.0/port/querying_ports.rst
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@ -39,7 +39,7 @@ Request Parameters
+-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_group_id | No | String | Specifies the peer ID of the belonged security group. |
| | | | |
| | | | Either **remote_group_id** or **remote_ip_prefix** is used. |
| | | | This parameter is mutually exclusive with **remote_ip_prefix**. |
+-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| direction | Yes | String | Specifies the direction of the traffic for which the security group rule takes effect. |
| | | | |
@ -47,7 +47,7 @@ Request Parameters
+-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| remote_ip_prefix | No | String | Specifies the peer IP address segment. |
| | | | |
| | | | Either **remote_ip_prefix** or **remote_group_id** is used. |
| | | | This parameter is mutually exclusive with **remote_group_id**. |
+-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| protocol | No | String | Specifies the protocol type or the IP protocol number. |
| | | | |

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

@ -30,25 +30,33 @@ Request Parameters
.. table:: **Table 2** **subnet** objects
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Attribute | Mandatory | Type | Description |
+==================+=================+============================================================================+=================================================================================================================================================================================================================================================+
+===================+=================+============================================================================+=================================================================================================================================================================================================================================================+
| name | No | String | Specifies the subnet name. |
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_version | No | Integer | Specifies the IP address version. |
| | | | |
| | | | Supported versions: IPv4 |
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_address_mode | No | String | Specifies the IPv6 addressing mode. |
| | | | |
| | | | Only **dhcpv6-stateful** is supported. |
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_ra_mode | No | String | Specifies the IPv6 route broadcast mode. |
| | | | |
| | | | Only **dhcpv6-stateful** is supported. |
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| network_id | Yes | String | Specifies the ID of the network to which the subnet belongs. |
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| cidr | Yes | String | Specifies the CIDR format. |
| | | | |
| | | | Only the IPv4 addresses in the 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 ranges are supported. The subnet mask cannot be greater than 28. |
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gateway_ip | No | String | The gateway IP address cannot conflict with IP addresses configured for **allocation_pools**. |
| | | | |
| | | | This attribute cannot be modified. |
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| allocation_pools | No | Array of :ref:`allocation_pool <vpc_subnet02_0003__table24611730>` objects | Specifies the available IP address pool. For details, see :ref:`Table 3 <vpc_subnet02_0003__table24611730>`. |
| | | | |
| | | | Example: [ { "start": "10.0.0.2", "end": "10.0.0.251"} ] |
@ -58,7 +66,7 @@ Request Parameters
| | | | By default, the IP addresses reserved by the system are not in the IP address pool specified by **allocation_pool**. |
| | | | |
| | | | When updating an IP address pool, the **allocation_pool** value can contain neither gateway nor broadcast IP addresses. |
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| dns_nameservers | No | Array of strings | Specifies the DNS server address. |
| | | | |
| | | | Instructions: |
@ -66,15 +74,15 @@ Request Parameters
| | | | Example: "dns_nameservers": ["8.xx.xx.8","8.xx.xx.4"] |
| | | | |
| | | | A maximum of five DNS server addresses are supported. |
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| host_routes | No | Array of :ref:`host_route <vpc_subnet02_0003__table5232330>` objects | Specifies the static VM routes. For details, see :ref:`Table 4 <vpc_subnet02_0003__table5232330>`. |
| | | | |
| | | | Static routes are not supported, and entered information will be ignored. |
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| enable_dhcp | No | Boolean | Specifies whether to enable the DHCP function. Value **false** indicates that the DHCP function is not enabled. |
| | | | |
| | | | The value can only be **true**. |
+------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------+-----------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _vpc_subnet02_0003__table24611730:
@ -144,7 +152,15 @@ Response Parameters
+-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_version | Integer | Specifies the IP address version. |
| | | |
| | | Supported versions: IPv4 |
| | | Supported versions: IPv4 and IPv6 |
+-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_address_mode | String | Specifies the IPv6 addressing mode. |
| | | |
| | | Only **dhcpv6-stateful** is supported. |
+-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. |
| | | |
| | | Only **dhcpv6-stateful** is supported. |
+-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| network_id | String | Specifies the ID of the network to which the subnet belongs. |
+-----------------------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

10
api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_a_subnet.rst
View File

@ -53,7 +53,15 @@ Response Parameters
+-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_version | Integer | Specifies the IP address version. |
| | | |
| | | Supported versions: IPv4 |
| | | Supported versions: IPv4 and IPv6 |
+-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_address_mode | String | Specifies the IPv6 addressing mode. |
| | | |
| | | Only **dhcpv6-stateful** is supported. |
+-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. |
| | | |
| | | Only **dhcpv6-stateful** is supported. |
+-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| network_id | String | Specifies the ID of the network to which the subnet belongs. |
+-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

10
api-ref/source/native_openstack_neutron_apis_v2.0/subnet/querying_subnets.rst
View File

@ -118,7 +118,15 @@ Response Parameters
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_version | Integer | Specifies the IP address version. |
| | | |
| | | Supported versions: IPv4 |
| | | Supported versions: IPv4 and IPv6 |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_address_mode | String | Specifies the IPv6 addressing mode. |
| | | |
| | | Only **dhcpv6-stateful** is supported. |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. |
| | | |
| | | Only **dhcpv6-stateful** is supported. |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| network_id | String | Specifies the ID of the network to which the subnet belongs. |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

10
api-ref/source/native_openstack_neutron_apis_v2.0/subnet/updating_a_subnet.rst
View File

@ -130,7 +130,15 @@ Response Parameters
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ip_version | Integer | Specifies the IP address version. |
| | | |
| | | Supported versions: IPv4 |
| | | Supported versions: IPv4 and IPv6 |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_address_mode | String | Specifies the IPv6 addressing mode. |
| | | |
| | | Only **dhcpv6-stateful** is supported. |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| ipv6_ra_mode | String | Specifies the IPv6 route broadcast mode. |
| | | |
| | | Only **dhcpv6-stateful** is supported. |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| network_id | String | Specifies the ID of the network to which the subnet belongs. |
+-----------------------+---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+