Job - List

Referencia

Service:: Data Lake Analytics

API Version:: 2016-11-01

Listas los trabajos, si los hay, asociados a la cuenta de Data Lake Analytics especificada. La respuesta incluye un vínculo a la página siguiente de resultados, si existe.

GET https://{accountName}.{adlaJobDnsSuffix}/Jobs?api-version=2016-11-01

With optional parameters:

GET https://{accountName}.{adlaJobDnsSuffix}/Jobs?$filter={$filter}&$top={$top}&$skip={$skip}&$select={$select}&$orderby={$orderby}&$count={$count}&api-version=2016-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string	La cuenta de Azure Data Lake Analytics en la que ejecutar operaciones de trabajo.
adlaJobDnsSuffix	path	True	string	Obtiene el sufijo DNS que se usa como base para todas las solicitudes del servicio de trabajos de Azure Data Lake Analytics.
api-version	query	True	string	Versión de api de cliente.
$count	query		boolean	Valor booleano de true o false para solicitar un recuento de los recursos coincidentes incluidos con los recursos de la respuesta, por ejemplo, Categories?$count=true. Opcional.
$filter	query		string	Filtro OData. Opcional.
$orderby	query		string	Cláusula OrderBy. Una o varias expresiones separadas por comas con un "asc" opcional (valor predeterminado) o "desc" según el orden en que quiera ordenar los valores, por ejemplo, Categories?$orderby=CategoryName desc. Opcional.
$select	query		string	Instrucción Select de OData. Limita las propiedades de cada entrada a solo las solicitadas, por ejemplo, Categories?$select=CategoryName,Description. Opcional.
$skip	query		integer int32	Número de elementos que se van a omitir antes de devolver elementos. Opcional.
$top	query		integer int32	Número de elementos que se van a devolver. Opcional.

Respuestas

Nombre	Tipo	Description
200 OK	JobInfoListResult	Recuperó correctamente la lista de trabajos.

Ejemplos

Lists the jobs, if any, associated with the specified Data Lake Analytics account

Sample Request

HTTP

GET https://account123.contosopipelineservice.com/Jobs?$filter=test_filter&$top=1&$skip=1&$select=test_select&$orderby=test_orderby&$count=False&api-version=2016-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "jobId": "076713da-9018-41ae-a3bd-9eab14e54d09",
      "name": "test_name",
      "type": "USql",
      "submitter": "test_submitter",
      "degreeOfParallelism": 1,
      "priority": 1,
      "submitTime": "2017-04-18T11:16:49.0748958-07:00",
      "startTime": "2017-04-18T11:16:49.0748958-07:00",
      "endTime": "2017-04-18T11:16:49.0748958-07:00",
      "state": "Accepted",
      "result": "Succeeded",
      "logFolder": "adl://contosoadla.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/",
      "logFilePatterns": [
        "test_log_file_pattern_1",
        "test_log_file_pattern_2"
      ],
      "related": {
        "pipelineId": "076713da-9018-41ae-a3bd-9eab14e54d09",
        "pipelineName": "test_pipeline_name",
        "pipelineUri": "https://account123.contosopipelineservice.com/076713da-9018-41ae-a3bd-9eab14e54d09",
        "runId": "67034c12-b250-468e-992d-39fb978bde2c",
        "recurrenceId": "67034c12-b250-468e-992d-39fb978bde2d",
        "recurrenceName": "test_recurrence_name"
      }
    }
  ],
  "nextLink": "https://account123.contosopipelineservice.com/076713da-9018-41ae-a3bd-9eab14e54d09"
}

Definiciones

Nombre	Description
JobInfoListResult	Lista de elementos JobInfo.
JobInformationBasic	Las propiedades comunes Data Lake Analytics información del trabajo.
JobRelationshipProperties	Propiedades de información de relación del trabajo, incluida la información de canalización, la información de correlación, etc.
JobResult	el resultado de la ejecución del trabajo o el resultado actual del trabajo en ejecución.
JobState	el estado del trabajo. Cuando el trabajo está en estado Finalizado, consulte Result y ErrorMessage para obtener más información.
JobType	el tipo de trabajo del trabajo actual (Hive o USql).

JobInfoListResult

Lista de elementos JobInfo.

Nombre	Tipo	Description
nextLink	string	vínculo (url) a la página siguiente de resultados.
value	JobInformationBasic[]	la lista de elementos JobInfo.

JobInformationBasic

Las propiedades comunes Data Lake Analytics información del trabajo.

Nombre	Tipo	Valor predeterminado	Description
degreeOfParallelism	integer	1	el grado de paralelismo utilizado para este trabajo.
degreeOfParallelismPercent	number		el grado de paralelismo en porcentaje utilizado para este trabajo.
endTime	string		la hora de finalización del trabajo.
hierarchyQueueNode	string		el nombre del nodo de cola de jerarquía al que se asigna este trabajo, null si el trabajo aún no se ha asignado o la cuenta no tiene cola de jerarquía.
jobId	string		identificador único del trabajo (un GUID).
logFilePatterns	string[]		la lista de patrones de nombre de archivo de registro que se van a buscar en logFolder. '' es el único carácter coincidente permitido. Formato de ejemplo: jobExecution.log o mylog.txt
logFolder	string		la ruta de acceso de la carpeta de registro que se va a usar en el siguiente formato: adl://.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/.
name	string		el nombre descriptivo del trabajo.
priority	integer		el valor de prioridad del trabajo actual. Los números más bajos tienen mayor prioridad. De manera predeterminada, un trabajo tiene una prioridad de 1000. Debe ser mayor que 0.
related	JobRelationshipProperties		las propiedades periódicas de la relación de trabajo.
result	JobResult		el resultado de la ejecución del trabajo o el resultado actual del trabajo en ejecución.
startTime	string		la hora de inicio del trabajo.
state	JobState		el estado del trabajo. Cuando el trabajo está en estado Finalizado, consulte Result y ErrorMessage para obtener más información.
submitTime	string		la hora en que se envió el trabajo al servicio.
submitter	string		el usuario o la cuenta que envió el trabajo.
type	JobType		el tipo de trabajo del trabajo actual (Hive o USql).

JobRelationshipProperties

Propiedades de información de relación del trabajo, incluida la información de canalización, la información de correlación, etc.

Nombre	Tipo	Description
pipelineId	string	el identificador de canalización de relación de trabajo (un GUID).
pipelineName	string	el nombre descriptivo de la canalización de relación de trabajo, que no necesita ser único.
pipelineUri	string	el URI de canalización, único, vincula al servicio de origen de esta canalización.
recurrenceId	string	el identificador de periodicidad (un GUID), único por actividad o script, independientemente de las iteraciones. Esto es algo para vincular diferentes apariciones del mismo trabajo juntos.
recurrenceName	string	el nombre de periodicidad, nombre descriptivo para la correlación entre trabajos.
runId	string	el identificador de ejecución (un GUID), identificador único de la iteración de esta canalización.

JobResult

el resultado de la ejecución del trabajo o el resultado actual del trabajo en ejecución.

Nombre	Tipo	Description
Cancelled	string
Failed	string
None	string
Succeeded	string

JobState

el estado del trabajo. Cuando el trabajo está en estado Finalizado, consulte Result y ErrorMessage para obtener más información.

Nombre	Tipo	Description
Accepted	string
Compiling	string
Ended	string
New	string
Paused	string
Queued	string
Running	string
Scheduling	string
Starting	string
WaitingForCapacity	string

JobType

el tipo de trabajo del trabajo actual (Hive o USql).

Nombre	Tipo	Description
Hive	string
USql	string

Share via