Pipeline Run - Query Activity Runs

Referencia

Szolgáltatás:: Synapse

API-verzió:: 2020-12-01

A lekérdezési tevékenység a bemeneti szűrő feltételei alapján fut.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A munkaterület fejlesztési végpontja, például `https://myworkspace.dev.azuresynapse.net`.
pipelineName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	A csővezeték neve.
runId	path	True	string	A folyamatfuttatás azonosítója.
api-version	query	True	string	A Synapse ügyfél API-verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
lastUpdatedAfter	True	string (date-time)	Az az időpont, amikor a futtatási esemény "ISO 8601" formátumban frissült.
lastUpdatedBefore	True	string (date-time)	Az az időpont, amikor a futtatási esemény "ISO 8601" formátumban frissült.
continuationToken		string	A folytatási jogkivonat az eredmények következő oldalának lekéréséhez. Null érték az első oldalhoz.
filters		RunQueryFilter[]	Szűrők listája.
orderBy		RunQueryOrderBy[]	Az OrderBy beállítás listája.

Válaszok

Name	Típus	Description
200 OK	ActivityRunsQueryResponse	OKÉ.
Other Status Codes	CloudError	Hibaválasz érkezett az Azure Synapse szolgáltatástól.

Példák

ActivityRuns_QueryByPipelineRun

Mintakérelem

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"
}

Mintaválasz

Állapotkó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"
    }
  ]
}

Definíciók

Name	Description
ActivityRun	Információk egy folyamatban futó tevékenységről.
ActivityRunsQueryResponse	Egy listatevékenység fut.
CloudError	Az Azure Synapse-hibaválasz szerkezetét meghatározó objektum.
RunFilterParameters	Listafuttatások lekérdezési paraméterei.
RunQueryFilter	Lekérdezésszűrő beállítás listafuttatásokhoz.
RunQueryFilterOperand	A szűrőhöz használandó paraméternév. A folyamatfuttatások lekérdezéséhez engedélyezett operandusok a Következők: PipelineName, RunStart, RunEnd és Status; a lekérdezési tevékenységfuttatások a következők: ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType és Status, valamint a lekérdezési eseményindító-futtatások: TriggerName, TriggerRunTimestamp és Status.
RunQueryFilterOperator	Szűrőhöz használandó operátor.
RunQueryOrder	A paraméter rendezési sorrendje.
RunQueryOrderBy	Egy objektum, amely a listafuttatások beállításai alapján adja meg a sorrendet.
RunQueryOrderByField	A rendeléshez használandó paraméternév. A folyamatfuttatások számára engedélyezett paraméterek a PipelineName, a RunStart, a RunEnd és az Status; tevékenységfuttatások esetén: ActivityName, ActivityRunStart, ActivityRunEnd és Status; az eseményindító-futtatások esetében a TriggerName, a TriggerRunTimestamp és az Állapot.

ActivityRun

Objektum

Információk egy folyamatban futó tevékenységről.

Name	Típus	Description
activityName	string	A tevékenység neve.
activityRunEnd	string (date-time)	A tevékenység befejezési ideje "ISO 8601" formátumban fut.
activityRunId	string	A tevékenységfuttatás azonosítója.
activityRunStart	string (date-time)	A tevékenység kezdő időpontja "ISO 8601" formátumban fut.
activityType	string	A tevékenység típusa.
durationInMs	integer	A tevékenység futásának időtartama.
error	object	A hiba, ha a tevékenység fut.
input	object	A tevékenység bemenete.
linkedServiceName	string	A számítási társított szolgáltatás neve.
output	object	A tevékenység kimenete.
pipelineName	string	A folyamat neve.
pipelineRunId	string	A folyamatfuttatás azonosítója.
status	string	A tevékenységfuttatás állapota.

ActivityRunsQueryResponse

Objektum

Egy listatevékenység fut.

Name	Típus	Description
continuationToken	string	A folytatási jogkivonat az eredmények következő oldalának lekéréséhez, ha vannak még eredmények, null értékű.
value	ActivityRun[]	A tevékenységfuttatások listája.

CloudError

Objektum

Az Azure Synapse-hibaválasz szerkezetét meghatározó objektum.

Name	Típus	Description
error.code	string	Hibakód.
error.details	CloudError[]	Tömb további hibaadatokkal.
error.message	string	Hibaüzenet.
error.target	string	A kérelemben szereplő tulajdonság neve/elérési útja hibával van társítva.

RunFilterParameters

Objektum

Listafuttatások lekérdezési paraméterei.

Name	Típus	Description
continuationToken	string	A folytatási jogkivonat az eredmények következő oldalának lekéréséhez. Null érték az első oldalhoz.
filters	RunQueryFilter[]	Szűrők listája.
lastUpdatedAfter	string (date-time)	Az az időpont, amikor a futtatási esemény "ISO 8601" formátumban frissült.
lastUpdatedBefore	string (date-time)	Az az időpont, amikor a futtatási esemény "ISO 8601" formátumban frissült.
orderBy	RunQueryOrderBy[]	Az OrderBy beállítás listája.

RunQueryFilter

Objektum

Lekérdezésszűrő beállítás listafuttatásokhoz.

Name	Típus	Description
operand	RunQueryFilterOperand	A szűrőhöz használandó paraméternév. A folyamatfuttatások lekérdezéséhez engedélyezett operandusok a Következők: PipelineName, RunStart, RunEnd és Status; a lekérdezési tevékenységfuttatások a következők: ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType és Status, valamint a lekérdezési eseményindító-futtatások: TriggerName, TriggerRunTimestamp és Status.
operator	RunQueryFilterOperator	Szűrőhöz használandó operátor.
values	string[]	Szűrőértékek listája.

RunQueryFilterOperand

Enumerálás

A szűrőhöz használandó paraméternév. A folyamatfuttatások lekérdezéséhez engedélyezett operandusok a Következők: PipelineName, RunStart, RunEnd és Status; a lekérdezési tevékenységfuttatások a következők: ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType és Status, valamint a lekérdezési eseményindító-futtatások: TriggerName, TriggerRunTimestamp és Status.

Érték	Description
ActivityName
ActivityRunEnd
ActivityRunStart
ActivityType
LatestOnly
PipelineName
RunEnd
RunGroupId
RunStart
Status
TriggerName
TriggerRunTimestamp

RunQueryFilterOperator

Enumerálás

Szűrőhöz használandó operátor.

Érték	Description
Equals
In
NotEquals
NotIn

RunQueryOrder

Enumerálás

A paraméter rendezési sorrendje.

Érték	Description
ASC
DESC

RunQueryOrderBy

Objektum

Egy objektum, amely a listafuttatások beállításai alapján adja meg a sorrendet.

Name	Típus	Description
order	RunQueryOrder	A paraméter rendezési sorrendje.
orderBy	RunQueryOrderByField	A rendeléshez használandó paraméternév. A folyamatfuttatások számára engedélyezett paraméterek a PipelineName, a RunStart, a RunEnd és az Status; tevékenységfuttatások esetén: ActivityName, ActivityRunStart, ActivityRunEnd és Status; az eseményindító-futtatások esetében a TriggerName, a TriggerRunTimestamp és az Állapot.

RunQueryOrderByField

Enumerálás

A rendeléshez használandó paraméternév. A folyamatfuttatások számára engedélyezett paraméterek a PipelineName, a RunStart, a RunEnd és az Status; tevékenységfuttatások esetén: ActivityName, ActivityRunStart, ActivityRunEnd és Status; az eseményindító-futtatások esetében a TriggerName, a TriggerRunTimestamp és az Állapot.

Érték	Description
ActivityName
ActivityRunEnd
ActivityRunStart
PipelineName
RunEnd
RunStart
Status
TriggerName
TriggerRunTimestamp

Megosztás a következőn keresztül:

Pipeline Run - Query Activity Runs

URI-paraméterek

Kérelem törzse

Válaszok

Példák

ActivityRuns_QueryByPipelineRun

Mintakérelem

Mintaválasz

Definíciók

ActivityRun

ActivityRunsQueryResponse

CloudError

RunFilterParameters

RunQueryFilter

RunQueryFilterOperand

RunQueryFilterOperator

RunQueryOrder

RunQueryOrderBy

RunQueryOrderByField

További források