Compute Node - Upload Batch Service Logs

Referência

Serviço:: Batch Service

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

Carregue arquivos de log de serviço do Lote do Azure do Nó de Computação especificado para o Armazenamento de Blobs do Azure.
Isso é para coletar arquivos de log de serviço do Lote do Azure de forma automatizada de Nós de Computação se você estiver enfrentando um erro e desejar escalonar para o suporte do Azure. Os arquivos de log de serviço do Lote do Azure devem ser compartilhados com o suporte do Azure para ajudar na depuração de problemas com o serviço lote.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2024-07-01.20.0

Com parâmetros opcionais:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?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.
nodeId	path	True	string	A ID do Nó de Computação do qual você deseja carregar os arquivos de log de serviço do Lote do Azure.
poolId	path	True	string	A ID do pool que contém o Nó de Computação.
api-version	query	True	string	Versão da API do cliente.
timeout	query		integer (int32)	O tempo máximo que o servidor pode gastar processando a solicitação, em segundos. A predefiniçã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	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.

Corpo da solicitação

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

Nome	Obrigatório	Tipo	Description
containerUrl	True	string	A URL do contêiner no Armazenamento de Blobs do Azure para o qual carregar os arquivos de log do Serviço de Lote. Se uma identidade gerenciada atribuída pelo usuário não estiver sendo usada, a URL deverá incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de gravação ao contêiner. A duração da SAS deve permitir tempo suficiente para que o upload seja concluído. A hora de início da SAS é opcional e é recomendável não ser especificada.
startTime	True	string (date-time)	O início do intervalo de tempo do qual carregar arquivos de log do Serviço de Lote. Qualquer arquivo de log que contenha uma mensagem de log no intervalo de tempo será carregado. Isso significa que a operação pode recuperar mais logs do que foram solicitados, pois todo o arquivo de log sempre é carregado, mas a operação não deve recuperar menos logs do que foram solicitados.
endTime		string (date-time)	O fim do intervalo de tempo do qual carregar arquivos de log do Serviço de Lote. Qualquer arquivo de log que contenha uma mensagem de log no intervalo de tempo será carregado. Isso significa que a operação pode recuperar mais logs do que foram solicitados, pois todo o arquivo de log sempre é carregado, mas a operação não deve recuperar menos logs do que foram solicitados. Se omitido, o padrão é carregar todos os logs disponíveis após o startTime.
identityReference		ComputeNodeIdentityReference	A referência à identidade atribuída pelo usuário a ser usada para acessar o Armazenamento de Blobs do Azure especificado pelo containerUrl. A identidade deve ter acesso de gravação ao contêiner do Armazenamento de Blobs do Azure.

Respostas

Nome	Tipo	Description
200 OK	UploadBatchServiceLogsResult	A solicitação para o serviço do Lote foi bem-sucedida. Cabeçalhos client-request-id: string request-id: string
Other Status Codes	BatchError	O erro do serviço do Lote.

Nome

Tipo

Description

200 OK

UploadBatchServiceLogsResult

A solicitação para o serviço do Lote foi bem-sucedida.

Cabeçalhos

client-request-id: string
request-id: string

Other Status Codes

BatchError

O erro do serviço do Lote.

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

Upload BatchService Logs

Solicitação de exemplo

HTTP

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/uploadbatchservicelogs?api-version=2024-07-01.20.0



{
  "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig",
  "startTime": "2017-11-27T00:00:00Z"
}

Resposta de exemplo

Código de status:: 200

{
  "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0",
  "numberOfFilesUploaded": 8
}

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.
ComputeNodeIdentityReference	A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.
ErrorMessage	Uma mensagem de erro recebida em uma resposta de erro do Lote do Azure.
UploadBatchServiceLogsConfiguration	A configuração de upload de arquivos de log de serviço do Lote do Azure para um Nó de Computação.
UploadBatchServiceLogsResult	O resultado do carregamento de arquivos de log de serviço do Lote de um Nó de Computação específico.

BatchError

Objeto

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

Objeto

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.

ComputeNodeIdentityReference

Objeto

A referência a uma identidade atribuída pelo usuário associada ao pool do Lote que um nó de computação usará.

Nome	Tipo	Description
resourceId	string	A ID de recurso do ARM da identidade atribuída pelo usuário.

ErrorMessage

Objeto

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.

UploadBatchServiceLogsConfiguration

Objeto

A configuração de upload de arquivos de log de serviço do Lote do Azure para um Nó de Computação.

Nome	Tipo	Description
containerUrl	string	A URL do contêiner no Armazenamento de Blobs do Azure para o qual carregar os arquivos de log do Serviço de Lote. Se uma identidade gerenciada atribuída pelo usuário não estiver sendo usada, a URL deverá incluir uma SAS (Assinatura de Acesso Compartilhado) concedendo permissões de gravação ao contêiner. A duração da SAS deve permitir tempo suficiente para que o upload seja concluído. A hora de início da SAS é opcional e é recomendável não ser especificada.
endTime	string (date-time)	O fim do intervalo de tempo do qual carregar arquivos de log do Serviço de Lote. Qualquer arquivo de log que contenha uma mensagem de log no intervalo de tempo será carregado. Isso significa que a operação pode recuperar mais logs do que foram solicitados, pois todo o arquivo de log sempre é carregado, mas a operação não deve recuperar menos logs do que foram solicitados. Se omitido, o padrão é carregar todos os logs disponíveis após o startTime.
identityReference	ComputeNodeIdentityReference	A referência à identidade atribuída pelo usuário a ser usada para acessar o Armazenamento de Blobs do Azure especificado pelo containerUrl. A identidade deve ter acesso de gravação ao contêiner do Armazenamento de Blobs do Azure.
startTime	string (date-time)	O início do intervalo de tempo do qual carregar arquivos de log do Serviço de Lote. Qualquer arquivo de log que contenha uma mensagem de log no intervalo de tempo será carregado. Isso significa que a operação pode recuperar mais logs do que foram solicitados, pois todo o arquivo de log sempre é carregado, mas a operação não deve recuperar menos logs do que foram solicitados.

UploadBatchServiceLogsResult

Objeto

O resultado do carregamento de arquivos de log de serviço do Lote de um Nó de Computação específico.

Nome	Tipo	Description
numberOfFilesUploaded	integer (int32)	O número de arquivos de log que serão carregados.
virtualDirectoryName	string	O diretório virtual dentro do contêiner do Armazenamento de Blobs do Azure para o qual os arquivos de log do Serviço de Lote serão carregados. O nome do diretório virtual faz parte do nome do blob para cada arquivo de log carregado e é baseado em poolId, nodeId e um identificador exclusivo.

Compartilhar via

Compute Node - Upload Batch Service Logs

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Authorization

Exemplos

Upload BatchService Logs

Solicitação de exemplo

Resposta de exemplo

Definições

BatchError

BatchErrorDetail

ComputeNodeIdentityReference

ErrorMessage

UploadBatchServiceLogsConfiguration

UploadBatchServiceLogsResult

Recursos adicionais