pydo.databases.get_migration_status()
Generated on 25 November 2024
from pydo version v0.6.0
Description
To retrieve the status of the most recent online migration, send a GET request to /v2/databases/$DATABASE_ID/online-migration.
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_migration_status(database_cluster_uuid="a7a7ab90")
Responses
See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.
A JSON object.
Click to expand an example response.
{
"id": "77b28fc8-19ff-11eb-8c9c-c68e24557488",
"status": "running",
"created_at": "2020-10-29T15:57:38Z"
}
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"
}