Job - List

Référence

Service:: Data Lake Analytics

API Version:: 2016-11-01

Listes les travaux, le cas échéant, associés au compte Data Lake Analytics spécifié. La réponse inclut un lien vers la page de résultats suivante, le cas échéant.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Le compte Azure Data Lake Analytics sur lequel exécuter des opérations de travail.
adlaJobDnsSuffix	path	True	string	Obtient le suffixe DNS utilisé comme base pour toutes les demandes de service Azure Data Lake Analytics Job.
api-version	query	True	string	Version de l’API cliente.
$count	query		boolean	Valeur booléenne true ou false pour demander le nombre des ressources correspondantes incluses avec les ressources dans la réponse, par exemple Categories ?$count=true. facultatif.
$filter	query		string	Filtre OData. facultatif.
$orderby	query		string	Clause OrderBy. Une ou plusieurs expressions séparées par des virgules avec un « asc » facultatif (valeur par défaut) ou « desc » en fonction de l’ordre dans lequel vous souhaitez trier les valeurs, par exemple Categories ?$orderby=CategoryName desc. facultatif.
$select	query		string	Instruction OData Select. Limite les propriétés de chaque entrée à celles demandées, par exemple Catégories ?$select=CategoryName,Description. facultatif.
$skip	query		integer int32	Nombre d’éléments à ignorer avant de retourner des éléments. facultatif.
$top	query		integer int32	Nombre d’éléments à retourner. facultatif.

Réponses

Nom	Type	Description
200 OK	JobInfoListResult	La liste des travaux a été récupérée.

Exemples

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

Définitions

Nom	Description
JobInfoListResult	Liste des éléments JobInfo.
JobInformationBasic	Propriétés courantes Data Lake Analytics informations sur le travail.
JobRelationshipProperties	Propriétés d’informations sur la relation de travail, y compris les informations de pipeline, les informations de corrélation, etc.
JobResult	le résultat de l’exécution du travail ou le résultat actuel du travail en cours d’exécution.
JobState	état du travail. Lorsque le travail est à l’état Terminé, reportez-vous à Result et ErrorMessage pour plus d’informations.
JobType	type de travail du travail actuel (Hive ou USql).

JobInfoListResult

Liste des éléments JobInfo.

Nom	Type	Description
nextLink	string	lien (URL) vers la page de résultats suivante.
value	JobInformationBasic[]	liste des éléments JobInfo.

JobInformationBasic

Propriétés courantes Data Lake Analytics informations sur le travail.

Nom	Type	Valeur par défaut	Description
degreeOfParallelism	integer	1	degré de parallélisme utilisé pour ce travail.
degreeOfParallelismPercent	number		degré de parallélisme en pourcentage utilisé pour ce travail.
endTime	string		heure d’achèvement du travail.
hierarchyQueueNode	string		nom du nœud de file d’attente de hiérarchie auquel ce travail est affecté, null si le travail n’a pas encore été attribué ou si le compte n’a pas de file d’attente de hiérarchie.
jobId	string		l’identificateur unique du travail (un GUID).
logFilePatterns	string[]		liste des modèles de nom de fichier journal à trouver dans logFolder. '' est le seul caractère correspondant autorisé. Exemple de format : jobExecution.log ou mylog.txt
logFolder	string		chemin du dossier du journal à utiliser au format suivant : adl ://.azuredatalakestore.net/system/jobservice/jobs/Usql/2016/03/13/17/18/5fe51957-93bc-4de0-8ddc-c5a4753b068b/logs/.
name	string		nom convivial du travail.
priority	integer		valeur de priorité pour le travail actuel. Les nombres inférieurs ont une priorité plus élevée. Par défaut, une tâche affiche une priorité de 1 000. La valeur doit être supérieure à 0.
related	JobRelationshipProperties		propriétés d’informations sur les relations de travail périodiques.
result	JobResult		le résultat de l’exécution du travail ou le résultat actuel du travail en cours d’exécution.
startTime	string		heure de début du travail.
state	JobState		état du travail. Lorsque le travail est à l’état Terminé, reportez-vous à Result et ErrorMessage pour plus d’informations.
submitTime	string		heure à laquelle le travail a été soumis au service.
submitter	string		l’utilisateur ou le compte qui a envoyé le travail.
type	JobType		type de travail du travail actuel (Hive ou USql).

JobRelationshipProperties

Propriétés d’informations sur la relation de travail, y compris les informations de pipeline, les informations de corrélation, etc.

Nom	Type	Description
pipelineId	string	identificateur de pipeline de relation de travail (GUID).
pipelineName	string	nom convivial du pipeline de relation de travail, qui n’a pas besoin d’être unique.
pipelineUri	string	l’URI de pipeline, unique, est lié au service d’origine pour ce pipeline.
recurrenceId	string	identificateur de périodicité (GUID), unique par activité/script, quelles que soient les itérations. Il s’agit d’un élément permettant de lier différentes occurrences d’un même travail.
recurrenceName	string	nom de périodicité, nom convivial pour la corrélation entre les travaux.
runId	string	l’identificateur d’exécution (un GUID), identificateur unique de l’itération de ce pipeline.

JobResult

le résultat de l’exécution du travail ou le résultat actuel du travail en cours d’exécution.

Nom	Type	Description
Cancelled	string
Failed	string
None	string
Succeeded	string

JobState

état du travail. Lorsque le travail est à l’état Terminé, reportez-vous à Result et ErrorMessage pour plus d’informations.

Nom	Type	Description
Accepted	string
Compiling	string
Ended	string
New	string
Paused	string
Queued	string
Running	string
Scheduling	string
Starting	string
WaitingForCapacity	string

JobType

type de travail du travail actuel (Hive ou USql).

Nom	Type	Description
Hive	string
USql	string