pydo.databases.list()
Generated on 25 November 2024
from pydo
version v0.6.0
Description
To list all of the databases in a clusters, send a GET request to
/v2/databases/$DATABASE_ID/dbs
.
The result will be a JSON object with a dbs
key. This will be set to an array
of database objects, each of which will contain the standard database attributes.
Note: Database management is not supported for Redis clusters.
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 . list ( database_cluster_uuid = "a7aba9d" )
Responses
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.
A JSON object with a key of databases
.
Click to expand an example response.
{
"dbs" : [
{
"name" : "alpha"
},
{
"name" : "defaultdb"
}
]
}
Unauthorized
Click to expand an example response.
{
"id" : "unauthorized" ,
"message" : "Unable to authenticate you."
}
The resource was not found.
Click to expand an example response.
{
"id" : "not_found" ,
"message" : "The resource you requested could not be found."
}
API Rate limit exceeded
Click to expand an example response.
{
"id" : "too_many_requests" ,
"message" : "API Rate limit exceeded."
}
Server error.
Click to expand an example response.
{
"id" : "server_error" ,
"message" : "Unexpected server-side error"
}
Unexpected error
Click to expand an example response.
{
"id" : "example_error" ,
"message" : "some error message"
}