Manuels d'intégration › Manuel de référence de l'API de service Web › Objets valides › objet comp › Méthode stop (objet comp)

Méthode stop (objet comp)

Description

Arrête un composant.

Syntaxe

/api/v2/comp/stop?app=application&comp=composant&vdc=nom_contrôleur 

Arguments

app

Nom de l'application

comp

Nom du composant

vdc

Nom du centre de données virtuel cible

Type de transaction

Asynchrone

Type de requête

GET

Exemples

Pour arrêter le composant main.LUX5 de l'application test :

GET http://192.168.123.200/api/v2/comp/stop?app=test&comp=main.LUX5&vdc=mygrid 

Exemple de sortie

XML

<job>be805915-76b2-48c8-b8a0-b881cca66da6</job>

JSON

{
   "job" : "be805915-76b2-48c8-b8a0-b881cca66da6"
} 

Codes d'erreur HTTP

404

L'entité vdc mygrid est introuvable - Le nom de VDC spécifié n'est pas configuré dans l'application WS_API.

400.4

Missing required arguments (app). - La requête ne contient pas l'argument app=application.

400.4

Missing required arguments (comp). - La requête ne contient pas l'argument comp=composant.

Remarque : Pour obtenir le statut du job, exécutez une requête /api/v2/job/info? avec comme argument le job_id renvoyé plus haut. Pour plus d'informations sur la manière d'obtenir le statut du job, reportez-vous à l'objet job.