Compute Node - Upload Batch Service Logs

Servizio:

Batch Service

Versione API:

2024-07-01.20.0

Caricare i file di log del servizio Azure Batch dal nodo di calcolo specificato in Archiviazione BLOB di Azure.
Questo è per raccogliere i file di log del servizio Azure Batch in modo automatizzato dai nodi di calcolo se si verifica un errore e si vuole inoltrare al supporto di Azure. I file di log del servizio Azure Batch devono essere condivisi con il supporto di Azure per facilitare il debug dei problemi con il servizio Batch.

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
batchUrl	path	True	string	URL di base per tutte le richieste del servizio Azure Batch.
nodeId	path	True	string	ID del nodo di calcolo da cui si desidera caricare i file di log del servizio Azure Batch.
poolId	path	True	string	ID del pool che contiene il nodo di calcolo.
api-version	query	True	string	Versione dell'API client.
timeout	query		integer (int32)	Tempo massimo di elaborazione della richiesta da parte del server, espresso in secondi. Il valore predefinito è 30 secondi. Se il valore è maggiore di 30, verrà usato il valore predefinito.

Intestazione della richiesta

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

Nome	Necessario	Tipo	Descrizione
client-request-id		string (uuid)	Identità della richiesta generata dal chiamante, sotto forma di GUID senza decorazioni come parentesi graffe, ad esempio 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indica se il server deve restituire l'ID richiesta client nella risposta.
ocp-date		string (date-time-rfc1123)	Ora di emissione della richiesta. Le librerie client in genere impostano questo valore sull'ora corrente dell'orologio di sistema; impostarla in modo esplicito se si chiama direttamente l'API REST.

Corpo della richiesta

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

Nome	Necessario	Tipo	Descrizione
containerUrl	True	string	URL del contenitore all'interno di Archiviazione BLOB di Azure in cui caricare i file di log del servizio Batch. Se non viene usata un'identità gestita assegnata dall'utente, l'URL deve includere una firma di accesso condiviso concedendo autorizzazioni di scrittura al contenitore. La durata della firma di accesso condiviso deve consentire tempo sufficiente per il completamento del caricamento. L'ora di inizio per la firma di accesso condiviso è facoltativa e consigliata per non essere specificata.
startTime	True	string (date-time)	Inizio dell'intervallo di tempo da cui caricare i file di log del servizio Batch. Tutti i file di log contenenti un messaggio di log nell'intervallo di tempo verranno caricati. Ciò significa che l'operazione potrebbe recuperare più log di quelli richiesti perché l'intero file di log viene sempre caricato, ma l'operazione non deve recuperare meno log di quanto richiesto.
endTime		string (date-time)	Fine dell'intervallo di tempo da cui caricare i file di log del servizio Batch. Tutti i file di log contenenti un messaggio di log nell'intervallo di tempo verranno caricati. Ciò significa che l'operazione potrebbe recuperare più log di quelli richiesti perché l'intero file di log viene sempre caricato, ma l'operazione non deve recuperare meno log di quanto richiesto. Se omesso, il valore predefinito consiste nel caricare tutti i log disponibili dopo startTime.
identityReference		ComputeNodeIdentityReference	Riferimento all'identità assegnata dall'utente da usare per accedere ad Archiviazione BLOB di Azure specificata da containerUrl. L'identità deve avere accesso in scrittura al contenitore di Archiviazione BLOB di Azure.

Risposte

Nome	Tipo	Descrizione
200 OK	UploadBatchServiceLogsResult	La richiesta al servizio Batch ha avuto esito positivo. Intestazioni client-request-id: string request-id: string
Other Status Codes	BatchError	Errore del servizio Batch.

Sicurezza

azure_auth

Flusso del codice di autenticazione di Microsoft Entra OAuth 2.0

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Rappresentare l'account utente

Authorization

Tipo: apiKey
In: header

Esempio

Upload BatchService Logs

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

200

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

Definizioni

Nome	Descrizione
BatchError	Risposta di errore ricevuta dal servizio Azure Batch.
BatchErrorDetail	Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.
ComputeNodeIdentityReference	Riferimento a un'identità assegnata dall'utente associata al pool di Batch che verrà usato da un nodo di calcolo.
ErrorMessage	Messaggio di errore ricevuto in una risposta di errore di Azure Batch.
UploadBatchServiceLogsConfiguration	La configurazione di caricamento dei file di log del servizio Azure Batch per un nodo di calcolo.
UploadBatchServiceLogsResult	Risultato del caricamento dei file di log del servizio Batch da un nodo di calcolo specifico.

BatchError

Object

Risposta di errore ricevuta dal servizio Azure Batch.

Nome	Tipo	Descrizione
code	string	Identificatore dell'errore. I codici sono invarianti e devono essere utilizzati a livello di codice.
message	ErrorMessage	Messaggio che descrive l'errore, destinato a essere adatto per la visualizzazione in un'interfaccia utente.
values	BatchErrorDetail[]	Raccolta di coppie chiave-valore contenenti dettagli aggiuntivi sull'errore.

BatchErrorDetail

Object

Elemento di informazioni aggiuntive incluse in una risposta di errore di Azure Batch.

Nome	Tipo	Descrizione
key	string	Identificatore che specifica il significato della proprietà Value.
value	string	Informazioni aggiuntive incluse nella risposta di errore.

ComputeNodeIdentityReference

Object

Riferimento a un'identità assegnata dall'utente associata al pool di Batch che verrà usato da un nodo di calcolo.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa ARM dell'identità assegnata dall'utente.

ErrorMessage

Object

Messaggio di errore ricevuto in una risposta di errore di Azure Batch.

Nome	Tipo	Descrizione
lang	string	Codice linguistico del messaggio di errore
value	string	Testo del messaggio.

UploadBatchServiceLogsConfiguration

Object

La configurazione di caricamento dei file di log del servizio Azure Batch per un nodo di calcolo.

Nome	Tipo	Descrizione
containerUrl	string	URL del contenitore all'interno di Archiviazione BLOB di Azure in cui caricare i file di log del servizio Batch. Se non viene usata un'identità gestita assegnata dall'utente, l'URL deve includere una firma di accesso condiviso concedendo autorizzazioni di scrittura al contenitore. La durata della firma di accesso condiviso deve consentire tempo sufficiente per il completamento del caricamento. L'ora di inizio per la firma di accesso condiviso è facoltativa e consigliata per non essere specificata.
endTime	string (date-time)	Fine dell'intervallo di tempo da cui caricare i file di log del servizio Batch. Tutti i file di log contenenti un messaggio di log nell'intervallo di tempo verranno caricati. Ciò significa che l'operazione potrebbe recuperare più log di quelli richiesti perché l'intero file di log viene sempre caricato, ma l'operazione non deve recuperare meno log di quanto richiesto. Se omesso, il valore predefinito consiste nel caricare tutti i log disponibili dopo startTime.
identityReference	ComputeNodeIdentityReference	Riferimento all'identità assegnata dall'utente da usare per accedere ad Archiviazione BLOB di Azure specificata da containerUrl. L'identità deve avere accesso in scrittura al contenitore di Archiviazione BLOB di Azure.
startTime	string (date-time)	Inizio dell'intervallo di tempo da cui caricare i file di log del servizio Batch. Tutti i file di log contenenti un messaggio di log nell'intervallo di tempo verranno caricati. Ciò significa che l'operazione potrebbe recuperare più log di quelli richiesti perché l'intero file di log viene sempre caricato, ma l'operazione non deve recuperare meno log di quanto richiesto.

UploadBatchServiceLogsResult

Object

Risultato del caricamento dei file di log del servizio Batch da un nodo di calcolo specifico.

Nome	Tipo	Descrizione
numberOfFilesUploaded	integer (int32)	Numero di file di log che verranno caricati.
virtualDirectoryName	string	Directory virtuale all'interno del contenitore di Archiviazione BLOB di Azure in cui verranno caricati i file di log del servizio Batch. Il nome della directory virtuale fa parte del nome del BLOB per ogni file di log caricato e viene compilato poolId, nodeId e un identificatore univoco.