pydo.databases.get()
Generated on 25 November 2024
from pydo
version v0.6.0
Description
To show information about an existing database cluster, send a GET request to
/v2/databases/$DATABASE_ID/dbs/$DB_NAME
.
Note: Database management is not supported for Redis clusters.
The response will be a JSON object with a db
key. This will be set to an object
containing the standard database attributes.
Parameters
Name |
Type |
Required |
Description |
Default Value |
database_cluster_uuid |
string |
True |
A unique identifier for a database cluster. |
|
database_name |
string |
True |
The name of the database. |
|
Request Sample
import os
from pydo import Client
client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))
get_resp = client.databases.get(database_cluster_uuid="a9a8a77", database_name="admin")
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 db
.
Click to expand an example response.
{
"db": {
"name": "alpha"
}
}
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"
}