Add an ACL rule to a Database Instance. Add an additional ACL rule to a Database Instance.
The request AddInstanceACLRulesRequest
A Promise of AddInstanceACLRulesResponse
Add Database Instance advanced settings. Add an advanced setting to a
Database Instance. You must set the name and the value of each
setting.
The request AddInstanceSettingsRequest
A Promise of AddInstanceSettingsResponse
Apply Database Instance maintenance. Apply maintenance tasks to your
Database Instance. This will trigger pending maintenance tasks to start in
your Database Instance and can generate service interruption. Maintenance
tasks can be applied between starts_at and stops_at times, and are run
directly by Scaleway at forced_at timestamp.
The request ApplyInstanceMaintenanceRequest
A Promise of Maintenance
Clone a Database Instance. Clone a given Database Instance, specified by
the region and instance_id parameters. The clone feature allows you to
create a new Database Instance from an existing one. The clone includes all
existing databases, users and permissions. You can create a clone on a
Database Instance bigger than your current one.
The request CloneInstanceRequest
A Promise of Instance
Create a database in a Database Instance. Create a new database. You must
define the name parameter in the request.
The request CreateDatabaseRequest
A Promise of Database
Create a database backup. Create a new backup. You must set the
instance_id, database_name, name and expires_at parameters.
The request CreateDatabaseBackupRequest
A Promise of DatabaseBackup
Create a new Database Instance endpoint. Create a new endpoint for a
Database Instance. You can add load_balancer and private_network
specifications to the body of the request.
The request CreateEndpointRequest
A Promise of Endpoint
Create a Database Instance. Create a new Database Instance. You must set
the engine, user_name, password and node_type parameters.
Optionally, you can specify the volume type and size.
The request CreateInstanceRequest
A Promise of Instance
Create a new Database Instance from a snapshot. Restore a snapshot. When you restore a snapshot, a new Instance is created and billed to your account. Note that is possible to select a larger node type for your new Database Instance. However, the Block volume size will be the same as the size of the restored snapshot. All Instance settings will be restored if you chose a node type with the same or more memory size than the initial Instance. Settings will be reset to the default if your node type has less memory.
The request CreateInstanceFromSnapshotRequest
A Promise of Instance
Create a Read Replica. Create a new Read Replica of a Database Instance.
You must specify the region and the instance_id. You can only create a
maximum of 3 Read Replicas per Database Instance.
The request CreateReadReplicaRequest
A Promise of ReadReplica
Create an endpoint for a Read Replica. Create a new endpoint for a Read Replica. Read Replicas can have at most one direct access and one Private Network endpoint.
The request CreateReadReplicaEndpointRequest
A Promise of ReadReplica
Create a Database Instance snapshot. Create a new snapshot of a Database
Instance. You must define the name parameter in the request.
The request CreateSnapshotRequest
A Promise of Snapshot
Create a user for a Database Instance. Create a new user for a Database
Instance. You must define the name, password and is_admin
parameters.
The request CreateUserRequest
A Promise of User
Delete a database in a Database Instance. Delete a given database on a
Database Instance. You must specify, in the endpoint, the region,
instance_id and name parameters of the database you want to delete.
The request DeleteDatabaseRequest
Delete a database backup. Delete a backup, specified by its database backup ID and region. Deleting a backup is permanent, and cannot be undone.
The request DeleteDatabaseBackupRequest
A Promise of DatabaseBackup
Delete a Database Instance endpoint. Delete the endpoint of a Database
Instance. You must specify the region and endpoint_id parameters of the
endpoint you want to delete. Note that might need to update any environment
configurations that point to the deleted endpoint.
The request DeleteEndpointRequest
Delete a Database Instance. Delete a given Database Instance, specified by
the region and instance_id parameters. Deleting a Database Instance is
permanent, and cannot be undone. Note that upon deletion all your data will
be lost.
The request DeleteInstanceRequest
A Promise of Instance
Delete ACL rules of a Database Instance. Delete one or more ACL rules of a Database Instance.
The request DeleteInstanceACLRulesRequest
A Promise of DeleteInstanceACLRulesResponse
Delete Database Instance advanced settings. Delete an advanced setting in a Database Instance. You must specify the names of the settings you want to delete in the request.
The request DeleteInstanceSettingsRequest
A Promise of DeleteInstanceSettingsResponse
Delete a Read Replica. Delete a Read Replica of a Database Instance. You
must specify the region and read_replica_id parameters of the Read
Replica you want to delete.
The request DeleteReadReplicaRequest
A Promise of ReadReplica
Delete a Database Instance snapshot. Delete a given snapshot of a Database
Instance. You must specify, in the endpoint, the region and snapshot_id
parameters of the snapshot you want to delete.
The request DeleteSnapshotRequest
A Promise of Snapshot
Delete a user on a Database Instance. Delete a given user on a Database
Instance. You must specify, in the endpoint, the region, instance_id
and name parameters of the user you want to delete.
The request DeleteUserRequest
Export a database backup. Export a backup, specified by the
database_backup_id and the region parameters. The download URL is
returned in the response.
The request ExportDatabaseBackupRequest
A Promise of DatabaseBackup
Get a database backup. Retrieve information about a given backup, specified by its database backup ID and region. Full details about the backup, like size, URL and expiration date, are returned in the response.
The request GetDatabaseBackupRequest
A Promise of DatabaseBackup
Get a Database Instance endpoint. Retrieve information about a Database
Instance endpoint. Full details about the endpoint, like ip, port,
private_network and load_balancer specifications are returned in the
response.
The request GetEndpointRequest
A Promise of Endpoint
Get a Database Instance. Retrieve information about a given Database
Instance, specified by the region and instance_id parameters. Its full
details, including name, status, IP address and port, are returned in the
response object.
The request GetInstanceRequest
A Promise of Instance
Get the TLS certificate of a Database Instance. Retrieve information about the TLS certificate of a given Database Instance. Details like name and content are returned in the response.
The request GetInstanceCertificateRequest
A Promise of Blob
Get given logs of a Database Instance. Retrieve information about the logs
of a Database Instance. Specify the instance_log_id and region in your
request to get information such as download_url, status, expires_at
and created_at about your logs in the response.
The request GetInstanceLogRequest
A Promise of InstanceLog
Get Database Instance metrics. Retrieve the time series metrics of a given
Database Instance. You can define the period from which to retrieve metrics
by specifying the start_date and end_date.
The request GetInstanceMetricsRequest
A Promise of InstanceMetrics
Get a Read Replica. Retrieve information about a Database Instance Read
Replica. Full details about the Read Replica, like endpoints, status
and region are returned in the response.
The request GetReadReplicaRequest
A Promise of ReadReplica
Get a Database Instance snapshot. Retrieve information about a given
snapshot, specified by its snapshot_id and region. Full details about
the snapshot, like size and expiration date, are returned in the response.
The request GetSnapshotRequest
A Promise of Snapshot
List database backups. List all backups in a specified region, for a given
Scaleway Organization or Scaleway Project. By default, the backups listed
are ordered by creation date in ascending order. This can be modified via
the order_by field.
The request ListDatabaseBackupsRequest
A Promise of ListDatabaseBackupsResponse
List available database engines. List the PostgreSQL and MySQL database engines available at Scaleway.
The request ListDatabaseEnginesRequest
A Promise of ListDatabaseEnginesResponse
List databases in a Database Instance. List all databases of a given
Database Instance. By default, the databases returned in the list are
ordered by creation date in ascending order, though this can be modified
via the order_by field. You can define additional parameters for your
query, such as name, managed and owner.
The request ListDatabasesRequest
A Promise of ListDatabasesResponse
List ACL rules of a Database Instance. List the ACL rules for a given Database Instance. The response is an array of ACL objects, each one representing an ACL that denies, allows or redirects traffic based on certain conditions.
The request ListInstanceACLRulesRequest
A Promise of ListInstanceACLRulesResponse
List available logs of a Database Instance. List the available logs of a Database Instance. By default, the logs returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
The request ListInstanceLogsRequest
A Promise of ListInstanceLogsResponse
List remote Database Instance logs details. List remote log details. By default, the details returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
The request ListInstanceLogsDetailsRequest
A Promise of ListInstanceLogsDetailsResponse
List Database Instances. List all Database Instances in the specified
region, for a given Scaleway Organization or Scaleway Project. By default,
the Database Instances returned in the list are ordered by creation date in
ascending order, though this can be modified via the order_by field. You
can define additional parameters for your query, such as tags and name.
For the name parameter, the value you include will be checked against the
whole name string to see if it includes the string you put in the
parameter.
The request ListInstancesRequest
A Promise of ListInstancesResponse
List available node types. List all available node types. By default, the
node types returned in the list are ordered by creation date in ascending
order, though this can be modified via the order_by field.
The request ListNodeTypesRequest
A Promise of ListNodeTypesResponse
List user privileges for a database. List privileges of a user on a
database. By default, the details returned in the list are ordered by
creation date in ascending order, though this can be modified via the
order_by field. You can define additional parameters for your query, such
as database_name and user_name.
The request ListPrivilegesRequest
A Promise of ListPrivilegesResponse
List snapshots. List snapshots. You can include the instance_id or
project_id in your query to get the list of snapshots for specific
Database Instances and/or Projects. By default, the details returned in the
list are ordered by creation date in ascending order, though this can be
modified via the order_by field.
The request ListSnapshotsRequest
A Promise of ListSnapshotsResponse
List users of a Database Instance. List all users of a given Database Instance. By default, the users returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field.
The request ListUsersRequest
A Promise of ListUsersResponse
Migrate an existing instance endpoint to another instance.
The request MigrateEndpointRequest
A Promise of Endpoint
Prepare logs of a Database Instance. Prepare your Database Instance logs.
You can define the start_date and end_date parameters for your query.
The download URL is returned in the response. Logs are recorded from 00h00
to 23h59 and then aggregated in a .log file once a day. Therefore, even
if you specify a timeframe from which you want to get the logs, you will
receive logs from the full 24 hours.
The request PrepareInstanceLogsRequest
A Promise of PrepareInstanceLogsResponse
Promote a Read Replica. Promote a Read Replica to Database Instance automatically.
The request PromoteReadReplicaRequest
A Promise of Instance
Purge remote Database Instance logs. Purge a given remote log from a
Database Instance. You can specify the log_name of the log you wish to
clean from your Database Instance.
The request PurgeInstanceLogsRequest
Renew the TLS certificate of a Database Instance. Renew a TLS for a Database Instance. Renewing a certificate means that you will not be able to connect to your Database Instance using the previous certificate. You will also need to download and update the new certificate for all database clients.
The request RenewInstanceCertificateRequest
Resync a Read Replica. When you resync a Read Replica, first it is reset, then its data is resynchronized from the primary node. Your Read Replica remains unavailable during the resync process. The duration of this process is proportional to the size of your Database Instance. The configured endpoints do not change.
The request ResetReadReplicaRequest
A Promise of ReadReplica
Restart Database Instance. Restart a given Database Instance, specified by
the region and instance_id parameters. The status of the Database
Instance returned in the response.
The request RestartInstanceRequest
A Promise of Instance
Restore a database backup. Launch the process of restoring database backup.
You must specify the instance_id of the Database Instance of destination,
where the backup will be restored. Note that large database backups can
take up to several hours to restore.
The request RestoreDatabaseBackupRequest
A Promise of DatabaseBackup
Set ACL rules for a Database Instance. Replace all the ACL rules of a Database Instance.
The request SetInstanceACLRulesRequest
A Promise of SetInstanceACLRulesResponse
Set Database Instance advanced settings. Update an advanced setting for a Database Instance. Settings added upon database engine initalization can only be defined once, and cannot, therefore, be updated.
The request SetInstanceSettingsRequest
A Promise of SetInstanceSettingsResponse
Set user privileges for a database. Set the privileges of a user on a
database. You must define database_name, user_name and permission in
the request body.
The request SetPrivilegeRequest
A Promise of Privilege
Update a database backup. Update the parameters of a backup, including name and expiration date.
The request UpdateDatabaseBackupRequest
A Promise of DatabaseBackup
Update a Database Instance. Update the parameters of a Database Instance, including name, tags and backup schedule details.
The request UpdateInstanceRequest
A Promise of Instance
Update a Database Instance snapshot. Update the parameters of a snapshot of
a Database Instance. You can update the name and expires_at
parameters.
The request UpdateSnapshotRequest
A Promise of Snapshot
Update a user on a Database Instance. Update the parameters of a user on a
Database Instance. You can update the password and is_admin parameters,
but you cannot change the name of the user.
The request UpdateUserRequest
A Promise of User
Upgrade a Database Instance. Upgrade your current Database Instance
specifications like node type, high availability, volume, or the database
engine version. Note that upon upgrade the enable_ha parameter can only
be set to true.
The request UpgradeInstanceRequest
A Promise of Instance
Waits for DatabaseBackup to be in a final state.
The request GetDatabaseBackupRequest
Optionaloptions: Readonly<WaitForOptions<RDB.v1.DatabaseBackup>>The waiting options
A Promise of DatabaseBackup
Waits for Instance to be in a final state.
The request GetInstanceRequest
Optionaloptions: Readonly<WaitForOptions<RDB.v1.Instance>>The waiting options
A Promise of Instance
Waits for InstanceLog to be in a final state.
The request GetInstanceLogRequest
Optionaloptions: Readonly<WaitForOptions<RDB.v1.InstanceLog>>The waiting options
A Promise of InstanceLog
Waits for ReadReplica to be in a final state.
The request GetReadReplicaRequest
Optionaloptions: Readonly<WaitForOptions<RDB.v1.ReadReplica>>The waiting options
A Promise of ReadReplica
Waits for Snapshot to be in a final state.
The request GetSnapshotRequest
Optionaloptions: Readonly<WaitForOptions<RDB.v1.Snapshot>>The waiting options
A Promise of Snapshot
Managed Database for PostgreSQL and MySQL API.
This API allows you to manage your Managed Databases for PostgreSQL and MySQL.