Google - API Google Cloud Memorystore for Redis

Google / Google Cloud Memorystore for Redis

Google Cloud Memorystore for Redis

Creates and manages Redis instances on the Google Cloud Platform.

License: Creative Commons Attribution 3.0

Resources

projects

GET

/v1/{name}/locations

Lists information about the supported locations for this service.

Request

Path

Name	Data Type	Description
`name`	string	The resource that owns the locations collection, if applicable.

Query

Name	Data Type	Description
`pageToken`	string	The standard list page token.
`pageSize`	integer	The standard list page size.
`filter`	string	The standard list filter.

Responses

200Successful response

Body

Name Data Type Description

ListLocationsResponse


                        ListLocationsResponse

object

The response message for Locations.ListLocations.

Properties


                        nextPageToken

string

The standard List next-page token.


                        locations

array [Location]

A list of locations that matches the specified filter in the request.


                        Location

object

A resource that represents Google Cloud Platform location.

Properties

`name`	string	Full resource name for the region. For example: "projects/example-project/locations/us-east1".
`metadata`	object	Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.
`locationId`	string	Resource ID for the region. For example: "us-east1".
`labels`	object	Cross-service attributes for the location. For example `{"cloud.googleapis.com/region": "us-east1"}`
`displayName`	string	The friendly name for this location, typically a nearby city name. For example, "Tokyo".

GET

/v1/{name}/operations

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Request

Path

Name	Data Type	Description
`name`	string	The name of the operation's parent resource.

Query

Name	Data Type	Description
`pageToken`	string	The standard list page token.
`pageSize`	integer	The standard list page size.
`filter`	string	The standard list filter.

Responses

200Successful response

Body

Name Data Type Description

ListOperationsResponse


                        ListOperationsResponse

object

The response message for Operations.ListOperations.

Properties


                        operations

array [Operation]

A list of operations that matches the specified filter in the request.


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties

`response`	object	The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
`name`	string	The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
`metadata`	object	{ `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. }
`error`	Status	The error result of the operation in case of failure or cancellation.
`done`	boolean	If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.


                        nextPageToken

string

The standard List next-page token.

POST

/v1/{name}:cancel

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Request

Path

Name	Data Type	Description
`name`	string	The name of the operation resource to be cancelled.

Responses

200Successful response

Body

Name Data Type Description

Empty


                        Empty

object

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

POST

/v1/{name}:export

Export Redis instance data into a Redis RDB format file in Cloud Storage.

Redis will continue serving during this operation.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Request

Path

Name	Data Type	Description
`name`	string	Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.

Body

Name Data Type Description

ExportInstanceRequest


                        ExportInstanceRequest

object

Request for Export.

Properties


                        outputConfig

OutputConfig

Required. Specify data to be exported.


                        OutputConfig

object

The output content

Properties


                        gcsDestination

GcsDestination

Google Cloud Storage destination for output content.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.


                        name

string

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.


                        metadata

object

{

createTime: The time the operation was created.

endTime: The time the operation finished running.

target: Server-defined resource path for the target of the operation.

verb: Name of the verb executed by the operation.

statusDetail: Human-readable status of the operation, if any.

cancelRequested: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

apiVersion: API version used to start the operation.

}


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

POST

/v1/{name}:failover

Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

Request

Path

Name	Data Type	Description
`name`	string	Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.

Body

Name Data Type Description

FailoverInstanceRequest


                        FailoverInstanceRequest

object

Request for Failover.

Properties


                        dataProtectionMode

string
Allowed values:
- DATA_PROTECTION_MODE_UNSPECIFIED
- LIMITED_DATA_LOSS
- FORCE_DATA_LOSS

Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object

{

createTime: The time the operation was created.

endTime: The time the operation finished running.

target: Server-defined resource path for the target of the operation.

verb: Name of the verb executed by the operation.

statusDetail: Human-readable status of the operation, if any.

apiVersion: API version used to start the operation.

}


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

POST

/v1/{name}:import

Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Request

Path

Name	Data Type	Description
`name`	string	Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region.

Body

Name Data Type Description

ImportInstanceRequest


                        ImportInstanceRequest

object

Request for Import.

Properties


                        inputConfig

InputConfig

Required. Specify data to be imported.


                        InputConfig

object

The input content

Properties


                        gcsSource

GcsSource

Google Cloud Storage location where input content is located.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object

{

createTime: The time the operation was created.

endTime: The time the operation finished running.

target: Server-defined resource path for the target of the operation.

verb: Name of the verb executed by the operation.

statusDetail: Human-readable status of the operation, if any.

apiVersion: API version used to start the operation.

}


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

DELETE

/v1/{name}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Request

Path

Name	Data Type	Description
`name`	string	The name of the operation resource to be deleted.

Responses

200Successful response

Body

Name Data Type Description

Empty


                        Empty

object

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

GET

/v1/{name}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Request

Path

Name	Data Type	Description
`name`	string	The name of the operation resource.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object

{

createTime: The time the operation was created.

endTime: The time the operation finished running.

target: Server-defined resource path for the target of the operation.

verb: Name of the verb executed by the operation.

statusDetail: Human-readable status of the operation, if any.

apiVersion: API version used to start the operation.

}


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

PATCH

/v1/{name}

Updates the metadata and configuration of a specific Redis instance.

Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Request

Path

Name	Data Type	Description
`name`	string	Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id 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 location_id and alternative_location_id fields for more details.

Query

Name	Data Type	Description
`updateMask`	string	Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance: `displayName` `labels` `memorySizeGb` `redisConfig`

Body

Name Data Type Description

Instance


                        Instance

object

A Google Cloud Redis instance.

Properties

`tier`	string Allowed values: - `TIER_UNSPECIFIED` - `BASIC` - `STANDARD_HA`	Required. The service tier of the instance.
`statusMessage`	string	Output only. Additional information about the current status of this instance, if available.
`state`	string Allowed values: - `STATE_UNSPECIFIED` - `CREATING` - `READY` - `UPDATING` - `DELETING` - `REPAIRING` - `MAINTENANCE` - `IMPORTING` - `FAILING_OVER`	Output only. The current state of this instance.
`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.
`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
`redisConfigs`	object	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
`port`	integer	Output only. The port number of the exposed Redis endpoint.
`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.
`name`	string	Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id 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 location_id and alternative_location_id fields for more details.
`memorySizeGb`	integer	Required. Redis memory size in GiB.
`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 alternative_location_id is also provided, it must be different from location_id.
`labels`	object	Resource labels to represent user provided metadata
`host`	string	Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
`displayName`	string	An arbitrary and optional user-provided name for the instance.
`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 location_id provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event.
`createTime`	string	Output only. The time the instance was created.
`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.
`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 location_id.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object

{

createTime: The time the operation was created.

endTime: The time the operation finished running.

target: Server-defined resource path for the target of the operation.

verb: Name of the verb executed by the operation.

statusDetail: Human-readable status of the operation, if any.

apiVersion: API version used to start the operation.

}


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

GET

/v1/{parent}/instances

Lists all Redis instances owned by a project in either the specified location (region) or all locations.

The location should have the following format:

projects/{project_id}/locations/{location_id}

If location_id is specified as - (wildcard), then all regions available to the project are queried, and the results are aggregated.

Request

Path

Name	Data Type	Description
`parent`	string	Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.

Query

Name	Data Type	Description
`pageToken`	string	The `next_page_token` value returned from a previous ListInstances request, if any.
`pageSize`	integer	The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more instances left to be queried.

Responses

200Successful response

Body

Name Data Type Description

ListInstancesResponse


                        ListInstancesResponse

object

Response for ListInstances.

Properties


                        unreachable

array [string]

Locations that could not be reached.


                        nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.


                        instances

array [Instance]

A list of Redis instances in the project in the specified location, or across all locations.

If the location_id in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a dummy Redis entry is included in the response with the name field set to a value of the form projects/{project_id}/locations/{location_id}/instances/- and the status field set to ERROR and status_message field set to "location not available for ListInstances".


                        Instance

object

A Google Cloud Redis instance.

Properties

`tier`	string Allowed values: - `TIER_UNSPECIFIED` - `BASIC` - `STANDARD_HA`	Required. The service tier of the instance.
`statusMessage`	string	Output only. Additional information about the current status of this instance, if available.
`state`	string Allowed values: - `STATE_UNSPECIFIED` - `CREATING` - `READY` - `UPDATING` - `DELETING` - `REPAIRING` - `MAINTENANCE` - `IMPORTING` - `FAILING_OVER`	Output only. The current state of this instance.
`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.
`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
`redisConfigs`	object	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
`port`	integer	Output only. The port number of the exposed Redis endpoint.
`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.
`name`	string	Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id 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 location_id and alternative_location_id fields for more details.
`memorySizeGb`	integer	Required. Redis memory size in GiB.
`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 alternative_location_id is also provided, it must be different from location_id.
`labels`	object	Resource labels to represent user provided metadata
`host`	string	Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
`displayName`	string	An arbitrary and optional user-provided name for the instance.
`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 location_id provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event.
`createTime`	string	Output only. The time the instance was created.
`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.
`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 location_id.

POST

/v1/{parent}/instances

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project's default network.

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. Completed longrunning.Operation will contain the new instance object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

Request

Path

Name	Data Type	Description
`parent`	string	Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.

Query

Name	Data Type	Description
`instanceId`	string	Required. The logical name of the Redis instance in the customer project with the following restrictions: Must contain only lowercase letters, numbers, and hyphens. Must start with a letter. Must be between 1-40 characters. Must end with a number or a letter. Must be unique within the customer project / location

Body

Name Data Type Description

Instance


                        Instance

object

A Google Cloud Redis instance.

Properties

`tier`	string Allowed values: - `TIER_UNSPECIFIED` - `BASIC` - `STANDARD_HA`	Required. The service tier of the instance.
`statusMessage`	string	Output only. Additional information about the current status of this instance, if available.
`state`	string Allowed values: - `STATE_UNSPECIFIED` - `CREATING` - `READY` - `UPDATING` - `DELETING` - `REPAIRING` - `MAINTENANCE` - `IMPORTING` - `FAILING_OVER`	Output only. The current state of this instance.
`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.
`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
`redisConfigs`	object	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
`port`	integer	Output only. The port number of the exposed Redis endpoint.
`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.
`name`	string	Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id 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 location_id and alternative_location_id fields for more details.
`memorySizeGb`	integer	Required. Redis memory size in GiB.
`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 alternative_location_id is also provided, it must be different from location_id.
`labels`	object	Resource labels to represent user provided metadata
`host`	string	Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
`displayName`	string	An arbitrary and optional user-provided name for the instance.
`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 location_id provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event.
`createTime`	string	Output only. The time the instance was created.
`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.
`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 location_id.

Responses

200Successful response

Body

Name Data Type Description

Operation


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object

{

createTime: The time the operation was created.

endTime: The time the operation finished running.

target: Server-defined resource path for the target of the operation.

verb: Name of the verb executed by the operation.

statusDetail: Human-readable status of the operation, if any.

apiVersion: API version used to start the operation.

}


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

Models

Empty

service Foo {
  rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
}

The JSON representation for Empty is empty JSON object {}.

Name	Data Type	Description
`Empty`	object	A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: `service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }` The JSON representation for `Empty` is empty JSON object `{}`.

ExportInstanceRequest

Request for Export.

Properties

Name Data Type Description


                        outputConfig

OutputConfig

Required. Specify data to be exported.


                        OutputConfig

object

The output content

Properties


                        gcsDestination

GcsDestination

Google Cloud Storage destination for output content.


                        GcsDestination

object

The Cloud Storage location for the output content

Properties

uri

string

Required. Data destination URI (e.g. 'gs://my_bucket/my_object'). Existing files will be overwritten.

FailoverInstanceRequest

GcsDestination

GcsSource

GoogleCloudRedisV1LocationMetadata

GoogleCloudRedisV1OperationMetadata

Represents the v1 metadata of the long-running operation.

Properties

Name	Data Type	Description
`verb`	string	Operation verb.
`target`	string	Operation target.
`statusDetail`	string	Operation status details.
`endTime`	string	End timestamp.
`createTime`	string	Creation timestamp.
`cancelRequested`	boolean	Specifies if cancellation was requested for the operation.
`apiVersion`	string	API version.

GoogleCloudRedisV1ZoneMetadata

ImportInstanceRequest

Request for Import.

Properties

Name Data Type Description


                        inputConfig

InputConfig

Required. Specify data to be imported.


                        InputConfig

object

The input content

Properties


                        gcsSource

GcsSource

Google Cloud Storage location where input content is located.


                        GcsSource

object

The Cloud Storage location for the input content

Properties

uri

string

Required. Source data URI. (e.g. 'gs://my_bucket/my_object').

InputConfig

Instance

A Google Cloud Redis instance.

Properties

Name	Data Type	Description
`tier`	string Allowed values: - `TIER_UNSPECIFIED` - `BASIC` - `STANDARD_HA`	Required. The service tier of the instance.
`statusMessage`	string	Output only. Additional information about the current status of this instance, if available.
`state`	string Allowed values: - `STATE_UNSPECIFIED` - `CREATING` - `READY` - `UPDATING` - `DELETING` - `REPAIRING` - `MAINTENANCE` - `IMPORTING` - `FAILING_OVER`	Output only. The current state of this instance.
`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.
`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
`redisConfigs`	object	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
`port`	integer	Output only. The port number of the exposed Redis endpoint.
`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.
`name`	string	Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id 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 location_id and alternative_location_id fields for more details.
`memorySizeGb`	integer	Required. Redis memory size in GiB.
`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 alternative_location_id is also provided, it must be different from location_id.
`labels`	object	Resource labels to represent user provided metadata
`host`	string	Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
`displayName`	string	An arbitrary and optional user-provided name for the instance.
`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 location_id provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event.
`createTime`	string	Output only. The time the instance was created.
`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.
`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 location_id.

ListInstancesResponse

Response for ListInstances.

Properties

Name Data Type Description


                        unreachable

array [string]

Locations that could not be reached.


                        nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.


                        instances

array [Instance]

A list of Redis instances in the project in the specified location, or across all locations.


                        Instance

object

A Google Cloud Redis instance.

Properties

`tier`	string Allowed values: - `TIER_UNSPECIFIED` - `BASIC` - `STANDARD_HA`	Required. The service tier of the instance.
`statusMessage`	string	Output only. Additional information about the current status of this instance, if available.
`state`	string Allowed values: - `STATE_UNSPECIFIED` - `CREATING` - `READY` - `UPDATING` - `DELETING` - `REPAIRING` - `MAINTENANCE` - `IMPORTING` - `FAILING_OVER`	Output only. The current state of this instance.
`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.
`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
`redisConfigs`	object	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
`port`	integer	Output only. The port number of the exposed Redis endpoint.
`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.
`name`	string	Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id 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 location_id and alternative_location_id fields for more details.
`memorySizeGb`	integer	Required. Redis memory size in GiB.
`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 alternative_location_id is also provided, it must be different from location_id.
`labels`	object	Resource labels to represent user provided metadata
`host`	string	Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.
`displayName`	string	An arbitrary and optional user-provided name for the instance.
`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 location_id provided by the user at creation time. For Standard Tier instances, this can be either location_id or alternative_location_id and can change after a failover event.
`createTime`	string	Output only. The time the instance was created.
`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.
`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 location_id.

ListLocationsResponse

The response message for Locations.ListLocations.

Properties

Name Data Type Description


                        nextPageToken

string

The standard List next-page token.


                        locations

array [Location]

A list of locations that matches the specified filter in the request.


                        Location

object

A resource that represents Google Cloud Platform location.

Properties

`name`	string	Full resource name for the region. For example: "projects/example-project/locations/us-east1".
`metadata`	object	Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.
`locationId`	string	Resource ID for the region. For example: "us-east1".
`labels`	object	Cross-service attributes for the location. For example `{"cloud.googleapis.com/region": "us-east1"}`
`displayName`	string	The friendly name for this location, typically a nearby city name. For example, "Tokyo".

ListOperationsResponse

The response message for Operations.ListOperations.

Properties

Name Data Type Description


                        operations

array [Operation]

A list of operations that matches the specified filter in the request.


                        Operation

object

This resource represents a long-running operation that is the result of a network API call.

Properties


                        response

object


                        name

string


                        metadata

object

{

createTime: The time the operation was created.

endTime: The time the operation finished running.

target: Server-defined resource path for the target of the operation.

verb: Name of the verb executed by the operation.

statusDetail: Human-readable status of the operation, if any.

apiVersion: API version used to start the operation.

}


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.


                        nextPageToken

string

The standard List next-page token.

Location

A resource that represents Google Cloud Platform location.

Properties

Name	Data Type	Description
`name`	string	Full resource name for the region. For example: "projects/example-project/locations/us-east1".
`metadata`	object	Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance.
`locationId`	string	Resource ID for the region. For example: "us-east1".
`labels`	object	Cross-service attributes for the location. For example `{"cloud.googleapis.com/region": "us-east1"}`
`displayName`	string	The friendly name for this location, typically a nearby city name. For example, "Tokyo".

Operation

This resource represents a long-running operation that is the result of a network API call.

Properties

Name Data Type Description


                        response

object


                        name

string


                        metadata

object

{

createTime: The time the operation was created.

endTime: The time the operation finished running.

target: Server-defined resource path for the target of the operation.

verb: Name of the verb executed by the operation.

statusDetail: Human-readable status of the operation, if any.

apiVersion: API version used to start the operation.

}


                        error

Status

The error result of the operation in case of failure or cancellation.


                        Status

object

You can find out more about this error model and how to work with it in the API Design Guide.

Properties

`message`	string	A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
`details`	array [object]	A list of messages that carry the error details. There is a common set of message types for APIs to use.
`code`	integer	The status code, which should be an enum value of google.rpc.Code.


                        done

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

OutputConfig

Status

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 accessCode authentication

Flow: authorizationCode
Authorization URL: https://accounts.google.com/o/oauth2/auth
Token URL: https://accounts.google.com/o/oauth2/token
Scopes:

https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

Oauth 2.0 implicit authentication

Flow: implicit
Authorization URL: https://accounts.google.com/o/oauth2/auth
Scopes:

https://www.googleapis.com/auth/cloud-platform: View and manage your data across Google Cloud Platform services

Contact

Name	`Google`
External URL	`https://google.com`

Metadata (Technical Details)

OAS (OpenAPI Specification) v3.0.0

Comments

Loading comments ...