Share via

Activity Runs - Query By Pipeline Run

  • リファレンス
Service:
Data Factory
API Version:
2018-06-01

クエリ アクティビティは、入力フィルター条件に基づいて実行されます。

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

URI パラメーター

名前 / 必須 型 説明
factoryName
 path True

string

ファクトリ名。

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

string

リソース グループ名。

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

string

パイプライン実行識別子。
subscriptionId
 path True

string

サブスクリプションの識別子です。
api-version
 query True

string

API のバージョン。

要求本文

名前 必須 型 説明
lastUpdatedAfter True

string

実行イベントが 'ISO 8601' 形式で更新された日時。
lastUpdatedBefore True

string

実行イベントが 'ISO 8601' 形式で更新された時点またはそれ以前の時刻。
continuationToken

string

結果の次のページを取得するための継続トークン。 最初のページの場合は Null。
filters

RunQueryFilter[]

フィルターの一覧。
orderBy

RunQueryOrderBy[]

OrderBy オプションの一覧。

応答

名前 型 説明
200 OK

ActivityRunsQueryResponse

OK です。
Other Status Codes

CloudError

Azure Data Factory サービスから受信したエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

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

Status code:
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
Response Body
{
  "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"
    }
  ]
}

定義

名前 説明
ActivityRun

パイプラインでのアクティビティの実行に関する情報。
ActivityRunsQueryResponse

リスト アクティビティが実行されます。
CloudError

Azure Data Factoryエラー応答の構造を定義する オブジェクト。
RunFilterParameters

実行を一覧表示するためのクエリ パラメーター。
RunQueryFilter

実行を一覧表示するためのクエリ フィルター オプション。
RunQueryFilterOperand

フィルターに使用するパラメーター名。 パイプラインの実行のクエリに使用できるオペランドは、PipelineName、RunStart、RunEnd、Status です。クエリ アクティビティの実行は ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType、Status であり、クエリ トリガーの実行は TriggerName、TriggerRunTimestamp、Status です。
RunQueryFilterOperator

フィルターに使用する演算子。
RunQueryOrder

パラメーターの並べ替え順序。
RunQueryOrderBy

実行を一覧表示するためのオプション別の順序を指定する オブジェクト。
RunQueryOrderByField

順序に使用するパラメーター名。 パイプラインの実行に対して順序付けできるパラメーターは、PipelineName、RunStart、RunEnd、Status です。アクティビティの実行は、ActivityName、ActivityRunStart、ActivityRunEnd、Status です。トリガーの実行は、TriggerName、TriggerRunTimestamp、および Status です。

ActivityRun

パイプラインでのアクティビティの実行に関する情報。

名前 型 説明
activityName

string

アクティビティの名前。
activityRunEnd

string

アクティビティの終了時刻は、'ISO 8601' 形式で実行されます。
activityRunId

string

アクティビティ実行の ID。
activityRunStart

string

アクティビティ実行の開始時刻を 'ISO 8601' 形式で指定します。
activityType

string

アクティビティの種類。
durationInMs

integer

アクティビティの実行時間。
error

object

アクティビティが実行された場合のエラー。
input

object

アクティビティの入力。
linkedServiceName

string

コンピューティングのリンクされたサービスの名前。
output

object

アクティビティの出力。
pipelineName

string

パイプラインの名前。
pipelineRunId

string

パイプライン実行の ID。
status

string

アクティビティの実行の状態。

ActivityRunsQueryResponse

リスト アクティビティが実行されます。

名前 型 説明
continuationToken

string

残りの結果が存在する場合は、結果の次のページを取得するための継続トークン。それ以外の場合は null。
value

ActivityRun[]

アクティビティの実行の一覧。

CloudError

Azure Data Factoryエラー応答の構造を定義する オブジェクト。

名前 型 説明
error.code

string

エラー コード。
error.details

CloudError[]

追加のエラーの詳細を含む配列。
error.message

string

エラー メッセージ。
error.target

string

エラーに関連付けられている要求のプロパティ名/パス。

RunFilterParameters

実行を一覧表示するためのクエリ パラメーター。

名前 型 説明
continuationToken

string

結果の次のページを取得するための継続トークン。 最初のページの場合は Null。
filters

RunQueryFilter[]

フィルターの一覧。
lastUpdatedAfter

string

実行イベントが 'ISO 8601' 形式で更新された日時。
lastUpdatedBefore

string

実行イベントが 'ISO 8601' 形式で更新された時点またはそれ以前の時刻。
orderBy

RunQueryOrderBy[]

OrderBy オプションの一覧。

RunQueryFilter

実行を一覧表示するためのクエリ フィルター オプション。

名前 型 説明
operand

RunQueryFilterOperand

フィルターに使用するパラメーター名。 パイプラインの実行のクエリに使用できるオペランドは、PipelineName、RunStart、RunEnd、Status です。クエリ アクティビティの実行は ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType、Status であり、クエリ トリガーの実行は TriggerName、TriggerRunTimestamp、Status です。
operator

RunQueryFilterOperator

フィルターに使用する演算子。
values

string[]

フィルター値の一覧。

RunQueryFilterOperand

フィルターに使用するパラメーター名。 パイプラインの実行のクエリに使用できるオペランドは、PipelineName、RunStart、RunEnd、Status です。クエリ アクティビティの実行は ActivityName、ActivityRunStart、ActivityRunEnd、ActivityType、Status であり、クエリ トリガーの実行は TriggerName、TriggerRunTimestamp、Status です。

名前 型 説明
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

フィルターに使用する演算子。

名前 型 説明
Equals

string

In

string

NotEquals

string

NotIn

string

RunQueryOrder

パラメーターの並べ替え順序。

名前 型 説明
ASC

string

DESC

string

RunQueryOrderBy

実行を一覧表示するためのオプション別の順序を指定する オブジェクト。

名前 型 説明
order

RunQueryOrder

パラメーターの並べ替え順序。
orderBy

RunQueryOrderByField

順序に使用するパラメーター名。 パイプラインの実行に対して順序付けできるパラメーターは、PipelineName、RunStart、RunEnd、Status です。アクティビティの実行は、ActivityName、ActivityRunStart、ActivityRunEnd、Status です。トリガーの実行は、TriggerName、TriggerRunTimestamp、および Status です。

RunQueryOrderByField

順序に使用するパラメーター名。 パイプラインの実行に対して順序付けできるパラメーターは、PipelineName、RunStart、RunEnd、Status です。アクティビティの実行は、ActivityName、ActivityRunStart、ActivityRunEnd、Status です。トリガーの実行は、TriggerName、TriggerRunTimestamp、および Status です。

名前 型 説明
ActivityName

string

ActivityRunEnd

string

ActivityRunStart

string

PipelineName

string

RunEnd

string

RunStart

string

Status

string

TriggerName

string

TriggerRunTimestamp

string