REST Resource: projects.locations.instances

Resource: Instance

A Parallelstore instance.

JSON representation 
{
  "name": string,
  "description": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "capacityGib": string,
  "daosVersion": string,
  "accessPoints": [
    string
  ],
  "network": string,
  "reservedIpRange": string,
  "effectiveReservedIpRange": string,
  "fileStripeLevel": enum (FileStripeLevel),
  "directoryStripeLevel": enum (DirectoryStripeLevel)
}
Fields
name

string

Identifier. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instanceId}.
description

string

Optional. The description of the instance. 2048 characters or less.
state

enum (State)

Output only. The instance state.
createTime

string (Timestamp format)

Output only. The time when the instance was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the instance was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Optional. Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. See https://cloud.google.com/resource-manager/docs/labels-overview for details.

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

string (int64 format)

Required. Immutable. The instance's storage capacity in Gibibytes (GiB). Allowed values are between 12000 and 100000, in multiples of 4000; e.g., 12000, 16000, 20000, ...
daosVersion

string

Output only. The version of DAOS software running in the instance.
accessPoints[]

string

Output only. A list of IPv4 addresses used for client side configuration.
network

string

Optional. Immutable. The name of the Compute Engine VPC network to which the instance is connected.
reservedIpRange

string

Optional. Immutable. The ID of the IP address range being used by the instance's VPC network. See Configure a VPC network. If no ID is provided, all ranges are considered.
effectiveReservedIpRange

string

Output only. Immutable. The ID of the IP address range being used by the instance's VPC network. This field is populated by the service and contains the value currently used by the service.
fileStripeLevel

enum (FileStripeLevel)

Optional. Stripe level for files. Allowed values are:

  • FILE_STRIPE_LEVEL_MIN: offers the best performance for small size files.
  • FILE_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large files.
  • FILE_STRIPE_LEVEL_MAX: higher throughput performance for larger files.
directoryStripeLevel

enum (DirectoryStripeLevel)

Optional. Stripe level for directories. Allowed values are:

  • DIRECTORY_STRIPE_LEVEL_MIN: recommended when directories contain a small number of files.
  • DIRECTORY_STRIPE_LEVEL_BALANCED: balances performance for workloads involving a mix of small and large directories.
  • DIRECTORY_STRIPE_LEVEL_MAX: recommended for directories with a large number of files.

State

The possible states of a Parallelstore instance.

Enums
STATE_UNSPECIFIED Not set.
CREATING The instance is being created.
ACTIVE The instance is available for use.
DELETING The instance is being deleted.
FAILED The instance is not usable.
UPGRADING The instance is being upgraded.

FileStripeLevel

Represents the striping options for files.

Enums
FILE_STRIPE_LEVEL_UNSPECIFIED If not set, FileStripeLevel will default to FILE_STRIPE_LEVEL_BALANCED
FILE_STRIPE_LEVEL_MIN Minimum file striping
FILE_STRIPE_LEVEL_BALANCED Medium file striping
FILE_STRIPE_LEVEL_MAX Maximum file striping

DirectoryStripeLevel

Represents the striping options for directories.

Enums
DIRECTORY_STRIPE_LEVEL_UNSPECIFIED If not set, DirectoryStripeLevel will default to DIRECTORY_STRIPE_LEVEL_MAX
DIRECTORY_STRIPE_LEVEL_MIN Minimum directory striping
DIRECTORY_STRIPE_LEVEL_BALANCED Medium directory striping
DIRECTORY_STRIPE_LEVEL_MAX Maximum directory striping

Methods

create

 Creates a Parallelstore instance in a given project and location.

delete

 Deletes a single instance.

exportData

 Copies data from Parallelstore to Cloud Storage.

get

 Gets details of a single instance.

importData

 Copies data from Cloud Storage to Parallelstore.

list

 Lists all instances in a given project and location.

patch

 Updates the parameters of a single instance.