Managed Databases API (v1)
Managing databases: creating and scaling database clusters up, restoring from backup, managing users, and more
List ACLs
Authorizations:
query Parameters
id | string Filter the list result by the id |
project_id | string Filter the list result by the project_id |
datastore_id | string Filter the list result by the datastore_id |
pattern | string Filter the list result by the pattern |
pattern_type | string Filter the list result by the pattern_type |
status | string Filter the list result by the status |
user_id | string Filter the list result by the user_id |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "acls": [
- {
- "allow_read": true,
- "allow_write": true,
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "pattern": "string",
- "pattern_type": "string",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00",
- "user_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
]
}
Create ACL
Authorizations:
Request Body schema: application/jsonrequired
required | object (ACLCreate) | ||||||||||||
|
Responses
Request samples
- Payload
{- "acl": {
- "allow_read": true,
- "allow_write": true,
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "pattern": "string",
- "pattern_type": "literal",
- "user_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "acl": {
- "allow_read": true,
- "allow_write": true,
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "pattern": "string",
- "pattern_type": "string",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00",
- "user_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "acl": {
- "allow_read": true,
- "allow_write": true,
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "pattern": "string",
- "pattern_type": "string",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00",
- "user_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Update ACL resource
Authorizations:
path Parameters
acl_id required | string |
Request Body schema: application/jsonrequired
required | object (ACLUpdate) | ||||
|
Responses
Request samples
- Payload
{- "acl": {
- "allow_read": true,
- "allow_write": true
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "acl": {
- "allow_read": true,
- "allow_write": true,
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "pattern": "string",
- "pattern_type": "string",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00",
- "user_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
List actions
Authorizations:
query Parameters
id | string Filter the list result by the id |
name | string Filter the list result by the name |
status | string Filter the list result by the status |
project_id | string Filter the list result by the project_id |
request_id | string Filter the list result by the request_id |
datastore_id | string Filter the list result by the datastore_id |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "actions": [
- {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "finish_time": "1970-01-01T00:00:00",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "string",
- "project_id": "123e4567e89b12d3a456426655440000",
- "request_id": "string",
- "start_time": "1970-01-01T00:00:00",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
]
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "action": {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "finish_time": "1970-01-01T00:00:00",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "string",
- "project_id": "123e4567e89b12d3a456426655440000",
- "request_id": "string",
- "start_time": "1970-01-01T00:00:00",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
List available DBMS extensions
Authorizations:
query Parameters
id | string Filter the list result by the id |
name | string Filter the list result by the name |
datastore_type_id | string Filter the list result by the datastore_type_id |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "available-extensions": [
- {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "dependency_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name"
}
]
}
Create an available DBMS extension
Authorizations:
Request Body schema: application/jsonrequired
required | object (AvailableExtensionCreate) | ||||||
|
Responses
Request samples
- Payload
{- "available-extension": {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "dependency_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "name": "string"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "available-extension": {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "dependency_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name"
}
}
Drop an extension
FIXME: Warning! This endpoint will remove available extension with all related records in extensions table. It acts like DELETE /flavors (and maybe some of the other deletion endpoints).
Authorizations:
path Parameters
available_extension_id required | string |
Responses
Response samples
- 400
- 401
- 403
- 404
{- "error": {
- "code": 400,
- "message": "string",
- "title": "Bad Request"
}
}
Get an extension resource
Authorizations:
path Parameters
available_extension_id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "available-extension": {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "dependency_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name"
}
}
Update an available DBMS extension
Authorizations:
path Parameters
available_extension_id required | string |
Request Body schema: application/jsonrequired
required | object (AvailableExtensionUpdate) | ||||
|
Responses
Request samples
- Payload
{- "available-extension": {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "dependency_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
]
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "dependency_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name"
}
List configuration parameters
Authorizations:
query Parameters
id | string Filter the list result by the id |
datastore_type_id | string Filter the list result by the datastore_type_id |
name | string Filter the list result by the name |
ram | string Filter the list result by the ram |
vcpus | string Filter the list result by the vcpus |
disk | string Filter the list result by the disk |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "configuration-parameters": [
- {
- "can_be_empty": true,
- "choices": [
- 0
], - "datastore_type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "default_value": 0,
- "factor": 1,
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "invalid_values": [
- 0
], - "is_changeable": true,
- "is_multiple_choice_available": true,
- "is_restart_required": true,
- "max": 0,
- "min": 0,
- "name": "string",
- "type": "string",
- "unit": "string"
}
]
}
Create a configuration parameter
Authorizations:
Request Body schema: application/jsonrequired
required | object (ConfigurationParameterCreate) | ||||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "configuration-parameter": {
- "can_be_empty": true,
- "choices": [
- 0
], - "datastore_type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "default_value_template": "string",
- "factor": 1,
- "invalid_values": [
- 0
], - "is_available_for_customer": true,
- "is_changeable": true,
- "is_multiple_choice_available": true,
- "is_restart_required": true,
- "max_template": "string",
- "min_template": "string",
- "name": "string",
- "type": "string",
- "unit": "string"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "configuration-parameter": {
- "can_be_empty": true,
- "choices": [
- 0
], - "datastore_type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "default_value": 0,
- "factor": 1,
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "invalid_values": [
- 0
], - "is_changeable": true,
- "is_multiple_choice_available": true,
- "is_restart_required": true,
- "max": 0,
- "min": 0,
- "name": "string",
- "type": "string",
- "unit": "string"
}
}
Get a configuration parameter resource
Authorizations:
path Parameters
configuration_parameter_id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "configuration-parameter": {
- "can_be_empty": true,
- "choices": [
- 0
], - "datastore_type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "default_value": 0,
- "factor": 1,
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "invalid_values": [
- 0
], - "is_changeable": true,
- "is_multiple_choice_available": true,
- "is_restart_required": true,
- "max": 0,
- "min": 0,
- "name": "string",
- "type": "string",
- "unit": "string"
}
}
List databases
Authorizations:
query Parameters
id | string Filter the list result by the id |
project_id | string Filter the list result by the project_id |
name | string Filter the list result by the name |
datastore_id | string Filter the list result by the datastore_id |
status | string Filter the list result by the status |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "databases": [
- {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "lc_collate": "string",
- "lc_ctype": "string",
- "name": "Name",
- "owner_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
]
}
Create a database
Authorizations:
Request Body schema: application/jsonrequired
required | object (DatabaseCreate) | ||||||||||
|
Responses
Request samples
- Payload
{- "database": {
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "lc_collate": "string",
- "lc_ctype": "string",
- "name": "Name",
- "owner_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "database": {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "lc_collate": "string",
- "lc_ctype": "string",
- "name": "Name",
- "owner_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
Get a database resource
Authorizations:
path Parameters
database_id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "database": {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "lc_collate": "string",
- "lc_ctype": "string",
- "name": "Name",
- "owner_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
Update a database user resource
Authorizations:
path Parameters
database_id required | string |
Request Body schema: application/jsonrequired
required | object (DatabaseUpdate) | ||
|
Responses
Request samples
- Payload
{- "database": {
- "owner_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "database": {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "lc_collate": "string",
- "lc_ctype": "string",
- "name": "Name",
- "owner_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
List datastores
Authorizations:
query Parameters
id | string Filter the list result by the id |
project_id | string Filter the list result by the project_id |
name | string Filter the list result by the name |
status | string Filter the list result by the status |
enabled | string Filter the list result by the enabled |
type_id | string Filter the list result by the type_id |
flavor_id | string Filter the list result by the flavor_id |
subnet_id | string Filter the list result by the subnet_id |
allow_restore | string Filter the list result by the allow_restore |
is_maintenance | string Filter the list result by the is_maintenance |
is_protected | string Filter the list result by the is_protected |
deleted | string Filter the list result by the deleted |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "datastores": [
- {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
]
}
Create a datastore
Authorizations:
Request Body schema: application/jsonrequired
required | object (DatastoreCreate) | ||||||||||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "datastore": {
- "backup_retention_days": 1,
- "config": { },
- "disk": {
- "size": 1,
- "type": "string"
}, - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "floating_ips": {
- "master": 1,
- "replica": 0
}, - "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "session",
- "size": 1
}, - "project_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "redis_password": "Secret",
- "restore": {
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "target_time": "1970-01-01T00:00:00"
}, - "subnet_id": "string",
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "datastore": {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
}
Get a datastore resource
Authorizations:
path Parameters
datastore_id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "datastore": {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
}
Update a datastore
Authorizations:
path Parameters
datastore_id required | string |
Request Body schema: application/jsonrequired
object (DatastoreUpdate) | |||
|
Responses
Request samples
- Payload
{- "datastore": {
- "name": "Name"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "datastore": {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
}
Update datastore backup parameters
Authorizations:
path Parameters
datastore_id required | string |
Request Body schema: application/jsonrequired
required | object (DatastoreUpdateBackups) | ||
|
Responses
Request samples
- Payload
{- "backups": {
- "backup_retention_days": 1
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "datastore": {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
}
Configure datastore
This method will change provided parameters. Send nulls as values to reset parameter to default value.
Authorizations:
path Parameters
datastore_id required | string |
Request Body schema: application/jsonrequired
config | object |
Responses
Request samples
- Payload
{- "config": { }
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "datastore": {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
}
Get metrics for datastore databases
Authorizations:
path Parameters
datastore_id required | string |
query Parameters
start | string Filter the list result by the start |
end | string Filter the list result by the end |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "metrics": {
- "*": {
- "property1": {
- "avg": 0,
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "db_name": "string",
- "ip": "127.0.0.1",
- "last": 0,
- "max": 0,
- "min": 0,
- "timestamps": [
- 0
], - "values": [
- 0
]
}, - "property2": {
- "avg": 0,
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "db_name": "string",
- "ip": "127.0.0.1",
- "last": 0,
- "max": 0,
- "min": 0,
- "timestamps": [
- 0
], - "values": [
- 0
]
}
}, - "step": 0
}
}
Update firewall rules for datastore
Authorizations:
path Parameters
datastore_id required | string |
Request Body schema: application/jsonrequired
required | object (DatastoreUpdateFirewall) | ||
|
Responses
Request samples
- Payload
{- "firewall": {
- "ips": [
- "127.0.0.1"
]
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "datastore": {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
}
Get all logs for datastore instance
Authorizations:
path Parameters
datastore_id required | string |
query Parameters
job | string Filter the list result by the job |
start | string Filter the list result by the start |
end | string Filter the list result by the end |
limit | string Filter the list result by the limit |
ips | string Filter the list result by the ips |
databases | string Filter the list result by the databases |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "logs": {
- "datastore_id": "string",
- "ip": "string",
- "labels": {
- "key": "value"
}, - "ts": 0,
- "value": "string"
}
}
Get all metrics for datastore instance
Authorizations:
path Parameters
datastore_id required | string |
query Parameters
start | string Filter the list result by the start |
end | string Filter the list result by the end |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "metrics": {
- "*": {
- "property1": {
- "avg": 0,
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "last": 0,
- "max": 0,
- "min": 0,
- "timestamps": [
- 0
], - "values": [
- 0
]
}, - "property2": {
- "avg": 0,
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "last": 0,
- "max": 0,
- "min": 0,
- "timestamps": [
- 0
], - "values": [
- 0
]
}
}, - "step": 0
}
}
Update Redis datastore password
Authorizations:
path Parameters
datastore_id required | string |
Request Body schema: application/jsonrequired
required | object (DatastoreUpdatePassword) | ||
|
Responses
Request samples
- Payload
{- "password": {
- "redis_password": "Secret"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "datastore": {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
}
Update datastore pooler settings
Authorizations:
path Parameters
datastore_id required | string |
Request Body schema: application/jsonrequired
required | object (DatastoreUpdatePooler) | ||||
|
Responses
Request samples
- Payload
{- "pooler": {
- "mode": "session",
- "size": 1
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "datastore": {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
}
Resize datastore
Authorizations:
path Parameters
datastore_id required | string |
Request Body schema: application/jsonrequired
required | object (DatastoreResize) | ||||||||
|
Responses
Request samples
- Payload
{- "resize": {
- "disk": {
- "size": 1
}, - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "node_count": 1
}
}
Response samples
- 200
- 400
- 401
- 403
{- "datastore": {
- "allow_restore": true,
- "backup_retention_days": 0,
- "config": { },
- "connection": {
- "key": "value"
}, - "created_at": "1970-01-01T00:00:00",
- "creation_finished_at": "1970-01-01T00:00:00",
- "databases_count": 0,
- "disk_used": 0,
- "enabled": true,
- "firewall": [
- {
- "ip": "127.0.0.1"
}
], - "flavor": {
- "disk": 1,
- "disk_type": "string",
- "ram": 1,
- "vcpus": 1
}, - "flavor_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "instances": [
- {
- "floating_ip": "127.0.0.1",
- "hostname": "string",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "ip": "127.0.0.1",
- "role": "string",
- "status": "string"
}
], - "is_maintenance": true,
- "is_protected": true,
- "name": "Name",
- "node_count": 1,
- "pooler": {
- "mode": "string",
- "size": 0
}, - "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "subnet_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "topics_count": 0,
- "type_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "updated_at": "1970-01-01T00:00:00"
}
}
List DBMS extensions
Authorizations:
query Parameters
id | string Filter the list result by the id |
project_id | string Filter the list result by the project_id |
available_extension_id | string Filter the list result by the available_extension_id |
datastore_id | string Filter the list result by the datastore_id |
database_id | string Filter the list result by the database_id |
status | string Filter the list result by the status |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "extensions": [
- {
- "available_extension_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
]
}
Create an extension
Authorizations:
Request Body schema: application/jsonrequired
required | object (ExtensionCreate) | ||||||
|
Responses
Request samples
- Payload
{- "extension": {
- "available_extension_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "extension": {
- "available_extension_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "dependencies": [
- {
- "available_extension_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
], - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
Get an extension resource
Authorizations:
path Parameters
extension_id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "extension": {
- "available_extension_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
List flavors
Authorizations:
query Parameters
id | string Filter the list result by the id |
name | string Filter the list result by the name |
fl_size | string Filter the list result by the fl_size |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "flavors": [
- {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "description": "string",
- "disk": 1,
- "fl_size": "string",
- "host": {
- "available_count": 1,
- "line": "string",
- "processor": "string"
}, - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "ram": 1,
- "vcpus": 1
}
]
}
Create a flavor
Authorizations:
Request Body schema: application/jsonrequired
required | object (FlavorCreate) | ||||||||||||||||||||
|
Responses
Request samples
- Payload
{- "flavor": {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "description": "string",
- "disk": 1,
- "fl_size": "string",
- "host": {
- "line": "string",
- "processor": "string",
- "total_count": 1
}, - "is_public": true,
- "name": "Name",
- "ram": 1,
- "template": "string",
- "vcpus": 1
}
}
Response samples
- 200
- 400
- 401
- 403
{- "flavor": {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "description": "string",
- "disk": 1,
- "fl_size": "string",
- "host": {
- "available_count": 1,
- "line": "string",
- "processor": "string"
}, - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "ram": 1,
- "vcpus": 1
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "flavor": {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "description": "string",
- "disk": 1,
- "fl_size": "string",
- "host": {
- "available_count": 1,
- "line": "string",
- "processor": "string"
}, - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "ram": 1,
- "vcpus": 1
}
}
Update a flavor
Authorizations:
path Parameters
flavor_id required | string |
Request Body schema: application/jsonrequired
object (FlavorUpdate) | |||||
|
Responses
Request samples
- Payload
{- "flavor": {
- "description": "string",
- "name": "Name"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "flavor": {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "description": "string",
- "disk": 1,
- "fl_size": "string",
- "host": {
- "available_count": 1,
- "line": "string",
- "processor": "string"
}, - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "ram": 1,
- "vcpus": 1
}
}
Update a flavor host
Authorizations:
path Parameters
flavor_id required | string |
Request Body schema: application/jsonrequired
required | object (FlavorUpdateHost) | ||||||
|
Responses
Request samples
- Payload
{- "host": {
- "line": "string",
- "processor": "string",
- "total_count": 1
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "flavor": {
- "datastore_type_ids": [
- "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
], - "description": "string",
- "disk": 1,
- "fl_size": "string",
- "host": {
- "available_count": 1,
- "line": "string",
- "processor": "string"
}, - "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "ram": 1,
- "vcpus": 1
}
}
Delete floating IP from instance
Authorizations:
Request Body schema: application/jsonrequired
required | object (FloatingIPRemove) | ||
|
Responses
Request samples
- Payload
{- "floating_ip": {
- "instance_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 400
- 401
- 403
{- "error": {
- "code": 400,
- "message": "string",
- "title": "Bad Request"
}
}
Create a new floating IP
Authorizations:
Request Body schema: application/jsonrequired
required | object (FloatingIPCreate) | ||
|
Responses
Request samples
- Payload
{- "floating_ip": {
- "instance_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 400
- 401
- 403
{- "error": {
- "code": 400,
- "message": "string",
- "title": "Bad Request"
}
}
List database grants
Authorizations:
query Parameters
id | string Filter the list result by the id |
project_id | string Filter the list result by the project_id |
datastore_id | string Filter the list result by the datastore_id |
database_id | string Filter the list result by the database_id |
user_id | string Filter the list result by the user_id |
status | string Filter the list result by the status |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "grants": [
- {
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00",
- "user_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
]
}
Create a database grant
Authorizations:
Request Body schema: application/jsonrequired
required | object (GrantCreate) | ||||||
|
Responses
Request samples
- Payload
{- "grant": {
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "user_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "grant": {
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00",
- "user_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "grant": {
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00",
- "user_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "limits": {
- "disk_local_max": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "disk_local_min": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "disk_network_ultra_max": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "disk_network_ultra_min": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "disk_types": [
- "string"
], - "disk_vcpus_multiplier": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "flavor_max_disk": 1,
- "flavor_max_ram": 1,
- "flavor_max_vcpus": 1,
- "flavor_min_disk": 1,
- "flavor_min_ram": 1,
- "flavor_min_vcpus": 1,
- "ram_max": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "ram_min": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "ram_vcpus_multiplier": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "vcpus_max": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "vcpus_min": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}, - "vcpus_multiplier_min_threshold": {
- "kafka": 1,
- "mysql": 1,
- "mysql_native": 1,
- "postgresql": 1,
- "redis": 1
}
}
}
List logical replication slots
Authorizations:
query Parameters
id | string Filter the list result by the id |
project_id | string Filter the list result by the project_id |
name | string Filter the list result by the name |
datastore_id | string Filter the list result by the datastore_id |
database_id | string Filter the list result by the database_id |
status | string Filter the list result by the status |
in_use | string Filter the list result by the in_use |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "logical-replication-slots": [
- {
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "in_use": true,
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "size": 0,
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
]
}
Create a logical replication slot
Authorizations:
Request Body schema: application/jsonrequired
required | object (LogicalRepplicationSlotCreate) | ||||||
|
Responses
Request samples
- Payload
{- "logical-replication-slot": {
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "logical-replication-slot": {
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "in_use": true,
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "size": 0,
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
Get a logical replication slot
Authorizations:
path Parameters
logical_replication_slot_id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "logical-replication-slot": {
- "created_at": "1970-01-01T00:00:00",
- "database_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "in_use": true,
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "size": 0,
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
List prometheus metrics tokens
Authorizations:
query Parameters
id | string Filter the list result by the id |
project_id | string Filter the list result by the project_id |
name | string Filter the list result by the name |
value | string Filter the list result by the value |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "prometheus-metrics-tokens": [
- {
- "created_at": "1970-01-01T00:00:00",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "updated_at": "1970-01-01T00:00:00",
- "value": "string"
}
]
}
Issue prometheus metrics token
Authorizations:
Request Body schema: application/jsonrequired
required | object (PrometheusMetricsTokenCreate) | ||
|
Responses
Request samples
- Payload
{- "prometheus-metrics-token": {
- "name": "Name"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "prometheus-metrics-token": {
- "created_at": "1970-01-01T00:00:00",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "updated_at": "1970-01-01T00:00:00",
- "value": "string"
}
}
Get prometheus_metrics_token resource
Authorizations:
path Parameters
prometheus_metrics_token_id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "prometheus-metrics-token": {
- "created_at": "1970-01-01T00:00:00",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "updated_at": "1970-01-01T00:00:00",
- "value": "string"
}
}
Update prometheus_metrics_token data
Authorizations:
path Parameters
prometheus_metrics_token_id required | string |
Request Body schema: application/jsonrequired
required | object (PrometheusMetricsTokenUpdate) | ||
|
Responses
Request samples
- Payload
{- "prometheus-metrics-token": {
- "name": "Name"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "prometheus-metrics-token": {
- "created_at": "1970-01-01T00:00:00",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "updated_at": "1970-01-01T00:00:00",
- "value": "string"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "quotas": {
- "acls": 0,
- "cores": 0,
- "databases": 0,
- "datastores": 0,
- "disk_local": 0,
- "disk_network_ultra": 0,
- "firewall_rules": 0,
- "in_use_acls": 0,
- "in_use_cores": 0,
- "in_use_databases": 0,
- "in_use_datastores": 0,
- "in_use_disk_local": 0,
- "in_use_disk_network_ultra": 0,
- "in_use_firewall_rules": 0,
- "in_use_local_gb": 0,
- "in_use_prometheus_metrics_tokens": 0,
- "in_use_ram": 0,
- "in_use_topics": 0,
- "in_use_users": 0,
- "local_gb": 0,
- "prometheus_metrics_tokens": 0,
- "ram": 0,
- "topics": 0,
- "users": 0
}
}
List database users
Authorizations:
query Parameters
id | string Filter the list result by the id |
project_id | string Filter the list result by the project_id |
name | string Filter the list result by the name |
datastore_id | string Filter the list result by the datastore_id |
status | string Filter the list result by the status |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "users": [
- {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
]
}
Create a database user
Authorizations:
Request Body schema: application/jsonrequired
required | object (UserCreate) | ||||||
|
Responses
Request samples
- Payload
{- "user": {
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "password": "Secret"
}
}
Response samples
- 200
- 400
- 401
- 403
{- "user": {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
Get a database user resource
Authorizations:
path Parameters
user_id required | string |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
{- "user": {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
Update a database user resource
Authorizations:
path Parameters
user_id required | string |
Request Body schema: application/jsonrequired
required | object (UserUpdate) | ||
|
Responses
Request samples
- Payload
{- "user": {
- "password": "Secret"
}
}
Response samples
- 200
- 400
- 401
- 403
- 404
{- "user": {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}
List topics
Authorizations:
query Parameters
id | string Filter the list result by the id |
project_id | string Filter the list result by the project_id |
name | string Filter the list result by the name |
datastore_id | string Filter the list result by the datastore_id |
status | string Filter the list result by the status |
Responses
Response samples
- 200
- 400
- 401
- 403
{- "topics": [
- {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "partitions": 1,
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
]
}
Create a topic
Authorizations:
Request Body schema: application/jsonrequired
required | object (TopicCreate) | ||||||
|
Responses
Request samples
- Payload
{- "topic": {
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "partitions": 1
}
}
Response samples
- 200
- 400
- 401
- 403
{- "topic": {
- "created_at": "1970-01-01T00:00:00",
- "datastore_id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "id": "20d7bcf4-f8d6-4bf6-b8f6-46cb440a87f4",
- "name": "Name",
- "partitions": 1,
- "project_id": "123e4567e89b12d3a456426655440000",
- "status": "string",
- "updated_at": "1970-01-01T00:00:00"
}
}