Job - List Preparation And Release Task Status

Referência

Serviço:: Batch Service

Versão da API:: 2024-07-01.20.0

Lista o status de execução da Tarefa de Preparação e Liberação de Trabalho para o Trabalho especificado nos Nós de Computação onde o Trabalho foi executado.
Essa API retorna o status da Tarefa de Preparação e Liberação de Trabalho em todos os Nós de Computação que executaram a Tarefa de Preparação ou Liberação de Trabalho. Isso inclui nós de computação que já foram removidos do pool. Se essa API for invocada em um trabalho que não tenha nenhuma tarefa de preparação ou liberação de trabalho, o serviço em lote retornará o código de status HTTP 409 (Conflito) com um código de erro de JobPreparationTaskNotSpecified.

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?api-version=2024-07-01.20.0

Com parâmetros opcionais:

GET {batchUrl}/jobs/{jobId}/jobpreparationandreleasetaskstatus?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
batchUrl	path	True	string	A URL base para todas as solicitações de serviço do Lote do Azure.
jobId	path	True	string	A ID do trabalho.
api-version	query	True	string	Versão da API do cliente.
$filter	query		string	Uma cláusula $filter OData. Para obter mais informações sobre como construir esse filtro, consulte https://zcusa.951200.xyz/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 serem retornados na resposta. Um máximo de 1000 tarefas podem ser retornadas.
timeout	query		integer int32	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. O padrão é 30 segundos. Se o valor for maior que 30, o padrão será usado.

Cabeçalho do Pedido

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

Name	Tipo	Description
client-request-id	string uuid	A identidade de solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves encaracoladas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Se o servidor deve retornar o client-request-id na resposta.
ocp-date	string date-time-rfc1123	A hora em que o pedido foi emitido. As bibliotecas de cliente normalmente definem isso para a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Name	Tipo	Description
200 OK	CloudJobListPreparationAndReleaseTaskStatusResult	Uma resposta contendo uma lista de status de Tarefa de Preparação e Liberação de Trabalho. Cabeçalhos client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	O erro do serviço de lote. Se essa API for invocada em um trabalho que não tenha nenhuma tarefa de preparação ou liberação de trabalho, o serviço em lote retornará o código de status HTTP 409.

Name

Tipo

Description

200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Uma resposta contendo uma lista de status de Tarefa de Preparação e Liberação de Trabalho.

Cabeçalhos

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

Other Status Codes

BatchError

O erro do serviço de lote. Se essa API for invocada em um trabalho que não tenha nenhuma tarefa de preparação ou liberação de trabalho, o serviço em lote retornará o código de status HTTP 409.

Segurança

azure_auth

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

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Authorization

Tipo: apiKey
Em: header

Exemplos

Job list preparation and release task status

Pedido de amostra

HTTP

GET account.region.batch.azure.com/jobs/jobId/jobpreparationandreleasetaskstatus?api-version=2024-07-01.20.0

Resposta da amostra

Código de estado:: 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=2024-07-01.20.0"
}

Definições

Name	Description
BatchError	Uma resposta de erro recebida do serviço Batch do Azure.
BatchErrorDetail	Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.
CloudJobListPreparationAndReleaseTaskStatusResult	O resultado da listagem do status das Tarefas de Preparação e Liberação de Trabalho para um Trabalho.
ErrorCategory	A categoria do erro.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
JobPreparationAndReleaseTaskExecutionInformation	O status das tarefas de preparação e liberação de trabalho em um nó de computação.
JobPreparationTaskExecutionInformation	Contém informações sobre a execução de uma Tarefa de Preparação de Trabalho em um Nó de Computação.
JobPreparationTaskState	O estado atual da Tarefa de Preparação de Trabalho no Nó de Computação.
JobReleaseTaskExecutionInformation	Contém informações sobre a execução de uma tarefa de liberação de trabalho em um nó de computação.
JobReleaseTaskState	O estado atual da Tarefa de Liberação de Trabalho no Nó de Computação.
NameValuePair	Representa um par nome-valor.
TaskContainerExecutionInformation	Contém informações sobre o contêiner que uma tarefa está executando.
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 Batch do Azure.

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 descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
values	BatchErrorDetail[]	Uma coleção de pares chave-valor contendo detalhes adicionais sobre o erro.

BatchErrorDetail

Um item de informações adicionais incluído em uma resposta de erro do Lote do Azure.

Name	Tipo	Description
key	string	Um identificador que especifica o significado da propriedade Value.
value	string	As informações adicionais incluídas com a resposta de erro.

CloudJobListPreparationAndReleaseTaskStatusResult

O resultado da listagem do status das Tarefas de Preparação e Liberação de Trabalho para um Trabalho.

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 de tarefas de preparação e liberação de trabalho.

ErrorCategory

A categoria do erro.

Name	Tipo	Description
servererror	string	O erro é devido a um problema interno do servidor.
usererror	string	O erro é devido a um problema do usuário, como configuração incorreta.

ErrorMessage

Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.

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

JobPreparationAndReleaseTaskExecutionInformation

O status das tarefas de preparação e liberação de trabalho em um nó de computação.

Name	Tipo	Description
jobPreparationTaskExecutionInfo	JobPreparationTaskExecutionInformation	Informações sobre o status de execução da Tarefa de Preparação de Trabalho neste Nó de Computação.
jobReleaseTaskExecutionInfo	JobReleaseTaskExecutionInformation	Informações sobre o status de execução da Tarefa de Liberação de Trabalho neste Nó de Computação. Essa propriedade será definida somente se a Tarefa de Liberação de Trabalho tiver sido executada no nó de computação.
nodeId	string	A ID do nó de computação ao qual esta entrada se refere.
nodeUrl	string	A URL do Nó de Computação ao qual esta entrada se refere.
poolId	string	A ID do Pool 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 Trabalho em um Nó de Computação.

Name	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Informações sobre o contêiner sob o qual a Tarefa está sendo executada. Essa propriedade é definida somente se a Tarefa for executada em um contexto de contêiner.
endTime	string	O momento em que a Tarefa de Preparação do Trabalho foi concluída. Esta propriedade é definida somente se a tarefa estiver no estado concluído.
exitCode	integer	O código de saída do programa especificado na linha de comando Tarefa. Esse parâmetro será retornado somente 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 desenvolvedor do aplicativo para esse processo. Se você usar o valor do código de saída para tomar decisões em seu código, certifique-se de conhecer a convenção de código de saída usada pelo processo de aplicativo. Observe que o código de saída também pode ser gerado pelo sistema operacional Compute Node, como quando um processo é encerrado à força.
failureInfo	TaskFailureInformation	Informações que descrevem a falha da tarefa, se houver. Esta propriedade é definida somente se a tarefa estiver no estado concluído e encontrou uma falha.
lastRetryTime	string	O momento mais recente em que uma nova tentativa da Tarefa de Preparação de Trabalho começou a ser executada. Esta propriedade é definida somente se a tarefa foi tentada novamente (ou seja, retryCount é diferente de zero). Se presente, normalmente é o mesmo que startTime, mas pode ser diferente se a Tarefa tiver sido reiniciada por motivos diferentes de repetir; por exemplo, se o nó de computação foi reinicializado durante uma nova tentativa, então o startTime é atualizado, mas o lastRetryTime não.
result	TaskExecutionResult	O resultado da execução da tarefa. Se o valor for 'failed', 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 de lote. Falhas de aplicativo de tarefa (código de saída diferente de zero) são repetidas, erros de pré-processamento (a tarefa não pôde ser executada) e erros de upload de arquivo não são repetidos. O serviço Batch tentará novamente a Tarefa até o limite especificado pelas restrições. Falhas de aplicativo de tarefa (código de saída diferente de zero) são repetidas, erros de pré-processamento (a tarefa não pôde ser executada) e erros de upload de arquivo não são repetidos. O serviço Batch tentará novamente a Tarefa até o 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 de Trabalho no Nó de Computação.
taskRootDirectory	string	O diretório raiz da Tarefa de Preparação de Trabalho no nó de computação. Você pode usar esse caminho para recuperar arquivos criados pela tarefa, como arquivos de log.
taskRootDirectoryUrl	string	A URL para o diretório raiz da Tarefa de Preparação de Trabalho no nó de computação.

JobPreparationTaskState

O estado atual da Tarefa de Preparação de Trabalho 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 seu limite de novas tentativas, ou o serviço em Lote não pôde iniciar a Tarefa devido a erros de preparação da Tarefa (como falhas de download do arquivo de recurso).
running	string	A tarefa está atualmente em execução (incluindo novas tentativas).

JobReleaseTaskExecutionInformation

Contém informações sobre a execução de uma tarefa de liberação de trabalho em um nó de computação.

Name	Tipo	Description
containerInfo	TaskContainerExecutionInformation	Informações sobre o contêiner sob o qual a Tarefa está sendo executada. Essa propriedade é definida somente se a Tarefa for executada em um contexto de contêiner.
endTime	string	O momento em que a Tarefa de Liberação de Trabalho foi concluída. Esta propriedade é definida somente se a tarefa estiver no estado concluído.
exitCode	integer	O código de saída do programa especificado na linha de comando Tarefa. Esse parâmetro será retornado somente 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 desenvolvedor do aplicativo para esse processo. Se você usar o valor do código de saída para tomar decisões em seu código, certifique-se de conhecer a convenção de código de saída usada pelo processo de aplicativo. Observe que o código de saída também pode ser gerado pelo sistema operacional Compute Node, como quando um processo é encerrado à força.
failureInfo	TaskFailureInformation	Informações que descrevem a falha da tarefa, se houver. Esta propriedade é definida somente se a tarefa estiver no estado concluído e encontrou uma falha.
result	TaskExecutionResult	O resultado da execução da tarefa. Se o valor for 'failed', 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 Liberação de Trabalho no Nó de Computação.
taskRootDirectory	string	O diretório raiz da tarefa de liberação de trabalho no nó de computação. Você pode usar esse caminho para recuperar arquivos criados pela tarefa, como arquivos de log.
taskRootDirectoryUrl	string	A URL para o diretório raiz da Tarefa de Liberação de Trabalho no nó de computação.

JobReleaseTaskState

O estado atual da Tarefa de Liberação de Trabalho 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 seu limite de novas tentativas, ou o serviço em Lote não pôde iniciar a Tarefa devido a erros de preparação da Tarefa (como falhas de download do arquivo de recurso).
running	string	A tarefa está atualmente em execução (incluindo novas tentativas).

NameValuePair

Representa um par nome-valor.

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

TaskContainerExecutionInformation

Contém informações sobre o contêiner que uma tarefa está executando.

Name	Tipo	Description
containerId	string	A ID do contêiner.
error	string	Informações detalhadas de erro sobre o contêiner. Esta é a cadeia de erro detalhada do serviço Docker, se disponível. É equivalente ao campo de erro retornado por "docker inspect".
state	string	O estado do recipiente. Este é o estado do contêiner de acordo com o serviço Docker. É equivalente ao campo de status retornado por "docker inspect".

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 do processo de Tarefa ter sido iniciado, enquanto o processo de Tarefa estava em execução ou depois de 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 ao erro.
message	string	Uma mensagem descrevendo o erro de tarefa, destinado a ser adequado para exibição em uma interface do usuário.

Partilhar via

Job - List Preparation And Release Task Status

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Authorization

Exemplos

Job list preparation and release task status

Pedido de amostra

Resposta da amostra

Definições

BatchError

BatchErrorDetail

CloudJobListPreparationAndReleaseTaskStatusResult

ErrorCategory

ErrorMessage

JobPreparationAndReleaseTaskExecutionInformation

JobPreparationTaskExecutionInformation

JobPreparationTaskState

JobReleaseTaskExecutionInformation

JobReleaseTaskState

NameValuePair

TaskContainerExecutionInformation

TaskExecutionResult

TaskFailureInformation

Recursos adicionais