banshee/cloud-collection/cloud/scaleway/https/databases

Scaleway managed databases

Returns the status of each database instance of Managed Databases for PostgreSQL and MySQL in a Scaleway region, read from its API with an API key that may only read. Three watches are offered, each one set on the probe.

Versions

Generic: the API rdb/v1, the same for every region and both engines.

How it works

GET https://api.scaleway.com/rdb/v1/regions/<scaleway:region>/instances?page=<n>&page_size=100, the secret key of the API key in the header X-Auth-Token, page after page: a page of fewer than 100 databases is the last.

{"instances": [{"id": "…", "name": "main-db", "status": "ready", "engine": "PostgreSQL-16", "region": "fr-par"}], "total_count": 3}

A database is named by its name; two of one name each keep their own, the second carrying its id.
status is ready, provisioning, configuring, initializing, deleting, error, autohealing, locked, disk_full, backuping, snapshotting, restarting or unknown, as Scaleway writes it.
The region holds only lower-case letters, digits and hyphens; any other character stops the collector misconfigured before anything leaves.
A code 401 (the key refused) or 403 (the key may not list the databases) stops the collector misconfigured, a code 400 or 404 (the region unknown) too; any other code but 200 stops it unreachable.

The secret key comes from protocol:http:token, a secret variable: it only goes in the header. The answer is not secret.

Prerequisites

An API key of an IAM application whose policy gives it, on the project of the databases, the read-only permission set of Managed Databases for PostgreSQL and MySQL, and nothing else (its exact name is in Scaleway's list of permission sets). Its secret key goes in protocol:http:token; its access key is not used.
The poller reaches api.scaleway.com in HTTPS. Its certificate is issued by a public authority: the profile "Standard" trusts it.

Variables

Name	Label	Says	Default
`scaleway:region`	Region	the region: `fr-par`, `nl-ams` or `pl-waw`	`fr-par`

Outputs

Name	Label	Unit	Per instance
`status`	Status	—	yes, per database

Watches

Name	Title	Kind	Defaults	Checked by default
`down`	Database in error	state to avoid, on `status`	critical on `error`, `disk_full`, `locked`	yes
`not-ready`	Database not ready	expected value, on `status`	warning when neither `ready`, `backuping` nor `snapshotting` for 3 runs: a restart, an autohealing or a change of configuration that lasts	yes
`missing`	Database missing	expected instances, on `status`	no name given: it raises nothing until names are set on the probe	no

Limits

One region per probe; the databases of every project the key may read are listed together. The read replicas and the use of the volume are not read.
Not checked against a Scaleway account: Scaleway's own reference pages could not be read from here. The route, its parameters page and page_size, the fields and the statuses are those of Scaleway's Go SDK (scaleway-sdk-go, api/rdb/v1: ListInstances, Instance, InstanceStatus); the maximum of 100 per page is that of Scaleway's other lists, not checked for this one: a page size refused would stop the collector misconfigured, code 400. The name of the read-only permission set of Managed Databases is not checked.