Obtenir le détail d'une opération via API

Une opération est un ticket permettant de suivre l'exécution d'une action effectuée par l'utilisateur en temps réel, notamment l'état grâce au champ status. Il n'est pas possible d'avoir des opérations, des actions concurrentes de modification sur un même cluster. Ces actions doivent se faire séquentiellement.

Prérequis

• Un compte NumSpot.
• Un espace NumSpot auquel le compte est associé.
• Un compte avec le rôle OpenShift Viewer ou OpenShift Admin sur l'espace ou les accès RBAC qui octroient le droit de lecture au cluster dont est issue l'opération.
• Un jeton de connexion associé au compte NumSpot utilisé.

Les données requises

• OPERATION_ID est l'identifiant de l'opération que l'on souhaite consulter.
• SPACE_ID est l'identifiant de l'espace NumSpot dans lequel le cluster cible a été créé.
• REGION est la région dans laquelle l'espace NumSpot a été créé.
• ACCESS_TOKEN est le jeton (token) généré via la connexion (consulter la génération d'un token d'accès).

Exemple de requête: Récupérer les informations d'une opération sur cluster OpenShift

export REGION="myregion"
export SPACE_ID="myspaceid"
export OPERATION_ID="myoperationid"
export ACCESS_TOKEN="myaccesstoken"

curl -X GET  https://api.$REGION.numspot.com/openshift/spaces/$SPACE_ID/operations/$OPERATION_ID \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header 'Content-Type: application/json' 

Exemple de réponse: Récupérer les informations d'une opération sur cluster OpenShift

{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "[OPERATION_ACTION]",
    "status": "PENDING",
    "data": "string",
    "progress": "string",
    "targetLink": "space:8e9cbfeb-573d-4f77-97c2-b7301f38bd2f:cluster:1bff91bc-0172-11ef-9704-da1d4c40a070",
    "createTime": "2024-06-12T16:04:14.267Z",
    "startTime": "2024-06-12T16:04:14.267Z",
    "endTime": "2024-06-12T16:04:14.267Z",
    "result": "string",
    "error": "string"
}

• targetLink est l'identifiant complet du cluster au format: "space:{spaceId}:cluster:{clusterId}.
• startTime est la date à laquelle le statut de l'opération est passé de PENDING à RUNNING.
• endTime est la date à laquelle l'opération s'est terminée, passant du statut RUNNING à DONE ou FAILED.
• error indique la raison de l'erreur si l'opération en statut FAILED.
• type indique l'action effectuée sur le cluster ou nodepool.