Querying VPCs

Function

This API is used to query VPCs using search criteria and to display the VPCs in a list.

URI

GET /v1/{project_id}/vpcs

Example:

GET https://{Endpoint}/v1/{project_id}/vpcs?limit=10&marker=13551d6b-755d-4757-b956-536f674975c0

Table 1 describes the parameters.

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
id	No	String	Specifies the VPC ID that is used as the filtering condition.
marker	No	String	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, 11th to 2,000th resource records will be returned. The default value of limit is 2000.
limit	No	Integer	Specifies the number of records that will be returned on each page. The value is from 0 to intmax (2^31-1). The default value is 2000. limit can be used together with marker. For details, see the parameter description of marker.
enterprise_project_id	No	String	Specifies the enterprise project ID that is used to filter out the VPCs associated with a specified enterprise project. 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. To obtain the VPCs bound to all enterprise projects of the user, set all_granted_eps.

Request Parameters

None

Example Request

GET https://{Endpoint}/v1/{project_id}/vpcs

Response Parameters

**Table 2** Response parameter
Parameter	Type	Description
vpcs	Array of vpc objects	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 up to 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 value is left blank by default. If cidr is specified, 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.
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:
routes	Array of route objects	Specifies the route information. For details, see Table 4.
tenant_id	String	Project ID
created_at	String	Specifies the 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

{
    "vpcs": [
        {
            "id": "13551d6b-755d-4757-b956-536f674975c0",
            "name": "default",
            "description": "test",
            "cidr": "172.16.0.0/16",
            "status": "OK"
,
            "routes": []
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T02:11:13",
            "updated_at": "2022-12-15T02:11:13"
        },
        {
            "id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
            "name": "222",
            "description": "test",
            "cidr": "192.168.0.0/16",
            "status": "OK"
,
            "routes": []
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T04:01:21",
            "updated_at": "2022-12-15T04:01:21"
        },
        {
            "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-15T05:36:29",
            "updated_at": "2022-12-15T05:36:29"
        }
    ]
}