Compartir a través de

Background Jobs - Run On Demand Execute

  • Referencia
Servicio:
Dataflow
Versión de la API:
v1

Nota:

Esta API está en versión preliminar.

Ejecute la instancia de trabajo de ejecución a petición.

Ámbitos delegados necesarios

En el caso de las API de flujos de datos, use estos tipos de ámbito:

  • Ámbito específico: Dataflow.Execute.All

para obtener más información sobre los ámbitos, vea: artículo ámbitos.

Identidades admitidas de Microsoft Entra

Esta API admite las identidades de Microsoft enumeradas en esta sección.

identidad Apoyo
Usuario Sí
Entidad de servicio e Identidades administradas No

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dataflows/{dataflowId}/jobs/instances?jobType={jobType}

Parámetros de identificador URI

Nombre En Requerido Tipo Description
dataflowId
 path True

string (uuid)

Identificador del flujo de datos.
workspaceId
 path True

string (uuid)

El identificador del área de trabajo.
jobType
 query True

string

Ejecute el tipo de trabajo. La actualización también se puede usar como alias para Execute.

Cuerpo de la solicitud

Nombre Tipo Description
executionData

DataflowExecutionPayload

Carga útil para ejecutar una solicitud de trabajo de ejecución a petición. Solo es necesario si el flujo de datos tiene habilitada la parametrización.

Respuestas

Nombre Tipo Description
202 Accepted

Solicitud aceptada, la ejecución del trabajo está en curso.

Encabezados

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de error comunes:

  • InsufficientPrivileges: el autor de la llamada no tiene permisos suficientes para ejecutar la instancia de trabajo.

  • InvalidJobType: el tipo de trabajo solicitado no es válido.

  • TooManyRequestsForJobs: el autor de la llamada solicita demasiadas solicitudes de trabajo a petición.

  • ItemNotFound: no se encontró el identificador de elemento solicitado.

Ejemplos

Run dataflow Execute job instance with no request body example
Run dataflow Execute job instance with request body containing parameters example

Run dataflow Execute job instance with no request body example

Solicitud de ejemplo

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances?jobType=Execute

Respuesta de muestra

status code:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

Run dataflow Execute job instance with request body containing parameters example

Solicitud de ejemplo

POST https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/dataflows/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances?jobType=Execute

{
  "executionData": {
    "executeOption": "ApplyChangesIfNeeded",
    "parameters": [
      {
        "parameterName": "OrderKey",
        "type": "Automatic",
        "value": 25
      },
      {
        "parameterName": "Threshold",
        "type": "Automatic",
        "value": "start"
      }
    ]
  }
}

Respuesta de muestra

status code:
202 
Location: https://api.fabric.microsoft.com/v1/workspaces/a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1/items/dddddddd-9999-0000-1111-eeeeeeeeeeee/jobs/instances/bbbbbbbb-1111-2222-3333-cccccccccccc
Retry-After: 60

Definiciones

Nombre Description
DataflowExecutionPayload

La carga de datos de ejecución para el flujo de datos
ErrorRelatedResource

Objeto de detalles del recurso relacionado con el error.
ErrorResponse

Respuesta de error.
ErrorResponseDetails

Detalles de la respuesta de error.
ExecuteOption

Opciones para ejecutar la operación de ejecución. Se pueden agregar executeOptions adicionales a lo largo del tiempo.
ItemJobParameter

Detalles del parámetro.
RunOnDemandDataflowExecuteJobRequest

Ejecución a petición de la carga de la instancia de trabajo de flujo de datos
Type

Tipo de parámetro. Se pueden agregar tipos de parámetros adicionales a lo largo del tiempo.

DataflowExecutionPayload

Object

La carga de datos de ejecución para el flujo de datos

Nombre Tipo Description
executeOption

ExecuteOption

Opciones para ejecutar la operación de ejecución. Se pueden agregar executeOptions adicionales a lo largo del tiempo.
parameters

ItemJobParameter[]

Lista de parámetros que se van a invalidar durante la ejecución.

ErrorRelatedResource

Object

Objeto de detalles del recurso relacionado con el error.

Nombre Tipo Description
resourceId

string

Identificador de recurso implicado en el error.
resourceType

string

Tipo del recurso implicado en el error.

ErrorResponse

Object

Respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
moreDetails

ErrorResponseDetails[]

Lista de detalles de error adicionales.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.
requestId

string

Identificador de la solicitud asociada al error.

ErrorResponseDetails

Object

Detalles de la respuesta de error.

Nombre Tipo Description
errorCode

string

Identificador específico que proporciona información sobre una condición de error, lo que permite una comunicación estandarizada entre nuestro servicio y sus usuarios.
message

string

Representación legible del error.
relatedResource

ErrorRelatedResource

Detalles del recurso relacionado con el error.

ExecuteOption

Enumeración

Opciones para ejecutar la operación de ejecución. Se pueden agregar executeOptions adicionales a lo largo del tiempo.

Valor Description
ApplyChangesIfNeeded

La operación Appply Changes se realiza si es necesario. Se puede usar cuando se requieren los cambios más recientes para Execute.
SkipApplyChanges

Valor predeterminado. Se omite la operación Aplicar cambios.

ItemJobParameter

Object

Detalles del parámetro.

Nombre Tipo Description
parameterName

string

Nombre del parámetro.
type

Type

Tipo de parámetro. Se pueden agregar tipos de parámetros adicionales a lo largo del tiempo.
value

Valor del parámetro que se va a invalidar durante la ejecución.

RunOnDemandDataflowExecuteJobRequest

Object

Ejecución a petición de la carga de la instancia de trabajo de flujo de datos

Nombre Tipo Description
executionData

DataflowExecutionPayload

Carga útil para ejecutar una solicitud de trabajo de ejecución a petición. Solo es necesario si el flujo de datos tiene habilitada la parametrización.

Type

Enumeración

Tipo de parámetro. Se pueden agregar tipos de parámetros adicionales a lo largo del tiempo.

Valor Description
Automatic

El valor debe ser Automático