Help Center/ Virtual Private Cloud/ API Reference/ VPC APIs (V1/V2)/ Virtual Private Cloud/ Querying VPC Details
Updated on 2025-12-29 GMT+08:00
View PDF

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.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a 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

Parameter

Type

Description

vpc

vpc object

Specifies the VPC objects.
Table 3 VPC objects

Parameter

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.
  • Range:
    • 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.

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.
    NOTE:

tenant_id

String
  • Project ID

created_at

String
  • Time (UTC) when the VPC is created.
  • Format: yyyy-MM-ddTHH:mm:ss

updated_at

String
  • Specifies the time (UTC) when the VPC is updated.
  • Format: yyyy-MM-ddTHH:mm:ss
Table 4 route objects

Parameter

Type

Description

destination

String
  • Specifies the destination CIDR block 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": [],
        "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
        "created_at": "2022-12-15T02:25:11",
        "updated_at": "2022-12-15T02:25:11"
}
}

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent Topic: Virtual Private Cloud