Method: projects.locations.clusters.delete

Stay organized with collections Save and categorize content based on your preferences.

Deletes a single Cluster.

HTTP request

DELETE https://alloydb.googleapis.com/v1beta/{name=projects/*/locations/*/clusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the resource. For the required format, see the comment on the Cluster.name field.

Authorization requires the following IAM permission on the specified resource name:

  • alloydb.clusters.delete

Query parameters

Parameters
requestId

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

etag

string

Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.

validateOnly

boolean

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.

force

boolean

Optional. Whether to cascade delete child instances for given cluster.

Request body

The request body must be empty.

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.