Activity Runs - Query By Pipeline Run

Aktivitas kueri berjalan berdasarkan kondisi filter input.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns?api-version=2018-06-01

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
factoryName
path True

string

Nama pabrik.

Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$

resourceGroupName
path True

string

Nama grup sumber daya.

Regex pattern: ^[-\w\._\(\)]+$

runId
path True

string

Pengidentifikasi eksekusi alur.

subscriptionId
path True

string

Pengidentifikasi langganan.

api-version
query True

string

Versi API.

Isi Permintaan

Nama Diperlukan Jenis Deskripsi
lastUpdatedAfter True

string

Waktu pada atau setelah peristiwa eksekusi diperbarui dalam format 'ISO 8601'.

lastUpdatedBefore True

string

Waktu pada 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

OK.

Other Status Codes

CloudError

Respons kesalahan yang diterima dari layanan Azure Data Factory.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

ActivityRuns_QueryByPipelineRun

Sample Request

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/pipelineruns/2f7fdb90-5df1-4b8e-ac2f-064cfa58202b/queryActivityruns?api-version=2018-06-01

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

Sample Response

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 Data Factory.

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 mengkueri eksekusi aktivitas 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

Mengurutkan urutan 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

Informasi tentang aktivitas yang dijalankan dalam alur.

Nama Jenis Deskripsi
activityName

string

Nama aktivitas.

activityRunEnd

string

Waktu akhir aktivitas berjalan dalam format 'ISO 8601'.

activityRunId

string

Id eksekusi aktivitas.

activityRunStart

string

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

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 yang menentukan struktur respons kesalahan Azure Data Factory.

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

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

Waktu pada atau setelah peristiwa eksekusi diperbarui dalam format 'ISO 8601'.

lastUpdatedBefore

string

Waktu pada atau sebelum peristiwa eksekusi diperbarui dalam format 'ISO 8601'.

orderBy

RunQueryOrderBy[]

Daftar opsi OrderBy.

RunQueryFilter

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 mengkueri eksekusi aktivitas 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

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

Nama Jenis Deskripsi
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

ActivityType

string

LatestOnly

string

PipelineName

string

RunEnd

string

RunGroupId

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string

RunQueryFilterOperator

Operator yang akan digunakan untuk filter.

Nama Jenis Deskripsi
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

Mengurutkan urutan parameter.

Nama Jenis Deskripsi
ASC

string

DESC

string

RunQueryOrderBy

Objek untuk menyediakan urutan berdasarkan opsi untuk mencantumkan eksekusi.

Nama Jenis Deskripsi
order

RunQueryOrder

Mengurutkan urutan 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

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.

Nama Jenis Deskripsi
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string