PHP SDK

Databases

Database instances and backups

18 methods

GET

listDatabaseBackups()

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

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->listDatabaseBackups();
print_r($result);

POST

createDatabaseBackup()

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

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->createDatabaseBackup([
  'instance_id' => '550e8400-e29b-41d4-a716-446655440000',
  'name' => 'backup-2024-01-15'
]);
print_r($result);

GET

getDatabaseBackup()

Get database backup

Parameters

database_backup_id

string

required

- Database Backup ID

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->getDatabaseBackup([
  'database_backup_id' => '550e8400-e29b-41d4-a716-446655440000'
]);
print_r($result);

DELETE

deleteDatabaseBackup()

Delete database backup

Parameters

database_backup_id

string

required

- Database Backup ID

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->deleteDatabaseBackup([
  'database_backup_id' => '550e8400-e29b-41d4-a716-446655440000'
]);
print_r($result);

POST

restoreDatabaseBackup()

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

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->restoreDatabaseBackup([
  'database_backup_id' => '550e8400-e29b-41d4-a716-446655440000',
  'name' => 'example-string'
]);
print_r($result);

GET

listDatabaseInstances()

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

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->listDatabaseInstances();
print_r($result);

POST

createDatabaseInstance()

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

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->createDatabaseInstance([
  'name' => 'production-db',
  'flavor_id' => '550e8400-e29b-41d4-a716-446655440000',
  'datastore' => [
    'type' => 'postgresql',
    'version' => '15.4'
  ],
  'volume' => [
    'size' => 10,
    'type' => 'example-string'
  ]
]);
print_r($result);

GET

getDatabaseInstance()

Get database instance

Parameters

database_instance_id

string

required

- Database Instance ID

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->getDatabaseInstance([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000'
]);
print_r($result);

PATCH

updateDatabaseInstance()

Update database instance

Parameters

database_instance_id

string

required

- Database Instance ID

name

string

configuration_id

string

public_access

boolean

backup_schedule

object

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->updateDatabaseInstance([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000'
]);
print_r($result);

DELETE

deleteDatabaseInstance()

Delete database instance

Parameters

database_instance_id

string

required

- Database Instance ID

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->deleteDatabaseInstance([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000'
]);
print_r($result);

GET

listDatabases()

List databases

Parameters

database_instance_id

string

required

- Database Instance ID

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->listDatabases([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000'
]);
print_r($result);

POST

createDatabase()

Create database

Parameters

database_instance_id

string

required

- Database Instance ID

name

string

required

character_set

string

collation

string

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->createDatabase([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000',
  'name' => 'myapp'
]);
print_r($result);

DELETE

deleteDatabase()

Delete database

Parameters

database_instance_id

string

required

- Database Instance ID

database_name

string

required

- Database name

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->deleteDatabase([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000',
  'database_name' => 'example'
]);
print_r($result);

POST

resizeDatabaseInstance()

Resize database instance

Parameters

database_instance_id

string

required

- Database Instance ID

flavor_id

string

- New flavor ID

volume

object

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->resizeDatabaseInstance([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000'
]);
print_r($result);

POST

restartDatabaseInstance()

Restart database instance

Parameters

database_instance_id

string

required

- Database Instance ID

force

boolean

- Force restart even if instance is busy

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->restartDatabaseInstance([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000'
]);
print_r($result);

GET

listDatabaseUsers()

List database users

Parameters

database_instance_id

string

required

- Database Instance ID

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->listDatabaseUsers([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000'
]);
print_r($result);

POST

createDatabaseUser()

Create database user

Parameters

database_instance_id

string

required

- Database Instance ID

name

string

required

password

string

required

host

string

databases

array

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->createDatabaseUser([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000',
  'name' => 'app_user',
  'password' => 'example-string'
]);
print_r($result);

DELETE

deleteDatabaseUser()

Delete database user

Parameters

database_instance_id

string

required

- Database Instance ID

user_name

string

required

- Database user name

Example

<?php

use ByCloud\SDK\ByCloud;

$client = new ByCloud(["token" => "YOUR_ACCESS_TOKEN"]);

$result = $client->databases->deleteDatabaseUser([
  'database_instance_id' => '550e8400-e29b-41d4-a716-446655440000',
  'user_name' => 'example'
]);
print_r($result);