List Node Pools
const url = 'https://example.com/topology/v1/node-pools';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/topology/v1/node-poolsReturns a paginated list of node pools. Scope to a zone with filter=zone_id="<uuid>".
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”The maximum number of node pools to return. The service may return fewer than this value. If unspecified, at most 20 node pools will be returned. The maximum value is 100; values above 100 will be coerced to 100.
A page token, received from a previous ListNodePools call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListNodePools must match
the call that provided the page token.
AIP-160 filter expression.
Partial matches (:, a quoted wildcard, contains/startsWith/endsWith) ignore capitalisation; = and the relational operators are exact.
Filterable fields: create_time, display_name, id, name, update_time, zone_id.
AIP-132 order_by expression. Sortable fields: create_time, display_name, 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
ListNodePoolsResponse
Response message for ListNodePools.
object
The list of node pools
Node Pool
A named group of nodes within a zone, selected by labels. Workloads target a node pool to be scheduled onto one of its nodes. A node pool groups nodes that already exist: it does not create, scale, upgrade or drain them.
object
The unique identifier of the node pool
The unique identifier of the parent zone. Supplied on create (the flat collection’s parent reference), immutable thereafter.
The handle of the node pool, e.g. “gpu-pool”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Parent-scoped-unique. Used to address the node pool by name or id.
A human-readable label for the node pool, e.g. “GPU (A100) pool”. Free text in any script. Never used to address the node pool. Optional; defaults to the handle (name) when omitted.
The timestamp when the node pool was created
The timestamp when the node pool was last updated
Label Selector
Defines pool membership over Nodes. A Node belongs to this pool iff its Kubernetes label map contains every key in match_labels with the matching value. matchLabels-only for the alpha; matchExpressions is reserved for future use.
object
Required labels and their values. A Node matches iff every key is present in its label map with the matching value.
object
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
{ "node_pools": [ { "zone_id": "example", "name": "example", "display_name": "example", "label_selector": { "match_labels": { "additionalProperty": "example" } } } ], "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" } ]}