Pipeline Run - Query Activity Runs

Služba:: Synapse

Verze rozhraní API:: 2020-12-01

Aktivita dotazu se spouští na základě podmínek vstupního filtru.

POST {endpoint}/pipelines/{pipelineName}/pipelineruns/{runId}/queryActivityruns?api-version=2020-12-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Koncový bod vývoje pracovního prostoru, například `https://myworkspace.dev.azuresynapse.net`.
pipelineName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	Název kanálu.
runId	path	True	string	Identifikátor spuštění kanálu.
api-version	query	True	string	Verze rozhraní API klienta Synapse.

Text požadavku

Name	Vyžadováno	Typ	Description
lastUpdatedAfter	True	string (date-time)	Čas, po kterém byla událost spuštění aktualizována ve formátu ISO 8601.
lastUpdatedBefore	True	string (date-time)	Čas aktualizace události spuštění ve formátu ISO 8601 nebo před tím.
continuationToken		string	Token pokračování pro získání další stránky výsledků. Null pro první stránku.
filters		RunQueryFilter[]	Seznam filtrů
orderBy		RunQueryOrderBy[]	Seznam možností OrderBy.

Odpovědi

Name	Typ	Description
200 OK	ActivityRunsQueryResponse	OK.
Other Status Codes	CloudError	Odpověď na chybu přijatá ze služby Azure Synapse

Příklady

ActivityRuns_QueryByPipelineRun

Ukázkový požadavek

HTTP

POST exampleWorkspace.dev.azuresynapse.net/pipelines/examplePipeline/pipelineruns/2f7fdb90-5df1-4b8e-ac2f-064cfa58202b/queryActivityruns?api-version=2020-12-01

{
  "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z",
  "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z"
}

Ukázková odpověď

Stavový kód:: 200

Date: Sat, 16 Jun 2018 00:40:13 GMT
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-writes: 1187
x-ms-request-id: 5465cf41-2e71-4ce6-8db4-9de1b92ffda9
x-ms-correlation-request-id: 5465cf41-2e71-4ce6-8db4-9de1b92ffda9

{
  "value": [
    {
      "activityRunEnd": "2018-06-16T00:38:11.5445431Z",
      "activityName": "ExampleForeachActivity",
      "activityRunStart": "2018-06-16T00:37:49.4804925Z",
      "activityType": "ForEach",
      "durationInMs": 22064,
      "retryAttempt": null,
      "error": {
        "errorCode": "",
        "message": "",
        "failureType": "",
        "target": "ExampleForeachActivity"
      },
      "activityRunId": "f30c5514-fb85-43ed-9fa4-768d42e58680",
      "input": {},
      "linkedServiceName": "",
      "output": {},
      "userProperties": {},
      "pipelineName": "examplePipeline",
      "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
      "status": "Succeeded"
    },
    {
      "activityRunEnd": "2018-06-16T00:38:07.4188923Z",
      "activityName": "ExampleCopyActivity",
      "activityRunStart": "2018-06-16T00:37:50.2460952Z",
      "activityType": "Copy",
      "durationInMs": 17172,
      "retryAttempt": null,
      "error": {
        "errorCode": "",
        "message": "",
        "failureType": "",
        "target": "ExampleCopyActivity"
      },
      "activityRunId": "a96678c8-7167-4f00-b629-afccfbad4e51",
      "input": {
        "source": {
          "type": "BlobSource"
        },
        "sink": {
          "type": "BlobSink"
        },
        "dataIntegrationUnits": 32
      },
      "linkedServiceName": "",
      "output": {
        "dataRead": 142000,
        "dataWritten": 142000,
        "filesRead": 1,
        "filesWritten": 1,
        "copyDuration": 6,
        "throughput": 23.112,
        "errors": [],
        "effectiveIntegrationRuntime": "DefaultIntegrationRuntime (East US)",
        "usedCloudDataMovementUnits": 4,
        "usedParallelCopies": 1,
        "executionDetails": [
          {
            "source": {
              "type": "AzureBlob"
            },
            "sink": {
              "type": "AzureBlob"
            },
            "status": "Succeeded",
            "start": "2018-06-16T00:37:50.68834Z",
            "duration": 6,
            "usedCloudDataMovementUnits": 4,
            "usedParallelCopies": 1,
            "detailedDurations": {
              "queuingDuration": 4,
              "transferDuration": 2
            }
          }
        ]
      },
      "userProperties": {},
      "pipelineName": "examplePipeline",
      "pipelineRunId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b",
      "status": "Succeeded"
    }
  ]
}

Definice

Name	Description
ActivityRun	Informace o spuštění aktivity v kanálu
ActivityRunsQueryResponse	Spustí se aktivita seznamu.
CloudError	Objekt, který definuje strukturu odpovědi na chybu Azure Synapse.
RunFilterParameters	Parametry dotazu pro výpis spuštění
RunQueryFilter	Možnost filtru dotazu pro spuštění výpisu
RunQueryFilterOperand	Název parametru, který se má použít pro filtr. Povolené operandy pro dotazování spuštění kanálu jsou PipelineName, RunStart, RunEnd a Status; Spuštění aktivit dotazů jsou ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType a Status a spuštění triggeru dotazu jsou TriggerName, TriggerRunTimestamp a Status.
RunQueryFilterOperator	Operátor, který se má použít pro filtr.
RunQueryOrder	Pořadí řazení parametru
RunQueryOrderBy	Objekt, který poskytuje pořadí podle možností pro výpis spuštění.
RunQueryOrderByField	Název parametru, který se má použít pro řazení podle. Povolené parametry pro řazení podle spuštění kanálu jsou PipelineName, RunStart, RunEnd a Status; Pro spuštění aktivit jsou ActivityName, ActivityRunStart, ActivityRunEnd a Status; Pro spuštění triggeru jsou TriggerName, TriggerRunTimestamp a Status.

ActivityRun

Objekt

Informace o spuštění aktivity v kanálu

Name	Typ	Description
activityName	string	Název aktivity.
activityRunEnd	string (date-time)	Koncový čas spuštění aktivity ve formátu ISO 8601.
activityRunId	string	ID spuštění aktivity.
activityRunStart	string (date-time)	Počáteční čas spuštění aktivity ve formátu ISO 8601.
activityType	string	Typ aktivity.
durationInMs	integer	Doba trvání spuštění aktivity.
error	object	Chyba, pokud je spuštěna nějaká aktivita.
input	object	Vstup pro aktivitu.
linkedServiceName	string	Název propojené služby výpočetních prostředků.
output	object	Výstup aktivity.
pipelineName	string	Název kanálu.
pipelineRunId	string	ID spuštění kanálu.
status	string	Stav spuštění aktivity.

ActivityRunsQueryResponse

Objekt

Spustí se aktivita seznamu.

Name	Typ	Description
continuationToken	string	Token pro pokračování pro získání další stránky výsledků, pokud existují nějaké zbývající výsledky, null jinak.
value	ActivityRun[]	Seznam spuštění aktivit

CloudError

Objekt

Objekt, který definuje strukturu odpovědi na chybu Azure Synapse.

Name	Typ	Description
error.code	string	Kód chyby
error.details	CloudError[]	Pole s dalšími podrobnostmi o chybě
error.message	string	Zpráva o chybě.
error.target	string	Název vlastnosti nebo cesta v požadavku přidruženém k chybě.

RunFilterParameters

Objekt

Parametry dotazu pro výpis spuštění

Name	Typ	Description
continuationToken	string	Token pokračování pro získání další stránky výsledků. Null pro první stránku.
filters	RunQueryFilter[]	Seznam filtrů
lastUpdatedAfter	string (date-time)	Čas, po kterém byla událost spuštění aktualizována ve formátu ISO 8601.
lastUpdatedBefore	string (date-time)	Čas aktualizace události spuštění ve formátu ISO 8601 nebo před tím.
orderBy	RunQueryOrderBy[]	Seznam možností OrderBy.

RunQueryFilter

Objekt

Možnost filtru dotazu pro spuštění výpisu

Name	Typ	Description
operand	RunQueryFilterOperand	Název parametru, který se má použít pro filtr. Povolené operandy pro dotazování spuštění kanálu jsou PipelineName, RunStart, RunEnd a Status; Spuštění aktivit dotazů jsou ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType a Status a spuštění triggeru dotazu jsou TriggerName, TriggerRunTimestamp a Status.
operator	RunQueryFilterOperator	Operátor, který se má použít pro filtr.
values	string[]	Seznam hodnot filtru

RunQueryFilterOperand

Výčet

Název parametru, který se má použít pro filtr. Povolené operandy pro dotazování spuštění kanálu jsou PipelineName, RunStart, RunEnd a Status; Spuštění aktivit dotazů jsou ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType a Status a spuštění triggeru dotazu jsou TriggerName, TriggerRunTimestamp a Status.

Hodnota	Description
PipelineName
Status
RunStart
RunEnd
ActivityName
ActivityRunStart
ActivityRunEnd
ActivityType
TriggerName
TriggerRunTimestamp
RunGroupId
LatestOnly

RunQueryFilterOperator

Výčet

Operátor, který se má použít pro filtr.

Hodnota	Description
Equals
NotEquals
In
NotIn

RunQueryOrder

Výčet

Pořadí řazení parametru

Hodnota	Description
ASC
DESC

RunQueryOrderBy

Objekt

Objekt, který poskytuje pořadí podle možností pro výpis spuštění.

Name	Typ	Description
order	RunQueryOrder	Pořadí řazení parametru
orderBy	RunQueryOrderByField	Název parametru, který se má použít pro řazení podle. Povolené parametry pro řazení podle spuštění kanálu jsou PipelineName, RunStart, RunEnd a Status; Pro spuštění aktivit jsou ActivityName, ActivityRunStart, ActivityRunEnd a Status; Pro spuštění triggeru jsou TriggerName, TriggerRunTimestamp a Status.

RunQueryOrderByField

Výčet

Název parametru, který se má použít pro řazení podle. Povolené parametry pro řazení podle spuštění kanálu jsou PipelineName, RunStart, RunEnd a Status; Pro spuštění aktivit jsou ActivityName, ActivityRunStart, ActivityRunEnd a Status; Pro spuštění triggeru jsou TriggerName, TriggerRunTimestamp a Status.

Hodnota	Description
RunStart
RunEnd
PipelineName
Status
ActivityName
ActivityRunStart
ActivityRunEnd
TriggerName
TriggerRunTimestamp

Sdílet prostřednictvím

Pipeline Run - Query Activity Runs

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

ActivityRuns_QueryByPipelineRun

Ukázkový požadavek

Ukázková odpověď

Definice

ActivityRun

ActivityRunsQueryResponse

CloudError

RunFilterParameters

RunQueryFilter

RunQueryFilterOperand

RunQueryFilterOperator

RunQueryOrder

RunQueryOrderBy

RunQueryOrderByField