- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Examples
- Try it!
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 operations.delete.
HTTP request
PATCH https://redis.googleapis.com/v1/{instance.name=projects/*/locations/*/instances/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
instance.name
|
Required. Unique name of the resource in this scope including project and location using the form: 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 |
Query parameters
updateMask
string (
FieldMask
format)
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 -
replicaCount
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
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
For more information, see the Authentication Overview .
