Activity Runs - Query By Pipeline Run
La actividad de consulta se ejecuta en función de las condiciones de filtro de entrada.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelineruns/{runId}/queryActivityruns?api-version=2018-06-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
factory
|
path | True |
string |
Nombre del generador. Patrón de Regex: |
resource
|
path | True |
string |
El nombre del grupo de recursos. Patrón de Regex: |
run
|
path | True |
string |
Identificador de ejecución de canalización. |
subscription
|
path | True |
string |
Identificador de la suscripción. |
api-version
|
query | True |
string |
Versión de la API. |
Cuerpo de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
lastUpdatedAfter | True |
string |
Hora en la que se actualizó el evento de ejecución en formato "ISO 8601". |
lastUpdatedBefore | True |
string |
Hora en la que se actualizó el evento de ejecución en formato "ISO 8601". |
continuationToken |
string |
Token de continuación para obtener la siguiente página de resultados. Null para la primera página. |
|
filters |
Lista de filtros. |
||
orderBy |
Lista de la opción OrderBy. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar. |
|
Other Status Codes |
Respuesta de error recibida del servicio Azure Data Factory. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
ActivityRuns_QueryByPipelineRun
Solicitud de ejemplo
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"
}
Respuesta de muestra
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"
}
]
}
Definiciones
Nombre | Description |
---|---|
Activity |
Información sobre una ejecución de actividad en una canalización. |
Activity |
Se ejecuta una actividad de lista. |
Cloud |
Objeto que define la estructura de una respuesta de error Azure Data Factory. |
Run |
Parámetros de consulta para enumerar ejecuciones. |
Run |
Opción de filtro de consulta para enumerar ejecuciones. |
Run |
Nombre de parámetro que se va a usar para el filtro. Los operandos permitidos para consultar las ejecuciones de canalización son PipelineName, RunStart, RunEnd y Status; para consultar las ejecuciones de actividad son ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType y Status, y para las ejecuciones del desencadenador de consulta son TriggerName, TriggerRunTimestamp y Status. |
Run |
Operador que se va a usar para el filtro. |
Run |
Criterio de ordenación del parámetro. |
Run |
Objeto para proporcionar el orden por opciones para enumerar ejecuciones. |
Run |
Nombre de parámetro por el que se va a usar para el pedido. Los parámetros permitidos para ordenar por para las ejecuciones de canalización son PipelineName, RunStart, RunEnd y Status; para las ejecuciones de actividad son ActivityName, ActivityRunStart, ActivityRunEnd y Status; para las ejecuciones de desencadenador son TriggerName, TriggerRunTimestamp y Status. |
ActivityRun
Información sobre una ejecución de actividad en una canalización.
Nombre | Tipo | Description |
---|---|---|
activityName |
string |
El nombre de la actividad. |
activityRunEnd |
string |
La hora de finalización de la actividad se ejecuta en formato "ISO 8601". |
activityRunId |
string |
Identificador de la ejecución de la actividad. |
activityRunStart |
string |
La hora de inicio de la actividad se ejecuta en formato "ISO 8601". |
activityType |
string |
Tipo de la actividad. |
durationInMs |
integer |
Duración de la ejecución de la actividad. |
error |
object |
Error si se ejecuta alguna de la actividad. |
input |
object |
Entrada de la actividad. |
linkedServiceName |
string |
Nombre del servicio vinculado de proceso. |
output |
object |
Salida de la actividad. |
pipelineName |
string |
El nombre de la canalización. |
pipelineRunId |
string |
Identificador de la ejecución de la canalización. |
status |
string |
Estado de la ejecución de la actividad. |
ActivityRunsQueryResponse
Se ejecuta una actividad de lista.
Nombre | Tipo | Description |
---|---|---|
continuationToken |
string |
Token de continuación para obtener la siguiente página de resultados, si existen resultados restantes, null de lo contrario. |
value |
Lista de ejecuciones de actividad. |
CloudError
Objeto que define la estructura de una respuesta de error Azure Data Factory.
Nombre | Tipo | Description |
---|---|---|
error.code |
string |
Código de error. |
error.details |
Matriz con detalles de error adicionales. |
|
error.message |
string |
Mensaje de error. |
error.target |
string |
Nombre o ruta de acceso de propiedad en la solicitud asociada al error. |
RunFilterParameters
Parámetros de consulta para enumerar ejecuciones.
Nombre | Tipo | Description |
---|---|---|
continuationToken |
string |
Token de continuación para obtener la siguiente página de resultados. Null para la primera página. |
filters |
Lista de filtros. |
|
lastUpdatedAfter |
string |
Hora en la que se actualizó el evento de ejecución en formato "ISO 8601". |
lastUpdatedBefore |
string |
Hora en la que se actualizó el evento de ejecución en formato "ISO 8601". |
orderBy |
Lista de la opción OrderBy. |
RunQueryFilter
Opción de filtro de consulta para enumerar ejecuciones.
Nombre | Tipo | Description |
---|---|---|
operand |
Nombre de parámetro que se va a usar para el filtro. Los operandos permitidos para consultar las ejecuciones de canalización son PipelineName, RunStart, RunEnd y Status; para consultar las ejecuciones de actividad son ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType y Status, y para las ejecuciones del desencadenador de consulta son TriggerName, TriggerRunTimestamp y Status. |
|
operator |
Operador que se va a usar para el filtro. |
|
values |
string[] |
Lista de valores de filtro. |
RunQueryFilterOperand
Nombre de parámetro que se va a usar para el filtro. Los operandos permitidos para consultar las ejecuciones de canalización son PipelineName, RunStart, RunEnd y Status; para consultar las ejecuciones de actividad son ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType y Status, y para las ejecuciones del desencadenador de consulta son TriggerName, TriggerRunTimestamp y Status.
Nombre | Tipo | Description |
---|---|---|
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
Operador que se va a usar para el filtro.
Nombre | Tipo | Description |
---|---|---|
Equals |
string |
|
In |
string |
|
NotEquals |
string |
|
NotIn |
string |
RunQueryOrder
Criterio de ordenación del parámetro.
Nombre | Tipo | Description |
---|---|---|
ASC |
string |
|
DESC |
string |
RunQueryOrderBy
Objeto para proporcionar el orden por opciones para enumerar ejecuciones.
Nombre | Tipo | Description |
---|---|---|
order |
Criterio de ordenación del parámetro. |
|
orderBy |
Nombre de parámetro por el que se va a usar para el pedido. Los parámetros permitidos para ordenar por para las ejecuciones de canalización son PipelineName, RunStart, RunEnd y Status; para las ejecuciones de actividad son ActivityName, ActivityRunStart, ActivityRunEnd y Status; para las ejecuciones de desencadenador son TriggerName, TriggerRunTimestamp y Status. |
RunQueryOrderByField
Nombre de parámetro por el que se va a usar para el pedido. Los parámetros permitidos para ordenar por para las ejecuciones de canalización son PipelineName, RunStart, RunEnd y Status; para las ejecuciones de actividad son ActivityName, ActivityRunStart, ActivityRunEnd y Status; para las ejecuciones de desencadenador son TriggerName, TriggerRunTimestamp y Status.
Nombre | Tipo | Description |
---|---|---|
ActivityName |
string |
|
ActivityRunEnd |
string |
|
ActivityRunStart |
string |
|
PipelineName |
string |
|
RunEnd |
string |
|
RunStart |
string |
|
Status |
string |
|
TriggerName |
string |
|
TriggerRunTimestamp |
string |