Background Jobs - Run On Demand Spark Job Definition

Servicio:: SparkJobDefinition

Versión de la API:: v1

Ejecute la instancia de trabajo de definición de trabajo de Spark a petición.

Ámbitos delegados necesarios

SparkJobDefinition.Execute.All o Item.Execute.All

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	Sí

Interfaz

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
sparkJobDefinitionId	path	True	string (uuid)	Identificador del elemento de definición del trabajo de Spark.
workspaceId	path	True	string (uuid)	El identificador del área de trabajo.
jobType	query	True	string	El tipo de trabajo admitido para la definición de trabajo de Spark es `sparkjob`.

Cuerpo de la solicitud

Nombre	Tipo	Description
executionData	ExecutionData	Parámetros de definición de trabajo de Spark que se usarán durante la ejecución si es necesario. De forma predeterminada, no se necesita ningún cuerpo

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: MissingMinimalPermissions: el autor de la llamada no tiene permisos suficientes para ejecutar la instancia de trabajo. n InvalidJobType: el tipo de trabajo solicitado no es válido. TooManyRequestsForJobs: el autor de la llamada realiza a muchas solicitudes de trabajo a petición de ejecución. ItemNotFound: no se encontró el identificador de elemento solicitado.

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:

MissingMinimalPermissions: el autor de la llamada no tiene permisos suficientes para ejecutar la instancia de trabajo. n
InvalidJobType: el tipo de trabajo solicitado no es válido.
TooManyRequestsForJobs: el autor de la llamada realiza a muchas solicitudes de trabajo a petición de ejecución.
ItemNotFound: no se encontró el identificador de elemento solicitado.

Ejemplos

Run SparkJobDefinition with no request body.

Run SparkJobDefinition with request body.

Run SparkJobDefinition with no request body.

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/sparkJobDefinitions/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=sparkjob

Respuesta de muestra

status code:: 202

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Run SparkJobDefinition with request body.

Solicitud de ejemplo

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/sparkJobDefinitions/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances?jobType=sparkjob

{
  "executionData": {
    "executableFile": "abfss://test@northcentralus-onelake.dfs.fabric.microsoft.com/salesdata.Lakehouse/Files/oneplusoneapp.jar",
    "mainClass": "com.microsoft.spark.example.OneplusOneApp",
    "commandLineArguments": "firstarg secondarg thirdarg",
    "additionalLibraryUris": [
      "abfss://test@onelakecst180.dfs.pbidedicated.windows-int.net/dfsd.Lakehouse/Files/testfile.jar"
    ],
    "defaultLakehouseId": {
      "referenceType": "ById",
      "workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
      "itemId": "01d11fd3-625b-4c89-880c-3fc0ad19e734"
    },
    "environmentId": {
      "referenceType": "ById",
      "workspaceId": "4b218778-e7a5-4d73-8187-f10824047715",
      "itemId": "937e2b52-320c-4e16-b232-f9907e433a0d"
    }
  }
}

Respuesta de muestra

status code:: 202

Location: https://api.fabric.microsoft.com/v1/workspaces/4b218778-e7a5-4d73-8187-f10824047715/items/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7/jobs/instances/f2d65699-dd22-4889-980c-15226deb0e1b
Retry-After: 60

Definiciones

Nombre	Description
ErrorRelatedResource	Objeto de detalles del recurso relacionado con el error.
ErrorResponse	Respuesta de error.
ErrorResponseDetails	Detalles de la respuesta de error.
ExecutionData	ExecutionData para la definición de trabajo de Spark se ejecuta si el cliente quiere invalidar los valores predeterminados.
ItemReferenceById	Referencia de elemento por objeto ID.
ItemReferenceType	Tipo de referencia Item. Se pueden agregar tipos de `ItemReferenceType` adicionales a lo largo del tiempo.
RunSparkJobDefinitionRequest	Ejecute la solicitud de definición de trabajo de Spark con executionData.

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.

ExecutionData

Object

ExecutionData para la definición de trabajo de Spark se ejecuta si el cliente quiere invalidar los valores predeterminados.

Nombre	Tipo	Description
additionalLibraryUris	string[]	Lista de rutas de acceso de biblioteca adicionales necesarias para la ejecución.
commandLineArguments	string	Argumentos de la línea de comandos. Los argumentos están separados por espacio
defaultLakehouseId	ItemReference: ItemReferenceById	Identificador de lakehouse que se usará como la instancia predeterminada de lakehouse de la definición del trabajo de Spark.
environmentId	ItemReference: ItemReferenceById	Identificador de entorno que se usará para la definición del trabajo de Spark. Se puede usar para especificar la configuración de Spark.
executableFile	string	Archivo principal ejecutable que se va a usar. La ruta de acceso debe ser una ruta de acceso abfs.
mainClass	string	Nombre de clase principal que se va a usar. Esto no es necesario para los archivos ejecutables de Python y r.

ItemReferenceById

Object

Referencia de elemento por objeto ID.

Nombre	Tipo	Description
itemId	string (uuid)	Identificador del elemento.
referenceType	string: ById	Tipo de referencia de elemento.
workspaceId	string (uuid)	Identificador del área de trabajo del elemento.

ItemReferenceType

Enumeración

Tipo de referencia Item. Se pueden agregar tipos de ItemReferenceType adicionales a lo largo del tiempo.

Valor	Description
ById	Su identificador hace referencia al elemento.

RunSparkJobDefinitionRequest

Object

Ejecute la solicitud de definición de trabajo de Spark con executionData.

Nombre	Tipo	Description
executionData	ExecutionData	Parámetros de definición de trabajo de Spark que se usarán durante la ejecución si es necesario. De forma predeterminada, no se necesita ningún cuerpo

Compartir a través de

Background Jobs - Run On Demand Spark Job Definition

Ámbitos delegados necesarios

Identidades admitidas de Microsoft Entra

Interfaz

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

Run SparkJobDefinition with no request body.

Solicitud de ejemplo

Respuesta de muestra

Run SparkJobDefinition with request body.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

ExecutionData

ItemReferenceById

ItemReferenceType

RunSparkJobDefinitionRequest