Job - List Preparation And Release Task Status

Referência

Service:: Batch Service

API Version:: 2023-11-01.18.0

Lista o estado de execução da Tarefa de Preparação da Tarefa e da Tarefa de Lançamento da Tarefa para a Tarefa especificada nos Nós de Computação onde a Tarefa foi executada.
Esta API devolve o estado da Tarefa de Preparação da Tarefa e da Tarefa de Lançamento da Tarefa em todos os Nós de Computação que executaram a Tarefa de Preparação da Tarefa ou a Tarefa de Lançamento da Tarefa. Isto inclui Nós de Computação que foram removidos do Conjunto desde então. Se esta API for invocada numa Tarefa sem Preparação de Tarefas ou Tarefa de Lançamento de Tarefas, o serviço Batch devolve o código de estado HTTP 409 (Conflito) com um código de erro 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 do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	O URL base para todos os pedidos de serviço Azure Batch.
jobId	path	True	string	O ID da Tarefa.
api-version	query	True	string	Versão da API de Cliente.
$filter	query		string	Uma cláusula OData $filter. Para obter mais informações sobre como construir este filtro, consulte https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.
$select	query		string	Uma cláusula OData $select.
maxresults	query		integer int32	O número máximo de itens a devolver na resposta. Pode ser devolvido um máximo de 1000 Tarefas.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos.

Cabeçalho do Pedido

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

Name	Tipo	Description
client-request-id	string uuid	A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Se o servidor deve devolver o client-request-id na resposta.
ocp-date	string date-time-rfc1123	A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente.

Respostas

Name	Tipo	Description
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	Uma resposta que contém uma lista de estados de Preparação de Trabalhos e tarefas de lançamento de tarefas. Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço Batch. Se esta API for invocada numa Tarefa sem Preparação de Trabalhos ou Tarefa de Lançamento de Tarefas, o serviço Batch devolve o código de estado HTTP 409.

Name

Tipo

Description

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Uma resposta que contém uma lista de estados de Preparação de Trabalhos e tarefas de lançamento de tarefas.

Headers

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

Other Status Codes

BatchError

O erro do serviço Batch. Se esta API for invocada numa Tarefa sem Preparação de Trabalhos ou Tarefa de Lançamento de Tarefas, o serviço Batch devolve o código de estado HTTP 409.

Segurança

azure_auth

Microsoft Entra fluxo de código de autenticação OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Representar a sua conta de utilizador

Authorization

Type: apiKey
In: header

Exemplos

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

Definições

Name	Description
BatchError	Uma resposta de erro recebida do serviço Azure Batch.
BatchErrorDetail	Um item de informações adicionais incluídas numa resposta de erro Azure Batch.
CloudJobListPreparationAndReleaseTaskStatusResult	O resultado da listagem do estado das Tarefas de Preparação da Tarefa e de Lançamento de Tarefas para uma Tarefa.
ErrorCategory	A categoria do erro.
ErrorMessage	Uma mensagem de erro recebida numa resposta de erro Azure Batch.
JobPreparationAndReleaseTaskExecutionInformation	O estado das Tarefas de Preparação da Tarefa e de Lançamento de Tarefas num Nó de Computação.
JobPreparationTaskExecutionInformation	Contém informações sobre a execução de uma Tarefa de Preparação de Trabalhos num Nó de Computação.
JobPreparationTaskState	O estado atual da Tarefa de Preparação da Tarefa no Nó de Computação.
JobReleaseTaskExecutionInformation	Contém informações sobre a execução de uma Tarefa de Lançamento de Tarefas num Nó de Computação.
JobReleaseTaskState	O estado atual da Tarefa de Lançamento da Tarefa no Nó de Computação.
NameValuePair	Representa um par nome-valor.
TaskContainerExecutionInformation	Contém informações sobre o contentor que uma Tarefa está a executar.
TaskExecutionResult	O resultado da execução da Tarefa.
TaskFailureInformation	Informações sobre uma Falha de tarefa.

BatchError

Uma resposta de erro recebida do serviço Azure Batch.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	ErrorMessage	Uma mensagem que descreve o erro, que se destina a ser adequada para ser apresentada numa interface de utilizador.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor que contém detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluídas numa resposta de erro Azure Batch.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Valor.
value	string	As informações adicionais incluídas na resposta do erro.

CloudJobListPreparationAndReleaseTaskStatusResult

O resultado da listagem do estado das Tarefas de Preparação da Tarefa e de Lançamento de Tarefas para uma Tarefa.

Name	Tipo	Description
odata.nextLink	string	O URL para obter o próximo conjunto de resultados.
value	JobPreparationAndReleaseTaskExecutionInformation[]	Uma lista de informações de execução da Tarefa de Preparação de Trabalhos e Lançamento de Tarefas.

ErrorCategory

A categoria do erro.

Name	Tipo	Description
servererror	string	O erro deve-se a um problema interno do servidor.
usererror	string	O erro deve-se a um problema do utilizador, como configuração incorreta.

ErrorMessage

Uma mensagem de erro recebida numa resposta de erro Azure Batch.

Name	Tipo	Description
lang	string	O código de idioma da mensagem de erro
value	string	O texto da mensagem.

JobPreparationAndReleaseTaskExecutionInformation

O estado das Tarefas de Preparação da Tarefa e de Lançamento de Tarefas num Nó de Computação.

Name	Tipo	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informações sobre o estado de execução da Tarefa de Preparação da Tarefa neste Nó de Computação.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Informações sobre o estado de execução da Tarefa de Lançamento da Tarefa neste Nó de Computação. Esta propriedade é definida apenas se a Tarefa de Lançamento da Tarefa tiver sido executada no Nó de Computação.
nodeId	string	O ID do Nó de Computação ao qual esta entrada se refere.
nodeUrl	string	O URL do Nó de Computação ao qual esta entrada se refere.
poolId	string	O ID do Conjunto que contém o Nó de Computação ao qual esta entrada se refere.

JobPreparationTaskExecutionInformation

Contém informações sobre a execução de uma Tarefa de Preparação de Trabalhos num Nó de Computação.

Name	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Informações sobre o contentor no qual a Tarefa está a ser executada. Esta propriedade só é definida se a Tarefa for executada num contexto de contentor.
endTime	string	O momento em que a Tarefa de Preparação da Tarefa foi concluída. Esta propriedade só é definida se a Tarefa estiver no estado Concluída.
exitCode	integer	O código de saída do programa especificado na linha de comandos Tarefa. Este parâmetro só é devolvido se a Tarefa estiver no estado concluído. O código de saída de um processo reflete a convenção específica implementada pelo programador da aplicação para esse processo. Se utilizar o valor do código de saída para tomar decisões no seu código, certifique-se de que conhece a convenção de código de saída utilizada pelo processo da aplicação. Tenha em atenção que o código de saída também pode ser gerado pelo sistema operativo do Nó de Computação, como quando um processo é forçado a terminar.
failureInfo	TaskFailureInformation	Informações que descrevem a falha da Tarefa, se existirem. Esta propriedade só é definida se a Tarefa estiver no estado concluído e tiver encontrado uma falha.
lastRetryTime	string	A hora mais recente em que uma nova tentativa da Tarefa de Preparação da Tarefa começou a ser executada. Esta propriedade só é definida se a Tarefa tiver sido repetida (ou seja, retryCount não for zero). Se estiver presente, é normalmente igual a startTime, mas pode ser diferente se a Tarefa tiver sido reiniciada por razões que não a repetição; por exemplo, se o Nó de Computação tiver sido reiniciado durante uma repetição, o startTime é atualizado, mas o últimoRetryTime não é.
result	TaskExecutionResult	O resultado da execução da Tarefa. Se o valor for "falha", os detalhes da falha podem ser encontrados na propriedade failureInfo.
retryCount	integer	O número de vezes que a Tarefa foi repetida pelo serviço Batch. As falhas da aplicação de tarefas (código de saída não zero) são repetidas, erros de pré-processamento (não foi possível executar a Tarefa) e os erros de carregamento de ficheiros não são repetidos. O serviço Batch repetirá a Tarefa até ao limite especificado pelas restrições. As falhas da aplicação de tarefas (código de saída não zero) são repetidas, erros de pré-processamento (não foi possível executar a Tarefa) e os erros de carregamento de ficheiros não são repetidos. O serviço Batch repetirá a Tarefa até ao limite especificado pelas restrições.
startTime	string	A hora em que a Tarefa começou a ser executada. Se a Tarefa tiver sido reiniciada ou repetida, esta é a hora mais recente em que a Tarefa começou a ser executada.
state	JobPreparationTaskState	O estado atual da Tarefa de Preparação da Tarefa no Nó de Computação.
taskRootDirectory	string	O diretório raiz da Tarefa de Preparação de Tarefas no Nó de Computação. Pode utilizar este caminho para obter ficheiros criados pela Tarefa, como ficheiros de registo.
taskRootDirectoryUrl	string	O URL para o diretório de raiz da Tarefa de Preparação da Tarefa no Nó de Computação.

JobPreparationTaskState

O estado atual da Tarefa de Preparação da Tarefa no Nó de Computação.

Name	Tipo	Description
completed	string	A Tarefa foi encerrada com o código de saída 0 ou a Tarefa esgotou o limite de repetições ou o serviço Batch não conseguiu iniciar a Tarefa devido a erros de preparação da tarefa (como falhas na transferência do ficheiro de recursos).
running	string	A Tarefa está atualmente em execução (incluindo a repetição).

JobReleaseTaskExecutionInformation

Contém informações sobre a execução de uma Tarefa de Lançamento de Tarefas num Nó de Computação.

Name	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Informações sobre o contentor no qual a Tarefa está a ser executada. Esta propriedade só é definida se a Tarefa for executada num contexto de contentor.
endTime	string	O momento em que a Tarefa de Lançamento da Tarefa foi concluída. Esta propriedade só é definida se a Tarefa estiver no estado Concluída.
exitCode	integer	O código de saída do programa especificado na linha de comandos Tarefa. Este parâmetro só é devolvido se a Tarefa estiver no estado concluído. O código de saída de um processo reflete a convenção específica implementada pelo programador da aplicação para esse processo. Se utilizar o valor do código de saída para tomar decisões no seu código, certifique-se de que conhece a convenção de código de saída utilizada pelo processo da aplicação. Tenha em atenção que o código de saída também pode ser gerado pelo sistema operativo do Nó de Computação, como quando um processo é forçado a terminar.
failureInfo	TaskFailureInformation	Informações que descrevem a falha da Tarefa, se existirem. Esta propriedade só é definida se a Tarefa estiver no estado concluído e tiver encontrado uma falha.
result	TaskExecutionResult	O resultado da execução da Tarefa. Se o valor for "falha", os detalhes da falha podem ser encontrados na propriedade failureInfo.
startTime	string	A hora em que a Tarefa começou a ser executada. Se a Tarefa tiver sido reiniciada ou repetida, esta é a hora mais recente em que a Tarefa começou a ser executada.
state	JobReleaseTaskState	O estado atual da Tarefa de Lançamento da Tarefa no Nó de Computação.
taskRootDirectory	string	O diretório raiz da Tarefa de Lançamento da Tarefa no Nó de Computação. Pode utilizar este caminho para obter ficheiros criados pela Tarefa, como ficheiros de registo.
taskRootDirectoryUrl	string	O URL para o diretório de raiz da Tarefa de Lançamento da Tarefa no Nó de Computação.

JobReleaseTaskState

O estado atual da Tarefa de Lançamento da Tarefa no Nó de Computação.

Name	Tipo	Description
completed	string	A Tarefa foi encerrada com o código de saída 0 ou a Tarefa esgotou o limite de repetições ou o serviço Batch não conseguiu iniciar a Tarefa devido a erros de preparação da tarefa (como falhas na transferência do ficheiro de recursos).
running	string	A Tarefa está atualmente em execução (incluindo a repetição).

NameValuePair

Representa um par nome-valor.

Name	Tipo	Description
name	string	O nome no par name-value.
value	string	O valor no par name-value.

TaskContainerExecutionInformation

Contém informações sobre o contentor que uma Tarefa está a executar.

Name	Tipo	Description
containerId	string	O ID do contentor.
error	string	Informações detalhadas sobre o erro sobre o contentor. Esta é a cadeia de erro detalhada do serviço Docker, se disponível. É equivalente ao campo de erro devolvido pela "inspeção do docker".
state	string	O estado do contentor. Este é o estado do contentor de acordo com o serviço Docker. É equivalente ao campo de estado devolvido pela "inspeção do docker".

TaskExecutionResult

O resultado da execução da Tarefa.

Name	Tipo	Description
failure	string	Ocorreu um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes de o processo de Tarefa ter sido iniciado, enquanto o processo de Tarefa estava em execução ou após o processo de Tarefa ter sido encerrado.
success	string	A Tarefa foi executada com êxito.

TaskFailureInformation

Informações sobre uma Falha de tarefa.

Name	Tipo	Description
category	ErrorCategory	A categoria do erro Tarefa.
code	string	Um identificador para o erro Tarefa. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	NameValuePair[]	Uma lista de detalhes adicionais relacionados com o erro.
message	string	Uma mensagem que descreve o erro Tarefa, que se destina a ser adequada para ser apresentada numa interface de utilizador.

Share via

Job - List Preparation And Release Task Status

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

azure_auth

Scopes

Authorization

Exemplos

Job list preparation and release task status

Sample Request

Sample Response

Definições

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Recursos adicionais