--- title: "PATCH /v1/{+name}" method: PATCH path: "/v1/{+name}" tags: ["projects"] --- # PATCH /v1/{+name} `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. ## Path parameters - `name` string, required ## Query parameters - `updateMask` string - `updateMask` string ## Request body - Instance — A Memorystore for Redis instance. - `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. - `displayName` string — An arbitrary and optional user-provided name for the instance. - `labels` object — Resource labels to represent user provided metadata - `locationId` string — Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone. - `alternativeLocationId` string — Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service. - `redisVersion` string — Optional. The version of Redis software. If not provided, the default version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility * `REDIS_7_0` for Redis 7.0 compatibility (default) * `REDIS_7_2` for Redis 7.2 compatibility - `reservedIpRange` string — Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28. - `secondaryIpRange` string — Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto". - `host` string — Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. - `port` integer — Output only. The port number of the exposed Redis endpoint. - `currentLocationId` string — Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance. - `createTime` string, google-datetime — Output only. The time the instance was created. - `state` 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'UPDATING' | 'DELETING' | 'REPAIRING' | 'MAINTENANCE' | 'IMPORTING' | 'FAILING_OVER' — Output only. The current state of this instance. - `statusMessage` string — Output only. Additional information about the current status of this instance, if available. - `redisConfigs` object — Optional. Redis configuration parameters, according to [Redis configuration](https://redis.io/docs/latest/operate/oss_and_stack/management/config/). Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries - `tier` 'TIER_UNSPECIFIED' | 'BASIC' | 'STANDARD_HA' — Required. The service tier of the instance. - `memorySizeGb` integer — Required. Redis memory size in GiB. - `authorizedNetwork` string — Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) 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. - `connectMode` 'CONNECT_MODE_UNSPECIFIED' | 'DIRECT_PEERING' | 'PRIVATE_SERVICE_ACCESS' — Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. - `authEnabled` boolean — Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled. - `serverCaCerts` TlsCertificate[] — Output only. List of server CA certificates for the instance. - `serialNumber` string — Serial number, as extracted from the certificate. - `cert` string — PEM representation. - `createTime` string, google-datetime — Output only. The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`. - `expireTime` string, google-datetime — Output only. The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2020-05-18T00:00:00.094Z`. - `sha1Fingerprint` string — Sha1 Fingerprint of the certificate. - `transitEncryptionMode` 'TRANSIT_ENCRYPTION_MODE_UNSPECIFIED' | 'SERVER_AUTHENTICATION' | 'DISABLED' — Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance. - `maintenancePolicy` MaintenancePolicy — Maintenance policy for an instance. - `createTime` string, google-datetime — Output only. The time when the policy was created. - `updateTime` string, google-datetime — Output only. The time when the policy was last updated. - `description` string — Optional. Description of what this policy is for. Create/Update methods return INVALID_ARGUMENT if the length is greater than 512. - `weeklyMaintenanceWindow` WeeklyMaintenanceWindow[] — Optional. Maintenance window that is applied to resources covered by this policy. Minimum 1. For the current version, the maximum number of weekly_window is expected to be one. - `day` 'DAY_OF_WEEK_UNSPECIFIED' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' — Required. The day of week that maintenance updates occur. - `startTime` TimeOfDay — Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. - `hours` integer — Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - `minutes` integer — Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. - `seconds` integer — Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. - `nanos` integer — Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. - `duration` string, google-duration — Output only. Duration of the maintenance window. The current window is fixed at 1 hour. - `maintenanceSchedule` MaintenanceSchedule — Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated. - `startTime` string, google-datetime — Output only. The start time of any upcoming scheduled maintenance for this instance. - `endTime` string, google-datetime — Output only. The end time of any upcoming scheduled maintenance for this instance. - `canReschedule` boolean — If the scheduled maintenance can be rescheduled, default is true. - `scheduleDeadlineTime` string, google-datetime — Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. - `replicaCount` integer — Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0. - `nodes` NodeInfo[] — Output only. Info per node. - `id` string — Output only. Node identifying string. e.g. 'node-0', 'node-1' - `zone` string — Output only. Location of the node. - `readEndpoint` string — Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. - `readEndpointPort` integer — Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. - `readReplicasMode` 'READ_REPLICAS_MODE_UNSPECIFIED' | 'READ_REPLICAS_DISABLED' | 'READ_REPLICAS_ENABLED' — Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. - `customerManagedKey` string — Optional. The KMS key reference that the customer provides when trying to create the instance. - `persistenceConfig` PersistenceConfig — Configuration of the persistence functionality. - `persistenceMode` 'PERSISTENCE_MODE_UNSPECIFIED' | 'DISABLED' | 'RDB' — Optional. Controls whether Persistence features are enabled. If not provided, the existing value will be used. - `rdbSnapshotPeriod` 'SNAPSHOT_PERIOD_UNSPECIFIED' | 'ONE_HOUR' | 'SIX_HOURS' | 'TWELVE_HOURS' | 'TWENTY_FOUR_HOURS' — Optional. Period between RDB snapshots. Snapshots will be attempted every period starting from the provided snapshot start time. For example, a start time of 01/01/2033 06:45 and SIX_HOURS snapshot period will do nothing until 01/01/2033, and then trigger snapshots every day at 06:45, 12:45, 18:45, and 00:45 the next day, and so on. If not provided, TWENTY_FOUR_HOURS will be used as default. - `rdbNextSnapshotTime` string, google-datetime — Output only. The next time that a snapshot attempt is scheduled to occur. - `rdbSnapshotStartTime` string, google-datetime — Optional. Date and time that the first snapshot was/will be attempted, and to which future snapshots will be aligned. If not provided, the current time will be used. - `suspensionReasons` string[] — Optional. reasons that causes instance in "SUSPENDED" state. - `maintenanceVersion` string — Optional. The self service update maintenance version. The version is date based such as "20210712_00_00". - `availableMaintenanceVersions` string[] — Optional. The available maintenance versions that an instance could update to. - `satisfiesPzs` boolean — Optional. Output only. Reserved for future use. - `satisfiesPzi` boolean — Optional. Output only. Reserved for future use. - `tags` object — Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/redis.md) · [All operations](https://skmtc.dev/google/apis/redis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/redis/revisions/001438d863e7/schema)