- Resource: Instance
- State
- FileShareConfig
- NfsExportOptions
- AccessMode
- SquashMode
- NetworkConfig
- AddressMode
- Methods
Resource: Instance
A Cloud Filestore instance.
JSON representation | |
---|---|
{ "name": string, "description": string, "state": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the instance, in the format projects/{projectId}/locations/{locationId}/instances/{instanceId}. |
description |
The description of the instance (2048 characters or less). |
state |
Output only. The instance state. |
statusMessage |
Output only. Additional information about the instance state, if available. |
createTime |
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: |
tier |
The service tier of the instance. |
labels |
Resource labels to represent user provided metadata. An object containing a list of |
fileShares[] |
File system shares on the instance. For this version, only a single file share is supported. |
networks[] |
VPC networks to which the instance is connected. For this version, only a single network is supported. |
etag |
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. |
RESTORING |
The instance is restoring a snapshot or backup to an existing file share and may be unusable during this time. |
NfsExportOptions
NFS export options specifications.
JSON representation | |
---|---|
{ "ipRanges": [ string ], "accessMode": enum ( |
Fields | |
---|---|
ipRanges[] |
List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions. |
accessMode |
Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE. |
squashMode |
Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. |
anonUid |
An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings. |
anonGid |
An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squashMode of ROOT_SQUASH. An error will be returned if this field is specified for other squashMode settings. |
AccessMode
The access mode.
Enums | |
---|---|
ACCESS_MODE_UNSPECIFIED |
AccessMode not set. |
READ_ONLY |
The client can only read the file share. |
READ_WRITE |
The client can read and write the file share (default). |
SquashMode
The squash mode.
Enums | |
---|---|
SQUASH_MODE_UNSPECIFIED |
SquashMode not set. |
NO_ROOT_SQUASH |
The Root user has root access to the file share (default). |
ROOT_SQUASH |
The Root user has squashed access to the anonymous uid/gid. |
NetworkConfig
Network configuration for the instance.
JSON representation | |
---|---|
{
"network": string,
"modes": [
enum ( |
Fields | |
---|---|
network |
The name of the Google Compute Engine VPC network to which the instance is connected. |
modes[] |
Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. |
reservedIpRange |
A /29 CIDR block for Basic or a /23 CIDR block for High Scale 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/23. 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[] |
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 |
|
---|---|
|
Creates an instance. |
|
Deletes an instance. |
|
Gets the details of a specific instance. |
|
Lists all instances in a project for either a specified location or for all locations. |
|
Updates the settings of a specific instance. |
|
Restores an existing instance's file share from a backup. |