Pipeline Run - Query Activity Runs

Hizmet:: Synapse

API Sürümü:: 2020-12-01

Sorgu etkinliği, giriş filtresi koşullarına göre çalıştırılır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	Çalışma alanı geliştirme uç noktası, örneğin `https://myworkspace.dev.azuresynapse.net`.
pipelineName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	İşlem hattı adı.
runId	path	True	string	İşlem hattı çalıştırma tanımlayıcısı.
api-version	query	True	string	Synapse istemci API Sürümü.

İstek Gövdesi

Name	Gerekli	Tür	Description
lastUpdatedAfter	True	string (date-time)	Çalıştırma olayının 'ISO 8601' biçiminde güncelleştirildiği veya sonrasındaki saat.
lastUpdatedBefore	True	string (date-time)	Çalıştırma olayının 'ISO 8601' biçiminde güncelleştirildiği saat veya öncesinde.
continuationToken		string	Sonuçların sonraki sayfasını almak için devam belirteci. İlk sayfa için null.
filters		RunQueryFilter[]	Filtre listesi.
orderBy		RunQueryOrderBy[]	OrderBy seçeneğinin listesi.

Yanıtlar

Name	Tür	Description
200 OK	ActivityRunsQueryResponse	TAMAM.
Other Status Codes	CloudError	Azure Synapse hizmetinden alınan bir hata yanıtı.

Örnekler

ActivityRuns_QueryByPipelineRun

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
    }
  ]
}

Tanımlar

Name	Description
ActivityRun	İşlem hattındaki bir etkinlik çalıştırması hakkında bilgi.
ActivityRunsQueryResponse	Liste etkinliği çalıştırılır.
CloudError	Azure Synapse hata yanıtının yapısını tanımlayan nesne.
RunFilterParameters	Çalıştırmaları listelemek için sorgu parametreleri.
RunQueryFilter	Çalıştırmaları listelemek için sorgu filtresi seçeneği.
RunQueryFilterOperand	Filtre için kullanılacak parametre adı. İşlem hattı çalıştırmalarını sorgulamak için izin verilen işlenenler PipelineName, RunStart, RunEnd ve Status'dır; sorgu etkinlik çalıştırmaları ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType ve Status şeklindedir ve tetikleyici çalıştırmalarını sorgulamak için TriggerName, TriggerRunTimestamp ve Status'dır.
RunQueryFilterOperator	Filtre için kullanılacak işleç.
RunQueryOrder	Parametrenin sıralama düzeni.
RunQueryOrderBy	Çalıştırmaları listelemek için sıralama seçenekleri sağlayan bir nesne.
RunQueryOrderByField	Sipariş için kullanılacak parametre adı. İşlem hattı çalıştırmaları için sıralanması gereken izin verilen parametreler PipelineName, RunStart, RunEnd ve Status parametreleridir; etkinlik çalıştırmaları için ActivityName, ActivityRunStart, ActivityRunEnd ve Status; tetikleyici çalıştırmaları için TriggerName, TriggerRunTimestamp ve Status'dır.

ActivityRun

Object

İşlem hattındaki bir etkinlik çalıştırması hakkında bilgi.

Name	Tür	Description
activityName	string	Etkinlik adı.
activityRunEnd	string (date-time)	Etkinliğin bitiş saati 'ISO 8601' biçiminde çalıştırılır.
activityRunId	string	Etkinlik çalıştırmasının kimliği.
activityRunStart	string (date-time)	Etkinliğin başlangıç saati 'ISO 8601' biçiminde çalıştırılır.
activityType	string	Etkinliğin türü.
durationInMs	integer	Etkinlik çalıştırmasının süresi.
error	object	Etkinlik çalıştırmasından herhangi biri varsa hata.
input	object	Etkinliğin girişi.
linkedServiceName	string	İşlem bağlantılı hizmetinin adı.
output	object	Etkinliğin çıktısı.
pipelineName	string	İşlem hattının adı.
pipelineRunId	string	İşlem hattı çalıştırmasının kimliği.
status	string	Etkinlik çalıştırmasının durumu.

ActivityRunsQueryResponse

Object

Liste etkinliği çalıştırılır.

Name	Tür	Description
continuationToken	string	Kalan sonuçlar varsa bir sonraki sonuç sayfasını almaya yönelik devamlılık belirteci, aksi takdirde null olur.
value	ActivityRun[]	Etkinlik çalıştırmalarının listesi.

CloudError

Object

Azure Synapse hata yanıtının yapısını tanımlayan nesne.

Name	Tür	Description
error.code	string	Hata kodu.
error.details	CloudError[]	Ek hata ayrıntıları içeren dizi.
error.message	string	Hata mesajı.
error.target	string	Hatayla ilişkili istekte özellik adı/yolu.

RunFilterParameters

Object

Çalıştırmaları listelemek için sorgu parametreleri.

Name	Tür	Description
continuationToken	string	Sonuçların sonraki sayfasını almak için devam belirteci. İlk sayfa için null.
filters	RunQueryFilter[]	Filtre listesi.
lastUpdatedAfter	string (date-time)	Çalıştırma olayının 'ISO 8601' biçiminde güncelleştirildiği veya sonrasındaki saat.
lastUpdatedBefore	string (date-time)	Çalıştırma olayının 'ISO 8601' biçiminde güncelleştirildiği saat veya öncesinde.
orderBy	RunQueryOrderBy[]	OrderBy seçeneğinin listesi.

RunQueryFilter

Object

Çalıştırmaları listelemek için sorgu filtresi seçeneği.

Name	Tür	Description
operand	RunQueryFilterOperand	Filtre için kullanılacak parametre adı. İşlem hattı çalıştırmalarını sorgulamak için izin verilen işlenenler PipelineName, RunStart, RunEnd ve Status'dır; sorgu etkinlik çalıştırmaları ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType ve Status şeklindedir ve tetikleyici çalıştırmalarını sorgulamak için TriggerName, TriggerRunTimestamp ve Status'dır.
operator	RunQueryFilterOperator	Filtre için kullanılacak işleç.
values	string[]	Filtre değerlerinin listesi.

RunQueryFilterOperand

Listeleme

Filtre için kullanılacak parametre adı. İşlem hattı çalıştırmalarını sorgulamak için izin verilen işlenenler PipelineName, RunStart, RunEnd ve Status'dır; sorgu etkinlik çalıştırmaları ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType ve Status şeklindedir ve tetikleyici çalıştırmalarını sorgulamak için TriggerName, TriggerRunTimestamp ve Status'dır.

Değer	Description
PipelineName
Status
RunStart
RunEnd
ActivityName
ActivityRunStart
ActivityRunEnd
ActivityType
TriggerName
TriggerRunTimestamp
RunGroupId
LatestOnly

RunQueryFilterOperator

Listeleme

Filtre için kullanılacak işleç.

Değer	Description
Equals
NotEquals
In
NotIn

RunQueryOrder

Listeleme

Parametrenin sıralama düzeni.

Değer	Description
ASC
DESC

RunQueryOrderBy

Object

Çalıştırmaları listelemek için sıralama seçenekleri sağlayan bir nesne.

Name	Tür	Description
order	RunQueryOrder	Parametrenin sıralama düzeni.
orderBy	RunQueryOrderByField	Sipariş için kullanılacak parametre adı. İşlem hattı çalıştırmaları için sıralanması gereken izin verilen parametreler PipelineName, RunStart, RunEnd ve Status parametreleridir; etkinlik çalıştırmaları için ActivityName, ActivityRunStart, ActivityRunEnd ve Status; tetikleyici çalıştırmaları için TriggerName, TriggerRunTimestamp ve Status'dır.

RunQueryOrderByField

Listeleme

Sipariş için kullanılacak parametre adı. İşlem hattı çalıştırmaları için sıralanması gereken izin verilen parametreler PipelineName, RunStart, RunEnd ve Status parametreleridir; etkinlik çalıştırmaları için ActivityName, ActivityRunStart, ActivityRunEnd ve Status; tetikleyici çalıştırmaları için TriggerName, TriggerRunTimestamp ve Status'dır.

Değer	Description
RunStart
RunEnd
PipelineName
Status
ActivityName
ActivityRunStart
ActivityRunEnd
TriggerName
TriggerRunTimestamp

Aracılığıyla paylaş

Pipeline Run - Query Activity Runs

URI Parametreleri

İstek Gövdesi

Yanıtlar

Örnekler

ActivityRuns_QueryByPipelineRun

Örnek isteği

Örnek yanıt

Tanımlar

ActivityRun

ActivityRunsQueryResponse

CloudError

RunFilterParameters

RunQueryFilter

RunQueryFilterOperand

RunQueryFilterOperator

RunQueryOrder

RunQueryOrderBy

RunQueryOrderByField