Zdieľať cez

Verejné rozhranie REST API pre údajový kanál služby Microsoft Fabric (Preview)

  • Článok

Dôležité

Rozhranie API služby Microsoft Fabric pre službu Data Factory je v súčasnosti vo verzii Public Preview. Tieto informácie sa týkajú predbežnej verzie produktu, ktorá môže byť pred vydaním podstatne upravená. Spoločnosť Microsoft neposkytuje žiadne záruky, vyjadrené alebo implicitné, na tu uvedené informácie.

V službe Microsoft Fabric pozostávajú rozhrania API služby Data Factory výlučne z operácií CRUD pre kanály a toky údajov. V súčasnosti sú podporované iba údajové kanály. Rozhrania API tokov údajov zatiaľ nie sú k dispozícii. Ďalšie bežné oblasti pre projekty integrácie údajov sú v samostatných rozhraniach API: plány, monitorovanie, pripojenia, majú vlastné rozhrania API v službe Fabric. Primárnu online referenčnú dokumentáciu pre rozhrania Microsoft Fabric REST API nájdete v odkazoch na rozhranie Microsoft Fabric REST API. Pozrite si tiež rozhranie API základných položiek a plánovač úloh.

Definícia položky s kódovanú údajovou časťou base64

  • Použite kódovanie Base64 a Dekódovanie na kódovanie JSON.
  • Skontrolujte, či nie je začiarknuté políčko Vykonať bezpečné kódovanie URL adresy.
  • Definície kanála môžete získať prostredníctvom karty kódu Zobraziť -> Zobraziť JSON v používateľskom rozhraní služby Fabric.
{ 
    "name": "Pipeline_1_updated", 
    "objectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    "properties": { 
        "description": "this is the description", 
        "activities": [ 
            { 
                "name": "Wait1", 
                "type": "Wait", 
                "dependsOn": [], 
                "typeProperties": { 
                    "waitTimeInSeconds": 240 
                } 
            } 
        ], 
        "annotations": [], 
        "lastModifiedByObjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
        "lastPublishTime": "2024-02-01T17:28:02Z" 
    } 
}

Vezmite objekt vlastnosti a obklopte ich zátvorkami – { } , takže údajová časť definície položky REST bude:

{
    "properties": { 
        "description": "this is the description", 
        "activities": [ 
            { 
                "name": "Wait1", 
                "type": "Wait", 
                "dependsOn": [], 
                "typeProperties": { 
                    "waitTimeInSeconds": 240 
                } 
            } 
        ], 
        "annotations": [], 
        "lastModifiedByObjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
        "lastPublishTime": "2024-02-01T17:28:02Z" 
    } 
}

Vytvoriť položku

ROZHRANIE REST API – položky – Vytvoriť položku

Príklad – CreateDataPipeline:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items

Telo:

{ 
  "displayName": "pipeline_1", 
  "type": "DataPipeline" 
}

Poznámka

V dokumentácii sú uvedené iba 2 požadované vlastnosti – displayName a type. Workload-DI v súčasnosti nepodporuje vytváranie aj bez definície . V súčasnosti sa nasadzuje oprava tejto chybnej požiadavky. Teraz môžete odoslať rovnakú predvolenú definíciu, ktorú používa používateľské rozhranie služby Fabric: ‘{"properties":{"activities":[]}}’

Upravený kód JSON vrátane definície:

{ 
  "displayName": "pipeline_1", 
  "type": "DataPipeline", 
  "definition": { 
    "parts": [ 
      { 
        "path": "pipeline-content.json", 
        "payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=", 
        "payloadType": "InlineBase64" 
      } 
    ] 
  } 
}

Odpoveď 201:

{ 
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    "type": "DataPipeline", 
    "displayName": "Pipeline_1", 
    "description": "", 
    "workspaceId": "<Your WS Id>" 
}

Odstrániť položku

ROZHRANIE REST API – položky – Odstránenie položky

Príklad:

DELETE https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>

Odpoveď 200: (Žiadne telo)

Získať položku

ROZHRANIE REST API – položky – Získať položku

Príklad:

GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>

Odpoveď 200:

{ 
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
    "type": "DataPipeline", 
    "displayName": "Pipeline_1", 
    "workspaceId": "<your WS Id>" 
}

Načítanie definície položky

ROZHRANIE REST API – položky – definícia získať položku

Príklad:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/getDefinition

Odpoveď 200:

{ 
    "definition": { 
        "parts":[ 
            { 
                "path": "pipeline-content.json", 
                "payload": "ewogICJwcm9wZXJ0aWVzIjogewogICAgImFjdGl2aXRpZXMiOiBbXQogIH0KfQ==", 
                "payloadType": "InlineBase64" 
            } 
        ] 
    } 
}

Položky zoznamu

ROZHRANIE REST API – položky – položky zoznamu

Príklad:

GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items

Odpoveď 200:

{ 
    "value": [ 
        { 
            "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
            "type": "SemanticModel", 
            "displayName": "deata_lh", 
            "description": "", 
            "workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 
        }, 
        { 
            "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
            "type": "SQLEndpoint", 
            "displayName": "deata_lh", 
            "description": "", 
            "workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 
        }, 
        { 
            "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
            "type": "Lakehouse", 
            "displayName": "deata_lh", 
            "description": "", 
            "workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 
        }, 
        { 
            "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
            "type": "DataPipeline", 
            "displayName": "Pipeline_1", 
            "description": "", 
            "workspaceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 
        } 
    ] 
}

Aktualizovať položku

ROZHRANIE REST API – položky – aktualizovať položku

Príklad:

PATCH https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>

Telo:

{ 
  "displayName": "Pipeline_1_updated", 
  "description": "This is the description." 
}

Odpoveď 200:

{ 
    "id": "<pipeline id>", 
    "type": "DataPipeline", 
    "displayName": "Pipeline_1_updated", 
    "description": "This is the description.", 
    "workspaceId": "<Your WS id>" 
}

Aktualizácia definície položky

ROZHRANIE REST API – položky – aktualizovať definíciu položky

Príklad:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/updateDefinition

Telo:

{ 
  "definition": { 
    "parts": [ 
      { 
        "path": "pipeline-content.json", 
        "payload": "eyJwcm9wZXJ0aWVzIjp7ImFjdGl2aXRpZXMiOltdfX0=", 
        "payloadType": "InlineBase64" 
      } 
    ] 
  } 
}

Odpoveď 200: (Žiadne telo)

Spustenie úlohy položky na požiadanie

ROZHRANIE REST API – položky – spustenie úlohy položky na požiadanie

Príklad:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline

Odpoveď 202: (Žiadne telo)

Príklad s dvomi hodnotami parametrov:

Tu máme aktivitu Čakať s parametrom s názvom param_waitsec na určenie počtu sekúnd čakania.

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances?jobType=Pipeline

Telo:

{ 
  "executionData": { 
    "parameters": {
      "param_waitsec": "10" 
    } 
  } 
}

Odpoveď 202: (Žiadne telo)

Poznámka

V súčasnosti nie je vrátené žiadne telo, ale malo by sa vrátiť ID úlohy. Počas používania verzie Preview ju nájdete vo vrátených hlavičkách vo vlastnosti Location.

Získanie inštancie úlohy položky

Rozhranie REST API – položky – inštancia úlohy získať položku

Príklad:

GET https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>

Odpoveď 200:

{ 
    "id": "4511ffcd-a9f6-4f75-91a9-9ceab08d7539", 
    "itemId": "2bb9fe4a-0a84-4725-a01f-7ac4e6850259", 
    "jobType": "Pipeline", 
    "invokeType": "Manual", 
    "status": "Completed", 
    "failureReason": null, 
    "rootActivityId": "f14bdd95-2cff-4451-b839-bea81509126d", 
    "startTimeUtc": "2024-02-01T03:03:19.8361605", 
    "endTimeUtc": "2024-02-01T03:05:00.3433333" 
}

Zrušenie inštancie úlohy položky

Rozhranie REST API – položky – zrušenie inštancie úlohy položky

Príklad:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/items/<pipeline id>/jobs/instances/<job ID>/cancel

Odpoveď 202: (Žiadne telo)

Poznámka

Po zrušení úlohy môžete skontrolovať stav buď volaním Získať inštanciu úlohy položky alebo pri pohľade na históriu spustenia Zobraziť v používateľskom rozhraní služby Fabric.

Spustenia aktivity dotazu

Príklad:

POST https://api.fabric.microsoft.com/v1/workspaces/<your WS Id>/datapipelines/pipelineruns/<Job ID>/queryactivityruns

Telo:

{
  "filters":[],
  "orderBy":[{"orderBy":"ActivityRunStart","order":"DESC"}],
  "lastUpdatedAfter":"2024-05-22T14:02:04.1423888Z",
  "lastUpdatedBefore":"2024-05-24T13:21:27.738Z"
}

Poznámka

ID úlohy je rovnaké ID, ktoré bolo vytvorené a použité v verejných rozhraniach API plánovača úloh

Odpoveď 200:

[
    {
        "pipelineName": "ca91f97e-5bdd-4fe1-b39a-1f134f26a701",
        "pipelineRunId": "bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
        "activityName": "Wait1",
        "activityType": "Wait",
        "activityRunId": "cccc2c2c-dd3d-ee4e-ff5f-aaaaaa6a6a6a",
        "linkedServiceName": "",
        "status": "Succeeded",
        "activityRunStart": "2024-05-23T13:43:03.6397566Z",
        "activityRunEnd": "2024-05-23T13:43:31.3906179Z",
        "durationInMs": 27750,
        "input": {
            "waitTimeInSeconds": 27
        },
        "output": {},
        "error": {
            "errorCode": "",
            "message": "",
            "failureType": "",
            "target": "Wait1",
            "details": ""
        },
        "retryAttempt": null,
        "iterationHash": "",
        "userProperties": {},
        "recoveryStatus": "None",
        "integrationRuntimeNames": null,
        "executionDetails": null,
        "id": "/SUBSCRIPTIONS/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/RESOURCEGROUPS/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/PROVIDERS/MICROSOFT.TRIDENT/WORKSPACES/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/pipelineruns/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f/activityruns/cccc2c2c-dd3d-ee4e-ff5f-aaaaaa6a6a6a"
    }
]

Známe obmedzenia

  • Overovanie objektu služby (SPN) v súčasnosti nie je podporované.

Súvisiaci obsah