Instanzen erstellen und verwalten

Auf dieser Seite erfahren Sie, wie Sie AML AI-Instanzen erstellen und verwalten. Sie können sie als Kurzanleitung verwenden.

Hinweise

Instanz erstellen

Einige API-Methoden geben einen Vorgang mit langer Ausführungszeit zurück. Diese Methoden sind asynchron. Der Vorgang ist möglicherweise nicht abgeschlossen, wenn die Methode eine Antwort zurückgibt. Senden Sie bei diesen Methoden die Anfrage und prüfen Sie dann das Ergebnis.

Anfrage senden

Verwenden Sie zum Erstellen einer Instanz die Methode projects.locations.instances.create.

Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:

  • PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt ist
  • LOCATION: der Speicherort des Schlüsselbunds und der Instanz. Verwenden Sie eine der unterstützten Regionen:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: eine benutzerdefinierte Kennung für die Instanz
  • KMS_PROJECT_ID: die Google Cloud-Projekt-ID für das Projekt, das den Schlüsselbund enthält
  • KEY_RING_ID: die benutzerdefinierte Kennung für den Schlüsselbund
  • KEY_ID ist die benutzerdefinierte Kennung für den Schlüssel.

JSON-Text anfordern:

{
  "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID"
}

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,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Ergebnis prüfen

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.

Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:

  • PROJECT_ID: Ihre Google Cloud-Projekt-ID, die in den IAM-Einstellungen aufgeführt ist
  • LOCATION ist der Standort der Instanz. Verwenden Sie eine der unterstützten Regionen:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-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"
  }
}

Instanz abrufen

Verwenden Sie die Methode projects.locations.instances.get, um eine Instanz abzurufen.

Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:

  • PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt ist
  • LOCATION ist der Standort der Instanz. Verwenden Sie eine der unterstützten Regionen:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: die benutzerdefinierte Kennung für die Instanz

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/instances/INSTANCE_ID",
  "createTime": CREATE_TIME,
  "updateTime": UPDATE_TIME,
  "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID",
  "state": "ACTIVE"
}

Instanz aktualisieren

Verwenden Sie die Methode projects.locations.instances.patch, um eine Instanz zu aktualisieren.

Nicht alle Felder in einer Instanz können aktualisiert werden. Im folgenden Beispiel wird das Schlüssel/Wert-Paar Nutzerlabels aktualisiert, das der Instanz zugeordnet ist.

Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:

  • PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt ist
  • LOCATION ist der Standort der Instanz. Verwenden Sie eine der unterstützten Regionen:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: die benutzerdefinierte Kennung für die Instanz
  • KEY: Schlüssel in einem Schlüssel/Wert-Paar zum Organisieren von Instanzen. Weitere Informationen finden Sie unter labels.
  • VALUE: Wert in einem Schlüssel/Wert-Paar zum Organisieren von Instanzen. Weitere Informationen finden Sie unter labels.

JSON-Text anfordern:

{
  "labels": {
    "KEY": "VALUE"
  }
}

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,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "update",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Weitere Informationen zum Abrufen des Ergebnisses des Vorgangs mit langer Ausführungszeit finden Sie unter Ergebnis prüfen.

Instanzen auflisten

Mit der Methode projects.locations.instances.list können Sie die Instanzen für eine bestimmte Instanz auflisten.

Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:

  • PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt ist
  • LOCATION ist der Standort der Instanzen. Verwenden Sie eine der unterstützten Regionen:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten in etwa folgende JSON-Antwort erhalten:

{
  "instances": [
    {
      "name": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
      "createTime": CREATE_TIME,
      "updateTime": UPDATE_TIME,
      "kmsKey": "projects/KMS_PROJECT_ID/locations/LOCATION/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID",
      "state": "ACTIVE"
    }
  ]
}

Registrierte Parteien importieren

Bereiten Sie zum Importieren registrierter Parteien zuerst eine BigQuery-Tabelle für den Geschäftsbereich vor, für den Sie Parteien registrieren möchten. Weitere Informationen finden Sie unter Kunden registrieren. Verwenden Sie eines der folgenden Schemas:

  • Schema für Einzelhandelsparteien

    SpalteTypBeschreibung
    party_idSTRINGEindeutige Kennung der Partei in den Datasets der Instanz
    party_sizeSTRINGNULL; der Inhalt wird bei Registrierungen von Einzelhandelsparten ignoriert

  • Schema für kommerzielle Parteien

    SpalteTypBeschreibung
    party_idSTRINGEindeutige Kennung der Partei in den Datasets der Instanz
    party_sizeSTRING Angeforderte Gruppengröße. Die Stufe basiert auf der durchschnittlichen Anzahl monatlicher Transaktionen für die Partei in den letzten 365 Tagen:
    • SMALL für kleine kommerzielle Parteien mit weniger als 500 durchschnittlichen monatlichen Transaktionen
    • LARGE für große kommerzielle Parteien mit mindestens 500 monatlichen Transaktionen

    Bei allen Werten wird die Groß-/Kleinschreibung beachtet.

Verwenden Sie die Methode projects.locations.instances.importRegisteredParties, um registrierte Parteien zu importieren.

Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:

  • PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt ist
  • LOCATION ist der Standort der Instanz. Verwenden Sie eine der unterstützten Regionen:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: die benutzerdefinierte Kennung für die Instanz
  • BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME: ein BigQuery-Dataset, das eine Tabelle enthält, in der die registrierten Parteien beschrieben werden
  • REGISTERED_PARTIES_TABLE: die Tabelle mit den registrierten Parteien
  • UPDATE_MODE: Verwenden Sie REPLACE, um Parteien, die in der Tabelle der registrierten Parteien entfernt werden können, durch neue Parteien zu ersetzen, oder fügen Sie der Tabelle der registrierten Parteien mithilfe von APPEND neue Parteien hinzu
  • LINE_OF_BUSINESS: Dieses Feld muss mit dem Wert lineOfBusiness in der Engine-Version übereinstimmen, die von der Engine-Konfiguration verwendet wird. Verwenden Sie COMMERCIAL für Geschäftskunden (juristische und natürliche Personen) oder RETAIL für Privatkundenkunden.

JSON-Text anfordern:

{
  "partyTables": [
     "bq://PROJECT_ID.BQ_INPUT_REGISTERED_PARTIES_DATASET_NAME.REGISTERED_PARTIES_TABLE"
  ],
  "mode": "UPDATE_MODE",
  "lineOfBusiness": "LINE_OF_BUSINESS"
}

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,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "importRegisteredParties",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Weitere Informationen zum Abrufen des Ergebnisses des Vorgangs mit langer Ausführungszeit finden Sie unter Ergebnis prüfen.

Wenn der Vorgang abgeschlossen ist, gibt die Antwort die Anzahl der Parteien an, die durch den Vorgang hinzugefügt, entfernt oder aktualisiert wurden.

AntwortfeldTypBeschreibung
partiesAddedinteger Anzahl der durch diesen Vorgang hinzugefügten Parteien
partiesRemovedinteger Anzahl der durch diesen Vorgang entfernten Parteien
partiesTotalinteger Gesamtzahl der Parteien, die in dieser Instanz registriert sind, nachdem der Aktualisierungsvorgang abgeschlossen wurde
partiesFailedToRemoveinteger Anzahl der Parteien, die durch diesen Vorgang nicht entfernt werden konnten

Registrierte Parteien exportieren

Verwenden Sie die Methode projects.locations.instances.exportRegisteredParties, um registrierte Parteien zu exportieren.

Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:

  • PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt ist
  • LOCATION ist der Standort der Instanz. Verwenden Sie eine der unterstützten Regionen:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: die benutzerdefinierte Kennung für die Instanz
  • BQ_OUTPUT_DATASET_NAME: ein BigQuery-Dataset, in das eine Tabelle exportiert werden soll, die die registrierten Parteien beschreibt
  • REGISTERED_PARTIES_TABLE: Tabelle, in die die registrierten Parteien geschrieben werden sollen
  • WRITE_DISPOSITION: Die Aktion, die ausgeführt wird, wenn die Zieltabelle bereits vorhanden ist. Verwenden Sie einen der folgenden Werte:
    • WRITE_EMPTY: Nur Daten exportieren, wenn die Zieltabelle leer ist.
    • WRITE_TRUNCATE: Alle vorhandenen Daten in der BigQuery-Tabelle werden gelöscht, bevor in die Tabelle geschrieben wird.
  • LINE_OF_BUSINESS: Verwenden Sie COMMERCIAL für Geschäftskunden (juristische und natürliche Einrichtungen) oder RETAIL für Privatkundenkunden

JSON-Text anfordern:

{
  "dataset": {
    "tableUri": "bq://PROJECT_ID.BQ_OUTPUT_DATASET_NAME.REGISTERED_PARTIES_TABLE",
    "writeDisposition": "WRITE_DISPOSITION"
  },
  "lineOfBusiness": "LINE_OF_BUSINESS"
}

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,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "exportRegisteredParties",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Weitere Informationen zum Abrufen des Ergebnisses des Vorgangs mit langer Ausführungszeit finden Sie unter Ergebnis prüfen.

Diese Methode gibt eine BigQuery-Tabelle mit dem folgenden Schema aus:

SpalteTypBeschreibung
party_idSTRINGEindeutige Kennung der Partei in den Datasets der Instanz
party_sizeSTRING Gibt die Stufe für Geschäftskunden an (groß oder klein). Dieses Feld gilt nicht für Einzelhandelskunden.
  • NULL für alle Einzelhandelskunden
  • SMALL für kleine kommerzielle Parteien mit weniger als 500 durchschnittlichen monatlichen Transaktionen
  • LARGE für große kommerzielle Parteien mit mindestens 500 monatlichen Transaktionen

Bei allen Werten wird die Groß-/Kleinschreibung beachtet.

earliest_remove_timeSTRINGDer früheste Zeitpunkt, zu dem die Partei entfernt werden kann

Weitere Informationen finden Sie unter Kunden registrieren.

Instanz löschen

Verwenden Sie zum Löschen einer Instanz die Methode projects.locations.instances.delete.

Bevor Sie die Anfragedaten verwenden, ersetzen Sie die folgenden Werte:

  • PROJECT_ID: Ihre Google Cloud-Projekt-ID, die unter IAM-Einstellungen aufgeführt ist
  • LOCATION ist der Standort der Instanz. Verwenden Sie eine der unterstützten Regionen:
    • us-central1
    • us-east1
    • europe-west1
    • europe-west2
    • europe-west4
    • southamerica-east1
  • INSTANCE_ID: die benutzerdefinierte Kennung für die Instanz

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,
    "target": "projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID",
    "verb": "delete",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Weitere Informationen zum Abrufen des Ergebnisses des Vorgangs mit langer Ausführungszeit finden Sie unter Ergebnis prüfen.