pydo.databases.get_cluster()
Generated on 17 Apr 2025
from pydo version
v0.10.0
Description
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. For multi-node clusters, the standby_connection and standby_private_connection objects contain the information needed to connect to the cluster’s standby node(s).
The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.
Parameters
| Name | Type | Required | Description | Default Value |
|---|---|---|---|---|
database_cluster_uuid |
string | True | A unique identifier for a database cluster. |
Request Sample
import os
from pydo import Client
client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))
get_resp = client.databases.get_cluster(database_cluster_uuid="a7a89a")More Information
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.