Auf dieser Seite wird beschrieben, wie Sie den Lebenszyklus eines lang andauernden Vorgangs in der Financial Services API verwalten.
Lang andauernde Vorgänge werden zurückgegeben, wenn Methodenaufrufe sehr lange dauern können. Beispielsweise erstellt die Financial Services API bei jedem Aufruf von projects.locations.instances.create einen LRO.
Der LRO verfolgt den Status des Verarbeitungsjobs.
Sie können die von der Financial Services API bereitgestellten projects.locations.operations-Methoden verwenden, um den Status von LROs zu prüfen. Sie können LROs auch auflisten, abbrechen oder löschen.
LROs werden auf Projekt- und Standortebene von Google Cloud verwaltet. Wenn Sie eine Anfrage an die API stellen, geben Sie das Google Cloud-Projekt und den Standort an, an dem der LRO ausgeführt wird.
Die Aufzeichnung eines LRO wird etwa 30 Tage nach dessen Ende aufbewahrt. Danach können Sie LRO nicht mehr anzeigen oder auflisten.
Details zu einem lang andauernden Vorgang abrufen
Angenommen, Sie haben eine Instanz erstellt.
Der Wert name in der Antwort zeigt, dass die Financial Services API einen LRO mit dem Namen projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID erstellt hat.
Prüfen Sie mit der Methode projects.locations.operations.get, ob die Instanz erstellt wurde. Wenn die Antwort "done": false enthält, wiederholen Sie den Befehl, bis die Antwort "done": true enthält.
Dieser Vorgang kann einige Minuten dauern.
Sie können den Namen des LRO auch abrufen, indem Sie lang laufende Vorgänge auflisten.
Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:
PROJECT_ID: Ihre Google Cloud-Projekt-ID, die in den IAM-Einstellungen aufgeführt istLOCATIONist der Standort der Instanz. Verwenden Sie eine der unterstützten Regionen:us-central1us-east1europe-west1europe-west2europe-west4southamerica-east1
OPERATION_ID: die ID für den Vorgang
Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:
Sie sollten in etwa folgende JSON-Antwort erhalten:
{
"name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
"metadata": {
"@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
"createTime": CREATE_TIME,
"endTime": END_TIME,
"target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
"verb": "create",
"requestedCancellation": false,
"apiVersion": "v1"
},
"done": true,
"response": {
"@type": "type.googleapis.com/google.cloud.financialservices.v1.Instance",
"name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
"createTime": CREATE_TIME,
"updateTime": UPDATE_TIME,
"state": "ACTIVE",
"kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID"
}
}
Lange laufende Vorgänge auflisten
Verwenden Sie die Methode projects.locations.operations.list, um alle Vorgänge an einem bestimmten Standort aufzulisten.
Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:
PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt istLOCATION: der Standort der Vorgänge. Verwenden Sie eine der unterstützten Regionen:us-central1us-east1europe-west1europe-west2europe-west4southamerica-east1
Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:
Sie sollten in etwa folgende JSON-Antwort erhalten:
{
"operations": [
{
"name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
"metadata": {
"@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
"createTime": CREATE_TIME,
"endTime": END_TIME,
"target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineConfigs/ENGINE_CONFIG_ID",
"verb": "create",
"requestedCancellation": false,
"apiVersion": "v1"
},
"done": false
},
{
"name": "projects/PROJECT_ID/locations/LOCATION/operations/my-other-operation",
"metadata": {
"@type": "type.googleapis.com/google.cloud.financialservices.v1.OperationMetadata",
"createTime": CREATE_TIME,
"endTime": END_TIME,
"target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
"verb": "create",
"requestedCancellation": false,
"apiVersion": "v1"
},
"done": true,
"response": {
"@type": "type.googleapis.com/google.cloud.financialservices.v1.Instance",
"name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
"createTime": CREATE_TIME,
"updateTime": UPDATE_TIME,
"state": "ACTIVE",
"kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID"
}
}
]
}
Lange laufenden Vorgang abbrechen
Verwenden Sie die Methode projects.locations.operations.cancel, um den asynchronen Abbruch eines lang andauernden Vorgangs zu starten. Der Server unternimmt alles, um den Vorgang abzubrechen, aber der Erfolg wird nicht garantiert.
Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:
PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt istLOCATION: Standort des Vorgangs. Verwenden Sie eine der unterstützten Regionen:us-central1us-east1europe-west1europe-west2europe-west4southamerica-east1
OPERATION_ID: die ID für den Vorgang
Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:
Sie sollten in etwa folgende JSON-Antwort erhalten:
{}
Lange laufenden Vorgang löschen
Verwenden Sie die Methode projects.locations.operations.delete, um einen abgeschlossenen Vorgang mit langer Ausführungszeit zu löschen. Diese Methode zeigt an, dass der Client nicht mehr am Ergebnis des Vorgangs interessiert ist. Der Vorgang wird dadurch nicht abgebrochen.
Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:
PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt istLOCATION: Standort des Vorgangs. Verwenden Sie eine der unterstützten Regionen:us-central1us-east1europe-west1europe-west2europe-west4southamerica-east1
OPERATION_ID: die ID für den Vorgang
Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:
Sie sollten in etwa folgende JSON-Antwort erhalten:
{}