Python SDK

Databases

Database instances and backups

10 methods

GET

list_database_backups()

List database backups

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

status

string

- Filter by status

instance_id

string

- Filter by database instance ID

datastore_type

string

- Filter by datastore type

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.list_database_backups()
print(result)

POST

create_database_backup()

Create database backup

Parameters

instance_id

string

required

name

string

required

description

string

parent_id

string

- Parent backup ID for incremental backup

incremental

boolean

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.create_database_backup(instance_id="550e8400-e29b-41d4-a716-446655440000", name="backup-2024-01-15")
print(result)

GET

get_database_backup()

Get database backup

Parameters

database_backup_id

string

required

- Database Backup ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.get_database_backup(database_backup_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

DELETE

delete_database_backup()

Delete database backup

Parameters

database_backup_id

string

required

- Database Backup ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.delete_database_backup(database_backup_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

GET

list_database_flavors()

List database flavors

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.list_database_flavors()
print(result)

GET

list_database_instances()

List database instances

Parameters

limit

integer

- Maximum number of items to return

marker

string

- ID of the last item from the previous page (for pagination)

name

string

- Filter by name (exact match or prefix with *)

status

string

- Filter by status

datastore_type

string

- Filter by datastore type

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.list_database_instances()
print(result)

POST

create_database_instance()

Create database instance

Parameters

name

string

required

flavor_id

string

required

datastore

object

required

volume

object

required

networks

array

databases

array

- Initial databases to create

users

array

- Initial users to create

configuration_id

string

replica_of

string

- Source instance ID (for read replicas)

replica_count

integer

- Number of read replicas to create

public_access

boolean

ssl_enabled

boolean

backup_schedule

object

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.create_database_instance(name="production-db", flavor_id="550e8400-e29b-41d4-a716-446655440000", datastore=[object Object], volume=[object Object])
print(result)

GET

get_database_instance()

Get database instance

Parameters

database_instance_id

string

required

- Database Instance ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.get_database_instance(database_instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

PATCH

update_database_instance()

Update database instance

Parameters

database_instance_id

string

required

- Database Instance ID

name

string

configuration_id

string

public_access

boolean

backup_schedule

object

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.update_database_instance(database_instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)

DELETE

delete_database_instance()

Delete database instance

Parameters

database_instance_id

string

required

- Database Instance ID

Example

from bycloud import ByCloud

client = ByCloud(token="YOUR_ACCESS_TOKEN")

result = client.databases.delete_database_instance(database_instance_id="550e8400-e29b-41d4-a716-446655440000")
print(result)