AlloyDB API

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

Service: alloydb.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://alloydb.googleapis.com

REST Resource: v1beta.projects.locations

Methods
get GET /v1beta/{name=projects/*/locations/*}
Gets information about a location.
list GET /v1beta/{name=projects/*}/locations
Lists information about the supported locations for this service.

REST Resource: v1beta.projects.locations.backups

Methods
create POST /v1beta/{parent=projects/*/locations/*}/backups
Creates a new Backup in a given project and location.
delete DELETE /v1beta/{name=projects/*/locations/*/backups/*}
Deletes a single Backup.
get GET /v1beta/{name=projects/*/locations/*/backups/*}
Gets details of a single Backup.
list GET /v1beta/{parent=projects/*/locations/*}/backups
Lists Backups in a given project and location.
patch PATCH /v1beta/{backup.name=projects/*/locations/*/backups/*}
Updates the parameters of a single Backup.

REST Resource: v1beta.projects.locations.clusters

Methods
create POST /v1beta/{parent=projects/*/locations/*}/clusters
Creates a new Cluster in a given project and location.
delete DELETE /v1beta/{name=projects/*/locations/*/clusters/*}
Deletes a single Cluster.
generateClientCertificate POST /v1beta/{parent=projects/*/locations/*/clusters/*}:generateClientCertificate
Generate a client certificate signed by a Cluster CA.
get GET /v1beta/{name=projects/*/locations/*/clusters/*}
Gets details of a single Cluster.
list GET /v1beta/{parent=projects/*/locations/*}/clusters
Lists Clusters in a given project and location.
patch PATCH /v1beta/{cluster.name=projects/*/locations/*/clusters/*}
Updates the parameters of a single Cluster.
restore POST /v1beta/{parent=projects/*/locations/*}/clusters:restore
Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.

REST Resource: v1beta.projects.locations.clusters.instances

Methods
create POST /v1beta/{parent=projects/*/locations/*/clusters/*}/instances
Creates a new Instance in a given project and location.
delete DELETE /v1beta/{name=projects/*/locations/*/clusters/*/instances/*}
Deletes a single Instance.
failover POST /v1beta/{name=projects/*/locations/*/clusters/*/instances/*}:failover
Forces a Failover for a highly available instance.
get GET /v1beta/{name=projects/*/locations/*/clusters/*/instances/*}
Gets details of a single Instance.
getConnectionInfo GET /v1beta/{parent=projects/*/locations/*/clusters/*/instances/*}/connectionInfo
Get instance metadata used for a connection.
list GET /v1beta/{parent=projects/*/locations/*/clusters/*}/instances
Lists Instances in a given project and location.
patch PATCH /v1beta/{instance.name=projects/*/locations/*/clusters/*/instances/*}
Updates the parameters of a single Instance.
restart POST /v1beta/{name=projects/*/locations/*/clusters/*/instances/*}:restart
Restart an Instance in a cluster.

REST Resource: v1beta.projects.locations.operations

Methods
cancel POST /v1beta/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1beta/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1beta/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1beta/{name=projects/*/locations/*}/operations
Lists operations that match the specified filter in the request.

REST Resource: v1beta.projects.locations.supportedDatabaseFlags

Methods
list GET /v1beta/{parent=projects/*/locations/*}/supportedDatabaseFlags
Lists SupportedDatabaseFlags for a given project and location.