Method: projects.locations.instances.patch

Updates the parameters of a single Instance.

HTTP request

PATCH https://memorystore.googleapis.com/v1/{instance.name=projects/*/locations/*/instances/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
instance.name

string

Identifier. Unique name of the instance. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to be updated on the instance. At least one field must be specified.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Request body

The request body contains an instance of Instance.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

IAM Permissions

Requires the following IAM permission on the name resource:

  • memorystore.instances.update

For more information, see the IAM documentation.