Compartilhar via

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 preparação do trabalho e da versão do trabalho para o trabalho especificado nos nós de computação em que o trabalho foi executado.
Essa API retorna o status da Tarefa preparação do trabalho e da liberação de trabalho em todos os nós de computação que executaram a tarefa Preparação do Trabalho ou Liberação de Trabalho. Isso inclui nós de computação que foram removidos do pool desde então. Se essa API for invocada em um trabalho que não tem tarefa de preparação de trabalho ou de liberação de trabalho, o serviço do 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 de URI

Nome Em Obrigató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 $select OData.
maxresults
 query

integer

int32

O número máximo de itens a serem retornados na resposta. No máximo 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 da solicitação

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

Nome Obrigatório Tipo Description
client-request-id

string

uuid

A identidade da solicitação gerada pelo chamador, na forma de um GUID sem decoração, como chaves, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Se o servidor deve retornar a ID de solicitação do cliente na resposta.
ocp-date

string

date-time-rfc1123

A hora em que a solicitação foi emitida. As bibliotecas de cliente normalmente definem isso como a hora atual do relógio do sistema; defina-o explicitamente se você estiver chamando a API REST diretamente.

Respostas

Nome Tipo Description
200 OK

CloudJobListPreparationAndReleaseTaskStatusResult

Uma resposta que contém uma lista de status de Tarefa de Preparação de Trabalho 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 do Lote. Se essa API for invocada em um trabalho que não tenha nenhuma tarefa de preparação de trabalho ou de liberação de trabalho, o serviço do 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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation Representar sua conta de usuário

Authorization

Tipo: apiKey
Em: header

Exemplos

Job list preparation and release task status

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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

Nome Description
BatchError

Uma resposta de erro recebida do serviço do Lote 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 preparação do trabalho 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 preparação do trabalho 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 preparação do 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 Versão do 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 do Lote do Azure.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
message

ErrorMessage

Uma mensagem que descreve 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.

Nome Tipo Description
key

string

Um identificador que especifica o significado da propriedade Value.
value

string

As informações adicionais incluídas na resposta de erro.

CloudJobListPreparationAndReleaseTaskStatusResult

O resultado da listagem do status das tarefas preparação do trabalho e liberação de trabalho para um trabalho.

Nome Tipo Description
odata.nextLink

string

A URL para obter o próximo conjunto de resultados.
value

JobPreparationAndReleaseTaskExecutionInformation[]

Uma lista das informações de execução da tarefa preparação do trabalho e da liberação do trabalho.

ErrorCategory

A categoria do erro.

Nome Tipo Description
servererror

string

O erro ocorre devido a um problema interno do servidor.
usererror

string

O erro ocorre devido a um problema de usuário, como configuração incorreta.

ErrorMessage

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

Nome Tipo Description
lang

string

O código de idioma da mensagem de erro
value

string

O texto da mensagem.

JobPreparationAndReleaseTaskExecutionInformation

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

Nome Tipo Description
jobPreparationTaskExecutionInfo

JobPreparationTaskExecutionInformation

Informações sobre o status de execução da Tarefa preparação do 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 essa entrada se refere.
nodeUrl

string

A URL do Nó de Computação ao qual essa entrada se refere.
poolId

string

A ID do pool que contém o Nó de Computação ao qual essa 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.

Nome Tipo Description
containerInfo

TaskContainerExecutionInformation

Informações sobre o contêiner no qual a Tarefa está sendo executada.
Essa propriedade será definida somente se a Tarefa for executada em um contexto de contêiner.
endTime

string

A hora em que a Tarefa de Preparação do Trabalho foi concluída.
Essa propriedade será 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 de aplicativos 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 do Nó de Computação, como quando um processo é encerrado à força.
failureInfo

TaskFailureInformation

Informações que descrevem a falha da tarefa, se houver.
Essa propriedade será definida somente se a Tarefa estiver no estado concluído e encontrar 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.
Essa propriedade será definida somente se a Tarefa foi repetida (ou seja, retryCount não é zero). Se presente, isso normalmente é o mesmo que startTime, mas pode ser diferente se a Tarefa tiver sido reiniciada por motivos diferentes da repetição; por exemplo, se o Nó de Computação foi reinicializado durante uma repetição, o startTime é atualizado, mas o lastRetryTime não é.
result

TaskExecutionResult

O resultado da execução da tarefa.
Se o valor for 'falha', os detalhes da falha poderão ser encontrados na propriedade failureInfo.
retryCount

integer

O número de vezes que a Tarefa foi repetida pelo serviço do 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 lote 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 lote 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 será a hora mais recente em que a Tarefa começou a ser executada.
state

JobPreparationTaskState

O estado atual da Tarefa preparação do trabalho no nó de computação.
taskRootDirectory

string

O diretório raiz da Tarefa preparação do 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 do Trabalho no Nó de Computação.

JobPreparationTaskState

O estado atual da Tarefa preparação do trabalho no nó de computação.

Nome Tipo Description
completed

string

A Tarefa foi encerrada com o código de saída 0 ou a Tarefa esgotou seu limite de repetição ou o serviço do Lote não pôde iniciar a Tarefa devido a erros de preparação da tarefa (como falhas de download de arquivo de recurso).
running

string

No momento, a Tarefa está em execução (incluindo a repetição).

JobReleaseTaskExecutionInformation

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

Nome Tipo Description
containerInfo

TaskContainerExecutionInformation

Informações sobre o contêiner no qual a Tarefa está sendo executada.
Essa propriedade será definida somente se a Tarefa for executada em um contexto de contêiner.
endTime

string

A hora em que a Tarefa de Liberação do Trabalho foi concluída.
Essa propriedade será 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 de aplicativos 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 do Nó de Computação, como quando um processo é encerrado à força.
failureInfo

TaskFailureInformation

Informações que descrevem a falha da tarefa, se houver.
Essa propriedade será definida somente se a Tarefa estiver no estado concluído e encontrar uma falha.
result

TaskExecutionResult

O resultado da execução da tarefa.
Se o valor for 'falha', os detalhes da falha poderão 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 será a hora mais recente em que a Tarefa começou a ser executada.
state

JobReleaseTaskState

O estado atual da Tarefa de Versão do 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 Versão do Trabalho no Nó de Computação.

Nome Tipo Description
completed

string

A Tarefa foi encerrada com o código de saída 0 ou a Tarefa esgotou seu limite de repetição ou o serviço do Lote não pôde iniciar a Tarefa devido a erros de preparação da tarefa (como falhas de download de arquivo de recurso).
running

string

No momento, a Tarefa está em execução (incluindo a repetição).

NameValuePair

Representa um par nome-valor.

Nome 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.

Nome Tipo Description
containerId

string

A ID do contêiner.
error

string

Informações detalhadas de erro sobre o contêiner.
Essa é a cadeia de caracteres de erro detalhada do serviço Docker, se disponível. É equivalente ao campo de erro retornado por "inspeção do docker".
state

string

O estado do contêiner.
Esse é o estado do contêiner de acordo com o serviço docker. É equivalente ao campo de status retornado por "inspeção do docker".

TaskExecutionResult

O resultado da execução da tarefa.

Nome Tipo Description
failure

string

Houve um erro durante o processamento da Tarefa. A falha pode ter ocorrido antes do processo de tarefa ser iniciado, enquanto o processo de tarefa estava em execução ou após a saída do processo de tarefa.
success

string

A Tarefa foi executada com êxito.

TaskFailureInformation

Informações sobre uma falha de tarefa.

Nome Tipo Description
category

ErrorCategory

A categoria do erro Tarefa.
code

string

Um identificador para o erro tarefa. Os códigos são invariáveis e devem ser consumidos programaticamente.
details

NameValuePair[]

Uma lista de detalhes adicionais relacionados ao erro.
message

string

Uma mensagem que descreve o erro Tarefa, destinada a ser adequada para exibição em uma interface do usuário.