Pipeline-Ausführung mit der Scheduler API planen

Mit der Scheduler API können Sie einmalige oder wiederkehrende Pipeline-Ausführungen in Vertex AI planen. So können Sie ein kontinuierliches Training in Ihrem Projekt implementieren.

Nachdem Sie einen Zeitplan erstellt haben, kann er einen der folgenden Status haben:

ACTIVE: Ein aktiver Zeitplan erstellt kontinuierlich Pipelineausführungen entsprechend der Häufigkeit, die mit dem Cron-Zeitplanausdruck konfiguriert wurde. Ein Zeitplan wird zu seiner Startzeit aktiv und verbleibt in diesem Status bis zur angegebenen Endzeit oder bis Sie ihn pausieren.
PAUSED: Ein pausierter Zeitplan erstellt keine Pipelineausführungen. Sie können einen pausierten Zeitplan fortsetzen, um ihn wieder zu aktivieren. Wenn Sie einen pausierten Zeitplan fortsetzen, können Sie mit dem Parameter catch_up angeben, ob übersprungene Ausführungen (Ausführungen, die mit dem aktiven Zeitplan geplant worden wären) neu geplant und gesendet werden müssen. so früh wie möglich.
COMPLETED: Ein abgeschlossener Zeitplan erstellt keine neuen Pipelineausführungen mehr. Ein Zeitplan wird gemäß der angegebenen Endzeit abgeschlossen.

Mit der API-Planer haben Sie folgende Möglichkeiten:

Zeitplan erstellen
Zeitpläne auflisten
Zeitplan abrufen
Zeitplan pausieren
Zeitplan aktualisieren
Zeitplan fortsetzen
Zeitplan löschen

Hinweise

Bevor Sie eine Pipeline-Ausführung mit der Scheduler API planen, richten Sie Ihr Google Cloud-Projekt und Ihre Entwicklungsumgebung mit der folgenden Anleitung in der Google Cloud Console ein.

Gewähren Sie dem Nutzer oder Dienstkonto mindestens eine der folgenden IAM-Berechtigungen für die Verwendung der Scheduler API.
- roles/aiplatform.admin
- roles/aiplatform.user
Pipeline erstellen und kompilieren. Weitere Informationen finden Sie unter Pipeline erstellen.

Zeitplan erstellen

Sie können einen einmaligen oder wiederkehrenden Zeitplan erstellen.

Console

Gehen Sie nach der folgenden Anleitung vor, um mit der Google Cloud Console einen Zeitplan zu erstellen. Wenn für das Projekt und die Region bereits ein Zeitplan vorhanden ist, folgen Sie der Anleitung unter Pipelineausführung erstellen.

Verwenden Sie die folgende Anleitung, um einen Pipeline-Zeitplan zu erstellen:

Rufen Sie in der Google Cloud Console im Abschnitt "Vertex AI" den Tab Zeitpläne auf der Seite Pipelines auf.

Zu "Zeitpläne"
Klicken Sie auf Scheduler-Ausführung erstellen, um den Bereich Pipeline-Ausführung erstellen zu öffnen.
Geben Sie die folgenden Ausführungsdetails an, indem Sie eine der folgenden Optionen auswählen:
- Klicken Sie zum Erstellen einer Pipeline-Ausführung basierend auf einer vorhandenen Pipeline-Vorlage auf Aus vorhandenen Pipelines auswählen und geben Sie die folgenden Details ein:
  1. Wählen Sie das Repository mit der Pipeline- oder Komponentendefinitionsdatei aus.
  2. Wählen Sie die Pipeline oder Komponente und die Version aus.
- Klicken Sie zum Hochladen einer kompilierten Pipelinedefinition auf Datei hochladen und geben Sie die folgenden Details ein:
  1. Klicken Sie auf Durchsuchen, um die Dateiauswahl zu öffnen. Wechseln Sie zur YAML-Datei der kompilierten Pipeline, die Sie ausführen möchten, wählen Sie die Pipeline aus und klicken Sie auf Öffnen.
  2. Der Name der Pipeline oder Komponente zeigt standardmäßig den in der Pipelinedefinition angegebenen Namen an. Geben Sie optional einen anderen Pipelinenamen an.
- Klicken Sie zum Importieren einer Pipelinedefinitionsdatei aus Cloud Storage auf Aus Cloud Storage importieren und geben Sie die folgenden Details ein:
  1. Klicken Sie auf Durchsuchen, um den Cloud Storage-Bucket aufzurufen, der das Pipelinedefinitionsobjekt enthält. Wählen Sie die Datei aus und klicken Sie auf Auswählen.
  2. Geben Sie den Namen der Pipeline oder Komponente an.
Geben Sie einen Ausführungsnamen an, um die Pipelineausführung eindeutig zu identifizieren.
Geben Sie den Ausführungszeitplan so an:
1. Wählen Sie Wiederkehrend aus.
2. Geben Sie unter Startzeit an, wann der Zeitplan aktiv werden soll.
  - Wählen Sie Sofort aus, um die erste Ausführung sofort nach der Zeitplanerstellung zu planen.
  - Wenn Sie die erste Ausführung zu einem bestimmten Zeitpunkt und Datum planen möchten, wählen Sie An aus.
3. Geben Sie im Feld Häufigkeit die Häufigkeit an, mit der die Pipelineausführungen geplant und ausgeführt werden sollen. Verwenden Sie dazu einen Cron-Zeitplanausdruck, der auf unix-cron basiert.
4. Geben Sie unter Ende an, wann der Zeitplan endet.
  - Wenn Sie angeben möchten, dass der Zeitplan Pipelineausführungen unbegrenzt erstellt, wählen Sie Nie aus.
  - Wenn der Zeitplan mit einem bestimmten Datum und einer bestimmten Uhrzeit endet, wählen Sie Ein aus und geben Sie das Enddatum und die Uhrzeit für den Zeitplan an.
Optional: Klicken Sie auf Erweiterte Optionen und geben Sie einen Namen für das Dienstkonto, den CMEK oder das Peering-VPC-Netzwerk an, um ein benutzerdefiniertes Dienstkonto, einen vom Kunden verwalteten Verschlüsselungsschlüssel (Customer-Managed Encryption Key, CMEK) oder ein Peering-VPC-Netzwerk anzugeben.
Klicken Sie auf Weiter und geben Sie die Laufzeitkonfiguration für die Pipeline an.
Klicken Sie auf Senden, um einen Zeitplan für Pipelineausführung zu erstellen.

REST

Senden Sie zum Erstellen eines Pipelinezeitplans die POST-Anfrage mit der Methode projects.locations.schedules.create.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

LOCATION ist die Region, in der Sie die Pipeline ausführen möchten. Weitere Informationen zu den Regionen, in denen Vertex AI Pipelines verfügbar ist, finden Sie in der Anleitung zu Vertex AI-Standorten.
PROJECT_ID: Das Google Cloud-Projekt, in dem Sie die Pipeline ausführen möchten.
DISPLAY_NAME: Der Name des Pipelinezeitplans. Sie können einen Namen mit einer maximalen Länge von 128 UTF-8-Zeichen angeben.
START_TIME: Zeitstempel, nach dem die erste Ausführung geplant werden kann, z. B. 2045-07-26T00:00:00Z. Wenn Sie diesen Parameter nicht angeben, wird der Zeitstempel für das Erstellen des Zeitplans als Standardwert verwendet.
END_TIME: Zeitstempel, nach dem Pipelineausführungen nicht mehr geplant werden. Wenn END_TIME erreicht ist, ändert sich der Status des Zeitplans in COMPLETED. Wenn Sie diesen Parameter nicht angeben, führt der Zeitplan weiterhin unbegrenzt neue Pipelinejobs aus, bis Sie den Zeitplan pausieren oder löschen.
CRON_EXPRESSION: Cron-Zeitplanausdruck, der die Häufigkeit zum Planen und Ausführen von Pipelineausführungen darstellt. Weitere Informationen finden Sie unter Cron.
MAX_CONCURRENT_RUN_COUNT: Die maximale Anzahl gleichzeitiger Ausführungen für den Zeitplan.

API_REQUEST_TEMPLATE: PipelineService.CreatePipelineJob-API-Anfragevorlage, die zum Ausführen der geplanten Pipelineausführungen verwendet wird. Weitere Informationen zu den Parametern in der API-Anfragevorlage finden Sie in der Dokumentation zu pipelineJobs.create. Beachten Sie, dass Sie den Parameter pipelineJobId in dieser Vorlage nicht angeben können, da die Scheduler-API diesen Parameter nicht unterstützt.

Klicken Sie hier, um ein Beispiel für eine API-Anfragevorlage anzusehen, wobei gs://gcs_directory der Cloud Storage-Bucket für Pipeline-Ausgabeartefakte ist.

{
  "parent":"projects//locations/us-central1",
  "pipelineJob": {
    "displayName": "hello-world",
    "pipelineSpec": {
      "deploymentConfig": {
        "@type": "type.googleapis.com/ml_pipelines.PipelineDeploymentConfig",
        "executors": {
          "HelloWorld_executor": {
            "container": {
              "command": ["sleep", "1"],
              "image": "google/cloud-sdk:latest"
            }
          }
        }
      },
      "pipelineInfo": {
        "name": "hello-world"
      },
      "root": {
        "dag": {
          "tasks": {
            "task-test-hello-world": {
              "taskInfo": {"name": "HelloWorld"},
              "componentRef": {"name": "HelloWorld"},
              "cachingOptions": {}
            }
          }
        }
      },
      "components": {
        "HelloWorld": {
          "executorLabel": "HelloWorld_executor"
        }
      },
      "schemaVersion": "2.0.0"
    },
    "runtimeConfig": {
      "gcsOutputDirectory": "gs://gcs_directory"
    }
  }
}

HTTP-Methode und URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules

JSON-Text der Anfrage:

{
  "display_name":"DISPLAY_NAME",
  "start_time": "START_TIME",
  "end_time": "END_TIME",
  "cron": "CRON_EXPRESSION",
  "max_concurrent_run_count": "MAX_CONCURRENT_RUN_COUNT",
  "create_pipeline_job_request": API_REQUEST_TEMPLATE
}

Wenn Sie die Anfrage senden möchten, wählen Sie eine der folgenden Optionen aus:

curl

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud CLI angemeldet haben. Dazu haben Sie gcloud init oder gcloud auth login ausgeführt oder die Cloud Shell genutzt, die Sie automatisch in der gcloud CLI anmeldet. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json und führen Sie den folgenden Befehl aus:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules"

PowerShell

Hinweis: Der folgende Befehl setzt voraus, dass Sie sich mit Ihrem Nutzerkonto in der gcloud-Befehlszeile angemeldet haben. Dazu führen Sie gcloud init oder gcloud auth login aus. Um herauszufinden, welches Konto gerade aktiv ist, führen Sie gcloud auth list aus.

Speichern Sie den Anfragetext in einer Datei mit dem Namen request.json und führen Sie den folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules" | Select-Object -Expand Content

Die Ausgabe sieht in etwa so aus: Sie können den Zeitplan SCHEDULE_ID aus der Antwort verwenden, um den Zeitplan abzurufen, zu pausieren, fortzusetzen oder zu löschen. PIPELINE_JOB_CREATION_REQUEST steht für die API-Anfrage zum Erstellen des Pipelinejobs.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID",
  "displayName": "DISPLAY_NAME",
  "startTime": "START_TIME",
  "state": "ACTIVE",
  "createTime": "2025-01-01T00:00:00.000000Z",
  "nextRunTime": "2045-08-01T00:00:00Z",
  "cron": "CRON_EXPRESSION",
  "maxConcurrentRunCount": "MAX_CONCURRENT_RUN_COUNT",
  "createPipelineJobRequest": PIPELINE_JOB_CREATION_REQUEST
}

Python

So können Sie einen Zeitplan für die Pipelineausführung erstellen:

Erstellen Sie einen Zeitplan anhand eines PipelineJob mit der Methode PipelineJob.create_schedule.
Zeitplan mit der Methode PipelineJobSchedule.create erstellen.

Beim Erstellen eines Pipeline-Ausführungszeitplans können Sie auch die folgenden Platzhalter übergeben, die vom KFP SDK unterstützt werden:

{{$.pipeline_job_name_placeholder}}
{{$.pipeline_job_resource_name_placeholder}}
{{$.pipeline_job_id_placeholder}}
{{$.pipeline_task_name_placeholder}}
{{$.pipeline_task_id_placeholder}}
{{$.pipeline_job_create_time_utc_placeholder}}
{{$.pipeline_job_schedule_time_utc_placeholder}}
{{$.pipeline_root_placeholder}}

Weitere Informationen finden Sie in der Kubeflow Pipelines Version 2 unter Spezielle Eingabetypen.

Zeitplan aus einem `PipelineJob` erstellen

Im folgenden Beispiel werden Pipelineausführungen mithilfe der Methode PipelineJob.create_schedule geplant:

from google.cloud import aiplatform

pipeline_job = aiplatform.PipelineJob(
  template_path="COMPILED_PIPELINE_PATH",
  pipeline_root="PIPELINE_ROOT_PATH",
  display_name="DISPLAY_NAME",
)

pipeline_job_schedule = pipeline_job.create_schedule(
  display_name="SCHEDULE_NAME",
  cron="TZ=CRON",
  max_concurrent_run_count=MAX_CONCURRENT_RUN_COUNT,
  max_run_count=MAX_RUN_COUNT,
)

COMPILED_PIPELINE_PATH: Der Pfad zur kompilierten Pipeline-YAML-Datei. Dies kann ein lokaler Pfad oder ein Google Cloud Storage-URI sein.

Optional: Wenn Sie eine bestimmte Version einer Vorlage angeben möchten, fügen Sie das Versions-Tag zusammen mit dem Pfad in einem der folgenden Formate ein:
- COMPILED_PIPELINE_PATH:TAG, wobei TAG das Versions-Tag ist.
- COMPILED_PIPELINE_PATH@SHA256_TAG, wobei SHA256_TAG der sha256-Hashwert der Pipelineversion ist.
PIPELINE_ROOT_PATH: (optional) Damit der in der Pipelinedefinition angegebene Root-Pfad der Pipeline überschrieben werden kann, geben Sie einen Pfad an, auf den Ihr Pipelinejob zugreifen kann, z. B. einen Cloud Storage-Bucket-URI.
DISPLAY_NAME: Der Name der Pipeline. Dieser wird in der Google Cloud Console angezeigt.
SCHEDULE_NAME: Der Name des Pipelinezeitplans. Sie können einen Namen mit einer maximalen Länge von 128 UTF-8-Zeichen angeben.
CRON: Cron-Zeitplanausdruck, der die Häufigkeit zum Planen und Ausführen von Pipelineausführungen darstellt. Weitere Informationen finden Sie unter Cron.
MAX_CONCURRENT_RUN_COUNT: Die maximale Anzahl gleichzeitiger Ausführungen für den Zeitplan.
MAX_RUN_COUNT: Die maximale Anzahl von Pipelineausführungen, die der Zeitplan erstellt, bevor er abgeschlossen wird.

Zeitplan mit `PipelineJobSchedule.create` erstellen

Im folgenden Beispiel werden Pipelineausführungen mithilfe der Methode PipelineJobSchedule.create geplant:

from google.cloud import aiplatform

pipeline_job = aiplatform.PipelineJob(
  template_path="COMPILED_PIPELINE_PATH",
  pipeline_root="PIPELINE_ROOT_PATH",
  display_name="DISPLAY_NAME",
)

pipeline_job_schedule = aiplatform.PipelineJobSchedule(
  pipeline_job=pipeline_job,
  display_name="SCHEDULE_NAME"
)

pipeline_job_schedule.create(
  cron="TZ=CRON",
  max_concurrent_run_count=MAX_CONCURRENT_RUN_COUNT,
  max_run_count=MAX_RUN_COUNT,
)

COMPILED_PIPELINE_PATH: Der Pfad zur kompilierten Pipeline-YAML-Datei. Dies kann ein lokaler Pfad oder ein Google Cloud Storage-URI sein.

Optional: Wenn Sie eine bestimmte Version einer Vorlage angeben möchten, fügen Sie das Versions-Tag zusammen mit dem Pfad in einem der folgenden Formate ein:
- COMPILED_PIPELINE_PATH:TAG, wobei TAG das Versions-Tag ist.
- COMPILED_PIPELINE_PATH@SHA256_TAG, wobei SHA256_TAG der sha256-Hash-Wert der Pipelineversion ist.
PIPELINE_ROOT_PATH: (optional) Damit der in der Pipelinedefinition angegebene Root-Pfad der Pipeline überschrieben werden kann, geben Sie einen Pfad an, auf den Ihr Pipelinejob zugreifen kann, z. B. einen Cloud Storage-Bucket-URI.
DISPLAY_NAME: Der Name der Pipeline. Dieser wird in der Google Cloud Console angezeigt.
SCHEDULE_NAME: Der Name des Pipelinezeitplans. Sie können einen Namen mit einer maximalen Länge von 128 UTF-8-Zeichen angeben.
CRON: Cron-Zeitplanausdruck, der die Häufigkeit zum Planen und Ausführen von Pipelineausführungen darstellt. Weitere Informationen finden Sie unter Cron.
MAX_CONCURRENT_RUN_COUNT: Die maximale Anzahl gleichzeitiger Ausführungen für den Zeitplan.
MAX_RUN_COUNT: Die maximale Anzahl von Pipelineausführungen, die der Zeitplan erstellt, bevor er abgeschlossen wird.

Zeitpläne auflisten

Sie können die Liste der Pipeline-Zeitpläne aufrufen, die für Ihr Google Cloud-Projekt erstellt wurden.

Console

Sie können die Liste der Pipelinepläne auf dem Tab Zeitpläne der Google Cloud Console für die ausgewählte Region aufrufen.

Rufen Sie in der Google Cloud Console im Abschnitt "Vertex AI" den Tab Zeitpläne auf der Seite Pipelines auf, um die Liste der Pipelinezeitpläne aufzurufen.

Zu "Zeitpläne"

REST

Senden Sie eine GET-Anfrage mit der Methode projects.locations.schedules.list, um Pipeline-Ausführungspläne in Ihrem Projekt aufzulisten.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

LOCATION ist die Region, in der Sie die Pipeline ausführen möchten. Weitere Informationen zu den Regionen, in denen Vertex AI Pipelines verfügbar ist, finden Sie in der Anleitung zu Vertex AI-Standorten.
PROJECT_ID: Das Google Cloud-Projekt, in dem Sie die Pipeline ausführen möchten.
FILTER: (optional) Ausdruck, um die Liste der Zeitpläne zu filtern. Weitere Informationen
PAGE_SIZE: (optional) Die Anzahl der Zeitpläne, die pro Seite aufgelistet werden sollen.
PAGE_TOKEN: (Optional) Das Standardtoken der Listenseite, das in der Regel über ListSchedulesResponse.next_page_token[] von einem vorherigen ScheduleService.ListSchedules[] stammt.
ORDER_BY: (optional) Durch Kommas getrennte Liste von Feldern, die die Sortierreihenfolge der Zeitpläne in der Antwort angibt

HTTP-Methode und URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules?FILTER&PAGE_SIZE&PAGE_TOKEN&ORDER_BY

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules?FILTER&PAGE_SIZE&PAGE_TOKEN&ORDER_BY"

PowerShell

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules?FILTER&PAGE_SIZE&PAGE_TOKEN&ORDER_BY" | Select-Object -Expand Content

Die Ausgabe sollte in etwa so aussehen:

{
  "schedules": [
    SCHEDULE_ENTITY_OBJECT_1,
    SCHEDULE_ENTITY_OBJECT_2,
    ...
  ],
}

Python

Im folgenden Beispiel werden alle Zeitpläne in Ihrem Projekt in absteigender Reihenfolge ihrer Erstellungszeit aufgelistet:

from google.cloud import aiplatform

aiplatform.PipelineJobSchedule.list(
  filter='display_name="DISPLAY_NAME"',
  order_by='create_time desc'
)

DISPLAY_NAME: Der Name des Pipelinezeitplans. Sie können einen Namen mit einer maximalen Länge von 128 UTF-8-Zeichen angeben.

Zeitplan abrufen

Sie können einen Pipeline-Ausführungszeitplan mit der Zeitplan-ID abrufen.

REST

Senden Sie zum Abrufen eines Pipeline-Ausführungszeitplans eine GET-Anfrage mit der Methode projects.locations.schedules.get und der Zeitplan-ID.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

LOCATION ist die Region, in der Sie die Pipeline ausführen möchten. Weitere Informationen zu den Regionen, in denen Vertex AI Pipelines verfügbar ist, finden Sie in der Anleitung zu Vertex AI-Standorten.
PROJECT_ID: Das Google Cloud-Projekt, in dem Sie die Pipeline ausführen möchten.
SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.

HTTP-Methode und URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus:

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

PowerShell

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID" | Select-Object -Expand Content

Die Ausgabe sieht in etwa so aus: PIPELINE_JOB_CREATION_REQUEST steht für die API-Anfrage zum Erstellen des Pipelinejobs.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID",
  "displayName": "schedule_display_name",
  "startTime": "2045-07-26T06:59:59Z",
  "state": "ACTIVE",
  "createTime": "20xx-01-01T00:00:00.000000Z",
  "nextRunTime": "2045-08-01T00:00:00Z",
  "cron": "TZ=America/New_York 0 0 1 * *",
  "maxConcurrentRunCount": "10",
  "createPipelineJobRequest": PIPELINE_JOB_CREATION_REQUEST
}

Python

Im folgenden Beispiel können Sie einen Zeitplan für die Pipelineausführung mithilfe der Zeitplan-ID abrufen:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.

Zeitplan pausieren

Sie können einen aktiven Pipelinezeitplan pausieren, indem Sie die Zeitplan-ID angeben. Wenn Sie einen Zeitplan pausieren, ändert sich sein Status von ACTIVE in PAUSED.

Console

Sie können einen Pipeline-Ausführungszeitplan pausieren, der aktuell aktiv ist.

So pausieren Sie einen Zeitplan:

Rufen Sie in der Google Cloud Console im Abschnitt "Vertex AI" den Tab Zeitpläne auf der Seite Pipelines auf.

Zu "Zeitpläne"
Rufen Sie das Menü -Optionen auf, das sich in derselben Zeile wie der zu pausierende Zeitplan befindet, und klicken Sie dann auf Pausieren. Sie können jeden Zeitplan pausieren, in dem in der Spalte Status der Wert Aktiv angezeigt wird.

REST

Senden Sie eine POST-Anfrage mit der Methode projects.locations.schedules.pause, um einen Zeitplan für die Pipeline-Ausführung in Ihrem Projekt zu pausieren.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

LOCATION: Die Region, in der der Pipeline-Ausführungszeitplan derzeit aktiv ist. Weitere Informationen zu den Regionen, in denen Vertex AI Pipelines verfügbar ist, finden Sie in der Anleitung zu Vertex AI-Standorten.
PROJECT_ID: Das Google Cloud-Projekt, in dem der Zeitplan für die Pipelineausführung derzeit aktiv ist.
SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.

HTTP-Methode und URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:pause

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:pause"

PowerShell

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:pause" | Select-Object -Expand Content

Sie sollten einen erfolgreichen Statuscode (2xx) und eine leere Antwort als Ausgabe erhalten.

Python

Verwenden Sie das folgende Beispiel, um einen Zeitplan für die Pipelineausführung zu pausieren:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.pause()

SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.

Zeitplan aktualisieren

Sie können einen vorhandenen Pipelinezeitplan aktualisieren, der für Ihr Google Cloud-Projekt erstellt wurde.

Das Aktualisieren eines Zeitplans ähnelt dem Löschen und Neuerstellen eines Zeitplans. Wenn Sie einen Zeitplan aktualisieren, werden neue Ausführungen basierend auf der Häufigkeit des aktualisierten Zeitplans geplant. Es werden keine neuen Ausführungen mehr basierend auf dem alten Zeitplan erstellt und alle Ausführungen in der Warteschlange werden gelöscht. Pipeline-Ausführungen, die nach dem alten Zeitplan bereits erstellt wurden, werden nicht pausiert oder abgebrochen.

REST

Senden Sie eine PATCH-Anfrage mit der Methode projects.locations.schedules.patch, um einen Pipeline-Ausführungszeitplan in Ihrem Projekt zu aktualisieren.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

LOCATION ist die Region, in der Sie die Pipeline ausführen möchten. Weitere Informationen zu den Regionen, in denen Vertex AI Pipelines verfügbar ist, finden Sie in der Anleitung zu Vertex AI-Standorten.
PROJECT_ID: Das Google Cloud-Projekt, in dem Sie die Pipeline ausführen möchten.
DISPLAY_NAME: Der Name des Pipelinezeitplans. Sie können einen Namen mit einer maximalen Länge von 128 UTF-8-Zeichen angeben.
MAX_CONCURRENT_RUN_COUNT: Die maximale Anzahl gleichzeitiger Ausführungen für den Zeitplan.

HTTP-Methode und URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID?updateMask=display_name,max_run_count -d '{"display_name":"DISPLAY_NAME", "max_concurrent_run_count": MAX_CONCURRENT_RUN_COUNT}'

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID?updateMask=display_name,max_run_count -d '{"display_name":"DISPLAY_NAME", "max_concurrent_run_count": MAX_CONCURRENT_RUN_COUNT}'"

PowerShell

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID?updateMask=display_name,max_run_count -d '{"display_name":"DISPLAY_NAME", "max_concurrent_run_count": MAX_CONCURRENT_RUN_COUNT}'" | Select-Object -Expand Content

Die Ausgabe sieht in etwa so aus: Basierend auf der Aktualisierung wird die NEXT_RUN_TIME neu berechnet. Wenn Sie den Zeitplan aktualisieren, bleibt START_TIME unverändert.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID",
  "displayName": "DISPLAY_NAME",
  "startTime": "START_TIME",
  "state": "ACTIVE",
  "createTime": "2025-01-01T00:00:00.000000Z",
  "nextRunTime": NEXT_RUN_TIME,
  "maxConcurrentRunCount": "MAX_CONCURRENT_RUN_COUNT",
}

Python

Im folgenden Beispiel werden Pipelineausführungen mithilfe der Methode PipelineJobSchedule.update geplant:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.update(
  display_name='DISPLAY_NAME',
  max_concurrent_run_count=MAX_CONCURRENT_RUN_COUNT,
)

SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.
DISPLAY_NAME: Der Name des Pipelinezeitplans. Sie können einen Namen mit einer maximalen Länge von 128 UTF-8-Zeichen angeben.
MAX_CONCURRENT_RUN_COUNT: Die maximale Anzahl gleichzeitiger Ausführungen für den Zeitplan.

Zeitplan fortsetzen

Sie können einen pausierten Pipelinezeitplan fortsetzen, indem Sie die Zeitplan-ID angeben. Wenn Sie einen Zeitplan fortsetzen, ändert sich sein Status von PAUSED in ACTIVE.

Console

Sie können einen Pipeline-Ausführungsplan fortsetzen, der aktuell pausiert ist.

Gehen Sie so vor, um einen Zeitplan fortzusetzen:

Rufen Sie in der Google Cloud Console im Abschnitt "Vertex AI" den Tab Zeitpläne auf der Seite Pipelines auf.

Zu "Zeitpläne"
Rufen Sie das Menü -Optionen auf, das sich in derselben Zeile wie der zu wiederholende Zeitplan befindet, und klicken Sie dann auf Fortsetzen. Sie können jeden Zeitplan fortsetzen, in dem die Spalte Status Pausiert anzeigt.

REST

Senden Sie eine POST-Anfrage mit der Methode projects.locations.schedules.resume, um eine Pipeline-Ausführungsplanung in Ihrem Projekt fortzusetzen.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

LOCATION: Die Region, in der der Zeitplan für die Pipelineausführung aktuell pausiert ist. Weitere Informationen zu den Regionen, in denen Vertex AI Pipelines verfügbar ist, finden Sie in der Anleitung zu Vertex AI-Standorten.
PROJECT_ID: Das Google Cloud-Projekt, in dem der Pipeline-Ausführungszeitplan derzeit pausiert ist.
SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.
CATCH_UP: (Optional) Geben Sie an, ob der pausierte Zeitplan die übersprungenen Pipelineausführungen füllen soll. Geben Sie Folgendes ein, um ein Backfill durchzuführen und die übersprungenen Pipelineausführungen neu zu planen:
{ "catch_up":true } Dieser Parameter ist standardmäßig auf "false" gesetzt.

HTTP-Methode und URL:

POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:resume -d 'CATCH_UP'

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus:

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d "" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:resume -d 'CATCH_UP'"

PowerShell

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID:resume -d 'CATCH_UP'" | Select-Object -Expand Content

Sie sollten einen erfolgreichen Statuscode (2xx) und eine leere Antwort als Ausgabe erhalten.

Python

Verwenden Sie das folgende Beispiel, um einen angehaltenen Zeitplan zur Pipelineausführung fortzusetzen:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.resume(catch_up=CATCH_UP)

SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.
CATCH_UP: (Optional) Geben Sie an, ob der pausierte Zeitplan die übersprungenen Pipelineausführungen füllen soll. Geben Sie Folgendes ein, um ein Backfill durchzuführen und die übersprungenen Pipelineausführungen neu zu planen:
{ "catch_up":true }

Zeitplan löschen

Sie können einen Pipelinezeitplan löschen, indem Sie die Zeitplan-ID angeben.

Console

Sie können einen Ausführungszeitplan für Pipelines unabhängig vom Status löschen.

Folgen Sie der Anleitung unten, um einen Zeitplan zu löschen.

Rufen Sie in der Google Cloud Console im Abschnitt "Vertex AI" den Tab Zeitpläne auf der Seite Pipelines auf.

Zu "Zeitpläne"
Rufen Sie das Menü -Optionen auf, das sich in derselben Zeile wie der zu löschende Zeitplan befindet, und klicken Sie dann auf Löschen.
Klicken Sie zur Bestätigung noch einmal auf Löschen.

REST

Senden Sie eine DELETE-Anfrage mit der Methode projects.locations.schedules.delete, um einen Pipeline-Ausführungszeitplan in Ihrem Projekt zu löschen.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

LOCATION: die Region, in der Sie den Pipelinezeitplan löschen möchten. Weitere Informationen zu den Regionen, in denen Vertex AI Pipelines verfügbar ist, finden Sie in der Anleitung zu Vertex AI-Standorten.
PROJECT_ID: Das Google Cloud-Projekt, in dem Sie den Zeitplan löschen möchten.
SCHEDULE_ID: die eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.

HTTP-Methode und URL:

DELETE https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus:

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

PowerShell

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/schedules/SCHEDULE_ID" | Select-Object -Expand Content

Die Ausgabe sieht in etwa so aus: OPERATION_ID steht für den Löschvorgang.

{
  "name": "projects/PROJECT_ID/locations/LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.aiplatform.v1.DeleteOperationMetadata",
    "genericMetadata": {
      "createTime": "20xx-01-01T00:00:00.000000Z",
      "updateTime": "20xx-01-01T00:00:00.000000Z"
    }
  },
  "done": true,
  "response": {
    "@type": "type.googleapis.com/google.protobuf.Empty"
  }
}

Python

Verwenden Sie das folgende Beispiel, um einen Zeitplan für Pipelineausführung zu löschen:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.delete()

SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.

Alle nach einem Zeitplan erstellten Pipelinejobs auflisten

Sie können eine Liste aller Pipelinejobs aufrufen, die von einem Zeitplan erstellt wurden, indem Sie die Zeitplan-ID angeben.

REST

Senden Sie eine GET-Anfrage mit der Methode projects.locations.pipelineJobs, um alle Pipelineausführungen aufzulisten, die von einem Pipelinezeitplan erstellt wurden.

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

LOCATION ist die Region, in der Sie die Pipeline ausführen möchten. Weitere Informationen zu den Regionen, in denen Vertex AI Pipelines verfügbar ist, finden Sie in der Anleitung zu Vertex AI-Standorten.
PROJECT_ID: Das Google Cloud-Projekt, in dem Sie die Pipeline ausführen möchten.
SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.

HTTP-Methode und URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs?filter=schedule_name=projects/PROJECT/locations/LOCATION/schedules/SCHEDULE_ID

Senden Sie die Anfrage mithilfe einer der folgenden Optionen:

curl

Führen Sie folgenden Befehl aus:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs?filter=schedule_name=projects/PROJECT/locations/LOCATION/schedules/SCHEDULE_ID"

PowerShell

Führen Sie folgenden Befehl aus:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs?filter=schedule_name=projects/PROJECT/locations/LOCATION/schedules/SCHEDULE_ID" | Select-Object -Expand Content

Die Ausgabe sieht in etwa so aus:

{
  "pipelineJobs": [
    PIPELINE_JOB_ENTITY_1,
    PIPELINE_JOB_ENTITY_2,
    ...
  ],
}

Python

Verwenden Sie das folgende Beispiel, um alle von einem Zeitplan erstellten Pipelinejobs in absteigender Reihenfolge ihrer Erstellungszeit aufzulisten:

from google.cloud import aiplatform

pipeline_job_schedule = aiplatform.PipelineJobSchedule.get(schedule_id=SCHEDULE_ID)

pipeline_job_schedule.list_jobs(order_by='create_time_desc')

SCHEDULE_ID: Eindeutige Zeitplan-ID, die beim Erstellen des Zeitplans generiert wurde.

Pipeline-Ausführung mit der Scheduler API planen

Hinweise

Zeitplan erstellen

Console

REST

curl

PowerShell

Python

Zeitplan aus einem PipelineJob erstellen

Zeitplan mit PipelineJobSchedule.create erstellen

Zeitpläne auflisten

Console

REST

curl

PowerShell

Python

Zeitplan abrufen

REST

curl

PowerShell

Python

Zeitplan pausieren

Console

REST

curl

PowerShell

Python

Zeitplan aktualisieren

REST

curl

PowerShell

Python

Zeitplan fortsetzen

Console

REST

curl

PowerShell

Python

Zeitplan löschen

Console

REST

curl

PowerShell

Python

Alle nach einem Zeitplan erstellten Pipelinejobs auflisten

REST

curl

PowerShell

Python

Zeitplan aus einem `PipelineJob` erstellen

Zeitplan mit `PipelineJobSchedule.create` erstellen