Function
This API is used to assign an EIP.
-The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSss, BMSs, virtual IP addresses, NAT gateways, or load balancers.
+The EIP service provides independent public IP addresses and bandwidth for Internet access. EIPs can be bound to or unbound from ECSs, BMSs, virtual IP addresses, NAT gateways, or load balancers.
- In eu-de, no more new EIPs of this type can be assigned. You can assign EIPs of the BGP (5_bgp) type.
- Existing EIPs of the Dedicated Load Balancer (5_gray) type can be bound to dedicated or shared load balancers.
- The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
- You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see Binding an EIP and Unbinding an EIP.
- EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
- You are advised to bind or unbind BGP EIPs to or from dedicated load balancers.
- 5_gray EIPs cannot be added to the same shared bandwidth as EIPs of other types. If they are in the same shared bandwidth, the bandwidth limit settings will not take effect.
Integer
- Specifies the bandwidth size.
- The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.)
- This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified.
- The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
- The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
- The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
- The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
- Specifies the bandwidth size.
- The value ranges from 1 Mbit/s to 1000 Mbit/s by default. (The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.)
- This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified.
- The minimum increment for bandwidth adjustment varies depending on the bandwidth range. The details are as follows:
- The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 Mbit/s to 300 Mbit/s (with 300 Mbit/s included).
- The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 300 Mbit/s to 1000 Mbit/s (with 1000 Mbit/s included).
- The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
By default, new IAM users do not have permissions assigned. You need to add them to one or more groups and attach policies or roles to these groups. The users then inherit permissions from the groups. This way, they can perform specified operations on cloud services based on the permissions.
An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query VPCs using an API, the user must have been granted permissions that allow the vpc:vpcs:list action.
Supported Actions
VPC provides system-defined policies that can be directly used in IAM. You can also create custom policies to supplement system-defined policies for more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:
-- Permissions: statements in a policy that allow or deny certain operations
- APIs: REST APIs that can be called by a user who has been granted specific permissions
- Actions: specific operations that are allowed or denied
- IAM project/Enterprise project: A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management.
√: supported; x: not supported
+- Permissions: statements in a policy that allow or deny certain operations
- APIs: REST APIs that can be called by a user who has been granted specific permissions
- Actions: specific operations that are allowed or denied in a custom policy
- IAM project/Enterprise project: A custom policy can be applied to IAM projects or enterprise projects or both. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management.
√: supported; x: not supported
diff --git a/docs/vpc/api-ref/vpc_api01_0001.html b/docs/vpc/api-ref/vpc_api01_0001.html index aa09c13d..75121a0c 100644 --- a/docs/vpc/api-ref/vpc_api01_0001.html +++ b/docs/vpc/api-ref/vpc_api01_0001.html @@ -184,13 +184,6 @@-Parent topic: Permissions Policies and Supported Actions+Parent topic: Permissions and Supported Actions- Specifies the route information.
- For details, see the description of the route objects.
enable_shared_snat
-Boolean
-Specifies whether the shared SNAT function is enabled. The value true indicates that the function is enabled, and the value false indicates that the function is not enabled.
-enterprise_project_id
String
diff --git a/docs/vpc/api-ref/vpc_api01_0003.html b/docs/vpc/api-ref/vpc_api01_0003.html index 851196ac..231c335c 100644 --- a/docs/vpc/api-ref/vpc_api01_0003.html +++ b/docs/vpc/api-ref/vpc_api01_0003.html @@ -43,7 +43,7 @@Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.
This parameter can work together with the parameter limit.
-- If parameters marker and limit are not passed, resource records on the first page will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
- If parameters marker and limit are not passed, resource records on the first page will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, 11th to 2,000th resource records will be returned. The default value of limit is 2000.
limit
diff --git a/docs/vpc/api-ref/vpc_api_0003.html b/docs/vpc/api-ref/vpc_api_0003.html index 192d85d8..30c57d54 100644 --- a/docs/vpc/api-ref/vpc_api_0003.html +++ b/docs/vpc/api-ref/vpc_api_0003.html @@ -9,31 +9,31 @@ }Error Code Description
-Module
+diff --git a/docs/vpc/api-ref/vpc_api_0012.html b/docs/vpc/api-ref/vpc_api_0012.html index b5fde3e4..6ce89694 100644 --- a/docs/vpc/api-ref/vpc_api_0012.html +++ b/docs/vpc/api-ref/vpc_api_0012.html @@ -2,13 +2,31 @@Module
Status Code
+Status Code
Error Code
Message
Description
+Description
Handling Measure
+Handling Measure
Public
+Public
400
+400
VPC.0002
Available zone Name is null.
The AZ is left blank.
+The AZ is left blank.
Check whether the availability_zone field in the request body for creating a subnet is left blank.
+Check whether the availability_zone field in the request body for creating a subnet is left blank.
404
@@ -80,17 +80,17 @@Contact technical support.
Public
+Public
400
+400
VPC.0007
urlTenantId is not equal tokenTenantId
Inconsistent tenant IDs.
+Inconsistent tenant IDs.
The tenant ID in the URL is different from that parsed in the token.
+The tenant ID in the URL is different from that parsed in the token.
401
@@ -115,18 +115,18 @@Check whether the account balance is insufficient or whether your account has been frozen.
Public
+Public
403
+403
VPC.0010
Rules on xx by ** disallowed by policy
Insufficient permissions to make calls to the underlying system.
+Insufficient permissions to make calls to the underlying system.
Obtain the required permissions.
+Obtain the required permissions.
403
@@ -140,17 +140,17 @@Obtain the required permissions.
Creating a VPC
+Creating a VPC
400
+400
VPC.0101
Param is invalid.
VPC parameters are incorrect.
+VPC parameters are incorrect.
Check whether the parameter values are valid based on the returned error message and API reference document.
+Check whether the parameter values are valid based on the returned error message and API reference document.
409
@@ -175,17 +175,17 @@Change the VPC name.
Querying a VPC
+Querying a VPC
400
+400
VPC.0101
getVpc error vpcId is invalid.
VPC parameters are incorrect.
+VPC parameters are incorrect.
Ensure that the specified VPC ID is correct.
+Ensure that the specified VPC ID is correct.
404/500
@@ -210,17 +210,17 @@Check whether the Neutron service is normal or contact technical support.
Querying VPCs
+Querying VPCs
400
+400
VPC.0101
Query vpc list error.
Failed to query the VPCs.
+Failed to query the VPCs.
Check whether the parameter values are valid based on the returned error message.
+Check whether the parameter values are valid based on the returned error message.
500
@@ -245,17 +245,17 @@Check whether the Neutron service is normal or contact technical support.
Deleting a VPC
+Deleting a VPC
400/404
+400/404
VPC.0101
Delete router error xx is invalid.
Invalid parameters.
+Invalid parameters.
Check whether the parameter values are valid based on the returned error message.
+Check whether the parameter values are valid based on the returned error message.
500
@@ -390,30 +390,30 @@Delete extension routes in the VPC.
Deleting a VPC
+Deleting a VPC
409
+409
VPC.0109
Router is used not allow deleted.
Failed to delete the VPC because one or more VPNs have been created for it.
+Failed to delete the VPC because one or more VPNs have been created for it.
Delete VPNs of the tenant.
+Delete VPNs of the tenant.
Updating a VPC
+Updating a VPC
400
+400
VPC.0101
Update router xx is invalid.
Invalid parameters.
+Invalid parameters.
Check whether the parameter values are valid based on the returned error message.
+Check whether the parameter values are valid based on the returned error message.
404/500
@@ -460,17 +460,17 @@Change the CIDR block of the VPC.
Creating a subnet
+Creating a subnet
400
+400
VPC.0201
Subnet name is invalid.
Incorrect subnet parameters.
+Incorrect subnet parameters.
Check whether the parameter values are valid based on the returned error message and API reference document.
+Check whether the parameter values are valid based on the returned error message and API reference document.
500
@@ -517,17 +517,17 @@Check whether the subnet CIDR block is valid.
Querying a subnet
+Querying a subnet
400
+400
VPC.0201
Subnet ID is invalid.
Invalid subnet ID.
+Invalid subnet ID.
Check whether the subnet ID is valid.
+Check whether the subnet ID is valid.
404/500
@@ -541,17 +541,17 @@Contact technical support.
Querying subnets
+Querying subnets
400
+400
VPC.0201
Query subnets list error.
Failed to query the subnets.
+Failed to query the subnets.
Check whether the parameter values are valid based on the returned error message.
+Check whether the parameter values are valid based on the returned error message.
500
@@ -565,17 +565,17 @@Contact technical support.
Deleting a subnet
+Deleting a subnet
400
+400
VPC.0201
Subnet ID is invalid.
Invalid subnet ID.
+Invalid subnet ID.
Check whether the parameter values are valid based on the returned error message.
+Check whether the parameter values are valid based on the returned error message.
404/500
@@ -644,30 +644,30 @@Delete load balancers in the subnet.
Deleting a subnet
+Deleting a subnet
500
+500
VPC.0206
Subnet has been used by VPN, please remove the subnet from the VPN and try again.
The subnet cannot be deleted because it is being used by the VPN.
+The subnet cannot be deleted because it is being used by the VPN.
Delete the subnet that is used by the VPN.
+Delete the subnet that is used by the VPN.
Updating a subnet
+Updating a subnet
400
+400
VPC.0201
xx is invalid.
Incorrect subnet parameters.
+Incorrect subnet parameters.
Check whether the parameter values are valid based on the returned error message.
+Check whether the parameter values are valid based on the returned error message.
404/500
@@ -703,18 +703,18 @@Check whether the subnet is in the VPC.
Assigning an EIP
+Assigning an EIP
400
+400
VPC.0301
Bandwidth name or share_type is invalid.
The specified bandwidth parameter for assigning an EIP is invalid.
+The specified bandwidth parameter for assigning an EIP is invalid.
Check whether the specified bandwidth parameter is valid.
+Check whether the specified bandwidth parameter is valid.
400
@@ -827,17 +827,17 @@Release unbound EIPs or try again later.
Querying an EIP
+Querying an EIP
400
+400
VPC.0501
Invalid floatingip_id.
Invalid EIP parameters.
+Invalid EIP parameters.
Check whether the EIP ID is valid.
+Check whether the EIP ID is valid.
404
@@ -862,30 +862,30 @@Check whether the Neutron service is normal or contact technical support.
Querying EIPs
+Querying EIPs
400
+400
VPC.0501
Invalid limit.
Invalid EIP parameters.
+Invalid EIP parameters.
Check whether the parameter values are valid based on the returned error message and API reference document.
+Check whether the parameter values are valid based on the returned error message and API reference document.
Releasing an EIP
+Releasing an EIP
400
+400
VPC.0501
Invalid param.
Invalid EIP parameters.
+Invalid EIP parameters.
Contact technical support.
+Contact technical support.
404
@@ -954,17 +954,17 @@Contact technical support.
Updating an EIP
+Updating an EIP
400
+400
VPC.0501
Port id is invalid.
Invalid EIP parameters.
+Invalid EIP parameters.
Check whether the port ID is valid.
+Check whether the port ID is valid.
404
@@ -1033,18 +1033,18 @@Check whether the Neutron service is normal or contact technical support.
Querying a bandwidth
+Querying a bandwidth
400
+400
VPC.0301
getBandwidth error bandwidthId is invalid.
The bandwidth parameters are incorrect.
+The bandwidth parameters are incorrect.
Check whether the bandwidth ID is valid.
+Check whether the bandwidth ID is valid.
404
@@ -1069,17 +1069,17 @@Check whether the Neutron service is normal or contact technical support.
Querying bandwidths
+Querying bandwidths
400
+400
VPC.0301
Get bandwidths error limit is invalid.
The bandwidth parameters are incorrect.
+The bandwidth parameters are incorrect.
Check whether the parameter values are valid based on the returned error message and API reference document.
+Check whether the parameter values are valid based on the returned error message and API reference document.
404
@@ -1104,17 +1104,17 @@Check whether the Neutron service is normal or contact technical support.
Updating a bandwidth
+Updating a bandwidth
400
+400
VPC.0301
updateBandwidth input param is invalid.
The bandwidth parameters are incorrect.
+The bandwidth parameters are incorrect.
Check whether the parameter values are valid based on the returned error message and API reference document.
+Check whether the parameter values are valid based on the returned error message and API reference document.
500
@@ -1139,30 +1139,30 @@Contact technical support.
Querying quotas
+Querying quotas
400
+400
VPC.1207
resource type is invalid.
The specified resource type does not exist.
+The specified resource type does not exist.
Use an existing resource type.
+Use an existing resource type.
Assigning a private IP address
+Assigning a private IP address
500
+500
VPC.0701
The IP has been used.
The private IP address already exists.
+The private IP address already exists.
Change another private IP address and try again.
+Change another private IP address and try again.
400
@@ -1198,43 +1198,43 @@Check whether the subnet has sufficient IP addresses.
Querying a Private IP Address
+Querying a Private IP Address
404
+404
VPC.0704
Query resource by id fail.
The private IP address does not exist.
+The private IP address does not exist.
Check whether the private IP address exists.
+Check whether the private IP address exists.
Querying Private IP Addresses
+Querying Private IP Addresses
400
+400
VPC.0702
query privateIps error.
Invalid parameters.
+Invalid parameters.
Check whether the parameter values are valid based on the returned error message.
+Check whether the parameter values are valid based on the returned error message.
Releasing a Private IP Address
+Releasing a Private IP Address
404
+404
VPC.0704
Query resource by id fail.
The private IP address does not exist.
+The private IP address does not exist.
Check whether the private IP address exists.
+Check whether the private IP address exists.
500
@@ -1259,18 +1259,18 @@Check whether the private IP address is being used by other resource.
Creating a security group
+Creating a security group
400
+400
VPC.0601
Creating securitygroup name is invalid.
The parameters of the security group are incorrect.
+The parameters of the security group are incorrect.
Check whether the parameter values are valid based on the returned error message and API reference document.
+Check whether the parameter values are valid based on the returned error message and API reference document.
500
@@ -1295,17 +1295,17 @@Delete the security group that is no longer required or apply for increasing the quota.
Querying a security group
+Querying a security group
400
+400
VPC.0601
Securitygroup id is invalid.
The parameters of the security group are incorrect.
+The parameters of the security group are incorrect.
Check whether the security group ID is valid.
+Check whether the security group ID is valid.
500
@@ -1341,17 +1341,17 @@Contact technical support.
Querying security groups
+Querying security groups
400
+400
VPC.0601
Query security groups error limit is invalid.
The parameters of the security group are incorrect.
+The parameters of the security group are incorrect.
Check whether the parameter values are valid based on the returned error message and API reference document.
+Check whether the parameter values are valid based on the returned error message and API reference document.
500
@@ -1365,17 +1365,17 @@Check whether the Neutron service is normal or contact technical support.
Associating multiple NIC ports to or disassociating them from a security group at a time
+Associating multiple NIC ports to or disassociating them from a security group at a time
400
+400
VPC.0606
Security group id is invalid
Invalid security group ID.
+Invalid security group ID.
Use a valid security group ID.
+Use a valid security group ID.
400
@@ -1488,19 +1488,19 @@Contact technical support.
Flow log
+Flow log
400
+400
VPC.3001
resource could not be found, flowlog id is invalid
Invalid parameters.
+Invalid parameters.
Check whether the parameters are valid.
+Check whether the parameters are valid.
400
@@ -1536,17 +1536,17 @@Contact technical support.
Resource tags
+Resource tags
400
+400
VPC.1801
resource id is invalid.
Incorrect resource ID.
+Incorrect resource ID.
Use a correct resource ID.
+Use a correct resource ID.
400
@@ -1793,17 +1793,17 @@Use an existing resource or obtain required permission.
Querying the network IP address usage
+Querying the network IP address usage
400
+400
VPC.2301
parameter network_id is invalid.
The request parameter is incorrect.
+The request parameter is incorrect.
Enter a valid network ID.
+Enter a valid network ID.
400
@@ -1817,17 +1817,17 @@Ensure that the network ID exists.
Creating a VPC flow log
+Creating a VPC flow log
400
+400
VPC.3001
resource_type/log_store_type/traffic_type/log_group_id/log_topic_id is invalid
Incorrect type or ID.
+Incorrect type or ID.
Check whether the type is supported or whether the ID format is correct.
+Check whether the type is supported or whether the ID format is correct.
400
@@ -1874,17 +1874,17 @@Try again later or contact technical support.
Querying VPC flow logs
+Querying VPC flow logs
404
+404
VPC.3001
resource could not be found, xxx(listParam) is invalid
Invalid parameters.
+Invalid parameters.
Check whether the parameter format is correct.
+Check whether the parameter format is correct.
500
@@ -1898,17 +1898,17 @@Try again later or contact technical support.
Querying a VPC flow log
+Querying a VPC flow log
404
+404
VPC.3001
resource could not be found, flowlog id is invalid.
Invalid VPC flow log ID.
+Invalid VPC flow log ID.
Check whether the VPC flow log ID format is correct.
+Check whether the VPC flow log ID format is correct.
404
@@ -1922,17 +1922,17 @@Check whether the VPC flow log exists or whether its ID is correct.
Updating a VPC flow log
+Updating a VPC flow log
404
+404
VPC.3001
resource could not be found, flowlog id is invalid.
Invalid VPC flow log ID.
+Invalid VPC flow log ID.
Check whether the VPC flow log ID format is correct.
+Check whether the VPC flow log ID format is correct.
404
@@ -1957,17 +1957,17 @@Try again later or contact technical support.
Deleting a VPC flow log
+Deleting a VPC flow log
404
+404
VPC.3001
resource could not be found, flowlog id is invalid.
Invalid VPC flow log ID.
+Invalid VPC flow log ID.
Check whether the VPC flow log ID format is correct.
+Check whether the VPC flow log ID format is correct.
404
@@ -1992,6 +1992,657 @@Try again later or contact technical support.
Querying a VPC (V3)
+ +400
+SYS.0400
+['xxx'] is invalid attribute for filter: Unknown attribute.
+Incorrect parameters.
+Enter valid filter parameters.
+404
+VPC.9904
+Vpc xxx could not be found.
+The queried VPC does not exist.
+Check whether the VPC to be queried exists.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Adding a secondary CIDR block to a VPC (V3)
+ +400
+SYS.0400
+'xxx' isn't supported attribute.
+Invalid request parameter.
+Modify request body parameters based on the error information.
+400
+VPC.9911
+xxx is not a valid cidr format.
+Invalid CIDR block format.
+Enter a valid CIDR block.
+400
+VPC.9912
+Input extend cidr num xxx over limit xxx.
+The number of secondary CIDR blocks to be added exceeds the upper limit.
+Check whether there are too many secondary CIDR blocks in the VPC.
+409
+VPC.9914
+Add Extend cidr xxx conflict with exist cidr xxx.
+The secondary CIDR block conflicts with an existing CIDR block.
+Enter a different secondary CIDR block.
+400
+VPC.9916
+Add Extend cidr %s conflict with black list cidr %s-24.
+The secondary CIDR block overlaps with a blacklisted CIDR block.
+Enter a secondary CIDR block that is not blacklisted. For details about the secondary CIDR block blacklist, see the API Reference.
+Removing a secondary CIDR block from a VPC (V3)
+400
+SYS.0400
+'xxx' isn't supported attribute.
+Invalid request parameter.
+Modify request body parameters based on the error information.
+404
+VPC.9915
+Extend cidr xxx could not be found.
+The secondary CIDR block to be removed does not exist.
+Enter an existing secondary CIDR block.
+Querying an IP address group
+ + + +400
+SYS.0400
+['xxx'] is invalid attribute for filter: Unknown attribute.
+Invalid filter parameters.
+Enter valid filter parameters.
+404
+VPC.9904
+Address_group xxx could not be found.
+The IP address group does not exist.
+Check whether the IP address group exists.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Creating an IP address group
+ + + + +400
+SYS.0400
+'xxx' isn't supported attribute.
+Invalid request parameter.
+Modify request body parameters based on the error information.
+400
+VPC.9901
+Duplicate ip_set in request body xxx.
+The ip_set request body contains duplicate data.
+Ensure that the ip_set request body does not contain duplicate data.
+400
+VPC.9901
+Invalid ip_set:xxx parameter in request body.
+Invalid data in the value of parameter ip_set.
+Ensure that the data in the value of parameter ip_set is valid.
+409
+VPC.9905
+Quota exceeded for resources: 'address_group'.
+Insufficient IP address group quota.
+Delete the address groups that are not required or increase the quota.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Updating an IP address group
+ + + + +400
+SYS.0400
+'xxx' isn't supported attribute.
+Invalid request parameter.
+Modify request body parameters based on the error information.
+400
+VPC.9901
+Duplicate ip_set in request body xxx.
+The ip_set request body contains duplicate data.
+Ensure that the ip_set request body does not contain duplicate data.
+400
+VPC.9901
+Invalid ip_set:xxx parameter in request body.
+Invalid data in the value of parameter ip_set.
+Ensure that the data in the value of parameter ip_set is valid.
+404
+VPC.9904
+Address_group xxx could not be found.
+The IP address group to be updated does not exist.
+Check whether the IP address group exists.
+409
+VPC.9905
+Quota exceeded for resources: ['address_group_contain_ipset'].
+Insufficient IP address group rule quota.
+Delete rules that are not required from the IP address group or increase the rule quota.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Deleting an IP address group
+ + +404
+VPC.9904
+Address_group xxx could not be found.
+The IP address group to be deleted does not exist.
+Check whether the IP address group exists.
+409
+VPC.9907
+1. Addressgroup xxx is used by securitygroup rules.
+2. Addressgroup xxx is used by firewall rules.
+1. The IP address group is used by a security group rule.
+2. The IP address group is used by a network ACL rule.
+Check whether the security group rule or network ACL rule is required. If not, use the API for forcibly deleting the IP address group.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Querying a security group (V3)
+ + +400
+SYS.0400
+['xxx'] is invalid attribute for filter: Unknown attribute.
+Incorrect parameters.
+Enter valid filter parameters.
+404
+VPC.9904
+Security group xxx does not exist.
+The security group to be queried does not exist.
+Check whether the security group to be queried exists.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Creating a security group (V3)
+ + +400
+SYS.0400
+'xxx' isn't supported attribute.
+Invalid request parameter.
+Modify request body parameters based on the error information.
+409
+VPC.9905
+Quota exceeded for resources: security_group.
+Insufficient security group quota.
+Delete the security groups that are not required or increase the quota.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Updating a security group (V3)
+ + +400
+SYS.0400
+'xxx' isn't supported attribute.
+Invalid request parameter.
+Modify request body parameters based on the error information.
+404
+VPC.9904
+SecurityGroup xxx could not be found.
+The security group to be updated does not exist.
+Check whether the security group to be queried exists.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Deleting a security group (V3)
+ + + + +404
+VPC.9904
+Security_group xxx could not be found.
+The security group to be deleted does not exist.
+Check whether the security group exists.
+409
+VPC.9902
+Security Group xxx is in use.
+The security group to be deleted is associated with a port.
+Disassociate the port from the security group and try again.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Querying a security group rule (V3)
+ + + + + +400
+SYS.0400
+['xxx'] is invalid attribute for filter: Unknown attribute.
+Incorrect parameters.
+Enter valid filter parameters.
+404
+VPC.9904
+Security_group_rule xxx could not be found.
+The security group rule to be queried does not exist.
+Check whether the security group rule exists.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Creating a security group rule (V3)
+ + + + + + + +400
+SYS.0400
+'xxx' isn't supported attribute.
+Invalid request parameter.
+Modify request body parameters based on the error information.
+409
+VPC.9905
+Quota exceeded for resources: ['security_group_rule'].
+Insufficient security group rule quota.
+Delete the security group rules that are not required or increase the quota.
+404
+VPC.9904
+security_group_id xxx could not be found.
+The security group defined by security_group_id does not exist.
+Check whether the security group information is correct.
+404
+VPC.9904
+remote security group xxx could not be found.
+The security group defined by remote_group_id does not exist.
+Check whether the security group information is correct.
+404
+VPC.9904
+Address group xxx does not exist.
+The IP address group defined by remote_address_group_id does not exist.
+Check whether the IP address group information is correct.
+400
+VPC.9902
+Security group rule for ethertype xxx not supported. Allowed values are [IPv4, IPv6].
+Invalid ethertype value.
+Modify the request parameter. Enter a valid ethertype value. Supported values are IPv4 and IPv6, which are case insensitive.
+400
+VPC.9902
+Ethertype xxx and address_group ip_version xxx not match
+The ethertype value in the request is inconsistent with the IP version of the IP address group.
+Check the IP version of the IP address group defined by remote_address_group_id. The IP address version must be the same as the ethertype value.
+409
+VPC.9902
+Security group rule already exists. Rule id is xxx.
+The security group rule already exists.
+Ensure that the specified security group rule does not conflict with existing rules.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Deleting a security group rule (V3)
+ +404
+VPC.9904
+Security_group_rule xxx could not be found.
+The security group rule to be queried does not exist.
+Check whether the security group rule exists.
+500
+SYS.0500
+Internal Server Error.
+Internal exception.
+Contact technical support.
+Change History
-Released On
+Released On
Description
+Description
2024-09-02
+2024-11-13
+This release incorporates the following changes:
+- Added parameter project_id in section "Querying Security Groups".
- Added parameters priority, ethertype, project_id, and remote_address_group_id in section "Querying Security Group Rules".
2024-10-21
+This release incorporates the following changes:
+- Added VPC (V3), Security Group (V3), and Security Group Rule (V3) in section "Permissions and Supported Actions".
- Added Section "Error Codes" in V3 APIs.
2024-09-06
+This release incorporates the following changes:
+- Deleted the response parameter enable_shared_snat from section Creating a VPC.
- Added section "Security Group".
- Added section "Security Group Rule".
2024-09-02
This release incorporates the following changes:
Deleted parameters created_at and updated_at from section Querying Floating IP Addresses.
@@ -106,7 +124,7 @@2023-08-07
This release incorporates the following changes:
-Added description about interconnection with IAM fine-grained authorization in Permissions Policies and Supported Actions.
+Added description about interconnection with IAM fine-grained authorization in Permissions and Supported Actions.
2023-06-20
@@ -204,26 +222,26 @@2020-06-30
This release incorporates the following changes:
-- Added the routes field in section Updating a VPC.
- Added field index_enabled in section VPC Flow Log.
- Modified URI parameters in sections Querying Security Group Rule Details and Deleting a Security Group Rule.
- Modified description of the tenant_id field in section Creating a VPC Peering Connection.
- Modified the network_ip_availability parameter type in section Querying IP Address Usage on a Specified Network.
- Modified the networks parameter type in section Querying Networks.
- Added response parameter project_id in sections Adding an Interface to a Router and Removing an Interface from a Router.
- Added the device_owner field in section Creating a Port.
- Added information about whether the allow_address_pair and extra_dhcp_opt fields are mandatory in section Updating a Port.
- Added or modified the ports_links, binding:profile, and binding:vif_details fields in section Port.
- Added the networks_links field in section Network.
- Added the subnets_links field in section Subnet.
- Added the routers_links field in section Router.
- Added or modified the firewall_rules_links and firewall_policies fields in section Firewall.
- Modified the URI in sections Querying a Security Group Rule and Deleting a Security Group Rule.
- Added the tenant_id field in sections Creating a Security Group and Querying Security Group Rule Details.
- Added the peerings_link object in section Querying VPC Peering Connections.
- Added the routes_link object in section Querying VPC Routes.
- Added the fixed_ip field in section Creating a Port.
- Added the firewall_policies_link object in section Querying Firewall Policies.
- Added the project_id field in sections Inserting a Firewall Rule and Removing a Firewall Rule.
- Added the created_at and updated_at fields in sections Querying Firewall Groups, Querying a Firewall Group, Creating a Firewall Group, and Updating a Firewall Group.
- Added the firewall_groups_link object in section Querying Firewall Groups.
- Changed the position of the section Permissions Policies and Supported Actions and adjusted the table.
- Added the routes field in section Updating a VPC.
- Added field index_enabled in section VPC Flow Log.
- Modified URI parameters in sections Querying Security Group Rule Details and Deleting a Security Group Rule.
- Modified description of the tenant_id field in section Creating a VPC Peering Connection.
- Modified the network_ip_availability parameter type in section Querying IP Address Usage on a Specified Network.
- Modified the networks parameter type in section Querying Networks.
- Added response parameter project_id in sections Adding an Interface to a Router and Removing an Interface from a Router.
- Added the device_owner field in section Creating a Port.
- Added information about whether the allow_address_pair and extra_dhcp_opt fields are mandatory in section Updating a Port.
- Added or modified the ports_links, binding:profile, and binding:vif_details fields in section Port.
- Added the networks_links field in section Network.
- Added the subnets_links field in section Subnet.
- Added the routers_links field in section Router.
- Added or modified the firewall_rules_links and firewall_policies fields in section Firewall.
- Modified the URI in sections Querying a Security Group Rule and Deleting a Security Group Rule.
- Added the tenant_id field in sections Creating a Security Group and Querying Security Group Rule Details.
- Added the peerings_link object in section Querying VPC Peering Connections.
- Added the routes_link object in section Querying VPC Routes.
- Added the fixed_ip field in section Creating a Port.
- Added the firewall_policies_link object in section Querying Firewall Policies.
- Added the project_id field in sections Inserting a Firewall Rule and Removing a Firewall Rule.
- Added the created_at and updated_at fields in sections Querying Firewall Groups, Querying a Firewall Group, Creating a Firewall Group, and Updating a Firewall Group.
- Added the firewall_groups_link object in section Querying Firewall Groups.
- Changed the position of the section Permissions and Supported Actions and adjusted the table.
2020-04-13
This release incorporates the following changes:
-- Modified description of parameters in the security_group_rule field in section Creating a Security Group Rule.
- Added URI parameter description in Port, Network, Querying Subnets, Querying Routers, Firewall, and Security Group.
- Added description of discarding vpc_id in section Creating a Security Group.
- Modified description of parameters in the security_group_rule field in section Adding a Security Group Rule.
- Added URI parameter description in Port, Network, Querying Subnets, Querying Routers, Firewall, and Security Group.
- Added description of discarding vpc_id in section Creating a Security Group.
2020-03-20
This release incorporates the following changes:
-Added the value of 5_mailbgp for parameters type and publicip_type
+Added the value of 5_mailbgp for parameters type and publicip_type
in sections Assigning an EIP, Bandwidth, and Bandwidth (V2.0).
2020-02-25
This release incorporates the following changes:
-- Added section Bandwidth (V2.0).
- Added Bandwidth (V2.0) in section Permissions Policies and Supported Actions.
- Added section Bandwidth (V2.0).
- Added Bandwidth (V2) in section Permissions and Supported Actions.
2019-09-10
@@ -241,7 +259,7 @@2018-10-22
This release incorporates the following changes:
-- Added sections APIs and Native OpenStack Neutron APIs (V2.0) and categorized VPC APIs and native OpenStack APIs.
- Deleted description about the Reject rule from section Updating a Firewall Rule.
- Added the project_id, created_at, and updated_at fields to and modified the example request and response in sections Port, Network, Subnet, Router, Floating IP Address, Firewall, and Security Group.
- Modified the API format to ensure consistency.
- Modified description about the tenant_id and project_id fields to ensure consistency.
- Added section VPC Peering Connection under API Permissions.
- Added sections APIs and Native OpenStack Neutron APIs (V2.0) and categorized VPC APIs and native OpenStack APIs.
- Deleted description about the Reject rule from section Updating a Firewall Rule.
- Added the project_id, created_at, and updated_at fields to and modified the example request and response in sections Port, Network, Subnet, Router, Floating IP Address, Firewall, and Security Group.
- Modified the API format to ensure consistency.
- Modified description about the tenant_id and project_id fields to ensure consistency.
- Added section VPC Peering Connection under API Permissions.
2018-10-12
@@ -265,7 +283,7 @@2018-07-30
This release incorporates the following changes:
-- Added section Permissions Policies and Supported Actions.
- Deleted sections related to VPNs. An independent VPN API reference will be provided.
- Added section Permissions and Supported Actions.
- Deleted sections related to VPNs. An independent VPN API reference will be provided.
2018-06-11
@@ -301,32 +319,32 @@2018-01-30
This release incorporates the following changes:
-- Deleted the section Port.
- Added section VPN (Native OpenStack API).
- Added section Subnet Pool (Native OpenStack API).
- Added parameters dns_name and dns_domain in the floating IP address object table in section Floating IP Address (Native OpenStack API).
- Added parameters dns_name and dns_assignment in the port object table in section Port (Native OpenStack API) > Overview.
- Added the parameter dns_domain in the network object table in section Network (Native OpenStack API) > Overview.
- Deleted the section Port.
- Added section VPN (Native OpenStack API).
- Added section Subnet Pool (Native OpenStack API).
- Added parameters dns_name and dns_domain in the floating IP address object table in section Floating IP Address (Native OpenStack API).
- Added parameters dns_name and dns_assignment in the port object table in section Port (Native OpenStack API) > Overview.
- Added the parameter dns_domain in the network object table in section Network (Native OpenStack API) > Overview.
2017-11-30
This release incorporates the following changes:
-- Added parameter port_security_enable in section Creating a Subnet.
- Modified the port_id parameter description in the publicip fields in section Binding or Unbinding an EIP under Elastic IP Address.
- Updated the device_owner parameter description in the port object table in section Port (Native OpenStack API) > Overview.
- Added the min parameter to the resources field in the response in section Querying Quotas.
- Added parameter port_security_enable in section Creating a Subnet.
- Modified the port_id parameter description in the publicip fields in section Binding or Unbinding an EIP under Elastic IP Address.
- Updated the device_owner parameter description in the port object table in section Port (Native OpenStack API) > Overview.
- Added the min parameter to the resources field in the response in section Querying Quotas.
2017-09-30
This release incorporates the following changes:
-- Deleted the ip_version field from the floatingip object, request parameter, and response parameter in section Floating IP Address (Native OpenStack API).
- Added section VPC Peering Connection.
- Added section VPC Route.
- Added a filter field to the URI of the APIs in sections Querying Ports and Querying VPC Routes.
- Deleted the ip_version field from the floatingip object, request parameter, and response parameter in section Floating IP Address (Native OpenStack API).
- Added section VPC Peering Connection.
- Added section VPC Route.
- Added a filter field to the URI of the APIs in sections Querying Ports and Querying VPC Routes.
2017-08-30
This release incorporates the following changes:
-Updated description in section Updating a Network under Network (Native OpenStack API).
-- Added section Elastic IP Address V2.0 (Extended OpenStack API).
- Deleted the ip_version field from the floatingip object, request parameter, and response parameter in section Floating IP Address (Native OpenStack API).
Updated description in section Updating a Network under Network (Native OpenStack API).
+- Added section Elastic IP Address V2.0 (Extended OpenStack API).
- Deleted the ip_version field from the floatingip object, request parameter, and response parameter in section Floating IP Address (Native OpenStack API).
2017-07-30
This release incorporates the following changes:
-- Changed the allowed maximum subnet mask value to 28 for CIDR blocks in the subnet object in section Overview under Subnet (Native OpenStack API).
- Changed the allowed maximum subnet mask value to 28 for CIDR blocks in the subnet object in section Overview under Subnet (Native OpenStack API).
2017-06-30
@@ -344,19 +362,19 @@2017-04-28
This release incorporates the following changes:
-- Added monitoring metrics up_stream and down_stream.
- Added field dnsList for APIs used to create a subnet, query a subnet, query subnets, and update a subnet.
- Changed the bandwidth size value to 1 Mbit/s to 500 Mbit/s in sections Elastic IP Address and Bandwidth.
- Added monitoring metrics up_stream and down_stream.
- Added field dnsList for APIs used to create a subnet, query a subnet, query subnets, and update a subnet.
- Changed the bandwidth size value to 1 Mbit/s to 500 Mbit/s in sections Elastic IP Address and Bandwidth.
2016-10-29
This release incorporates the following changes:
-- Added the ip_address field to enable users to obtain a specified EIP.
- Added the ip_address field to enable users to obtain a specified EIP.
2016-06-02
This release incorporates the following changes:
-Changed the ethertype field for creating a security group rule to an optional field.
+Changed the ethertype field for adding a security group rule to an optional field.
2016-04-14
diff --git a/docs/vpc/api-ref/vpc_apiroutetab_0001.html b/docs/vpc/api-ref/vpc_apiroutetab_0001.html index 9fa0f57f..f089476b 100644 --- a/docs/vpc/api-ref/vpc_apiroutetab_0001.html +++ b/docs/vpc/api-ref/vpc_apiroutetab_0001.html @@ -45,7 +45,7 @@Specifies a resource ID for pagination query, indicating that the query starts from the next record of the specified resource ID.
This parameter can work together with the parameter limit.
-- If parameters marker and limit are not passed, resource records on the first page will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, resource records starting from the 11th records (including 11th) will be returned.
- If parameters marker and limit are not passed, resource records on the first page will be returned.
- If the parameter marker is not passed and the value of parameter limit is set to 10, the first 10 resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the value of parameter limit is set to 10, the 11th to 20th resource records will be returned.
- If the value of the parameter marker is set to the resource ID of the 10th record and the parameter limit is not passed, 11th to 2,000th resource records will be returned. The default value of limit is 2000.
id
@@ -188,7 +188,7 @@Table 4 Description of the route field Parameter
Type
+Type
Description
Table 3 Description of the routetable field Parameter
Type
+Type
Description
String
- Specifies the route table name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Specifies the route table name.
- The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
routes
@@ -197,7 +197,7 @@Table 6 Description of the routetable field Parameter
Type
+Type
Description
Type
Description
+Description
Table 9 Description of the routetable field Parameter
Type
+Type
Description
String
- Specifies the route table name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Specifies the route table name.
- The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
default
diff --git a/docs/vpc/api-ref/vpc_apiroutetab_0007.html b/docs/vpc/api-ref/vpc_apiroutetab_0007.html index e860b972..f23a3e40 100644 --- a/docs/vpc/api-ref/vpc_apiroutetab_0007.html +++ b/docs/vpc/api-ref/vpc_apiroutetab_0007.html @@ -169,7 +169,7 @@String
- Specifies the route table name.
- The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
- Specifies the route table name.
- The value can contain up to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
default
diff --git a/docs/vpc/api-ref/vpc_apiv3_0000.html b/docs/vpc/api-ref/vpc_apiv3_0000.html index 986bf7a6..416d9bc3 100644 --- a/docs/vpc/api-ref/vpc_apiv3_0000.html +++ b/docs/vpc/api-ref/vpc_apiv3_0000.html @@ -4,7 +4,11 @@-
-
- VPC
+ - VPC
+
+ - Security Group
+
+ - Security Group Rule
- EIPs
diff --git a/docs/vpc/api-ref/vpc_apiv3_0001.html b/docs/vpc/api-ref/vpc_apiv3_0001.html
new file mode 100644
index 00000000..c0a6283a
--- /dev/null
+++ b/docs/vpc/api-ref/vpc_apiv3_0001.html
@@ -0,0 +1,22 @@
+
+
+ - Querying VPCs
+
+ - Querying the Details of a VPC
+
+ - Adding a Secondary CIDR Block to a VPC
+
+ - Removing a Secondary CIDR Block from a VPC
+
+ - Querying VPCs
-
- - Querying the Details of a VPC
-
- - Adding a Secondary CIDR Block to a VPC
-
- - Removing a Secondary CIDR Block from a VPC
-
- VPC ID, which can be used to filter VPCs.
VPC name, which can be used to filter VPCs.
Supplementary information about the VPC, which can be used to filter VPCs.
VPC CIDR block, which can be used to filter VPCs.
Time when the VPC is created.
-The value is a UTC time in the format of yyyy-MM-ddTHH:mmssZ.
+The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
Time when the VPC is updated.
-The value is a UTC time in the format of yyyy-MM-ddTHH:mmssZ.
+The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
Type and number of resources associated with the VPC.
Currently, only route tables and subnets of the VPC are returned. The number of virsubnets is the total number of IPv4 and IPv6 subnets.
@@ -259,7 +259,7 @@VPC tags. For details, see the tag objects.
Value range: 0 to 20 tag key-value pairs.
@@ -270,7 +270,7 @@Tag key.
-Value range:
+Value ranges:
Each key can contain up to 36 Unicode characters and cannot be left blank.
Each key value of a resource must be unique.
The value can contain:
@@ -343,7 +343,7 @@
Time when the VPC is created.
-The value is a UTC time in the format of yyyy-MM-ddTHH:mmssZ.
+The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
Time when the VPC is updated.
-The value is a UTC time in the format of yyyy-MM-ddTHH:mmssZ.
+The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
Type and number of resources associated with the VPC.
Currently, only route tables and subnets of the VPC are returned. The number of virsubnets is the total number of IPv4 and IPv6 subnets.
@@ -184,7 +184,7 @@VPC tags. For details, see the tag objects.
Value range: 0 to 20 tag key-value pairs.
@@ -195,7 +195,7 @@Tag key.
-Value range:
+Value ranges:
Each key can contain up to 36 Unicode characters and cannot be left blank.
Each key value of a resource must be unique.
The value can contain:
@@ -298,7 +298,7 @@ }Status Codes
-Status Code
+Status Code
Description
Adding a Secondary CIDR Block to a VPC
-Function
This API is used to add a secondary CIDR block to a VPC.
URI
PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/add-extend-cidr
+URI
PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/add-extend-cidr
Table 1 Path Parameters Parameter
Request Parameters
-Table 2 Request body parameters Parameter
+-Table 2 Request body parameters Parameter
Mandatory
Yes
AddExtendCidrOption object
+AddExtendCidrOption object
Request body for adding a secondary CIDR block.
Table 3 AddExtendCidrOption Parameter
+Table 3 AddExtendCidrOption Parameter
Mandatory
Response Parameters
Status code: 200
-Table 4 Response body parameters Parameter
+-Table 4 Response body parameters Parameter
Type
vpc
Vpc object
+Vpc object
Response body of adding a secondary CIDR block.
Table 5 Vpc Parameter
+-Table 5 Vpc Parameter
Type
String
Time when the VPC is created.
-The value is a UTC time in the format of yyyy-MM-ddTHH:mmssZ.
+The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
String
Time when the VPC is updated.
-The value is a UTC time in the format of yyyy-MM-ddTHH:mmssZ.
+The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ.
cloud_resources
Array of CloudResource objects
+Array of CloudResource objects
Type and number of resources associated with the VPC.
Currently, only route tables and subnets of the VPC are returned. The number of virsubnets is the total number of IPv4 and IPv6 subnets.
@@ -257,7 +257,7 @@
tags
Array of Tag objects
+Array of Tag objects
VPC tags. For details, see the tag objects.
Value range: 0 to 20 tag key-value pairs.
@@ -268,7 +268,7 @@
Table 6 CloudResource Parameter
+ -Table 7 Tag Parameter
+Table 7 Tag Parameter
Type
String
Tag key.
-Value range:
+Value ranges:
Each key can contain up to 36 Unicode characters and cannot be left blank.
Each key value of a resource must be unique.
The value can contain:
@@ -342,7 +342,7 @@Status code: 202
-Table 8 Response body parameters Parameter
+Table 8 Response body parameters Parameter
Type
Status Codes
-Status Code
+Status Code
Description
Removing a Secondary CIDR Block from a VPC
-Function
This API is used to remove a secondary CIDR block from a VPC.
URI
PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/remove-extend-cidr
+URI
PUT /v3/{project_id}/vpc/vpcs/{vpc_id}/remove-extend-cidr
Table 1 Path Parameters Parameter
Request Parameters
-Table 2 Request body parameters Parameter
+-Table 2 Request body parameters Parameter
Mandatory
Yes
RemoveExtendCidrOption object
+RemoveExtendCidrOption object
Request body for removing a secondary CIDR block.
VPC
++
+++ diff --git a/docs/vpc/api-ref/vpc_apiv3_0001_0.html b/docs/vpc/api-ref/vpc_apiv3_0001_0.html deleted file mode 100644 index bdd08356..00000000 --- a/docs/vpc/api-ref/vpc_apiv3_0001_0.html +++ /dev/null @@ -1,22 +0,0 @@ - - --
+
++Parent topic: API V3+VPC
--
--- diff --git a/docs/vpc/api-ref/vpc_apiv3_0003_0.html b/docs/vpc/api-ref/vpc_apiv3_0003.html similarity index 87% rename from docs/vpc/api-ref/vpc_apiv3_0003_0.html rename to docs/vpc/api-ref/vpc_apiv3_0003.html index 3819503c..61ca8833 100644 --- a/docs/vpc/api-ref/vpc_apiv3_0003_0.html +++ b/docs/vpc/api-ref/vpc_apiv3_0003.html @@ -1,11 +1,11 @@ - +-
-
--Parent topic: API V3-Querying VPCs
Function
This API is used to query VPCs.
-Constraints
This API is used to query all VPCs accessible to the tenant submitting the request. A maximum of 2000 records can be returned for each query. If the number of records exceeds 2000, the pagination marker will be returned.
URI
GET /v3/{project_id}/vpc/vpcs
+URI
GET /v3/{project_id}/vpc/vpcs
Table 1 Path Parameters Parameter
No
Array
+Array of strings
No
Array
+Array of strings
No
Array
+Array of strings
No
Array
+Array of strings
Response Parameters
Status code: 200
-Table 3 Response body parameters Parameter
+-Table 3 Response body parameters Parameter
Type
vpcs
Array of Vpc objects
+Array of Vpc objects
Response body for querying VPCs.
page_info
PageInfo object
+PageInfo object
Pagination information.
Table 4 Vpc Parameter
+-Table 4 Vpc Parameter
Type
String
String
cloud_resources
Array of CloudResource objects
+Array of CloudResource objects
tags
Array of Tag objects
+Array of Tag objects
Table 5 CloudResource Parameter
+ -Table 6 Tag Parameter
+-Table 6 Tag Parameter
Type
String
Table 7 PageInfo Parameter
+Table 7 PageInfo Parameter
Type
Status Codes
-Status Code
+Status Code
Description
Querying the Details of a VPC
-Function
This API is used to query the details of a VPC.
URI
GET /v3/{project_id}/vpc/vpcs/{vpc_id}
+URI
GET /v3/{project_id}/vpc/vpcs/{vpc_id}
Table 1 Path Parameters Parameter
Response Parameters
Status code: 200
-Table 2 Response body parameters Parameter
+-Table 2 Response body parameters Parameter
Type
vpc
Vpc object
+Vpc object
VPC response body.
Table 3 Vpc Parameter
+-Table 3 Vpc Parameter
Type
String
String
cloud_resources
Array of CloudResource objects
+Array of CloudResource objects
tags
Array of Tag objects
+Array of Tag objects
Table 4 CloudResource Parameter
+ -Table 5 Tag Parameter
+Table 5 Tag Parameter
Type
String