ByCloud Docs
GuidesCLIAPISDK

Python SDK

Databases

Database instances and backups

18 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)
POST

restore_database_backup()

Restore database backup

Parameters

database_backup_id

string

required

- Database Backup ID

name

string

required

- Name for the new restored instance

flavor_id

string

- Flavor for restored instance (uses original if omitted)

volume_size

integer

- Volume size for restored instance (uses original if omitted)

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.databases.restore_database_backup(database_backup_id="550e8400-e29b-41d4-a716-446655440000", name="example-string")
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)
GET

list_databases()

List databases

Parameters

database_instance_id

string

required

- Database Instance ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


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

create_database()

Create database

Parameters

database_instance_id

string

required

- Database Instance ID

name

string

required
character_set

string

collation

string

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.databases.create_database(database_instance_id="550e8400-e29b-41d4-a716-446655440000", name="myapp")
print(result)
DELETE

delete_database()

Delete database

Parameters

database_instance_id

string

required

- Database Instance ID

database_name

string

required

- Database name

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.databases.delete_database(database_instance_id="550e8400-e29b-41d4-a716-446655440000", database_name="example")
print(result)
POST

resize_database_instance()

Resize database instance

Parameters

database_instance_id

string

required

- Database Instance ID

flavor_id

string

- New flavor ID

volume

object

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


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

restart_database_instance()

Restart database instance

Parameters

database_instance_id

string

required

- Database Instance ID

force

boolean

- Force restart even if instance is busy

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


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

list_database_users()

List database users

Parameters

database_instance_id

string

required

- Database Instance ID

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


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

create_database_user()

Create database user

Parameters

database_instance_id

string

required

- Database Instance ID

name

string

required
password

string

required
host

string

databases

array

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.databases.create_database_user(database_instance_id="550e8400-e29b-41d4-a716-446655440000", name="app_user", password="example-string")
print(result)
DELETE

delete_database_user()

Delete database user

Parameters

database_instance_id

string

required

- Database Instance ID

user_name

string

required

- Database user name

Example

from bycloud import ByCloud


client = ByCloud(token="YOUR_ACCESS_TOKEN")


result = client.databases.delete_database_user(database_instance_id="550e8400-e29b-41d4-a716-446655440000", user_name="example")
print(result)