Lister les instances cloud¶
- GET /api/clouds¶
Renvoie une liste des instances clouds connues.
- En-têtes de requête:
Authorization – Les identifiants de l’utilisateur
- Paramètres:
limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)
offset (int) – Le numéro du premier résultat souhaité (défaut: 0)
sort ([name+|name-|type+|type-]) – Le paramètre selon lequel les utilisateurs seront triés (défaut: name+)
- Status Codes:
200 OK – La liste a été renvoyée avec succès
400 Bad Request – Requête invalide
401 Unauthorized – Authentification REST invalide
403 Forbidden – L’utilisateur REST n’a pas le droit d’effectuer cette action
- Objet JSON de réponse:
clouds (array) – La liste des instances cloud demandées
- Tableau d’objets JSON de réponse:
name (string) – Le nom de l’instance cloud.
type (string) – Le type d’instance cloud. Voir la section cloud pour la liste des types d’instance cloud supportés.
key (string) – La clé d’authentification de l’instance cloud (si l’instance cloud requiert une authentification).
options (object) – Les options de connexion à l’instance cloud. Voir la section cloud pour avoir la liste des options disponibles pour le type concerné.
Exemple de requête
GET https://my_waarp_gateway.net/api/clouds?limit=10&sort=name- HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Exemple de réponse
HTTP/1.1 200 OK Content-Type: application/json Content-Length: 397 { "clouds": [{ "name": "ms-azure", "type": "azure", "key": "bar", "options": { "region": "us-east-1" } },{ "name": "aws", "type": "s3", "key": "foo", "options": { "region": "eu-west-1" } }] }