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,
    ...
  },
  "perUnitStorageThroughput": string,
  "gkeSupportEnabled": boolean,
  "kmsKey": string,
  "stateReason": string,
  "accessRulesOptions": {
    object (AccessRulesOptions)
  },
  "uid": string,
  "maintenancePolicy": {
    object (MaintenancePolicy)
  },
  "upcomingMaintenanceSchedule": {
    object (MaintenanceSchedule)
  },
  "dynamicTierOptions": {
    object (DynamicTierOptions)
  }
}
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 depend on the perUnitStorageThroughput. See Performance tiers for specific minimums, maximums, and step sizes for each performance tier.
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 use 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 use 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" }.
perUnitStorageThroughput

string (int64 format)

Optional. The throughput of the instance in MBps per TiB. Valid values are 0, 125, 250, 500, 1000. See Performance tiers for more information.

If the instance is using the Dynamic tier, this field must not be set or must be set to zero.
gkeSupportEnabled
(deprecated)

boolean

Optional. Deprecated: No longer required for GKE instance creation. Indicates whether you want to enable support for GKE clients. By default, GKE clients are not supported.
kmsKey

string

Optional. Immutable. The Cloud KMS key name to use for data encryption. If not set, the instance will use Google-managed encryption keys. If set, the instance will use customer-managed encryption keys. The key must be in the same region as the instance. The key format is: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
stateReason

string

Output only. The reason why the instance is in a certain state (e.g. SUSPENDED).
accessRulesOptions

object (AccessRulesOptions)

Optional. The access rules options for the instance.
uid

string

Output only. Unique ID of the resource. This is unrelated to the access rules which allow specifying the root squash uid.
maintenancePolicy

object (MaintenancePolicy)

Optional. The maintenance policy for the instance to determine when to allow or exclude the instance from maintenance updates.
upcomingMaintenanceSchedule

object (MaintenanceSchedule)

Output only. Date and time of upcoming maintenance for the instance, if a maintenance policy is set.
dynamicTierOptions

object (DynamicTierOptions)

Optional. Immutable. Specifies whether the instance is on the Dynamic tier. See Performance tiers for more information.

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.
UPDATING

The instance is being updated.
SUSPENDED The instance is suspended due to an issue related to Cloud KMS. The details are available in stateReason.

AccessRulesOptions

IP-based access rules for the Managed Lustre instance. These options define the root user squash configuration.

JSON representation 
{
  "accessRules": [
    {
      object (AccessRule)
    }
  ],
  "defaultSquashMode": enum (SquashMode),
  "defaultSquashUid": integer,
  "defaultSquashGid": integer
}
Fields
accessRules[]

object (AccessRule)

Optional. The access rules for the instance.
defaultSquashMode

enum (SquashMode)

Required. The squash mode for the default access rule.
defaultSquashUid

integer

Optional. The user squash UID for the default access rule. This user squash UID applies to all root users connecting from clients that are not matched by any of the access rules. If not set, the default is 0 (no UID squash).
defaultSquashGid

integer

Optional. The user squash GID for the default access rule. This user squash GID applies to all root users connecting from clients that are not matched by any of the access rules. If not set, the default is 0 (no GID squash).

AccessRule

A single policy group with IP-based access rules for the Managed Lustre instance.

JSON representation 
{
  "name": string,
  "ipAddressRanges": [
    string
  ],
  "squashMode": enum (SquashMode)
}
Fields
name

string

Required. The name of the access rule policy group. Must be 16 characters or less and include only alphanumeric characters or '_'.
ipAddressRanges[]

string

Required. The IP address ranges to which to apply this access rule. Accepts non-overlapping CIDR ranges (e.g., 192.168.1.0/24) and IP addresses (e.g., 192.168.1.0).
squashMode

enum (SquashMode)

Required. Squash mode for the access rule.

SquashMode

Squash mode for an access rule.

Enums
SQUASH_MODE_UNSPECIFIED Unspecified squash mode.
NO_SQUASH

Squash is disabled.

If set inside an AccessRule, root users matching the [ip_ranges][AccessRule.ip_ranges] are not squashed.

If set as the defaultSquashMode, root squash is disabled for this instance.

If the default squash mode is NO_SQUASH, do not set the defaultSquashUid or defaultSquashGid, or an invalid argument error is returned.
ROOT_SQUASH

Root user squash is enabled.

Not supported inside an AccessRule.

If set as the defaultSquashMode, root users not matching any of the accessRules are squashed to the defaultSquashUid and defaultSquashGid.

MaintenancePolicy

Defines a maintenance policy for a resource.

JSON representation 
{
  "weeklyMaintenanceWindows": [
    {
      object (WeeklyMaintenanceWindow)
    }
  ],
  "maintenanceExclusionWindow": [
    {
      object (MaintenanceExclusionWindow)
    }
  ]
}
Fields
weeklyMaintenanceWindows[]

object (WeeklyMaintenanceWindow)

Required. The weekly maintenance windows for the instance. Currently limited to 1 window.
maintenanceExclusionWindow[]

object (MaintenanceExclusionWindow)

Optional. The exclusion windows for the instance. Currently limited to 1 window.

WeeklyMaintenanceWindow

Weekly time window in which maintenance updates may occur. Duration of the window is currently fixed at 1 hour. Time zone is UTC.

JSON representation 
{
  "dayOfWeek": enum (DayOfWeek),
  "startTime": {
    object (TimeOfDay)
  }
}
Fields
dayOfWeek

enum (DayOfWeek)

Required. Day of the week for the maintenance window.
startTime

object (TimeOfDay)

Required. Start time of the maintenance window in UTC time zone.

DayOfWeek

Represents a day of the week.

Enums
DAY_OF_WEEK_UNSPECIFIED The day of the week is unspecified.
MONDAY Monday
TUESDAY Tuesday
WEDNESDAY Wednesday
THURSDAY Thursday
FRIDAY Friday
SATURDAY Saturday
SUNDAY Sunday

TimeOfDay

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

JSON representation 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Fields
hours

integer

Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
minutes

integer

Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
seconds

integer

Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
nanos

integer

Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.

MaintenanceExclusionWindow

Exclusion period when maintenance updates should not occur. An exclusion window can be in either of the following two formats: * Non-recurring : A full date, with non-zero year, month and day values. * Recurring : A month and day value, with a zero year. Time zone is UTC.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "time": {
    object (TimeOfDay)
  }
}
Fields
startDate

object (Date)

Required. Start date of the exclusion period in UTC time zone. This date is inclusive.
endDate

object (Date)

Required. End date of the exclusion period in UTC time zone. This date is inclusive.
time

object (TimeOfDay)

Required. Time in UTC when the exclusion window starts on startDate and ends on endDate. This can be: * Full time OR * All zeros for 00:00:00 UTC

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

  • A full date, with non-zero year, month, and day values.
  • A month and day, with a zero year (for example, an anniversary).
  • A year on its own, with a zero month and a zero day.
  • A year and month, with a zero day (for example, a credit card expiration date).

Related types:

JSON representation 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

MaintenanceSchedule

Represents a scheduled maintenance event.

JSON representation 
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

Output only. The scheduled start time for the maintenance.

Uses RFC 3339, where generated output will always be Z-normalized and use 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".
endTime

string (Timestamp format)

Output only. The scheduled end time for the maintenance.

Uses RFC 3339, where generated output will always be Z-normalized and use 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".

DynamicTierOptions

Dynamic tier options for a Managed Lustre instance.

JSON representation 
{
  "mode": enum (Mode)
}
Fields
mode

enum (Mode)

Required. Immutable. The dynamic tier mode of the instance.

Mode

Specifies the Dynamic performance tier for the instance.

If this field is set to DEFAULT_CACHE, perUnitStorageThroughput must not be set or must be set to zero.

Enums
MODE_UNSPECIFIED Unspecified dynamic tier mode.
DISABLED The dynamic tier is explicitly disabled.
DEFAULT_CACHE The dynamic tier is enabled.

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.

rescheduleMaintenance

 Reschedules a planned maintenance event for a specific instance.