Freigeben über

Compute Node - Upload Batch Service Logs

  • Referenz
Dienst:
Batch Service
API-Version:
2024-07-01.20.0

Laden Sie Azure Batch-Dienstprotokolldateien aus dem angegebenen Computeknoten in Azure Blob Storage hoch.
Dies dient zum Sammeln von Azure Batch-Dienstprotokolldateien auf automatisierte Weise von ComputeKnoten, wenn ein Fehler auftritt und an den Azure-Support eskaliert werden soll. Die Azure Batch-Dienstprotokolldateien sollten mit Azure-Unterstützung geteilt werden, um Debuggingprobleme mit dem Batchdienst zu unterstützen.

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2024-07-01.20.0
Mit optionalen Parametern: 
POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?timeout={timeout}&api-version=2024-07-01.20.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 ausgeben kann. Der Standardwert ist 30 Sekunden. Wenn der Wert größer als 30 ist, wird stattdessen der Standardwert verwendet.

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 Clientanforderungs-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 Batchdienst-Protokolldatei(n) hochgeladen werden soll.
Wenn eine vom Benutzer zugewiesene verwaltete Identität nicht verwendet wird, muss die URL eine SAS (Shared Access Signature) enthalten, die Schreibberechtigungen für den Container gewährt. Die SAS-Dauer muss genügend Zeit für den Abschluss des Uploads zulassen. Die Startzeit für SAS ist optional und wird empfohlen, nicht angegeben zu werden.
startTime True

string (date-time)

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

string (date-time)

Das Ende des Zeitraums, aus dem Batchdienst-Protokolldateien hochgeladen werden sollen.
Jede Protokolldatei, die eine Protokollmeldung im Zeitraum enthält, wird hochgeladen. Dies bedeutet, dass der Vorgang möglicherweise mehr Protokolle abruft als angefordert wurde, da die gesamte Protokolldatei immer hochgeladen wird, aber der Vorgang sollte nicht weniger Protokolle abrufen, als angefordert wurden. Wenn nicht angegeben, besteht die Standardeinstellung darin, alle Protokolle hochzuladen, die nach der Startzeit 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, der durch containerUrl angegeben wird.
Die Identität muss Schreibzugriff auf den Azure Blob Storage-Container haben.

Antworten

Name Typ Beschreibung
200 OK

UploadBatchServiceLogsResult

Die Anforderung an den Batchdienst war erfolgreich.

Header

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

BatchError

Der Fehler vom Batchdienst.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Authorization

Typ: apiKey
In: header

Beispiele

Upload BatchService Logs

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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 vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
ErrorMessage

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

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

Das Ergebnis des Hochladens von Batchdienstprotokolldateien aus einem bestimmten Computeknoten.

BatchError

Objekt

Eine Vom Azure Batch-Dienst empfangene Fehlerantwort.

Name Typ Beschreibung
code

string

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

ErrorMessage

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

BatchErrorDetail[]

Eine Sammlung von Schlüssel-Wert-Paaren, die zusätzliche Details zum Fehler enthalten.

BatchErrorDetail

Objekt

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

Objekt

Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.

Name Typ Beschreibung
resourceId

string

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

ErrorMessage

Objekt

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

Objekt

Die Uploadkonfiguration der Azure Batch-Dienstprotokolldateien für einen Computeknoten.

Name Typ Beschreibung
containerUrl

string

Die URL des Containers in Azure Blob Storage, in den die Batchdienst-Protokolldatei(n) hochgeladen werden soll.
Wenn eine vom Benutzer zugewiesene verwaltete Identität nicht verwendet wird, muss die URL eine SAS (Shared Access Signature) enthalten, die Schreibberechtigungen für den Container gewährt. Die SAS-Dauer muss genügend Zeit für den Abschluss des Uploads zulassen. Die Startzeit für SAS ist optional und wird empfohlen, nicht angegeben zu werden.
endTime

string (date-time)

Das Ende des Zeitraums, aus dem Batchdienst-Protokolldateien hochgeladen werden sollen.
Jede Protokolldatei, die eine Protokollmeldung im Zeitraum enthält, wird hochgeladen. Dies bedeutet, dass der Vorgang möglicherweise mehr Protokolle abruft als angefordert wurde, da die gesamte Protokolldatei immer hochgeladen wird, aber der Vorgang sollte nicht weniger Protokolle abrufen, als angefordert wurden. Wenn nicht angegeben, besteht die Standardeinstellung darin, alle Protokolle hochzuladen, die nach der Startzeit 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, der durch containerUrl angegeben wird.
Die Identität muss Schreibzugriff auf den Azure Blob Storage-Container haben.
startTime

string (date-time)

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

UploadBatchServiceLogsResult

Objekt

Das Ergebnis des Hochladens von Batchdienstprotokolldateien aus einem bestimmten Computeknoten.

Name Typ Beschreibung
numberOfFilesUploaded

integer (int32)

Die Anzahl der Protokolldateien, die hochgeladen werden.
virtualDirectoryName

string

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