Pipeline Run - Query Activity Runs

サービス:: Synapse

API バージョン:: 2020-12-01

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

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	ワークスペース開発エンドポイント (`https://myworkspace.dev.azuresynapse.net`など)。
pipelineName	path	True	string minLength: 1 maxLength: 260 pattern: ^[A-Za-z0-9_][^<>#.%&:\\+?/]$	パイプライン名。
runId	path	True	string	パイプライン実行識別子。
api-version	query	True	string	Synapse クライアント API のバージョン。

要求本文

名前	必須	型	説明
lastUpdatedAfter	True	string (date-time)	実行イベントが 'ISO 8601' 形式で更新された時刻以降。
lastUpdatedBefore	True	string (date-time)	実行イベントが 'ISO 8601' 形式で更新された時刻またはそれ以前。
continuationToken		string	結果の次のページを取得するための継続トークン。最初のページの場合は Null。
filters		RunQueryFilter[]	フィルターの一覧。
orderBy		RunQueryOrderBy[]	OrderBy オプションの一覧。

応答

名前	型	説明
200 OK	ActivityRunsQueryResponse	わかりました。
Other Status Codes	CloudError	Azure Synapse サービスから受信したエラー応答。

例

ActivityRuns_QueryByPipelineRun

要求のサンプル

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

応答のサンプル

状態コード:: 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"
    }
  ]
}

定義

名前	説明
ActivityRun	パイプラインでのアクティビティの実行に関する情報。
ActivityRunsQueryResponse	リストアクティビティが実行されます。
CloudError	Azure Synapse エラー応答の構造を定義するオブジェクト。
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

Object

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

名前	型	説明
activityName	string	活動の名前。
activityRunEnd	string (date-time)	アクティビティの終了時刻を 'ISO 8601' 形式で実行します。
activityRunId	string	アクティビティの実行の ID。
activityRunStart	string (date-time)	アクティビティ実行の開始時刻を 'ISO 8601' 形式で指定します。
activityType	string	アクティビティの種類。
durationInMs	integer	アクティビティの実行時間。
error	object	アクティビティが実行された場合のエラー。
input	object	アクティビティの入力。
linkedServiceName	string	コンピューティングのリンクされたサービスの名前。
output	object	アクティビティの出力。
pipelineName	string	パイプラインの名前。
pipelineRunId	string	パイプライン実行の ID。
status	string	アクティビティの実行の状態。

ActivityRunsQueryResponse

Object

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

名前	型	説明
continuationToken	string	残りの結果が存在する場合は、結果の次のページを取得するための継続トークン。それ以外の場合は null。
value	ActivityRun[]	アクティビティの実行の一覧。

CloudError

Object

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

名前	型	説明
error.code	string	エラーコード。
error.details	CloudError[]	追加のエラーの詳細を含む配列。
error.message	string	エラーメッセージ。
error.target	string	エラーに関連付けられている要求のプロパティ名/パス。

RunFilterParameters

Object

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

名前	型	説明
continuationToken	string	結果の次のページを取得するための継続トークン。最初のページの場合は Null。
filters	RunQueryFilter[]	フィルターの一覧。
lastUpdatedAfter	string (date-time)	実行イベントが 'ISO 8601' 形式で更新された時刻以降。
lastUpdatedBefore	string (date-time)	実行イベントが 'ISO 8601' 形式で更新された時刻またはそれ以前。
orderBy	RunQueryOrderBy[]	OrderBy オプションの一覧。

RunQueryFilter

Object

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

名前	型	説明
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 があります。

値	説明
PipelineName
Status
RunStart
RunEnd
ActivityName
ActivityRunStart
ActivityRunEnd
ActivityType
TriggerName
TriggerRunTimestamp
RunGroupId
LatestOnly

RunQueryFilterOperator

列挙

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

値	説明
Equals
NotEquals
In
NotIn

RunQueryOrder

列挙

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

値	説明
ASC
DESC

RunQueryOrderBy

Object

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

名前	型	説明
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 があります。

値	説明
RunStart
RunEnd
PipelineName
Status
ActivityName
ActivityRunStart
ActivityRunEnd
TriggerName
TriggerRunTimestamp

次の方法で共有

Pipeline Run - Query Activity Runs

URI パラメーター

要求本文

応答

例

ActivityRuns_QueryByPipelineRun

要求のサンプル

応答のサンプル

定義

ActivityRun

ActivityRunsQueryResponse

CloudError

RunFilterParameters

RunQueryFilter

RunQueryFilterOperand

RunQueryFilterOperator

RunQueryOrder

RunQueryOrderBy

RunQueryOrderByField