Cette page a été traduite par l'API Cloud Translation.

Deployments: stop

Autorisation requise

Arrête une opération en cours. Cette opération n'annule pas le travail déjà effectué, mais empêche le démarrage de tout nouveau travail. Essayer maintenant

Requête

Requête HTTP

POST https://www.googleapis.com/deploymentmanager/v2/projects/project/global/deployments/deployment/stop

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de chemin d'accès
`deployment`	`string`	Nom du déploiement pour cette requête.
`project`	`string`	ID du projet pour cette requête.

Autorisation

Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation

Champ d'application
`https://www.googleapis.com/auth/cloud-platform`
`https://www.googleapis.com/auth/ndev.cloudman`

Corps de la requête

Dans le corps de la requête, indiquez des données en utilisant la structure suivante:

{
  "fingerprint": bytes
}

Nom de propriété	Valeur	Description	Remarques
`fingerprint`	`bytes`	Spécifie une empreinte pour les requêtes `stop()`. Une empreinte est une valeur générée de manière aléatoire qui doit être fournie dans les requêtes `stop()` pour effectuer un verrouillage optimiste. Cela garantit la concurrence optimiste afin que le déploiement ne comporte pas de requêtes en conflit (par exemple, si un utilisateur tente de créer une nouvelle requête de mise à jour alors qu'un autre utilisateur tente d'arrêter une requête de mise à jour en cours, cela évitera toute collision). L'empreinte est initialement générée par Deployment Manager et change après chaque requête de modification d'un déploiement. Pour obtenir la dernière valeur d'empreinte, exécutez une requête `get()` sur le déploiement.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "kind": "deploymentmanager#operation",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": unsigned long,
  "status": string,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string
      }
    ]
  },
  "warnings": [
    {
      "code": string,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string
}

Nom de propriété	Valeur	Description
`kind`	`string`	[Uniquement en sortie] Type de la ressource. Toujours `compute#operation` pour les ressources d'opération.
`id`	`unsigned long`	[Sortie uniquement] Identifiant unique de la ressource. Cet identifiant est défini par le serveur.
`creationTimestamp`	`string`	[Obsolète] Ce champ est obsolète.
`name`	`string`	[Uniquement en sortie] Nom de la ressource.
`zone`	`string`	[Uniquement en sortie] URL de la zone dans laquelle se trouve l'opération. Disponible uniquement lors de l'exécution d'opérations par zone. Vous devez spécifier ce champ dans l'URL de la requête HTTP. Il ne peut pas être défini en tant que champ dans le corps de la requête.
`clientOperationId`	`string`	[Sortie uniquement] Valeur de "requestId" si vous l'avez fournie dans la requête. Sinon, elle n'est pas présente.
`operationType`	`string`	[Uniquement en sortie] Type d'opération, tel que `insert`, `update` ou `delete`, etc.
`targetLink`	`string`	[Uniquement en sortie] URL de la ressource modifiée par l'opération. Pour les opérations liées à la création d'un instantané, il pointe vers le disque persistant à partir duquel l'instantané a été créé.
`targetId`	`unsigned long`	[Sortie uniquement] ID cible unique, qui identifie une incarnation spécifique de la ressource cible.
`status`	`string`	[Sortie uniquement] État de l'opération, qui peut être l'un des suivants: `PENDING`, `RUNNING` ou `DONE`.
`statusMessage`	`string`	[Uniquement en sortie] Description textuelle facultative de l'état actuel de l'opération.
`user`	`string`	[Uniquement en sortie] Utilisateur à l'origine de l'opération, par exemple: `user@example.com`.
`progress`	`integer`	[Uniquement en sortie] Indicateur de progression facultatif compris entre 0 et 100. Il ne doit pas nécessairement être linéaire ou permettre un suivi précis des opérations. Cette valeur ne doit pas être utilisée pour deviner quand l'opération sera terminée. Ce nombre doit augmenter de manière monotone au fur et à mesure de l'opération.
`insertTime`	`string`	[Uniquement en sortie] Heure à laquelle cette opération a été demandée. Cette valeur est au format texte RFC3339.
`startTime`	`string`	[Uniquement en sortie] Heure à laquelle cette opération a été démarrée par le serveur. Cette valeur est au format texte RFC3339.
`endTime`	`string`	[Uniquement en sortie] Heure à laquelle cette opération a été terminée. Cette valeur est au format texte RFC3339.
`error`	`object`	[Sortie uniquement] Si des erreurs sont générées lors du traitement de l'opération, ce champ est renseigné.
`error.errors[]`	`list`	[Uniquement en sortie] Tableau des erreurs rencontrées lors du traitement de cette opération.
`error.errors[].code`	`string`	[Uniquement en sortie] Identifiant du type d'erreur rencontré.
`error.errors[].location`	`string`	[Uniquement en sortie] Indique le champ de la requête à l'origine de l'erreur. Cette propriété est facultative.
`error.errors[].message`	`string`	[Uniquement en sortie] Message d'erreur facultatif qui s'affiche dans un format lisible.
`warnings[]`	`list`	[Uniquement en sortie] Si des messages d'avertissement sont générés lors du traitement de l'opération, ce champ est renseigné.
`warnings[].code`	`string`	[Uniquement en sortie] Code d'avertissement, le cas échéant. Par exemple, Compute Engine renvoie `NO_RESULTS_ON_PAGE` si la réponse ne contient aucun résultat.
`warnings[].message`	`string`	[Sortie uniquement] Description lisible du code d'avertissement.
`warnings[].data[]`	`list`	[Sortie uniquement] Métadonnées sur cet avertissement au format `key: value`. Exemple : "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`warnings[].data[].key`	`string`	[Sortie uniquement] Clé fournissant plus d'informations sur l'avertissement renvoyé. Par exemple, pour les avertissements où aucune zone n'est renvoyée dans une requête de liste, cette clé peut être `scope` et la valeur de la clé peut être le nom de la zone. Il peut s'agir, par exemple, d'une clé indiquant une ressource obsolète et une suggestion de remplacement, ou d'un avertissement concernant des paramètres réseau non valides (par exemple, si une instance tente d'effectuer un transfert d'adresses IP, mais que cette fonctionnalité n'est pas activée).
`warnings[].data[].value`	`string`	[Sortie uniquement] Valeur de données d'avertissement correspondant à la clé.
`httpErrorStatusCode`	`integer`	[Sortie uniquement] Si l'opération échoue, ce champ contient le code d'état d'erreur HTTP renvoyé. Par exemple, un `404` signifie que la ressource n'a pas été trouvée.
`httpErrorMessage`	`string`	[Sortie uniquement] Si l'opération échoue, ce champ contient le message d'erreur HTTP renvoyé, par exemple `NOT FOUND`.
`selfLink`	`string`	[Uniquement en sortie] URL définie par le serveur pour la ressource.
`region`	`string`	[Uniquement en sortie] URL de la région dans laquelle se trouve l'opération. Disponible uniquement lorsque vous effectuez des opérations régionales. Vous devez spécifier ce champ dans l'URL de la requête HTTP. Il ne peut pas être défini en tant que champ dans le corps de la requête.
`description`	`string`	[Uniquement en sortie] Description textuelle de l'opération, qui est définie lors de sa création.

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse. Vous pouvez également essayer l'explorateur autonome.