Tutorial 2: Aufgaben erstellen und verwalten

Einführung

In diesem Tutorial lernen Sie, wie Sie REST-Abfragen stellen, um Aufgaben zu erstellen und zu verwalten.

Voraussetzungen

Bemerkung

Wenn Sie die Schritte unter Gemeinsame Einrichtung für Snowflake REST APIs-Tutorials bereits ausgeführt haben, können Sie diese Voraussetzungen überspringen und mit dem ersten Schritt dieses Tutorials fortfahren.

Bevor Sie mit diesem Tutorial beginnen, müssen Sie die Anweisungen von common setup ausführen, die die folgenden Schritte umfassen:

  • Importieren Sie die Snowflake REST APIs Postman-Sammlungen.

  • Authentifizieren Sie Ihre Verbindung, indem Sie in Postman das Token für den Postman einstellen.

Nachdem Sie diese Voraussetzungen erfüllt haben, können Sie die API verwenden.

Warehouse erstellen

Sie können das Warehouse-API verwenden, um ein Snowflake Warehouse zu erstellen.

Um ein extra kleines (xsmall) Warehouse mit dem Namen demo_wh zu erstellen, senden Sie die folgende POST-Anfrage an den Endpunkt /api/v2/warehouses, wie gezeigt:

  • Setzen Sie auf der Registerkarte Params den Parameter createMode auf errorIfExists, damit Sie nicht versehentlich ein bestehendes Warehouse überschreiben.

    ../../../_images/create-warehouse-params.png
  • Fügen Sie auf der Body-Registerkarte den folgenden Code in den Body der Anfrage ein, wie gezeigt.

    {
      "name": "demo_wh",
      "warehouse_size": "xsmall"
    }
    
    Copy
    ../../../_images/create-warehouse1.png

Weitere Informationen finden Sie in der Snowflake Warehouse API-Referenz.

Aufgabe erstellen

Sie können die Aufgabe API verwenden, um eine Snowflake-Aufgabe zu erstellen.

Um eine Aufgabe zu erstellen, senden Sie eine POST-Anfrage an den Endpunkt /api/v2/databases/{database}/schemas/{schema}/tasks, wie gezeigt:

  • Setzen Sie auf der Registerkarte Params den Parameter createMode auf oderReplace, und setzen Sie die Pfadvariablen database und schema Pfadvariablen, um die Umgebungsvariablen ({{default_db}} und {{default_schema}}) zu verwenden, die Sie in den Gemeinsame Einrichtung für Snowflake REST APIs-Tutorials-Tutorials festgelegt haben.

    ../../../_images/create-task-params.png
  • Fügen Sie auf der Body-Registerkarte den Body der Anfrage wie gezeigt hinzu.

    {
      "name": "{{test_task_name}}",
      "definition": "SELECT 1",
      "warehouse": "{{default_wh}}",
      "schedule": {"minutes": 2, "schedule_type": "MINUTES_TYPE"},
      "config": {"consecteture": false, "sed_9": 61393640, "doloref3": -85761000},
      "commnent": "comment",
      "session_parameters": {
        "TIMEZONE": "America/Los Angeles",
        "AUTOMCOMMIT": true
      },
      "error_integration": null,
      "user_task_managed_initial_warehouse_size": null,
      "predecessors": null,
      "task_auto_retry_attempts": 3,
      "user_task_timeout_ms": 10000,
      "suspend_task_after_num_failures": 3,
      "condition": true,
      "allow_overlapping_execution": false
    }
    
    Copy
    ../../../_images/create-task1.png

Weitere Informationen finden Sie in der Snowflake-Aufgabe-API-Referenz.

Eine Aufgabe abrufen

Sie können die Aufgabe-API verwenden, um eine Snowflake Aufgabe abzurufen.

Um Details zu einer Aufgabe abzurufen, senden Sie eine GET-Anfrage an den Endpunkt /api/v2/databases/{database}/schemas/{schema}/tasks, wie gezeigt:

  • Setzen Sie auf der Params-Registerkarte die Variablen Datenbank, Schema und Name Pfad, um die Umgebungsvariablen zu verwenden ({{default_db}}, {{default_schema}} und {{test_task_name}}), die Sie in den Gemeinsame Einrichtung für Snowflake REST APIs-Tutorials-Tutorials festgelegt haben.

    ../../../_images/fetch-task1.png

Weitere Informationen finden Sie in der Snowflake-Aufgabe-API-Referenz.

Aufgaben auflisten

Sie können die Aufgabe-API verwenden, um Snowflake-Aufgaben aufzulisten.

Um alle verfügbaren Aufgaben aufzulisten, senden Sie eine GET-Anfrage an den Endpunkt /api/v2/databases/{database}/schemas/{schema}/tasks, wie gezeigt:

  • Setzen Sie auf der Params-Registerkarte den Parameter rootOnly auf false, und setzen Sie die Pfadvariablen database und schema Pfadvariablen, um die Umgebungsvariablen ({{default_db}} und {{default_schema}}) zu verwenden, die Sie in den Gemeinsame Einrichtung für Snowflake REST APIs-Tutorials -Tutorials festgelegt haben.

    ../../../_images/list-tasks1.png

Weitere Informationen finden Sie in der Snowflake-Aufgabe-API-Referenz.

Eine Aufgabe löschen

Sie können die Aufgabe-API verwenden, um eine Snowflake-Aufgabe zu löschen.

Um eine Aufgabe zu löschen, senden Sie eine DELETE-Anfrage an den Endpunkt /api/v2/databases/{database}/schemas/{schema}/tasks/{name}, wie gezeigt:

  • Setzen Sie auf der Params-Registerkarte die Variablen Datenbank, Schema und Name Pfad, um die Umgebungsvariablen zu verwenden ({{default_db}}, {{default_schema}} und {{test_task_name}}), die Sie in den Gemeinsame Einrichtung für Snowflake REST APIs-Tutorials-Tutorials festgelegt haben.

    ../../../_images/delete-task.png

Weitere Informationen finden Sie in der Snowflake-Aufgabe-API-Referenz.

Eine Aufgabe ausführen

Sie können die Aufgabe-API verwenden, um eine Snowflake-Aufgabe auszuführen.

Um eine Aufgabe auszuführen, die nicht wiederholt wird, wenn sie fehlschlägt, senden Sie eine POST-Anfrage an den Endpunkt /api/v2/databases/{database}/schemas/{schema}/tasks/{name}:execute, wie gezeigt:

  • Setzen Sie auf der Params-Registerkarte den Parameter retryLast auf false, und setzen Sie die Pfadvariablen database und schema Pfad-Variablen, um die Umgebungsvariablen ({{default_db}} und {{default_schema}}) zu verwenden, die Sie in den Gemeinsame Einrichtung für Snowflake REST APIs-Tutorials -Tutorials festgelegt haben.

    ../../../_images/execute-task.png

Weitere Informationen finden Sie in der Snowflake-Aufgabe-API-Referenz.

Diagramme abschließen

Bemerkung

In diesem Tutorial wird davon ausgegangen, dass Sie ein Standard-Warehouse definiert haben.

Sie können die Aufgabe-API verwenden, um Details zu abgeschlossenen Diagrammausführungen zu erhalten.

Um Details zu abgeschlossenen Diagrammausführungen für eine Aufgabe zurückzugeben, senden Sie eine GET-Anfrage an den /api/v2/databases/{database}/schemas/{schema}/tasks/{name}:execute Endpunkt, wie gezeigt:

  • Auf der Params-Registerkarte gehen Sie wie folgt vor:

    • Setzen Sie die Abfrageparameter resultLimit und errorOnly auf 5 bzw. false.

    • Setzen Sie die Variablen Datenbank, Schema und Name Pfad, um die Umgebungsvariablen zu verwenden ({{default_db}}, {{default_schema}} und {{test_task_name}}), die Sie in den Gemeinsame Einrichtung für Snowflake REST APIs-Tutorials-Tutorials festgelegt haben.

    ../../../_images/complete-graphs.png

Weitere Informationen finden Sie in der Snowflake-Aufgabe-API-Referenz.

Eine untergeordnete Aufgabe erstellen

Sie können die Aufgabe-API verwenden, um eine untergeordnete Aufgabe für eine bestehende Snowflake-Aufgabe zu erstellen.

Um eine untergeordnete Aufgabe zu erstellen, senden Sie eine POST-Anfrage an den Endpunkt /api/v2/databases/{database}/schemas/{schema}/tasks, wie gezeigt:

  • Setzen Sie auf der Registerkarte Params den Parameter createMode auf oderReplace, und setzen Sie die Pfadvariablen database und schema Pfadvariablen, um die Umgebungsvariablen ({{default_db}} und {{default_schema}}) zu verwenden, die Sie in den Gemeinsame Einrichtung für Snowflake REST APIs-Tutorials-Tutorials festgelegt haben.

    ../../../_images/create-task-params.png
  • Fügen Sie auf der Body-Registerkarte den Body der Anfrage wie gezeigt hinzu. Der Parameter name gibt den Namen der untergeordneten Aufgabe an und predecessors identifiziert den Namen des übergeordneten Objekts.

    {
      "name": "test_child_task",
      "definition": "SELECT 1",
      "warehouse": "{{default_wh}}",
      "predecessors": "{{test_task_name}}"
    }
    
    Copy
    ../../../_images/create-child-task.png

Weitere Informationen finden Sie in der Snowflake-Aufgabe-API-Referenz.

Abhängige Aufgaben eines übergeordneten Objekts abrufen

Bemerkung

In diesem Tutorial wird davon ausgegangen, dass Sie ein Standard-Warehouse definiert haben.

Sie können die Aufgabe-API verwenden, um die untergeordnete (abhängige) Aufgabe einer Snowflake- Aufgabe abzurufen.

Um Details über eine untergeordnete (abhängige) Aufgabe abzurufen, senden Sie eine GET-Anfrage an den Endpunkt /api/v2/databases/{database}/schemas/{schema}/tasks/{name}/dependents, wie gezeigt:

  • Setzen Sie auf der Params-Registerkarte den Parameter rekursiv Abfrage auf true, und setzen Sie die Parameter Datenbank, schema und name Pfadvariablen, um die Umgebungsvariablen ({{default_db}}, {{default_schema}}, und {{test_task_name}}) zu verwenden, die Sie in den Gemeinsame Einrichtung für Snowflake REST APIs-Tutorials-Tutorials festgelegt haben.

    ../../../_images/get-task-dependents.png

    Beachten Sie, dass das Ergebnis sowohl das übergeordnete Objekt als auch dessen untergeordnete Aufgabe enthält.

Weitere Informationen finden Sie in der Snowflake-Aufgabe-API-Referenz.

Nächste Schritte

Herzlichen Glückwunsch! In diesem Tutorial haben Sie die Grundlagen für das Management von Snowflake Warehouse- und Aufgabenressourcen mithilfe von Snowflake REST APIs kennengelernt.

Zusammenfassung

Dabei haben Sie die folgenden Schritte durchgeführt:

  • Ein Warehouse erstellen.

  • Eine Aufgabe erstellen.

  • Eine Aufgabe abrufen.

  • Löschen Sie eine Aufgabe.

  • Aufgabe ausführen.

  • Diagrammausführungen abschließen.

  • Eine untergeordnete Aufgabe erstellen.

  • Abhängige Aufgaben eines übergeordneten Objekts abrufen.