REST Resource: projects.locations.instances

Resource: Instance

A Managed Lustre instance.

JSON representation
{
  "name": string,
  "filesystem": string,
  "capacityGib": string,
  "network": string,
  "state": enum (State),
  "mountPoint": string,
  "createTime": string,
  "updateTime": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "gkeSupportEnabled": boolean
}
Fields
name

string

Identifier. The name of the instance.

filesystem

string

Required. Immutable. The filesystem name for this instance. This name is used by client-side tools, including when mounting the instance. Must be eight characters or less and can only contain letters and numbers.

capacityGib

string (int64 format)

Required. The storage capacity of the instance in gibibytes (GiB). Allowed values are from 18000 to 936000, in increments of 9000.

network

string

Required. Immutable. The full name of the VPC network to which the instance is connected. Must be in the format projects/{projectId}/global/networks/{network_name}.

state

enum (State)

Output only. The state of the instance.

mountPoint

string

Output only. Mount point of the instance in the format IP_ADDRESS@tcp:/FILESYSTEM.

createTime

string (Timestamp format)

Output only. Timestamp when the instance was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. Timestamp when the instance was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

description

string

Optional. A user-readable description of the instance.

labels

map (key: string, value: string)

Optional. Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

gkeSupportEnabled

boolean

Optional. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.

State

The possible states of an instance.

Enums
STATE_UNSPECIFIED Not set.
ACTIVE The instance is available for use.
CREATING The instance is being created and is not yet ready for use.
DELETING The instance is being deleted.
UPGRADING The instance is being upgraded.
REPAIRING The instance is being repaired.
STOPPED The instance is stopped.

Methods

create

Creates a new instance in a given project and location.

delete

Deletes a single instance.

exportData

Exports data from a Managed Lustre instance to Cloud Storage.

get

Gets details of a single instance.

importData

Imports data from Cloud Storage to a Managed Lustre instance.

list

Lists instances in a given project and location.

patch

Updates the parameters of a single instance.