Pipeline Run - Query Activity Runs

Layanan:: Synapse

Versi API:: 2020-12-01

Aktivitas kueri berjalan berdasarkan kondisi filter input.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	Titik akhir pengembangan ruang kerja, misalnya `https://myworkspace.dev.azuresynapse.net`.
pipelineName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	Nama jalur.
runId	path	True	string	Pengidentifikasi eksekusi alur.
api-version	query	True	string	Versi API klien Synapse.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
lastUpdatedAfter	True	string (date-time)	Waktu pada atau setelah peristiwa eksekusi diperbarui dalam format 'ISO 8601'.
lastUpdatedBefore	True	string (date-time)	Waktu di atau sebelum peristiwa eksekusi diperbarui dalam format 'ISO 8601'.
continuationToken		string	Token kelanjutan untuk mendapatkan halaman hasil berikutnya. Null untuk halaman pertama.
filters		RunQueryFilter[]	Daftar filter.
orderBy		RunQueryOrderBy[]	Daftar opsi OrderBy.

Respons

Nama	Jenis	Deskripsi
200 OK	ActivityRunsQueryResponse	OKE.
Other Status Codes	CloudError	Respons kesalahan diterima dari layanan Azure Synapse.

Contoh

ActivityRuns_QueryByPipelineRun

Permintaan sampel

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

Respon sampel

Kode status:: 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"
    }
  ]
}

Definisi

Nama	Deskripsi
ActivityRun	Informasi tentang aktivitas yang dijalankan dalam alur.
ActivityRunsQueryResponse	Aktivitas daftar berjalan.
CloudError	Objek yang menentukan struktur respons kesalahan Azure Synapse.
RunFilterParameters	Parameter kueri untuk mencantumkan eksekusi.
RunQueryFilter	Opsi filter kueri untuk mencantumkan eksekusi.
RunQueryFilterOperand	Nama parameter yang akan digunakan untuk filter. Operan yang diizinkan untuk mengkueri eksekusi alur adalah PipelineName, RunStart, RunEnd, dan Status; untuk menjalankan aktivitas kueri adalah ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType dan Status, dan untuk mengkueri eksekusi pemicu adalah TriggerName, TriggerRunTimestamp dan Status.
RunQueryFilterOperator	Operator yang akan digunakan untuk filter.
RunQueryOrder	Urutan pengurutan parameter.
RunQueryOrderBy	Objek untuk menyediakan urutan berdasarkan opsi untuk mencantumkan eksekusi.
RunQueryOrderByField	Nama parameter yang akan digunakan untuk urutan berdasarkan. Parameter yang diizinkan untuk diurutkan menurut untuk eksekusi alur adalah PipelineName, RunStart, RunEnd, dan Status; untuk eksekusi aktivitas adalah ActivityName, ActivityRunStart, ActivityRunEnd dan Status; untuk eksekusi pemicu adalah TriggerName, TriggerRunTimestamp, dan Status.

ActivityRun

Objek

Informasi tentang aktivitas yang dijalankan dalam alur.

Nama	Jenis	Deskripsi
activityName	string	Nama aktivitas.
activityRunEnd	string (date-time)	Waktu akhir aktivitas berjalan dalam format 'ISO 8601'.
activityRunId	string	Id eksekusi aktivitas.
activityRunStart	string (date-time)	Waktu mulai aktivitas berjalan dalam format 'ISO 8601'.
activityType	string	Jenis aktivitas.
durationInMs	integer	Durasi eksekusi aktivitas.
error	object	Kesalahan jika ada dari aktivitas yang dijalankan.
input	object	Input untuk aktivitas.
linkedServiceName	string	Nama layanan tertaut komputasi.
output	object	Output untuk aktivitas.
pipelineName	string	Nama alur.
pipelineRunId	string	Id eksekusi alur.
status	string	Status eksekusi aktivitas.

ActivityRunsQueryResponse

Objek

Aktivitas daftar berjalan.

Nama	Jenis	Deskripsi
continuationToken	string	Token kelanjutan untuk mendapatkan halaman hasil berikutnya, jika ada hasil yang tersisa, null sebaliknya.
value	ActivityRun[]	Daftar eksekusi aktivitas.

CloudError

Objek

Objek yang menentukan struktur respons kesalahan Azure Synapse.

Nama	Jenis	Deskripsi
error.code	string	Kode kesalahan.
error.details	CloudError[]	Array dengan detail kesalahan tambahan.
error.message	string	Pesan kesalahan.
error.target	string	Nama/jalur properti dalam permintaan yang terkait dengan kesalahan.

RunFilterParameters

Objek

Parameter kueri untuk mencantumkan eksekusi.

Nama	Jenis	Deskripsi
continuationToken	string	Token kelanjutan untuk mendapatkan halaman hasil berikutnya. Null untuk halaman pertama.
filters	RunQueryFilter[]	Daftar filter.
lastUpdatedAfter	string (date-time)	Waktu pada atau setelah peristiwa eksekusi diperbarui dalam format 'ISO 8601'.
lastUpdatedBefore	string (date-time)	Waktu di atau sebelum peristiwa eksekusi diperbarui dalam format 'ISO 8601'.
orderBy	RunQueryOrderBy[]	Daftar opsi OrderBy.

RunQueryFilter

Objek

Opsi filter kueri untuk mencantumkan eksekusi.

Nama	Jenis	Deskripsi
operand	RunQueryFilterOperand	Nama parameter yang akan digunakan untuk filter. Operan yang diizinkan untuk mengkueri eksekusi alur adalah PipelineName, RunStart, RunEnd, dan Status; untuk menjalankan aktivitas kueri adalah ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType dan Status, dan untuk mengkueri eksekusi pemicu adalah TriggerName, TriggerRunTimestamp dan Status.
operator	RunQueryFilterOperator	Operator yang akan digunakan untuk filter.
values	string[]	Daftar nilai filter.

RunQueryFilterOperand

Enumeration

Nama parameter yang akan digunakan untuk filter. Operan yang diizinkan untuk mengkueri eksekusi alur adalah PipelineName, RunStart, RunEnd, dan Status; untuk menjalankan aktivitas kueri adalah ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType dan Status, dan untuk mengkueri eksekusi pemicu adalah TriggerName, TriggerRunTimestamp dan Status.

Nilai	Deskripsi
PipelineName
Status
RunStart
RunEnd
ActivityName
ActivityRunStart
ActivityRunEnd
ActivityType
TriggerName
TriggerRunTimestamp
RunGroupId
LatestOnly

RunQueryFilterOperator

Enumeration

Operator yang akan digunakan untuk filter.

Nilai	Deskripsi
Equals
NotEquals
In
NotIn

RunQueryOrder

Enumeration

Urutan pengurutan parameter.

Nilai	Deskripsi
ASC
DESC

RunQueryOrderBy

Objek

Objek untuk menyediakan urutan berdasarkan opsi untuk mencantumkan eksekusi.

Nama	Jenis	Deskripsi
order	RunQueryOrder	Urutan pengurutan parameter.
orderBy	RunQueryOrderByField	Nama parameter yang akan digunakan untuk urutan berdasarkan. Parameter yang diizinkan untuk diurutkan menurut untuk eksekusi alur adalah PipelineName, RunStart, RunEnd, dan Status; untuk eksekusi aktivitas adalah ActivityName, ActivityRunStart, ActivityRunEnd dan Status; untuk eksekusi pemicu adalah TriggerName, TriggerRunTimestamp, dan Status.

RunQueryOrderByField

Enumeration

Nama parameter yang akan digunakan untuk urutan berdasarkan. Parameter yang diizinkan untuk diurutkan menurut untuk eksekusi alur adalah PipelineName, RunStart, RunEnd, dan Status; untuk eksekusi aktivitas adalah ActivityName, ActivityRunStart, ActivityRunEnd dan Status; untuk eksekusi pemicu adalah TriggerName, TriggerRunTimestamp, dan Status.

Nilai	Deskripsi
RunStart
RunEnd
PipelineName
Status
ActivityName
ActivityRunStart
ActivityRunEnd
TriggerName
TriggerRunTimestamp

Bagikan melalui

Pipeline Run - Query Activity Runs

Parameter URI

Isi Permintaan

Respons

Contoh

ActivityRuns_QueryByPipelineRun

Permintaan sampel

Respon sampel

Definisi

ActivityRun

ActivityRunsQueryResponse

CloudError

RunFilterParameters

RunQueryFilter

RunQueryFilterOperand

RunQueryFilterOperator

RunQueryOrder

RunQueryOrderBy

RunQueryOrderByField