Compute Node - Upload Batch Service Logs

  • Referenz
Service:
Batch Service
API Version:
2023-11-01.18.0

Laden Sie Azure Batch-Dienstprotokolldateien vom angegebenen Computeknoten in Azure Blob Storage hoch.
Dies dient zum automatisierten Sammeln Azure Batch Dienstprotokolldateien von Computeknoten, wenn ein Fehler auftritt und sie zu Azure-Support eskalieren möchten. Die Azure Batch-Dienstprotokolldateien sollten für Azure-Support freigegeben werden, um Beim Debuggen von Problemen mit dem Batch-Dienst zu helfen.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2023-11-01.18.0
With optional parameters: 
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?timeout={timeout}&api-version=2023-11-01.18.0

URI-Parameter

Name In Erforderlich Typ Beschreibung
batchUrl
 path True

string

Die Basis-URL für alle Azure Batch-Dienstanforderungen.
nodeId
 path True

string

Die ID des Computeknotens, aus dem Sie die Azure Batch-Dienstprotokolldateien hochladen möchten.
poolId
 path True

string

Die ID des Pools, der den Computeknoten enthält.
api-version
 query True

string

Client-API-Version.
timeout
 query

integer

int32

Die maximale Zeit, die der Server für die Verarbeitung der Anforderung in Sekunden aufwenden kann. Der Standardwert ist 30 Sekunden.

Anforderungsheader

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

Name Erforderlich Typ Beschreibung
client-request-id

string

uuid

Die vom Aufrufer generierte Anforderungsidentität in Form einer GUID ohne Dekoration wie geschweifte Klammern, z. B. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Gibt an, ob der Server die client-request-ID in der Antwort zurückgeben soll.
ocp-date

string

date-time-rfc1123

Der Zeitpunkt, zu dem die Anforderung ausgestellt wurde. Clientbibliotheken legen dies in der Regel auf die aktuelle Systemuhrzeit fest. legen Sie sie explizit fest, wenn Sie die REST-API direkt aufrufen.

Anforderungstext

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

Name Erforderlich Typ Beschreibung
containerUrl True

string

Die URL des Containers in Azure Blob Storage, in den die Batch-Dienstprotokolldateien hochgeladen werden sollen.
Wenn keine vom Benutzer zugewiesene verwaltete Identität verwendet wird, muss die URL eine Shared Access Signature (SAS) enthalten, die Schreibberechtigungen für den Container erteilt. Die SAS-Dauer muss genügend Zeit für den Abschluss des Uploads zulassen. Die Startzeit für SAS ist optional und sollte nicht angegeben werden.
startTime True

string

Der Anfang des Zeitbereichs, aus dem Batch Service-Protokolldateien hochgeladen werden sollen.
Jede Protokolldatei, die eine Protokollmeldung im Zeitbereich enthält, wird hochgeladen. Dies bedeutet, dass der Vorgang möglicherweise mehr Protokolle abruft, als angefordert wurden, da die gesamte Protokolldatei immer hochgeladen wird, aber der Vorgang sollte nicht weniger Protokolle abrufen, als angefordert wurden.
endTime

string

Das Ende des Zeitraums, aus dem Batch Service-Protokolldateien hochgeladen werden sollen.
Jede Protokolldatei, die eine Protokollmeldung im Zeitbereich enthält, wird hochgeladen. Dies bedeutet, dass der Vorgang möglicherweise mehr Protokolle abruft, als angefordert wurden, da die gesamte Protokolldatei immer hochgeladen wird, aber der Vorgang sollte nicht weniger Protokolle abrufen, als angefordert wurden. Ohne Angabe werden standardmäßig alle Protokolle hochgeladen, die nach startTime verfügbar sind.
identityReference

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf Azure Blob Storage verwendet werden soll, die von containerUrl angegeben werden.
Die Identität muss über Schreibzugriff auf den Azure Blob Storage Container verfügen.

Antworten

Name Typ Beschreibung
200 OK

UploadBatchServiceLogsResult

Die Anforderung an den Batch-Dienst war erfolgreich.

Headers

  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Der Fehler vom Batch-Dienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodeflow

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Authorization

Type: apiKey
In: header

Beispiele

Upload BatchService Logs

Sample Request

POST account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/uploadbatchservicelogs?api-version=2023-11-01.18.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"
}

Sample Response

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

Definitionen

Name Beschreibung
BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.
BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.
ComputeNodeIdentityReference

Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.
ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.
UploadBatchServiceLogsConfiguration

Die Azure Batch-Dienstprotokolldatei-Uploadkonfiguration für einen Computeknoten.
UploadBatchServiceLogsResult

Das Ergebnis des Hochladens von Batch-Dienstprotokolldateien von einem bestimmten Computeknoten.

BatchError

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollten programmgesteuert verwendet werden.
message

ErrorMessage

Eine Meldung, die den Fehler beschreibt, die für die Anzeige in einer Benutzeroberfläche geeignet sein soll.
values

BatchErrorDetail[]

Eine Auflistung von Schlüssel-Wert-Paaren mit zusätzlichen Details zum Fehler.

BatchErrorDetail

Ein Element mit zusätzlichen Informationen, die in einer Azure Batch Fehlerantwort enthalten sind.

Name Typ Beschreibung
key

string

Ein Bezeichner, der die Bedeutung der Value-Eigenschaft angibt.
value

string

Die zusätzlichen Informationen, die in der Fehlerantwort enthalten sind.

ComputeNodeIdentityReference

Der Verweis auf eine benutzerseitig zugewiesene Identität, die dem Batch-Pool zugeordnet ist, den ein Computeknoten verwendet.

Name Typ Beschreibung
resourceId

string

Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität.

ErrorMessage

Eine Fehlermeldung, die in einer Azure Batch Fehlerantwort empfangen wurde.

Name Typ Beschreibung
lang

string

Der Sprachcode der Fehlermeldung
value

string

Der Text der Meldung.

UploadBatchServiceLogsConfiguration

Die Azure Batch-Dienstprotokolldatei-Uploadkonfiguration für einen Computeknoten.

Name Typ Beschreibung
containerUrl

string

Die URL des Containers in Azure Blob Storage, in den die Batch-Dienstprotokolldateien hochgeladen werden sollen.
Wenn keine vom Benutzer zugewiesene verwaltete Identität verwendet wird, muss die URL eine Shared Access Signature (SAS) enthalten, die Schreibberechtigungen für den Container erteilt. Die SAS-Dauer muss genügend Zeit für den Abschluss des Uploads zulassen. Die Startzeit für SAS ist optional und sollte nicht angegeben werden.
endTime

string

Das Ende des Zeitraums, aus dem Batch Service-Protokolldateien hochgeladen werden sollen.
Jede Protokolldatei, die eine Protokollmeldung im Zeitbereich enthält, wird hochgeladen. Dies bedeutet, dass der Vorgang möglicherweise mehr Protokolle abruft, als angefordert wurden, da die gesamte Protokolldatei immer hochgeladen wird, aber der Vorgang sollte nicht weniger Protokolle abrufen, als angefordert wurden. Ohne Angabe werden standardmäßig alle Protokolle hochgeladen, die nach startTime verfügbar sind.
identityReference

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf Azure Blob Storage verwendet werden soll, die von containerUrl angegeben werden.
Die Identität muss über Schreibzugriff auf den Azure Blob Storage Container verfügen.
startTime

string

Der Anfang des Zeitbereichs, aus dem Batch Service-Protokolldateien hochgeladen werden sollen.
Jede Protokolldatei, die eine Protokollmeldung im Zeitbereich enthält, wird hochgeladen. Dies bedeutet, dass der Vorgang möglicherweise mehr Protokolle abruft, als angefordert wurden, da die gesamte Protokolldatei immer hochgeladen wird, aber der Vorgang sollte nicht weniger Protokolle abrufen, als angefordert wurden.

UploadBatchServiceLogsResult

Das Ergebnis des Hochladens von Batch-Dienstprotokolldateien von einem bestimmten Computeknoten.

Name Typ Beschreibung
numberOfFilesUploaded

integer

Die Anzahl der Protokolldateien, die hochgeladen werden.
virtualDirectoryName

string

Das virtuelle Verzeichnis in Azure Blob Storage Container, in den die Batch Service-Protokolldateien hochgeladen werden.
Der Name des virtuellen Verzeichnisses ist Teil des Blobnamens für jede hochgeladene Protokolldatei und basiert auf poolId, nodeId und einem eindeutigen Bezeichner.