Updated on 2024-04-15 GMT+08:00

Querying Details About a VPC

Function

This API is used to query details about a VPC.

URI

GET /v3/{project_id}/vpc/vpcs/{vpc_id}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

For details about how to obtain a project ID, see Obtaining a Project ID.

vpc_id

Yes

String

VPC ID.

Request Parameter

None

Example Request

  • Querying details about a VPC
    "GET https://{Endpoint}/v3/{project_id}/vpc/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3"

Response Parameter

Table 2 Response body parameters

Parameter

Type

Description

request_id

String

Request ID

vpc

Vpc object

VPC response body

Table 3 Vpc

Parameter

Type

Description

id

String

VPC ID, which uniquely identifies the VPC

The value is in UUID format with hyphens (-).

name

String

VPC name

The value can contain no more than 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

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

Available VPC CIDR blocks

Value range:

  • 10.0.0.0/8-10.255.255.240/28
  • 172.16.0.0/12-172.31.255.240/28
  • 192.168.0.0/16-192.168.255.240/28

If cidr is not specified, the default value is "".

The value must be in IPv4 CIDR format, for example, 192.168.0.0/16.

extend_cidrs

Array of strings

Secondary CIDR blocks of VPCs

Currently, only IPv4 CIDR blocks are supported.

status

String

VPC status

Value range:
  • PENDING: The VPC is being created.
  • ACTIVE: The VPC is created successfully.

project_id

String

ID of the project to which the VPC belongs

created_at

String

Time when the VPC is created

UTC time in the format of yyyy-MM-ddTHH:mmss

updated_at

String

Time when the VPC is updated

UTC time in the format of yyyy-MM-ddTHH:mmss

cloud_resources

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.

Table 4 CloudResource

Parameter

Type

Description

resource_type

String

Resource type

resource_count

Integer

Number of resources

Example Response

{
    "request_id": "84eb4f775d66dd916db121768ec55626", 
    "vpc": {
        "id": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", 
        "name": "name-test", 
        "description": "description-test", 
        "cidr": "192.168.0.0/16", 
        "extend_cidrs": [
            "21.8.0.0/16"
        ], 
        "cloud_resources": [
            {
                "resource_type": "routetable", 
                "resource_count": 1
            }
        ], 
        "status": "ACTIVE", 
        "project_id": "060576782980d5762f9ec014dd2f1148", 
        "created_at": "2018-03-23T09:26:08", 
        "updated_at": "2018-08-24T08:49:53"
    }
}

Status Code

See Status Codes.

Error Code

See Error Codes.