Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13174977.0 KB
projects

Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).

post/v1/{+parent}/instances

Path parameters

parentstring required

Required. The instance's project and location, in the format projects/{project_id}/locations/{location}. In Filestore, locations map to Google Cloud zones, for example us-west1-b.

Query parameters

instanceIdstring

Required. The name of the instance to create. The name must be unique for the specified project and location.

Request body

statusMessagestring

Output only. Additional information about the instance state, if available.

satisfiesPzsboolean

Output only. Reserved for future use.

protocol'FILE_PROTOCOL_UNSPECIFIED' | 'NFS_V3' | 'NFS_V4_1'

Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: NFS_V3.

namestring

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

maxCapacityGbstring int64

Output only. The maximum capacity of the instance in GB.

createTimestring google-datetime

Output only. The time when the instance was created.

capacityStepSizeGbstring int64

Output only. The incremental increase or decrease in capacity, designated in some number of GB.

descriptionstring

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

kmsKeyNamestring

KMS key name used for data encryption.

deletionProtectionEnabledboolean

Optional. Indicates whether the instance is protected against deletion.

minCapacityGbstring int64

Output only. The minimum capacity of the instance in GB.

deletionProtectionReasonstring

Optional. The reason for enabling deletion protection.

etagstring

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

suspensionReasonsstring[]

Output only. Field indicates all the reasons the instance is in "SUSPENDED" state.

tier'TIER_UNSPECIFIED' | 'STANDARD' | 'PREMIUM' | 'BASIC_HDD' | 'BASIC_SSD' | 'HIGH_SCALE_SSD' | 'ENTERPRISE' | 'ZONAL' | 'REGIONAL'

The service tier of the instance.

customPerformanceSupportedboolean

Output only. Indicates whether this instance supports configuring its performance. If true, the user can configure the instance's performance by using the 'performance_config' field.

labelsobject

Resource labels to represent user provided metadata.

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'REPAIRING' | 'DELETING' | 'ERROR' | 'RESTORING' | 'SUSPENDED' | 'SUSPENDING' | 'RESUMING' | 'REVERTING' | 'PROMOTING'

Output only. The instance state.

satisfiesPziboolean

Output only. Reserved for future use.

tagsobject

Optional. Input only. Immutable. Tag key-value pairs bound to this resource. Each key must be a namespaced name and each value a short name. Example: "123456789012/environment" : "production", "123456789013/costCenter" : "marketing" See the documentation for more information: - Namespaced name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_key - Short name: https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing#retrieving_tag_value

Response

Successful response