List VPCs
const url = 'https://example.com/network/v1/workspaces/example/engines/qibdo/vpcs';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/network/v1/workspaces/example/engines/qibdo/vpcsReturns a paginated list of VPCs within a workspace.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace to list VPCs for.
Query Parameters
Section titled “Query Parameters ”Page Size
The maximum number of VPCs to return. The service may return fewer than this value. If unspecified, at most 20 VPCs will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Page Token
A page token, received from a previous ListQibdoVpcs call.
Provide this to retrieve the subsequent page. When paginating,
all other parameters provided to ListQibdoVpcs must match the call
that provided the page token.
AIP-160 filter expression. Filterable fields: cidr, create_time, description, display_name, id, location, location_id, name, provider_resource_id, update_time, workspace_id.
AIP-132 order_by expression. Sortable fields: create_time, display_name, location, name, update_time.
AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).
Responses
Section titled “ Responses ”OK
ListQibdoVpcsResponse
Response message for ListQibdoVpcs.
object
The list of VPCs.
QibdoVpc: a virtual private cloud provisioned by the qibdo engine. The agnostic CTI root holds workspace, location, name, description, cidr; this engine-specific message exposes the surface clients interact with directly.
object
Unique identifier for this VPC.
The workspace that owns this VPC.
The region this VPC is deployed in. A VPC spans a region; its subnets are placed in individual zones within that region.
The handle of the VPC, e.g. “prod-vpc”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Parent-scoped-unique. Used to address the VPC by name or id.
A human-readable label for the VPC, e.g. “Production VPC”. Free text in any script. Never used to address the VPC. Optional; defaults to the handle (name) when omitted.
An optional human-readable description of the VPC.
The CIDR block that defines the IP address space for this VPC.
object
Engine-assigned VPC identifier. Populated once the engine provisions the VPC.
When this VPC was created.
When this VPC was last updated.
Next Page Token
A token, which can be sent as page_token to retrieve the next page.
If this field is empty, there are no subsequent pages.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example generated
{ "vpcs": [ { "location_id": "example", "name": "example", "display_name": "example", "description": "example", "cidr": { "address": "example", "prefix": 1 } } ], "next_page_token": "example", "total_size": "example"}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}