Condividi tramite


Job - List Preparation And Release Task Status

Elenca lo stato di esecuzione dell'attività Preparazione processo e rilascio processo per il processo specificato nei nodi di calcolo in cui è stato eseguito il processo.
Questa API restituisce lo stato dell'attività Preparazione processo e Rilascio processo in tutti i nodi di calcolo che hanno eseguito l'attività Preparazione processo o Rilascio processo. Sono inclusi i nodi di calcolo che sono stati rimossi dal pool. Se questa API viene richiamata in un processo senza attività di preparazione processo o rilascio processo, il servizio Batch restituisce il codice di stato HTTP 409 (conflitto) con un codice di errore JobPreparationTaskNotSpecified.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0
GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

Parametri dell'URI

Nome In Necessario Tipo Descrizione
batchUrl
path True

string

URL di base per tutte le richieste di servizio Azure Batch.

jobId
path True

string

ID del processo.

api-version
query True

string

Versione dell'API client.

$filter
query

string

Clausola $filter OData. Per altre informazioni sulla costruzione di questo filtro, vedere https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.

$select
query

string

Clausola $select OData.

maxresults
query

integer

int32

Numero massimo di elementi da restituire nella risposta. È possibile restituire un massimo di 1000 attività.

timeout
query

integer

int32

Tempo massimo per cui il server può dedicare l'elaborazione della richiesta, in secondi. Il valore predefinito è 30 secondi.

Intestazione della richiesta

Media Types: "application/json; odata=minimalmetadata"

Nome Necessario Tipo Descrizione
client-request-id

string

uuid

Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Indica se il server deve restituire l'ID richiesta client nella risposta.

ocp-date

string

date-time-rfc1123

Ora di emissione della richiesta. Le librerie client impostano in genere questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.

Risposte

Nome Tipo Descrizione
200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Risposta contenente un elenco di stati attività di preparazione processo e rilascio processo.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
Other Status Codes

BatchError

Errore del servizio Batch. Se questa API viene richiamata in un processo senza attività di preparazione processo o rilascio processo, il servizio Batch restituisce il codice di stato HTTP 409.

Sicurezza

azure_auth

Microsoft Entra flusso del codice di autenticazione OAuth 2.0

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Descrizione
user_impersonation Rappresentare l'account utente

Authorization

Type: apiKey
In: header

Esempio

Job list preparation and release task status

Sample Request

GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0


Sample Response

{
  "value": [
    {
      "poolId": "poolId",
      "nodeId": "tvm-2167304207_1-20140905t174658z",
      "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z",
      "jobPreparationTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask",
        "exitCode": 0,
        "retryCount": 0
      },
      "jobReleaseTaskExecutionInfo": {
        "state": "completed",
        "startTime": "2015-05-01T10:20:31Z",
        "endTime": "2015-05-02T20:12:42Z",
        "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask",
        "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask",
        "exitCode": 0
      }
    }
  ],
  "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2023-11-01.18.0"
}

Definizioni

Nome Descrizione
BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.

CloudJobListPreparationAndReleaseTaskStatusResult

Risultato dell'elenco dello stato delle attività di preparazione e rilascio dei processi per un processo.

ErrorCategory

Categoria dell'errore.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.

JobPreparationAndReleaseTaskExecutionInformation

Stato delle attività di preparazione e rilascio dei processi in un nodo di calcolo.

JobPreparationTaskExecutionInformation

Contiene informazioni sull'esecuzione di un'attività di preparazione dei processi in un nodo di calcolo.

JobPreparationTaskState

Stato corrente dell'attività Preparazione processo nel nodo di calcolo.

JobReleaseTaskExecutionInformation

Contiene informazioni sull'esecuzione di un'attività di rilascio del processo in un nodo di calcolo.

JobReleaseTaskState

Stato corrente dell'attività Versione processo nel nodo di calcolo.

NameValuePair

Rappresenta una coppia nome/valore.

TaskContainerExecutionInformation

Contiene informazioni sul contenitore in cui viene eseguita un'attività.

TaskExecutionResult

Risultato dell'esecuzione dell'attività.

TaskFailureInformation

Informazioni su un errore dell'attività.

BatchError

Risposta di errore ricevuta dal servizio Azure Batch.

Nome Tipo Descrizione
code

string

Identificatore dell'errore. I codici sono invarianti e devono essere usati a livello di codice.

message

ErrorMessage

Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.

values

BatchErrorDetail[]

Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Elemento di informazioni aggiuntive incluse in una risposta di errore Azure Batch.

Nome Tipo Descrizione
key

string

Identificatore che specifica il significato della proprietà Value.

value

string

Informazioni aggiuntive incluse nella risposta all'errore.

CloudJobListPreparationAndReleaseTaskStatusResult

Risultato dell'elenco dello stato delle attività di preparazione e rilascio dei processi per un processo.

Nome Tipo Descrizione
odata.nextLink

string

URL per ottenere il set successivo di risultati.

value

JobPreparationAndReleaseTaskExecutionInformation[]

Elenco delle informazioni sull'esecuzione dell'attività Preparazione processo e rilascio processi.

ErrorCategory

Categoria dell'errore.

Nome Tipo Descrizione
servererror

string

L'errore è dovuto a un problema interno del server.

usererror

string

L'errore è dovuto a un problema dell'utente, ad esempio la configurazione errata.

ErrorMessage

Messaggio di errore ricevuto in una risposta di errore Azure Batch.

Nome Tipo Descrizione
lang

string

Codice del linguaggio del messaggio di errore

value

string

Testo del messaggio.

JobPreparationAndReleaseTaskExecutionInformation

Stato delle attività di preparazione e rilascio dei processi in un nodo di calcolo.

Nome Tipo Descrizione
jobPreparationTaskExecutionInfo

JobPreparationTaskExecutionInformation

Informazioni sullo stato di esecuzione dell'attività preparazione processo in questo nodo di calcolo.

jobReleaseTaskExecutionInfo

JobReleaseTaskExecutionInformation

Informazioni sullo stato di esecuzione dell'attività Versione processo in questo nodo di calcolo.
Questa proprietà viene impostata solo se l'attività Versione processo è stata eseguita nel nodo di calcolo.

nodeId

string

ID del nodo di calcolo a cui fa riferimento questa voce.

nodeUrl

string

URL del nodo di calcolo a cui fa riferimento questa voce.

poolId

string

ID del pool contenente il nodo di calcolo a cui fa riferimento questa voce.

JobPreparationTaskExecutionInformation

Contiene informazioni sull'esecuzione di un'attività di preparazione dei processi in un nodo di calcolo.

Nome Tipo Descrizione
containerInfo

TaskContainerExecutionInformation

Informazioni sul contenitore in cui è in esecuzione l'attività.
Questa proprietà viene impostata solo se l'attività viene eseguita in un contesto del contenitore.

endTime

string

Ora in cui l'attività preparazione processo è stata completata.
Questa proprietà viene impostata solo se l'attività è nello stato Complete.

exitCode

integer

Codice di uscita del programma specificato nella riga di comando Attività.
Questo parametro viene restituito solo se l'attività è nello stato completato. Il codice di uscita per un processo riflette la convenzione specifica implementata dallo sviluppatore dell'applicazione per tale processo. Se si usa il valore del codice di uscita per prendere decisioni nel codice, assicurarsi di conoscere la convenzione di uscita del codice utilizzata dal processo dell'applicazione. Si noti che il codice di uscita può essere generato anche dal sistema operativo Nodo di calcolo, ad esempio quando un processo viene terminato in modo forcibmente.

failureInfo

TaskFailureInformation

Informazioni che descrivono l'errore dell'attività, se presente.
Questa proprietà viene impostata solo se l'attività è nello stato completato e ha rilevato un errore.

lastRetryTime

string

Ora più recente in cui è stata avviata l'esecuzione di un nuovo tentativo dell'attività preparazione processi.
Questa proprietà viene impostata solo se l'attività è stata ritrita (ad esempio, retryCount è diverso da zero). Se presente, questa operazione è in genere uguale a startTime, ma può essere diversa se l'attività è stata riavviata per motivi diversi da quelli di ripetizione; Ad esempio, se il nodo di calcolo è stato riavviato durante un nuovo tentativo, l'avvioTime viene aggiornato ma l'ultimoRetryTime non è.

result

TaskExecutionResult

Risultato dell'esecuzione dell'attività.
Se il valore è "non riuscito", i dettagli dell'errore sono disponibili nella proprietà failureInfo.

retryCount

integer

Numero di tentativi di ripetizione dell'attività dal servizio Batch. Gli errori dell'applicazione attività (codice di uscita non zero) vengono riprovati, vengono rieseguati errori di pre-elaborazione (impossibile eseguire l'attività) e non vengono riprovati gli errori di caricamento dei file. Il servizio Batch ritenta l'attività fino al limite specificato dai vincoli.
Gli errori dell'applicazione attività (codice di uscita non zero) vengono riprovati, vengono rieseguati errori di pre-elaborazione (impossibile eseguire l'attività) e non vengono riprovati gli errori di caricamento dei file. Il servizio Batch ritenta l'attività fino al limite specificato dai vincoli.

startTime

string

Ora in cui è stata avviata l'esecuzione dell'attività.
Se l'attività è stata riavviata o ritrita, questa è l'ora più recente in cui l'attività è stata avviata l'esecuzione.

state

JobPreparationTaskState

Stato corrente dell'attività Preparazione processo nel nodo di calcolo.

taskRootDirectory

string

Directory radice dell'attività Preparazione processi nel nodo di calcolo. È possibile usare questo percorso per recuperare i file creati dall'attività, ad esempio i file di log.

taskRootDirectoryUrl

string

URL della directory radice dell'attività preparazione processi nel nodo di calcolo.

JobPreparationTaskState

Stato corrente dell'attività Preparazione processo nel nodo di calcolo.

Nome Tipo Descrizione
completed

string

L'attività è stata chiusa con il codice di uscita 0 oppure l'attività ha esaurito il limite di tentativi oppure il servizio Batch non è riuscito ad avviare l'attività a causa di errori di preparazione attività, ad esempio errori di download del file di risorse.

running

string

L'attività è attualmente in esecuzione (inclusa la ripetizione dei tentativi).

JobReleaseTaskExecutionInformation

Contiene informazioni sull'esecuzione di un'attività di rilascio del processo in un nodo di calcolo.

Nome Tipo Descrizione
containerInfo

TaskContainerExecutionInformation

Informazioni sul contenitore in cui è in esecuzione l'attività.
Questa proprietà viene impostata solo se l'attività viene eseguita in un contesto del contenitore.

endTime

string

Ora in cui l'attività di rilascio del processo è stata completata.
Questa proprietà viene impostata solo se l'attività è nello stato Complete.

exitCode

integer

Codice di uscita del programma specificato nella riga di comando Attività.
Questo parametro viene restituito solo se l'attività è nello stato completato. Il codice di uscita per un processo riflette la convenzione specifica implementata dallo sviluppatore dell'applicazione per tale processo. Se si usa il valore del codice di uscita per prendere decisioni nel codice, assicurarsi di conoscere la convenzione di uscita del codice utilizzata dal processo dell'applicazione. Si noti che il codice di uscita può essere generato anche dal sistema operativo Nodo di calcolo, ad esempio quando un processo viene terminato in modo forcibmente.

failureInfo

TaskFailureInformation

Informazioni che descrivono l'errore dell'attività, se presente.
Questa proprietà viene impostata solo se l'attività è nello stato completato e ha rilevato un errore.

result

TaskExecutionResult

Risultato dell'esecuzione dell'attività.
Se il valore è "non riuscito", i dettagli dell'errore sono disponibili nella proprietà failureInfo.

startTime

string

Ora in cui è stata avviata l'esecuzione dell'attività.
Se l'attività è stata riavviata o ritrita, questa è l'ora più recente in cui l'attività è stata avviata l'esecuzione.

state

JobReleaseTaskState

Stato corrente dell'attività Versione processo nel nodo di calcolo.

taskRootDirectory

string

Directory radice dell'attività Versione processo nel nodo di calcolo. È possibile usare questo percorso per recuperare i file creati dall'attività, ad esempio i file di log.

taskRootDirectoryUrl

string

URL della directory radice dell'attività Versione processo nel nodo di calcolo.

JobReleaseTaskState

Stato corrente dell'attività Versione processo nel nodo di calcolo.

Nome Tipo Descrizione
completed

string

L'attività è stata chiusa con il codice di uscita 0 oppure l'attività ha esaurito il limite di tentativi oppure il servizio Batch non è riuscito ad avviare l'attività a causa di errori di preparazione attività, ad esempio errori di download del file di risorse.

running

string

L'attività è attualmente in esecuzione (inclusa la ripetizione dei tentativi).

NameValuePair

Rappresenta una coppia nome/valore.

Nome Tipo Descrizione
name

string

Nome nella coppia nome-valore.

value

string

Valore nella coppia nome-valore.

TaskContainerExecutionInformation

Contiene informazioni sul contenitore in cui viene eseguita un'attività.

Nome Tipo Descrizione
containerId

string

ID del contenitore.

error

string

Informazioni dettagliate sull'errore sul contenitore.
Questa è la stringa di errore dettagliata del servizio Docker, se disponibile. Equivale al campo di errore restituito da "docker inspect".

state

string

Stato del contenitore.
Questo è lo stato del contenitore in base al servizio Docker. Equivale al campo di stato restituito da "docker inspect".

TaskExecutionResult

Risultato dell'esecuzione dell'attività.

Nome Tipo Descrizione
failure

string

Errore durante l'elaborazione dell'attività. L'errore potrebbe verificarsi prima dell'avvio del processo attività, durante l'esecuzione del processo attività o dopo l'uscita dal processo attività.

success

string

L'attività è stata eseguita correttamente.

TaskFailureInformation

Informazioni su un errore dell'attività.

Nome Tipo Descrizione
category

ErrorCategory

Categoria dell'errore Attività.

code

string

Identificatore per l'errore attività. I codici sono invarianti e devono essere usati a livello di codice.

details

NameValuePair[]

Elenco di dettagli aggiuntivi correlati all'errore.

message

string

Messaggio che descrive l'errore attività, destinato a essere adatto per la visualizzazione in un'interfaccia utente.