Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1326112156.2 KB
projects

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

post/v1/{+parent}/clusters

Path parameters

parentstring required

Required. The resource name of the cluster location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a Google Cloud region.

Query parameters

clusterIdstring

Required. The logical name of the Redis cluster 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-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location

requestIdstring

Optional. Idempotent request UUID.

Request body

namestring

Required. Identifier. Unique name of the resource in this scope including project and location using the form: projects/{project_id}/locations/{location_id}/clusters/{cluster_id}

createTimestring google-datetime

Output only. The timestamp associated with the cluster creation request.

state'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING'

Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED

uidstring

Output only. System assigned, unique identifier for the cluster.

replicaCountinteger

Optional. The number of replica nodes per shard.

authorizationMode'AUTH_MODE_UNSPECIFIED' | 'AUTH_MODE_IAM_AUTH' | 'AUTH_MODE_DISABLED' | 'AUTH_MODE_TOKEN_AUTH'

Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.

transitEncryptionMode'TRANSIT_ENCRYPTION_MODE_UNSPECIFIED' | 'TRANSIT_ENCRYPTION_MODE_DISABLED' | 'TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION'

Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.

sizeGbinteger

Output only. Redis memory size in GB for the entire cluster rounded up to the next integer.

shardCountinteger

Optional. Number of shards for the Redis cluster.

nodeType'NODE_TYPE_UNSPECIFIED' | 'REDIS_SHARED_CORE_NANO' | 'REDIS_HIGHMEM_MEDIUM' | 'REDIS_HIGHMEM_XLARGE' | 'REDIS_STANDARD_SMALL' | 'REDIS_HIGHCPU_MEDIUM' | 'REDIS_STANDARD_LARGE' | 'REDIS_HIGHMEM_2XLARGE'

Optional. The type of a redis node in the cluster. NodeType determines the underlying machine-type of a redis node.

redisConfigsobject

Optional. Key/Value pairs of customer overrides for mutable Redis Configs

preciseSizeGbnumber double

Output only. Precise value of redis memory size in GB for the entire cluster.

deletionProtectionEnabledboolean

Optional. The delete operation will fail when the value is set to true.

satisfiesPzsboolean

Optional. Output only. Reserved for future use.

satisfiesPziboolean

Optional. Output only. Reserved for future use.

simulateMaintenanceEventboolean

Optional. Input only. Simulate a maintenance event.

backupCollectionstring

Optional. Output only. The backup collection full resource name. Example: projects/{project}/locations/{location}/backupCollections/{collection}

kmsKeystring

Optional. The KMS key used to encrypt the at-rest data of the cluster.

ondemandMaintenanceboolean

Optional. Input only. Ondemand maintenance for the cluster. This field can be used to trigger ondemand critical update on the cluster.

asyncClusterEndpointsDeletionEnabledboolean

Optional. If true, cluster endpoints that are created and registered by customers can be deleted asynchronously. That is, such a cluster endpoint can be de-registered before the forwarding rules in the cluster endpoint are deleted.

maintenanceVersionstring

Optional. This field can be used to trigger self service update to indicate the desired maintenance version. The input to this field can be determined by the available_maintenance_versions field.

effectiveMaintenanceVersionstring

Output only. This field represents the actual maintenance version of the cluster.

availableMaintenanceVersionsstring[]

Output only. This field is used to determine the available maintenance versions for the self service update.

allowFewerZonesDeploymentboolean

Optional. Immutable. Deprecated, do not use.

labelsobject

Optional. Labels to represent user-provided metadata.

serverCaMode'SERVER_CA_MODE_UNSPECIFIED' | 'SERVER_CA_MODE_GOOGLE_MANAGED_PER_INSTANCE_CA' | 'SERVER_CA_MODE_GOOGLE_MANAGED_SHARED_CA' | 'SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA'

Optional. Server CA mode for the cluster.

serverCaPoolstring

Optional. Customer-managed CA pool for the cluster. Only applicable for BYOCA i.e. if server_ca_mode is SERVER_CA_MODE_CUSTOMER_MANAGED_CAS_CA. Format: "projects/{project}/locations/{region}/caPools/{ca_pool}".

rotateServerCertificateboolean

Optional. Input only. Rotate the server certificates.

aclPolicystring

Optional. The ACL policy to be applied to the cluster.

aclPolicyInSyncboolean

Optional. Output only. Deprecated: Indicates whether the ACL rules applied to the cluster are in sync.

Response

Successful response