Vue d’ensemble

Ultipa Cloud API vous permet d'opérer vos instances Ultipa Cloud sans avoir besoin de vous connecter à Ultipa Cloud.

API

URL de Base

L'URL de base de l'Ultipa Cloud API est https://cloud.ultipa.com/open/dbaas/v1/instance.

Clés API

Dans Accounts, faites défiler vers le bas jusqu'aux Clés API pour créer ou gérer vos clés API.

Une clé API doit être incluse dans chaque en-tête de requête, avec le nom de la clé comme api_key.

Limite de Requêtes

La limite de requêtes API est fixée à 80 requêtes par minute.

Requêtes

Lister les Instances

Requête HTTP

Pour lister les instances, soumettez une requête GET au point de terminaison suivant :

https://cloud.ultipa.com/open/dbaas/v1/instance/list

En-tête de Requête

Paramètres de Requête

Exemple de requête GET avec paramètres :

https://cloud.ultipa.com/open/dbaas/v1/instance/list?instanceStateFilter=2&search=ultipa-abc123&page=1&size=1

Exemple de Corps de Réponse

{
    "code": 200,
    "message": "success",
    "data": {
        "page": 1,
        "size": 2,
        "totalPages": 1,
        "totalElements": 2,
        "list": [
            {
                "instanceId": "ultipa-abc123",
                "instanceState": "STOPPED",
                "name": "Community"
            },
            {
                "instanceId": "ultipa-abc456",
                "instanceState": "RUNNING",
                "name": "Course Lab"
            }
        ]
    }
}

Voir l'État de l'Instance

Requête HTTP

Pour voir l'état des instances, soumettez une requête POST au point de terminaison suivant :

https://cloud.ultipa.com/open/dbaas/v1/instance/state

En-tête de Requête

Corps de la Requête

{
    "instanceIds": ["ultipa-abc123", "ultipa-abc456"]
}

Exemple de Corps de Réponse

{
    "code": 200,
    "message": "success",
    "data": [
        {
            "instanceId": "ultipa-abc123",
            "instanceState": "RUNNING",
            "name": "Course Lab"
        },
        {
            "instanceId": "ultipa-abc456",
            "instanceState": "STOPPED",
            "name": "Community"
        }
    ]
}

Démarrer une Instance

Requête HTTP

Pour démarrer une instance, soumettez une requête POST au point de terminaison suivant :

https://cloud.ultipa.com/open/dbaas/v1/instance/start

En-tête de Requête

Corps de la Requête

{
    "instanceId": "ultipa-abc123"
}

Corps de Réponse

{
    "code": 200,
    "message": "success",
    "data": null
}

Arrêter une Instance

Requête HTTP

Pour arrêter une instance, soumettez une requête POST au point de terminaison suivant :

https://cloud.ultipa.com/open/dbaas/v1/instance/stop

En-tête de Requête

Corps de la Requête

{
    "instanceId": "ultipa-abc123"
}

Corps de Réponse

{
    "code": 200,
    "message": "success",
    "data": null
}

Codes d'Erreur de Réponse