List Subnets
const url = 'https://example.com/network/v1/workspaces/example/engines/qibdo/vpcs/example/subnets';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/vpcs/example/subnetsReturns a paginated list of subnets within a VPC.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Query Parameters
Section titled “Query Parameters ”The maximum number of subnets to return. The service may return fewer than this value. If unspecified, at most 20 subnets will be returned. The maximum value is 100; values above 100 will be coerced to 100.
AIP-160 filter expression. Filterable fields: cidr, create_time, description, display_name, gateway_ip, id, location, location_id, name, provider_resource_id, update_time, vpc_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
ListQibdoSubnetsResponse
Response message for ListQibdoSubnets.
object
QibdoSubnet: a subdivision of a VPC’s IP address space.
object
Unique identifier for this subnet.
The VPC that this subnet belongs to.
The zone this subnet is placed in. The zone must belong to the parent VPC’s region; a VPC’s subnets may span multiple zones for fault tolerance.
The handle of the subnet, e.g. “app-tier”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Parent-scoped-unique. Used to address the subnet by name or id.
A human-readable label for the subnet, e.g. “Application Tier”. Free text in any script. Never used to address the subnet. Optional; defaults to the handle (name) when omitted.
An optional human-readable description of the subnet.
The CIDR block that defines the IP address range for this subnet. Must be a subset of the parent VPC’s CIDR.
object
The gateway IP address for this subnet. If omitted on creation, the system automatically derives the gateway from the CIDR block.
object
Engine-assigned subnet identifier. Populated once the engine provisions the subnet.
When this subnet was created.
When this subnet was last updated.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example generated
{ "subnets": [ { "location_id": "example", "name": "example", "display_name": "example", "description": "example", "cidr": { "address": "example", "prefix": 1 }, "gateway_ip": { "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" } ]}