2023-09-28
▼ ▲ redis.projects.locations.clusters.list
Path: v1/{+parent}/clusters
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters
HTTP Method: GET
Parameters:
parent
Description: Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.
Location: query
Type: integer
Format: int32
pageToken
Description: The `next_page_token` value returned from a previous ListClusters request, if any.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists all Redis clusters owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.
▼ ▲ redis.projects.locations.clusters.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method: GET
Parameters:
name
Description: Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the details of a specific Redis cluster.
▼ ▲ redis.projects.locations.clusters.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method: PATCH
Parameters:
name
Description: Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: 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`
Location: query
Type: string
Format: google-fieldmask
requestId
Description: Idempotent request UUID.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the metadata and configuration of a specific Redis cluster. 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.
▼ ▲ redis.projects.locations.clusters.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Idempotent request UUID.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a specific Redis cluster. Cluster stops serving and data is deleted.
▼ ▲ redis.projects.locations.clusters.create
Path: v1/{+parent}/clusters
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
clusterId
Description: 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
Location: query
Type: string
requestId
Description: Idempotent request UUID.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
▼ ▲ redis.projects.locations.clusters.getCertificateAuthority
Path: v1/{+name}/certificateAuthority
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/certificateAuthority
HTTP Method: GET
Parameters:
name
Description: Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a GCP region.
Pattern: ^projects/[^/]+/locations/[^/]+/clusters/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the details of certificate authority information for Redis cluster.