banshee/cloud-collection/cloud/scaleway/https/instances

Scaleway instances

Returns the state of each instance of a Scaleway availability zone, read from the Instance API with an API key that may only read. Two watches are offered, each one set on the probe.

Versions

Generic: the Instance API v1, the same for every zone.

How it works

GET https://api.scaleway.com/instance/v1/zones/<scaleway:zone>/servers?page=<n>&per_page=100, the secret key of the API key in the header X-Auth-Token, page after page: a page of fewer than 100 instances is the last.

{"servers": [{"id": "…", "name": "web-1", "state": "running", "state_detail": "booted", "commercial_type": "PRO2-S"}]}

An instance is named by its name; two instances of one name each keep their own, the second carrying its id.
state is running, stopped, stopped in place, starting, stopping or locked, as Scaleway writes it.
The zone 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 instances) stops the collector misconfigured, a code 400 or 404 (the zone 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 instances, the permission set InstancesReadOnly (list and read access to Instances) and nothing else. 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:zone`	Zone	the availability zone: `fr-par-1`, `nl-ams-1`, `pl-waw-1`…	`fr-par-1`

Outputs

Name	Label	Unit	Per instance
`state`	State	—	yes, per instance

Watches

Name	Title	Kind	Defaults	Checked by default
`not-running`	Instance not running	expected value, on `state`	critical when not `running` for 2 runs: a start or a stop in progress does not raise	yes
`missing`	Instance missing	expected instances, on `state`	no name given: it raises nothing until names are set on the probe	no

An instance stopped on purpose is left out by the selection of the probe (Instances: All except test-*).

Limits

One zone per probe; the instances of every project the key may read are listed together.
Not checked against a Scaleway account: Scaleway's own reference pages could not be read from here. The route, its parameters page and per_page (100 at most), the header X-Auth-Token and the address api.scaleway.com are those of Scaleway's public developer pages as search results quote them; the fields and the states are those of Scaleway's Go SDK (scaleway-sdk-go, api/instance/v1: ListServers, Server, ServerState). The permission set InstancesReadOnly is that of Scaleway's list of permission sets, as search results quote it.