Änderungsanfragen mit Governance-Workflows verwalten

In diesem Dokument wird beschrieben, wie Antragsteller, Genehmiger und Workflow-Administratoren Governance-Anfragen in Knowledge Catalog (ehemals Dataplex Universal Catalog) verwalten.

Hinweis

Wenn Sie Governance-Workflows verwenden möchten, müssen Sie die erforderlichen APIs aktivieren und Genehmigende und Administratoren müssen die erforderlichen IAM-Rollen (Identity and Access Management) und ‑Berechtigungen haben.

Aktivieren Sie die Dataplex API, falls sie noch nicht aktiviert ist.

Rollen, die zum Aktivieren von APIs erforderlich sind

Zum Aktivieren von APIs benötigen Sie die Berechtigung serviceusage.services.enable. Wenn Sie das Projekt erstellt haben, haben Sie diese Berechtigung wahrscheinlich bereits über die Inhaberrolle (roles/owner). Andernfalls können Sie diese Berechtigung über die Rolle „Service Usage-Administrator“ (roles/serviceusage.serviceUsageAdmin) erhalten. Informationen zum Zuweisen von Rollen

API aktivieren

Erforderliche Rollen

Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für das Projekt zuzuweisen, damit Sie die nötigen Berechtigungen für die Verwaltung von Governance-Anfragen haben:

Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Weitere Informationen zu Rollen und Berechtigungen finden Sie unter IAM-Rollen für Knowledge Catalog.

Anfragen als Antragsteller verwalten

Als Antragsteller initiieren Sie Änderungsanfragen, z. B. den Zugriff auf Datenprodukte oder das Vorschlagen von Metadatenänderungen. Nachdem Sie eine Anfrage gesendet haben, können Sie den Fortschritt überwachen, die Anfragedetails aufrufen, Details für ausstehende Anfragen bearbeiten oder Anfragen im Status NEW löschen, bevor ein Genehmiger darauf reagiert.

Erstellte Anfragen ansehen

So rufen Sie die von Ihnen erstellten Anfragen auf oder prüfen eine bestimmte Anfrage:

Console

  1. Rufen Sie in der Google Cloud Console die Seite Governance-Workflows des Knowledge Catalog auf.

    Zu „Governance-Workflows“

  2. Klicken Sie auf den Tab Meine Anfragen, um eine Liste Ihrer früheren und ausstehenden Anfragen aufzurufen.

REST

Verwenden Sie die Methode changeRequests.list, um von Ihnen erstellte Anfragen aufzulisten:

curl -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests?filter=author=USER_EMAIL"

Wenn Sie eine bestimmte Anfrage aufrufen möchten, verwenden Sie die Methode changeRequests.get:

curl -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID"

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID IhresGoogle Cloud -Projekts.
  • LOCATION: die Region, in der sich die Ressource befindet, z. B. us-central1.
  • USER_EMAIL: Ihre E-Mail-Adresse.
  • CHANGE_REQUEST_ID: die eindeutige ID der Anfrage.

Prüfen Sie bei Batchanfragen zur Metadatenänderung die Antwortfelder, um festzustellen, wie die Anfrage erstellt wurde:

  • Vom Nutzer gesendete Anfrage: author ist die E-Mail-Adresse des Anfragenden und batchChangeMetadataRequest.description.job ist nicht festgelegt.
  • Vom Anreicherungs-Agent generierte Anfrage: author ist das Dienstkonto des Anreicherungs-Agents und batchChangeMetadataRequest.description.job.name ist auf die ID der Anreicherungsausführung festgelegt.

Anfrage bearbeiten

Sie können eine ausstehende Anfrage mit der REST API aktualisieren, während sie den Status NEW oder FAILED hat. Wenn Sie eine Anfrage im Status FAILED aktualisieren, wird ihr Status auf NEW zurückgesetzt, damit ein Genehmiger sie noch einmal prüfen kann. Wer eine Änderungsanfrage für Metadaten bearbeiten kann, hängt davon ab, wie sie erstellt wurde:

  • Von Nutzern gesendete Anfragen: Nur der ursprüngliche Autor kann eine PATCH-Anfrage senden, um die Begründung oder die Nutzlast der Anfrage zu aktualisieren.
  • Von Anreicherungs-Agents generierte Anfragen: Neben dem Autor können auch Prüfer und Genehmiger eine PATCH-Anfrage senden, während sich die Anfrage im Status NEW oder FAILED befindet, um den Batch zu kuratieren, z. B. um vorgeschlagene Aspektwerte zu ändern oder Elemente aus dem changes-Array zu entfernen. Das Feld author bleibt das Dienstkonto des Anreicherungs-Agents.

Verwenden Sie die Methode changeRequests.patch, um eine ausstehende Änderungsanfrage zu aktualisieren.

Wenn Sie nur die Begründung der Anfrage aktualisieren möchten, senden Sie die folgende PATCH-Anfrage:

curl -X PATCH \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{
    "justification": "NEW_JUSTIFICATION"
  }' \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID?updateMask=justification"

Senden Sie die folgende PATCH-Anfrage, um die Nutzlast einer Anfrage zur Änderung von Batch-Metadaten zu aktualisieren:

curl -X PATCH \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{
    "justification": "NEW_JUSTIFICATION",
    "batchChangeMetadataRequest": {
      "name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID",
      "changes": [
        {
          "updateEntryRequest": {
            "entry": {
              "name": "projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID/entries/EXISTING_ENTRY_ID",
              "aspects": {
                "ASPECT_PROJECT_ID.ASPECT_LOCATION.ASPECT_TYPE_ID": {
                  "data": {
                    "ASPECT_FIELD_NAME": "UPDATED_ASPECT_FIELD_VALUE"
                  }
                }
              }
            },
            "updateMask": "aspects",
            "aspectKeys": [
              "ASPECT_PROJECT_ID.ASPECT_LOCATION.ASPECT_TYPE_ID"
            ]
          }
        }
      ]
    }
  }' \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID?updateMask=batchChangeMetadataRequest.changes,justification"

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID IhresGoogle Cloud -Projekts.
  • LOCATION: die Region, in der die Änderungsanfrage vorhanden ist, z. B. us-central1.
  • CHANGE_REQUEST_ID: die eindeutige ID der Änderungsanfrage.
  • NEW_JUSTIFICATION: die aktualisierte Begründung für die Änderungsanfrage.
  • ENTRY_GROUP_ID: die ID der Ziel-Eintragsgruppe.
  • EXISTING_ENTRY_ID: die ID des Eintrags in der aktualisierten Batch-Nutzlast.
  • ASPECT_PROJECT_ID: die ID des Projekts, das den Aspekttyp enthält.
  • ASPECT_LOCATION: der Standort des Aspekttyps, z. B. us-central1 oder global.
  • ASPECT_TYPE_ID: die ID des zu aktualisierenden Aspekttyps.
  • ASPECT_FIELD_NAME: der Name des zu aktualisierenden Aspektfelds.
  • UPDATED_ASPECT_FIELD_VALUE: der aktualisierte Wert für das Aspektfeld.

Anfrage löschen

Als Antragsteller können Sie nur Anfragen mit dem Status NEW löschen. So löschen Sie eine Anfrage:

Console

  1. Rufen Sie in der Google Cloud Console die Seite Governance-Workflows des Knowledge Catalog auf.

    Zu „Governance-Workflows“

  2. Klicken Sie auf den Tab Meine Anfragen.

  3. Suchen Sie die Zeile mit der Anfrage, die Sie löschen möchten. Wenden Sie bei Bedarf einen Filter an, um den Eintrag zu isolieren.

  4. Klicken Sie auf Aktionen und dann auf Löschen.

REST

Verwenden Sie zum Löschen einer Anfrage die Methode changeRequests.delete.

Senden Sie beispielsweise die folgende DELETE-Anfrage:

curl -X DELETE \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID"

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID IhresGoogle Cloud -Projekts.
  • LOCATION: die Region, in der sich die Ressource befindet, z. B. us-central1.
  • CHANGE_REQUEST_ID: die eindeutige ID der Anfrage, die Sie löschen möchten.

Anfragen als Genehmiger verwalten

Als Genehmiger bewerten Sie ausstehende Anfragen, die für Ihre Datenressourcen eingereicht wurden, und reagieren darauf.

Benachrichtigungen

Wenn Sie eine Anfrage genehmigen oder ablehnen, verarbeitet Knowledge Catalog die Entscheidung und sendet eine E‑Mail-Benachrichtigung mit Ihrem Kommentar an den Anfragenden. Bei Batchanfragen sendet Knowledge Catalog die E-Mail-Benachrichtigung, nachdem der Aktualisierungsvorgang abgeschlossen ist. Wenn der Autor ein Dienstkonto ist, sendet Knowledge Catalog keine Benachrichtigung.

Überlegungen zur Genehmigung

Sie können Ihre eigene Anfrage nicht genehmigen. Der Genehmiger muss ein anderes Hauptkonto sein und alle Schreib- und Typnutzungsberechtigungen haben, die für die vorgeschlagenen Änderungen erforderlich sind. Ein Anreicherungs-Agent kann seine eigenen Anfragen jedoch entweder basierend auf der Konfidenz automatisch genehmigen oder sie zur Überprüfung an einen Genehmiger senden. Bei Batch-Anfragen zur Metadatenänderung, die von einem Anreicherungs-Agenten generiert wurden, können Sie die Nutzlast der Anfrage bearbeiten, während sich die Anfrage im Status NEW oder FAILED befindet, bevor Sie sie genehmigen.

Ausstehende Anforderungen anzeigen

So rufen Sie Anfragen auf, die noch überprüft werden müssen:

Console

  1. Rufen Sie in der Google Cloud Console die Seite Governance-Workflows des Knowledge Catalog auf.

    Zu „Governance-Workflows“

  2. Klicken Sie auf den Tab Ausstehende Genehmigungen, um Anfragen zu sehen, die noch überprüft werden müssen. Sie können Anfragen nach Ressourcentyp, Anfragetyp oder Datum filtern.

REST

Verwenden Sie die Methode changeRequests.list, um Anfragen aufzulisten, die in einem bestimmten Projekt und an einem bestimmten Standort auf eine Überprüfung warten.

Senden Sie beispielsweise die folgende GET-Anfrage:

curl -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests?filter=state=NEW"

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID IhresGoogle Cloud -Projekts.
  • LOCATION: die Region, in der sich die Ressource befindet, z. B. us-central1.

In der zurückgegebenen Liste ist das Feld changeType für Batch-Anfragen zur Metadatenänderung auf BATCH_CHANGE_METADATA gesetzt. Anfragen, die von einem Anreicherungs-Agenten erstellt wurden, enthalten die ID des Anreicherungslaufs in batchChangeMetadataRequest.description.job.name.

Beispielantwort für eine ausstehende Batchänderungsanfrage

{
"changeRequests": [
  {
    "name": "projects/my-project/locations/us-central1/changeRequests/b326114f-472b-457d-81e8-98b8ad89c608",
    "uid": "b326114f-472b-457d-81e8-98b8ad89c608",
    "justification": "Enrichment Agent Proposal: Batch Metadata Change",
    "author": "enrichment-agent@my-project.iam.gserviceaccount.com",
    "state": "NEW",
    "resource": "//dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-entry-group",
    "changeType": "BATCH_CHANGE_METADATA",
    "batchChangeMetadataRequest": {
      "name": "projects/my-project/locations/us-central1/entryGroups/my-entry-group",
      "description": {
        "job": {
          "name": "projects/123456789012/locations/us-central1/enrichmentTasks/my-enrichment-task/runs/55199e83-1a1e-4837-bb8c-c402c6bee641"
        }
      },
      "changes": [
        {
          "createEntryRequest": {
            "parent": "projects/my-project/locations/us-central1/entryGroups/my-entry-group",
            "entryId": "new-entry-id",
            "entry": {
              "entryType": "projects/my-project/locations/us-central1/entryTypes/my-entry-type"
            }
          }
        }
      ]
    }
  }
]
}

Anfrage genehmigen

So genehmigen Sie eine Anfrage:

Console

  1. Rufen Sie in der Google Cloud Console die Seite Governance-Workflows des Knowledge Catalog auf.

    Zu „Governance-Workflows“

  2. Klicken Sie auf den Tab Ausstehende Genehmigungen.

  3. Suchen Sie die Zeile mit der Anfrage, die Sie genehmigen möchten.

  4. Klicken Sie auf Aktionen und dann auf Genehmigen.

REST

Verwenden Sie die Methode changeRequests.approve, um eine Anfrage zu genehmigen.

Senden Sie beispielsweise die folgende POST-Anfrage:

curl -X POST \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID:approve"

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID IhresGoogle Cloud -Projekts.
  • LOCATION: die Region, in der sich die Ressource befindet, z. B. us-central1.
  • CHANGE_REQUEST_ID: die eindeutige ID der Änderungsanfrage, die Sie genehmigen möchten.

Wenn Sie eine Anfrage zur Batch-Metadatenänderung genehmigen, die von einem Nutzer oder einem Anreicherungs-Agenten eingereicht wurde, validiert Knowledge Catalog Ihre IAM-Berechtigungen und Nutzlastregeln synchron:

  • Wenn die Validierung erfolgreich ist, gibt die Methode den ChangeRequest im Status APPLYING zurück, während Knowledge Catalog den Batch im Hintergrund ausführt:
  {
    "name": "projects/my-project/locations/us-central1/changeRequests/b326114f-472b-457d-81e8-98b8ad89c608",
    "uid": "b326114f-472b-457d-81e8-98b8ad89c608",
    "justification": "Proposing new entry using RequestBatchMetadataChange",
    "author": "requester@example.com",
    "state": "APPLYING",
    "resource": "//dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-entry-group",
    "approver": "approver@example.com",
    "changeType": "BATCH_CHANGE_METADATA",
    "batchChangeMetadataRequest": {
      "name": "projects/my-project/locations/us-central1/entryGroups/my-entry-group",
      "changes": [
        {
          "createEntryRequest": {
            "parent": "projects/my-project/locations/us-central1/entryGroups/my-entry-group",
            "entryId": "new-entry-id",
            "entry": {
              "entryType": "projects/my-project/locations/us-central1/entryTypes/my-entry-type"
            }
          }
        }
      ]
    }
  }
  ```

* If synchronous payload validation fails (for example, with an
`INVALID_ARGUMENT` or `NOT_FOUND` error), the request immediately
transitions to the `FAILED` state instead of `APPLYING`.
* If permission validation fails with a `PERMISSION_DENIED` error, the request
remains in the `NEW` state.

After background execution finishes, poll `changeRequests.get` to check the
final state (`APPROVED` or `FAILED`). If any changes in the batch fail,
`batchChangeMetadataResponse.failedRequests` lists each failed change by its
position in `changes` (starting at `0`) along with the error details:

```json
{
  "name": "projects/my-project/locations/us-central1/changeRequests/b326114f-472b-457d-81e8-98b8ad89c608",
  "state": "APPROVED",
  "changeType": "BATCH_CHANGE_METADATA",
  "batchChangeMetadataResponse": {
    "failedRequests": {
      "1": {
        "code": 5,
        "message": "Entry not found."
      }
    }
  }
}

Weitere Informationen zu Anfragestatus finden Sie unter Verarbeitungspfad für Governance-Workflows.

Anfrage ablehnen

So lehnen Sie eine Anfrage ab:

Console

  1. Rufen Sie in der Google Cloud Console die Seite Governance-Workflows des Knowledge Catalog auf.

    Zu „Governance-Workflows“

  2. Klicken Sie auf den Tab Ausstehende Genehmigungen.

  3. Suchen Sie die Zeile mit der Anfrage, die Sie ablehnen möchten.

  4. Klicken Sie auf Aktionen und dann auf Ablehnen.

  5. Geben Sie im Dialogfeld eine Begründung für die Ablehnung ein.

  6. Klicken Sie zur Bestätigung auf Ablehnen.

REST

Verwenden Sie die Methode changeRequests.reject, um eine Anfrage abzulehnen.

Senden Sie beispielsweise die folgende POST-Anfrage:

curl -X POST \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "REJECTION_REASON"
  }' \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests/CHANGE_REQUEST_ID:reject"

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID IhresGoogle Cloud -Projekts.
  • LOCATION: die Region, in der sich die Ressource befindet, z. B. us-central1.
  • CHANGE_REQUEST_ID: die eindeutige ID der Änderungsanfrage, die Sie ablehnen möchten.
  • REJECTION_REASON: die Begründung für die Ablehnung.

Ein klarer Ablehnungskommentar hilft Antragstellern, die Entscheidung zu verstehen und ihre Begründungen zu verfeinern, bevor sie die Anfrage noch einmal einreichen.

Anfragen als Workflow-Administrator verwalten

Als Workflow-Administrator überwachen Sie Governance-Anfragen in Ihrer Organisation, konfigurieren E‑Mail-Benachrichtigungen für Genehmiger, prüfen den Genehmigungsverlauf und löschen Anfragen in jedem Status.

E-Mail-Benachrichtigungen für Genehmiger konfigurieren

Sie können E-Mail-Benachrichtigungen für Genehmiger für eine Eintraggruppe oder ein Unternehmensglossar konfigurieren, um bis zu 10 E-Mail-Adressen anzugeben, die automatisch benachrichtigt werden, wenn eine einzelne oder Batch-Metadatenänderungsanfrage für diese Ressource erstellt wird.

Verwenden Sie die Methode entryGroups.patch, um Benachrichtigungen für eine Eintraggruppe zu konfigurieren:

curl -X PATCH \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{
    "changeRequestConfig": {
      "approverEmails": [
        "APPROVER_EMAIL_1",
        "APPROVER_EMAIL_2"
      ]
    }
  }' \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/entryGroups/ENTRY_GROUP_ID?updateMask=changeRequestConfig"

Verwenden Sie die Methode glossaries.patch, um Benachrichtigungen für ein Unternehmensglossar zu konfigurieren:

curl -X PATCH \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  -H "Content-Type: application/json" \
  -d '{
    "changeRequestConfig": {
      "approverEmails": [
        "APPROVER_EMAIL_1",
        "APPROVER_EMAIL_2"
      ]
    }
  }' \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/global/glossaries/GLOSSARY_ID?updateMask=changeRequestConfig"

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID IhresGoogle Cloud -Projekts.
  • LOCATION: der Standort der Eintraggruppe, z. B. us-central1 oder global.
  • ENTRY_GROUP_ID: die ID der Eintraggruppe.
  • GLOSSARY_ID: die ID des Unternehmensglossars.
  • APPROVER_EMAIL_1, APPROVER_EMAIL_2: Die E-Mail-Adressen potenzieller Genehmiger, die benachrichtigt werden sollen, wenn eine Änderungsanfrage erstellt wird. Sie können bis zu 10 E-Mail-Adressen angeben.

Alle Anfragen ansehen und den Genehmigungsverlauf verfolgen

Sie können alle aktiven und historischen Anfragen in allen Status ansehen, um Workflows zu überwachen und den Zugriff auf Datenprodukte und Metadatenänderungen zu prüfen:

Console

  1. Rufen Sie in der Google Cloud Console die Seite Governance-Workflows des Knowledge Catalog auf.

    Zu „Governance-Workflows“

  2. Klicken Sie auf den Tab Genehmigungslog, um abgeschlossene Genehmigungen, Ablehnungen und Audit-Trails aufzurufen.

REST

Verwenden Sie die Methode changeRequests.list, um alle aktiven und historischen Anfragen in einem bestimmten Projekt und an einem bestimmten Standort aufzulisten.

Senden Sie beispielsweise die folgende GET-Anfrage:

curl -X GET \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/changeRequests"

Ersetzen Sie Folgendes:

  • PROJECT_ID: die ID IhresGoogle Cloud -Projekts.
  • LOCATION: die Region, in der sich die Ressource befindet, z. B. us-central1.

Anfrage in beliebigem Status löschen

Im Gegensatz zu Anfragenden, die nur Anfragen im Status NEW löschen können, können Workflow-Administratoren Anfragen in jedem Status über die Google Cloud -Konsole oder die Methode changeRequests.delete löschen. Eine Anleitung finden Sie unter Anfrage löschen.

Nächste Schritte