instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	linode.databases.instances

Fields

The following fields are returned by SELECT queries:

get_databases_instances

Returns a paginated list of all accessible Managed Databases on your account.

Name	Datatype	Description
id	integer	Read-only A unique ID that can be used to identify and reference the Managed Database.
allow_list	array	Controls access to the Managed Database. - Individually included IP addresses or CIDR ranges can access the Managed Database while all other sources are blocked. - A standalone value of 0.0.0.0/0 allows all IP addresses access to the Managed Database. - An empty array ([]) blocks all public and private connections to the Managed Database.
cluster_size	integer	The number of Linode instance nodes deployed to the Managed Database. - Choose 3 nodes to create a high availability cluster that consists of one primary node and two replica nodes. - A 2 node cluster is only available with a dedicated plan. It consists of one primary node and one replica node.
created	string (date-time)	Read-only When this Managed Database was created. (example: 2022-01-01T00:01:01)
encrypted	boolean	Read-only Whether the Managed Databases is encrypted. Currently required to be true.
engine	string	Filterable, Read-only The Managed Database engine type. (example: mysql)
fork	object	Details on the database that was the target of the fork. This only exists if the database was restored by creating a fork from another MySQL or PostgreSQL database.
hosts	object	Read-only The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.
instance_uri	string	Read-only Append this to https://api.linode.com to run commands for the Managed Database. (example: /v4/databases/mysql/instances/123)
label	string	Filterable A unique, user-defined string referring to the Managed Database. This string needs to be unique per Managed Database engine type. (example: example-db)
members	object	Read-only A mapping between IP addresses and strings designating them as primary or failover.
oldest_restore_time	string (date-time)	Read-only The oldest time to which a database can be restored. (example: 2024-10-03 20:48:05)
platform	string	Filterable, Read-only The back-end platform for relational databases used by the service. (example: rdbms-default)
port	integer	Read-only The access port for this Managed Database.
region	string	Filterable The Region ID for the Managed Database. (example: us-east)
status	string	Filterable, Read-only The operating status of the Managed Database. (example: active)
total_disk_size_gb	integer	Read-only The total disk size of the database, in GB.
type	string	Filterable The Linode Instance type used by the Managed Database for its nodes. (example: g6-dedicated-2)
updated	string (date-time)	Read-only When this Managed Database was last updated. (example: 2022-01-01T00:01:01)
updates	object	Configuration settings for automated patch update maintenance for the Managed Database.
used_disk_size_gb	integer	Read-only The amount of space currently in use in the database, in GB.
version	string	Filterable The Managed Database engine version. (example: 8.0.26)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_databases_instances	select		page, page_size	Display all Managed Databases accessible to your user, regardless of engine type. For more detailed information on a particular database instance, make a request to its instance_uri. Learn more... Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get_databases_instances

Display all Managed Databases accessible to your user, regardless of engine type. For more detailed information on a particular database instance, make a request to its instance_uri.

Learn more...

Learn more...

SELECT
id,
allow_list,
cluster_size,
created,
encrypted,
engine,
fork,
hosts,
instance_uri,
label,
members,
oldest_restore_time,
platform,
port,
region,
status,
total_disk_size_gb,
type,
updated,
updates,
used_disk_size_gb,
version
FROM linode.databases.instances
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';