REST Resource: projects.locations.instances

Resource: Instance

A Cloud Filestore instance.

JSON representation 
{
  "name": string,
  "description": string,
  "state": enum (State),
  "statusMessage": string,
  "createTime": string,
  "tier": enum (Tier),
  "labels": {
    string: string,
    ...
  },
  "fileShares": [
    {
      object (FileShareConfig)
    }
  ],
  "networks": [
    {
      object (NetworkConfig)
    }
  ],
  "etag": string
}
Fields
name

string

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

string

The description of the instance (2048 characters or less).
state

enum (State)

Output only. The instance state.
statusMessage

string

Output only. Additional information about the instance state, if available.
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".
tier

enum (Tier)

The service tier of the instance.
labels

map (key: string, value: string)

Resource labels to represent user provided metadata.

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

object (FileShareConfig)

File system shares on the instance. For this version, only a single file share is supported.
networks[]

object (NetworkConfig)

VPC networks to which the instance is connected. For this version, only a single network is supported.
etag

string

Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.

State

The instance state.

Enums
STATE_UNSPECIFIED State not set.
CREATING The instance is being created.
READY The instance is available for use.
REPAIRING Work is being done on the instance. You can get further details from the statusMessage field of the Instance resource.
DELETING The instance is shutting down.
ERROR The instance is experiencing an issue and might be unusable. You can get further details from the statusMessage field of the Instance resource.

Tier

Available service tiers.

Enums
TIER_UNSPECIFIED Not set.
STANDARD STANDARD tier.
PREMIUM PREMIUM tier.
BASIC_HDD BASIC instances offer a maximum capacity of 63.9 TB. BASIC_HDD is an alias for STANDARD Tier, offering economical performance backed by HDD.
BASIC_SSD BASIC instances offer a maximum capacity of 63.9 TB. BASIC_SSD is an alias for PREMIUM Tier, and offers improved performance backed by SSD.
HIGH_SCALE_SSD HIGH_SCALE instances offer expanded capacity and performance scaling capabilities.

FileShareConfig

File share configuration for the instance.

JSON representation 
{
  "name": string,
  "capacityGb": string
}
Fields
name

string

The name of the file share (must be 16 characters or less).
capacityGb

string (int64 format)

File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.

NetworkConfig

Network configuration for the instance.

JSON representation 
{
  "network": string,
  "modes": [
    enum (AddressMode)
  ],
  "reservedIpRange": string,
  "ipAddresses": [
    string
  ]
}
Fields
network

string

The name of the Google Compute Engine VPC network to which the instance is connected.
modes[]

enum (AddressMode)

Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
reservedIpRange

string

A /29 CIDR block in one of the internal IP address ranges that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
ipAddresses[]

string

Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.

AddressMode

Internet protocol versions supported by Cloud Filestore.

Enums
ADDRESS_MODE_UNSPECIFIED Internet protocol not set.
MODE_IPV4 Use the IPv4 internet protocol.

Methods

create

 Creates an instance.

delete

 Deletes an instance.

get

 Gets the details of a specific instance.

list

 Lists all instances in a project for either a specified location or for all locations.

patch

 Updates the settings of a specific instance.