REST Resource: projects.locations.instances

• Resource: Instance
  • JSON representation
• State
• Tier
• Methods

Resource: Instance

A Google Cloud Redis instance.

JSON representation

{ "name": string, "displayName": string, "labels": { string: string, ... }, "locationId": string, "alternativeLocationId": string, "redisVersion": string, "reservedIpRange": string, "host": string, "port": number, "currentLocationId": string, "createTime": string, "state": enum (State), "statusMessage": string, "redisConfigs": { string: string, ... }, "tier": enum (Tier), "memorySizeGb": number, "authorizedNetwork": string, "persistenceIamIdentity": string }

Fields
name	string Required. Unique name of the resource in this scope including project and location using the form: projects/{projectId}/locations/{locationId}/instances/{instanceId} Note: Redis instances are managed and addressed at regional level so locationId here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to locationId and alternativeLocationId fields for more details.
displayName	string An arbitrary and optional user-provided name for 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" }.
locationId	string Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone for the instance. For STANDARD_HA tier, instances will be created across two zones for protection against zonal failures. If alternativeLocationId is also provided, it must be different from locationId.
alternativeLocationId	string Optional. Only applicable to STANDARD_HA tier which protects the instance against zonal failures by provisioning it across two zones. If provided, it must be a different zone from the one provided in locationId.
redisVersion	string Optional. The version of Redis software. If not provided, latest supported version will be used. Updating the version will perform an upgrade/downgrade to the new version. Currently, the supported values are: REDIS_4_0 for Redis 4.0 compatibility (default) REDIS_3_2 for Redis 3.2 compatibility
reservedIpRange	string Optional. The CIDR range of internal addresses that are reserved for this instance. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique and non-overlapping with existing subnets in an authorized network.
host	string Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
port	number Output only. The port number of the exposed Redis endpoint.
currentLocationId	string Output only. The current zone where the Redis endpoint is placed. For Basic Tier instances, this will always be the same as the locationId provided by the user at creation time. For Standard Tier instances, this can be either locationId or alternativeLocationId and can change after a failover event.
createTime	string (Timestamp format) Output only. The time the instance was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
state	enum (State) Output only. The current state of this instance.
statusMessage	string Output only. Additional information about the current status of this instance, if available.
redisConfigs	map (key: string, value: string) Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis 3.2 and above: maxmemory-policy notify-keyspace-events Redis 4.0 and above: activedefrag lfu-log-factor lfu-decay-time An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
tier	enum (Tier) Required. The service tier of the instance.
memorySizeGb	number Required. Redis memory size in GiB.
authorizedNetwork	string Optional. The full name of the Google Compute Engine network to which the instance is connected. If left unspecified, the default network will be used.
persistenceIamIdentity	string Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation.

State

Represents the different states of a Redis instance.

Enums
STATE_UNSPECIFIED	Not set.
CREATING	Redis instance is being created.
READY	Redis instance has been created and is fully usable.
UPDATING	Redis instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.
DELETING	Redis instance is being deleted.
REPAIRING	Redis instance is being repaired and may be unusable.
MAINTENANCE	Maintenance is being performed on this Redis instance.
IMPORTING	Redis instance is importing data (availability may be affected).
FAILING_OVER	Redis instance is failing over (availability may be affected).

Tier

Available service tiers to choose from

Enums
TIER_UNSPECIFIED	Not set.
BASIC	BASIC tier: standalone instance
STANDARD_HA	STANDARD_HA tier: highly available primary/replica instances

Methods
create	Creates a Redis instance based on the specified tier and memory size.
delete	Deletes a specific Redis instance.
export	Export Redis instance data into a Redis RDB format file in Cloud Storage.
failover	Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
get	Gets the details of a specific Redis instance.
import	Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
list	Lists all Redis instances owned by a project in either the specified location (region) or all locations.
patch	Updates the metadata and configuration of a specific Redis instance.