projects

Changed on

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.

patch/v1/{+name}

Request

  • Base URL: https://redis.googleapis.com
  • URL: https://redis.googleapis.com/v1/{+name}
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, 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)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/redis.read-write) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/redis.read-write)

Path parameters

namestring required

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 parameters

updateMaskstring

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 * replica_count

updateMaskstring

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 Cluster: * size_gb * replica_count * cluster_endpoints

Request body

alternativeLocationIdstring

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.

authEnabledboolean

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.

authorizedNetworkstring

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.

availableMaintenanceVersionsstring[]

Optional. The available maintenance versions that an instance could update to.

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.

createTimestring google-datetime

Output only. The time the instance was created.

currentLocationIdstring

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.

customerManagedKeystring

Optional. The KMS key reference that the customer provides when trying to create the instance.

displayNamestring

An arbitrary and optional user-provided name for the instance.

hoststring

Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service.

labelsobject

Resource labels to represent user provided metadata

locationIdstring

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.

maintenanceVersionstring

Optional. The self service update maintenance version. The version is date based such as "20210712_00_00".

memorySizeGbinteger

Required. Redis memory size in GiB.

namestring

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.

persistenceIamIdentitystring

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.

portinteger

Output only. The port number of the exposed Redis endpoint.

readEndpointstring

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'.

readEndpointPortinteger

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.

redisConfigsobject

Optional. Redis configuration parameters, according to Redis configuration. 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

redisVersionstring

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

replicaCountinteger

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.

reservedIpRangestring

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.

satisfiesPziboolean

Optional. Output only. Reserved for future use.

satisfiesPzsboolean

Optional. Output only. Reserved for future use.

secondaryIpRangestring

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".

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'UPDATING' | 'DELETING' | 'REPAIRING' | 'MAINTENANCE' | 'IMPORTING' | 'FAILING_OVER'

Output only. The current state of this instance.

statusMessagestring

Output only. Additional information about the current status of this instance, if available.

suspensionReasonsstring[]

Optional. reasons that causes instance in "SUSPENDED" state.

tagsobject

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

tier'TIER_UNSPECIFIED' | 'BASIC' | 'STANDARD_HA'

Required. The service tier of the instance.

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.

Response

Successful response

Changes

  • 31e5b647e20eRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • warning

      deleted the query request parameter updateMask

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/redis.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/redis.read-write was removed from the endpoint's security scheme Oauth2c

    • info

      added the new optional query request parameter updateMask

  • f07df073e0a8Revision changes
    • warning

      deleted the query request parameter updateMask

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/redis.read-write was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/redis.read-write was removed from the endpoint's security scheme Oauth2c

    • info

      added the new optional query request parameter updateMask