Bereitstellungen: stop

Erfordert Autorisierung

Beendet einen laufenden Vorgang. Dies macht keine Arbeit, die bereits erledigt wurde, rückgängig, sondern verhindert, dass neue Arbeiten begonnen werden.

Anfrage

HTTP-Anfrage

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

Parameter

Parametername Wert Beschreibung
Pfadparameter
deployment string Der Name der Bereitstellung für diese Anfrage.
project string Die Projekt-ID für diese Anfrage.

Autorisierung

Diese Anfrage benötigt eine Autorisierung mit mindestens einem der folgenden Bereiche (weitere Informationen zu Authentifizierung und Autorisierung).

Bereich
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/ndev.cloudman

Anfragetext

Geben Sie im Anfragetext Daten mit der folgenden Struktur ein:

{
  "fingerprint": bytes
}
Property-Name Wert Beschreibung Hinweise
fingerprint bytes Gibt einen Fingerabdruck für stop()-Anfragen an. Ein Fingerabdruck ist ein zufällig erstellter Wert, der in stop()-Anfragen für das optimistische Sperrverfahren angegeben werden muss. Dadurch wird optimistische Gleichzeitigkeitserkennung ermöglicht und die Bereitstellung enthält keine konkurrierenden Anfragen (z. B. wenn jemand versucht, eine neue Aktualisierungsanfrage zu stellen, während ein anderer Benutzer versucht, eine laufende Aktualisierungsanfrage abzubrechen, würde dies eine Kollision verhindern).

Der Fingerabdruck wird zunächst vom Deployment Manager erzeugt und ändert sich nach jeder Anfrage zum Verändern einer Bereitstellung. Führen Sie eine get()-Anfrage mit der Bereitstellung durch, um den letzten Fingerabdruckswert zu erhalten.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "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
}
Property-Name Wert Beschreibung Hinweise
kind string [Nur Ausgabe] Typ der Ressource. Immer compute#operation für Vorgangsressourcen.
id unsigned long [Nur Ausgabe] Die eindeutige Kennung für die Ressource. Diese Kennung wird durch den Server definiert.
creationTimestamp string [Nur Ausgabe] Erstellungszeitstempel im RFC3339-Textformat.
name string [Nur Ausgabe] Name der Ressource.
zone string [Nur Ausgabe] Die URL der Zone, in der sich der Vorgang befindet. Nur verfügbar, wenn Vorgänge pro Zone durchgeführt werden.
clientOperationId string [Nur Ausgabe] Reserviert für zukünftige Verwendungen.
operationType string [Nur Ausgabe] Der Typ des Vorgangs, zum Beispiel insert, update oder delete.
targetId unsigned long [Nur Ausgabe] Die eindeutige Ziel-ID, durch die eine bestimmte Inkarnation der Zielressource identifiziert wird.
status string [Nur Ausgabe] Der Status des Vorgangs, der einer der folgenden sein kann: PENDING, RUNNING oder DONE.
statusMessage string [Nur Ausgabe] Eine optionale Beschreibung des aktuellen Status des Vorgangs.
user string [Nur Ausgabe] Benutzer, von dem der Vorgang angefordert wurde, zum Beispiel: user@example.com.
progress integer [Nur Ausgabe] Eine optionale Fortschrittsanzeige von 0 bis 100. Es gibt keine Voraussetzung, dass dies linear sein oder eine Granularität von Vorgängen unterstützen muss. Dies sollte nicht verwendet werden, um zu erraten, wann der Vorgang abgeschlossen ist. Diese Zahl sollte entsprechend dem Ablauf des Vorgangs kontinuierlich größer werden.
insertTime string [Nur Ausgabe] Der Zeitpunkt, zu dem dieser Vorgang angefordert wurde. Dieser Wert ist im RFC3339-Textformat.
startTime string [Nur Ausgabe] Der Zeitpunkt, zu dem dieser Vorgang durch den Server gestartet wurde. Dieser Wert ist im RFC3339-Textformat.
endTime string [Nur Ausgabe] Der Zeitpunkt, zu dem dieser Vorgang abgeschlossen wurde. Dieser Wert ist im RFC3339-Textformat.
error object [Nur Ausgabe] Wenn während der Verarbeitung des Vorgangs Fehler auftreten, erfolgt in diesem Feld eine Ausgabe.
error.errors[] list [Nur Ausgabe] Die Reihe der Fehler, die erkannt wurden, während dieser Vorgang verarbeitet wird.
error.errors[].code string [Nur Ausgabe] Die Fehlertypkennung für diesen Fehler.
error.errors[].location string [Nur Ausgabe] Gibt das Feld in der Anfrage an, das den Fehler verursacht hat. Diese Eigenschaft ist optional.
error.errors[].message string [Nur Ausgabe] Eine optionale, menschenlesbare Fehlermeldung.
warnings[] list [Nur Ausgabe] Wenn während der Verarbeitung dieses Vorgangs Warnmeldungen angezeigt werden, erfolgt eine Ausgabe in diesem Feld.
warnings[].code string [Nur Ausgabe] Ein Warncode, falls zutreffend. Zum Beispiel gibt Compute Engine NO_RESULTS_ON_PAGE zurück, wenn die Antwort keine Ergebnisse enthält.
warnings[].message string [Nur Ausgabe] Eine menschenlesbare Beschreibung des Warncodes.
warnings[].data[] list [Nur Ausgabe] Metadaten zu dieser Warnung im key: value-Format. Beispiel:

"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warnings[].data[].key string [Nur Ausgabe] Ein Schlüssel, der weitere Details zur zurückgegebenen Warnung enthält. Zum Beispiel für Warnungen, für die keine Ergebnisse in einer Listenanfrage für eine bestimmte Zone vorhanden sind, kann dieser Schlüssel beispielsweise scope und der Schlüsselwert der Zonenname sein. Andere Beispiele sind ein Schlüssel, der auf eine veraltete Ressource und einen Ersetzungsvorschlag verweist, und eine Warnung zu ungültigen Netzwerkeinstellungen (wenn zum Beispiel in einer Instanz versucht wird, IP-Weiterleitung durchzuführen, ohne dass sie für IP-Weiterleitung aktiviert ist).
warnings[].data[].value string [Nur Ausgabe] Ein Warndatenwert entsprechend dem Schlüssel.
httpErrorStatusCode integer [Nur Ausgabe] Wenn der Vorgang fehlschlägt, enthält dieses Feld den zurückgegebenen HTTP-Fehlerstatuscode. Zum Beispiel bedeutet 404, dass die Ressource nicht gefunden wurde.
httpErrorMessage string [Nur Ausgabe] Wenn der Vorgang fehlschlägt, enthält dieses Feld die zurückgegebene HTTP-Fehlermeldung, zum Beispiel NOT FOUND.
region string [Nur Ausgabe] Die URL des Bereichs, in dem sich der Vorgang befindet. Nur verfügbar, wenn regionale Vorgänge durchgeführt werden.
description string [Nur Ausgabe] Eine Textbeschreibung des Vorgangs, die bei der Erstellung des Vorgangs festgelegt wird.