Job - List Preparation And Release Task Status

Referencia

Service:: Batch Service

API Version:: 2023-11-01.18.0

Enumera el estado de ejecución de la tarea de preparación del trabajo y liberación de trabajos para el trabajo especificado en los nodos de proceso donde se ha ejecutado el trabajo.
Esta API devuelve el estado de la tarea de preparación y liberación de trabajos en todos los nodos de proceso que han ejecutado la tarea de preparación del trabajo o liberación de trabajos. Esto incluye los nodos de proceso que se han quitado del grupo. Si esta API se invoca en un trabajo que no tiene ninguna tarea de preparación o liberación de trabajos, el servicio Batch devuelve el código de estado HTTP 409 (conflicto) con un código de error de JobPreparationTaskNotSpecified.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2023-11-01.18.0

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
jobId	path	True	string	Identificador del trabajo.
api-version	query	True	string	Versión de la API de cliente.
$filter	query		string	Una cláusula de $filter OData. Para obtener más información sobre cómo construir este filtro, vea https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
$select	query		string	Una cláusula $select de OData.
maxresults	query		integer int32	Número máximo de elementos que se van a devolver en la respuesta. Se puede devolver un máximo de 1000 tareas.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

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

Nombre	Tipo	Description
client-request-id	string uuid	La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date	string date-time-rfc1123	Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre	Tipo	Description
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	Respuesta que contiene una lista de estados de la tarea de preparación y liberación de trabajos. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Error del servicio Batch. Si esta API se invoca en un trabajo que no tiene ninguna tarea de preparación o liberación de trabajos, el servicio Batch devuelve el código de estado HTTP 409.

Nombre

Tipo

Description

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Respuesta que contiene una lista de estados de la tarea de preparación y liberación de trabajos.

Headers

client-request-id: string
request-id: string
ETag: string
Last-Modified: string

Other Status Codes

BatchError

Error del servicio Batch. Si esta API se invoca en un trabajo que no tiene ninguna tarea de preparación o liberación de trabajos, el servicio Batch devuelve el código de estado HTTP 409.

Seguridad

azure_auth

flujo de código de autenticación de OAuth 2.0 Microsoft Entra

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

Scopes

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Authorization

Type: apiKey
In: header

Ejemplos

Job list preparation and release task status

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definiciones

Nombre	Description
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
CloudJobListPreparationAndReleaseTaskStatusResult	Resultado de enumerar el estado de las tareas de preparación del trabajo y liberación de trabajos para un trabajo.
ErrorCategory	Categoría del error.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.
JobPreparationAndReleaseTaskExecutionInformation	Estado de las tareas de preparación y liberación de trabajos en un nodo de proceso.
JobPreparationTaskExecutionInformation	Contiene información sobre la ejecución de una tarea de preparación de trabajos en un nodo de proceso.
JobPreparationTaskState	Estado actual de la tarea de preparación del trabajo en el nodo de proceso.
JobReleaseTaskExecutionInformation	Contiene información sobre la ejecución de una tarea de liberación de trabajos en un nodo de proceso.
JobReleaseTaskState	Estado actual de la tarea de liberación de trabajos en el nodo de proceso.
NameValuePair	Representa un par nombre-valor.
TaskContainerExecutionInformation	Contiene información sobre el contenedor que se está ejecutando una tarea.
TaskExecutionResult	Resultado de la ejecución de la tarea.
TaskFailureInformation	Información sobre un error de tarea.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	ErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.

Nombre	Tipo	Description
key	string	Identificador que especifica el significado de la propiedad Value.
value	string	La información adicional incluida con la respuesta de error.

CloudJobListPreparationAndReleaseTaskStatusResult

Resultado de enumerar el estado de las tareas de preparación del trabajo y liberación de trabajos para un trabajo.

Nombre	Tipo	Description
odata.nextLink	string	Dirección URL para obtener el siguiente conjunto de resultados.
value	JobPreparationAndReleaseTaskExecutionInformation[]	Una lista de la información de ejecución de tareas de preparación y liberación de trabajos.

ErrorCategory

Categoría del error.

Nombre	Tipo	Description
servererror	string	El error se debe a un problema interno del servidor.
usererror	string	El error se debe a un problema de usuario, como la configuración incorrecta.

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

Nombre	Tipo	Description
lang	string	Código de idioma del mensaje de error
value	string	Texto del mensaje.

JobPreparationAndReleaseTaskExecutionInformation

Estado de las tareas de preparación y liberación de trabajos en un nodo de proceso.

Nombre	Tipo	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Información sobre el estado de ejecución de la tarea de preparación del trabajo en este nodo de proceso.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Información sobre el estado de ejecución de la tarea de liberación de trabajos en este nodo de proceso. Esta propiedad solo se establece si la tarea de liberación de trabajos se ha ejecutado en el nodo de ejecución.
nodeId	string	Identificador del nodo de proceso al que hace referencia esta entrada.
nodeUrl	string	Dirección URL del nodo de ejecución al que hace referencia esta entrada.
poolId	string	Identificador del grupo que contiene el nodo de proceso al que hace referencia esta entrada.

JobPreparationTaskExecutionInformation

Contiene información sobre la ejecución de una tarea de preparación de trabajos en un nodo de proceso.

Nombre	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Información sobre el contenedor en el que se ejecuta la tarea. Esta propiedad solo se establece si la tarea se ejecuta en un contexto de contenedor.
endTime	string	Hora a la que se completó la tarea de preparación del trabajo. Esta propiedad solo se establece si la tarea está en estado Completado.
exitCode	integer	Código de salida del programa especificado en la línea de comandos task. Este parámetro solo se devuelve si la tarea está en estado completado. El código de salida de un proceso refleja la convención específica implementada por el desarrollador de aplicaciones para ese proceso. Si usa el valor de código de salida para tomar decisiones en el código, asegúrese de que conoce la convención de código de salida usada por el proceso de aplicación. Tenga en cuenta que el sistema operativo Del nodo de proceso también puede generar el código de salida, como cuando un proceso finaliza forzosamente.
failureInfo	TaskFailureInformation	Información que describe el error de tarea, si existe. Esta propiedad solo se establece si la tarea está en estado completado y encontró un error.
lastRetryTime	string	La hora más reciente en la que se inició la ejecución de un reintento de la tarea de preparación del trabajo. Esta propiedad solo se establece si se reintentó la tarea (es decir, retryCount es distinto de cero). Si está presente, suele ser el mismo que startTime, pero puede ser diferente si la tarea se ha reiniciado por motivos distintos del reintento; por ejemplo, si el nodo de proceso se ha reiniciado durante un reintento, se actualiza startTime, pero lastRetryTime no.
result	TaskExecutionResult	Resultado de la ejecución de la tarea. Si el valor es "failed", los detalles del error se pueden encontrar en la propiedad failureInfo.
retryCount	integer	Número de veces que el servicio Batch ha reintentado la tarea. Los errores de la aplicación de tareas (código de salida distinto de cero) se reintentan, se reintentan los errores de procesamiento previo (no se pudo ejecutar la tarea) y no se reintentan los errores de carga de archivos. El servicio Batch reintentará la tarea hasta el límite especificado por las restricciones. Los errores de la aplicación de tareas (código de salida distinto de cero) se reintentan, se reintentan los errores de procesamiento previo (no se pudo ejecutar la tarea) y no se reintentan los errores de carga de archivos. El servicio Batch reintentará la tarea hasta el límite especificado por las restricciones.
startTime	string	Hora en la que se inició la ejecución de la tarea. Si se ha reiniciado o reintentado la tarea, esta es la hora más reciente en la que se inició la ejecución de la tarea.
state	JobPreparationTaskState	Estado actual de la tarea de preparación del trabajo en el nodo de proceso.
taskRootDirectory	string	Directorio raíz de la tarea de preparación del trabajo en el nodo de proceso. Puede usar esta ruta de acceso para recuperar los archivos creados por la tarea, como los archivos de registro.
taskRootDirectoryUrl	string	Dirección URL del directorio raíz de la tarea de preparación del trabajo en el nodo de proceso.

JobPreparationTaskState

Estado actual de la tarea de preparación del trabajo en el nodo de proceso.

Nombre	Tipo	Description
completed	string	La tarea se ha cerrado con el código de salida 0 o la tarea ha agotado su límite de reintento o el servicio Batch no pudo iniciar la tarea debido a errores de preparación de la tarea (como errores de descarga de archivos de recursos).
running	string	La tarea se está ejecutando actualmente (incluido el reintento).

JobReleaseTaskExecutionInformation

Contiene información sobre la ejecución de una tarea de liberación de trabajos en un nodo de proceso.

Nombre	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Información sobre el contenedor en el que se ejecuta la tarea. Esta propiedad solo se establece si la tarea se ejecuta en un contexto de contenedor.
endTime	string	Hora a la que se completó la tarea de liberación del trabajo. Esta propiedad solo se establece si la tarea está en estado Completado.
exitCode	integer	Código de salida del programa especificado en la línea de comandos task. Este parámetro solo se devuelve si la tarea está en estado completado. El código de salida de un proceso refleja la convención específica implementada por el desarrollador de aplicaciones para ese proceso. Si usa el valor de código de salida para tomar decisiones en el código, asegúrese de que conoce la convención de código de salida usada por el proceso de aplicación. Tenga en cuenta que el sistema operativo Del nodo de proceso también puede generar el código de salida, como cuando un proceso finaliza forzosamente.
failureInfo	TaskFailureInformation	Información que describe el error de tarea, si existe. Esta propiedad solo se establece si la tarea está en estado completado y encontró un error.
result	TaskExecutionResult	Resultado de la ejecución de la tarea. Si el valor es "failed", los detalles del error se pueden encontrar en la propiedad failureInfo.
startTime	string	Hora en la que se inició la ejecución de la tarea. Si se ha reiniciado o reintentado la tarea, esta es la hora más reciente en la que se inició la ejecución de la tarea.
state	JobReleaseTaskState	Estado actual de la tarea de liberación de trabajos en el nodo de proceso.
taskRootDirectory	string	Directorio raíz de la tarea de liberación de trabajos en el nodo de proceso. Puede usar esta ruta de acceso para recuperar los archivos creados por la tarea, como los archivos de registro.
taskRootDirectoryUrl	string	Dirección URL del directorio raíz de la tarea de liberación de trabajos en el nodo de proceso.

JobReleaseTaskState

Estado actual de la tarea de liberación de trabajos en el nodo de proceso.

Nombre	Tipo	Description
completed	string	La tarea se ha cerrado con el código de salida 0 o la tarea ha agotado su límite de reintento o el servicio Batch no pudo iniciar la tarea debido a errores de preparación de la tarea (como errores de descarga de archivos de recursos).
running	string	La tarea se está ejecutando actualmente (incluido el reintento).

NameValuePair

Representa un par nombre-valor.

Nombre	Tipo	Description
name	string	Nombre del par nombre-valor.
value	string	Valor del par nombre-valor.

TaskContainerExecutionInformation

Contiene información sobre el contenedor que se está ejecutando una tarea.

Nombre	Tipo	Description
containerId	string	La ID del contenedor.
error	string	Información detallada del error sobre el contenedor. Esta es la cadena de error detallada del servicio Docker, si está disponible. Es equivalente al campo de error devuelto por "docker inspect".
state	string	Estado del contenedor. Este es el estado del contenedor según el servicio Docker. Es equivalente al campo de estado devuelto por "docker inspect".

TaskExecutionResult

Resultado de la ejecución de la tarea.

Nombre	Tipo	Description
failure	string	Se produjo un error durante el procesamiento de la tarea. Es posible que el error se haya producido antes de que se inicie el proceso de tarea, mientras se estaba ejecutando el proceso de tarea o después de salir del proceso de tarea.
success	string	La tarea se ejecutó correctamente.

TaskFailureInformation

Información sobre un error de tarea.

Nombre	Tipo	Description
category	ErrorCategory	Categoría del error de tarea.
code	string	Identificador del error de tarea. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	NameValuePair[]	Lista de detalles adicionales relacionados con el error.
message	string	Mensaje que describe el error de tarea, diseñado para ser adecuado para mostrarse en una interfaz de usuario.

Share via

Job - List Preparation And Release Task Status

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

azure_auth

Scopes

Authorization

Ejemplos

Job list preparation and release task status

Sample Request

Sample Response

Definiciones

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Recursos adicionales