Querying VPC Details

Function

This API is used to query details about a VPC.

URI

GET /v1/{project_id}/vpcs/{vpc_id}

Table 1 <vpc_api01_0002__table26431778> describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the project ID.
vpc_id	Yes	Specifies the VPC ID, which uniquely identifies the VPC.

Request Parameters

None

Example Request

GET https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3

Response Parameters

**Table 2** Response parameter
Name	Type	Description
vpc	`vpc <vpc_api01_0002__table1945411214515>` object	`Specifies the VPC objects. <vpc_api01_0002__table1945411214515>`

**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 <vpc_api01_0002__table3576833291556>` objects	Specifies the route information. For details, see the description of the `route objects <vpc_api01_0002__table3576833291556>`.
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	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.

**Table 4** **route** objects
Name	Type	Description
destination	String	Specifies the destination network segment of a route. Constraints: The value must be in the CIDR format. IPv4 and IPv6 CIDR formats are supported.
nexthop	String	Specifies the next hop of a route. The value must be an IP address from the subnet of the VPC. IPv4 and IPv6 addresses are supported.

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 <vpc_api_0002>.

Error Code

See Error Codes <vpc_api_0003>.

14 KiB Raw Blame History