clusters

Overview

Name	clusters
Type	Resource
Id	digitalocean.databases.clusters

Fields

Name	Datatype	Description
id	string	A unique ID that can be used to identify and reference a database cluster.
name	string	A unique, human-readable name referring to a database cluster.
connection	object
created_at	string	A time value given in ISO8601 combined date and time format that represents when the database cluster was created.
db_names	array	An array of strings containing the names of databases created in the database cluster.
engine	string	A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, and "mongodb" for MongoDB.
maintenance_window	object
num_nodes	integer	The number of nodes in the database cluster.
private_connection	object
private_network_uuid	string	A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region.
project_id	string	The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project.
region	string	The slug identifier for the region where the database cluster is located.
rules	array
size	string	The slug identifier representing the size of the nodes in the database cluster.
status	string	A string representing the current status of the database cluster.
tags	array	An array of tags that have been applied to the database cluster.
users	array
version	string	A string representing the version of the database engine in use for the cluster.
version_end_of_availability	string	A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline.
version_end_of_life	string	A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline.

Methods

Name	Accessible by	Required Params	Description
get_cluster	SELECT	database_cluster_uuid	To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID. The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes. The embedded connection and private_connection objects will contain the information needed to access the database cluster. The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
list_clusters	SELECT		To list all of the database clusters available on your account, send a GET request to /v2/databases. To limit the results to database clusters with a specific tag, include the tag_name query parameter set to the name of the tag. For example, /v2/databases?tag_name=$TAG_NAME. The result will be a JSON object with a databases key. This will be set to an array of database objects, each of which will contain the standard database attributes. The embedded connection and private_connection objects will contain the information needed to access the database cluster: The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
create_cluster	INSERT		To create a database cluster, send a POST request to /v2/databases. The response will be a JSON object with a key called database. The value of this will be an object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's status attribute will be creating. When the cluster is ready to receive traffic, this will transition to online. The embedded connection and private_connection objects will contain the information needed to access the database cluster. DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to /v2/databases. In addition to the standard database cluster attributes, the JSON body must include a key named backup_restore with the name of the original database cluster and the timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. Note: Backups are not supported for Redis clusters.
_get_cluster	EXEC	database_cluster_uuid	To show information about an existing database cluster, send a GET request to /v2/databases/$DATABASE_ID. The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes. The embedded connection and private_connection objects will contain the information needed to access the database cluster. The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
_list_clusters	EXEC		To list all of the database clusters available on your account, send a GET request to /v2/databases. To limit the results to database clusters with a specific tag, include the tag_name query parameter set to the name of the tag. For example, /v2/databases?tag_name=$TAG_NAME. The result will be a JSON object with a databases key. This will be set to an array of database objects, each of which will contain the standard database attributes. The embedded connection and private_connection objects will contain the information needed to access the database cluster: The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
destroy_cluster	EXEC	database_cluster_uuid	To destroy a specific database, send a DELETE request to /v2/databases/$DATABASE_ID. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
get_evictionPolicy	EXEC	database_cluster_uuid	To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to /v2/databases/$DATABASE_ID/eviction_policy. The response will be a JSON object with an eviction_policy key. This will be set to a string representing the eviction policy.
update_clusterSize	EXEC	database_cluster_uuid, data__num_nodes, data__size	To resize a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/resize. The body of the request must specify both the size and num_nodes attributes. A successful request will receive a 202 Accepted status code with no body in response. Querying the database cluster will show that its status attribute will now be set to resizing. This will transition back to online when the resize operation has completed.
update_evictionPolicy	EXEC	database_cluster_uuid, data__eviction_policy	To configure an eviction policy for an existing Redis cluster, send a PUT request to /v2/databases/$DATABASE_ID/eviction_policy specifying the desired policy.
update_maintenanceWindow	EXEC	database_cluster_uuid, data__day, data__hour	To configure the window when automatic maintenance should be performed for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/maintenance. A successful request will receive a 204 No Content status code with no body in response.