Querying VPC Details¶
Function¶
This API is used to query details about a VPC.
URI¶
GET /v1/{project_id}/vpcs/{vpc_id}
Table 1 describes the parameters.
Name | Mandatory | Description |
|---|---|---|
project_id | Yes | Specifies the project ID. |
vpc_id | Yes | Specifies the VPC ID, which uniquely identifies the VPC. |
Request Message¶
Request parameter
None
Example request
GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3
Response Message¶
Response parameter
Table 3 VPC objects¶ Name
Type
Description
id
String
Specifies a resource ID in UUID format.
name
String
Specifies the VPC name.
The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
Each VPC name of a tenant must be unique if the VPC name is not left blank.
description
String
Provides supplementary information about the VPC.
The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
cidr
String
Specifies the available IP address ranges for subnets in the VPC.
Possible values are as follows:
10.0.0.0/8-24
172.16.0.0/12-24
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.
status
String
Specifies the VPC status.
Possible values are as follows:
CREATING: The VPC is being created.
OK: The VPC is created successfully.
routes
Array of route objects
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
Specifies the enterprise project ID.
The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
Note
This parameter is unsupported. Do not use it.
Table 4 route objects¶ Name
Type
Description
destination
String
Specifies the destination network segment of a route.
The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.
nexthop
String
Specifies the next hop of a route.
The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.
Example response
{ "vpc": { "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", "name": "vpc", "description": "test", "cidr": "192.168.0.0/16", "status": "OK", "enterprise_project_id": "0" "routes": [], "enable_shared_snat": false } }
Status Code¶
See Status Codes.
Error Code¶
See Error Codes.