Compute Node - Upload Batch Service Logs

Tjänst:

Batch Service

API-version:

2024-07-01.20.0

Ladda upp Azure Batch-tjänstloggfiler från den angivna beräkningsnoden till Azure Blob Storage.
Det här är för att samla in Azure Batch-tjänstloggfiler på ett automatiserat sätt från Compute Nodes om du får ett fel och vill eskalera till Azure-supporten. Azure Batch-tjänstloggfilerna bör delas med Azure-stöd för att underlätta felsökning av problem med Batch-tjänsten.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
batchUrl	path	True	string	Bas-URL:en för alla Azure Batch-tjänstbegäranden.
nodeId	path	True	string	ID:t för beräkningsnoden som du vill ladda upp Azure Batch-tjänstloggfilerna från.
poolId	path	True	string	ID:t för poolen som innehåller beräkningsnoden.
api-version	query	True	string	Klient-API-version.
timeout	query		integer (int32)	Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
client-request-id		string (uuid)	Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Om servern ska returnera klient-request-id i svaret.
ocp-date		string (date-time-rfc1123)	Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.

Begärandetext

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

Name	Obligatorisk	Typ	Description
containerUrl	True	string	URL:en för containern i Azure Blob Storage som batchtjänstloggfilerna ska laddas upp till. Om en användartilldelad hanterad identitet inte används måste URL:en innehålla en signatur för delad åtkomst (SAS) som beviljar skrivbehörighet till containern. SAS-varaktigheten måste ge tillräckligt med tid för att uppladdningen ska slutföras. Starttiden för SAS är valfri och rekommenderas att inte anges.
startTime	True	string (date-time)	Början av det tidsintervall som batchtjänstens loggfiler ska laddas upp från. Alla loggfiler som innehåller ett loggmeddelande i tidsintervallet laddas upp. Det innebär att åtgärden kan hämta fler loggar än vad som har begärts sedan hela loggfilen alltid laddades upp, men åtgärden bör inte hämta färre loggar än vad som har begärts.
endTime		string (date-time)	Slutet av det tidsintervall som batchtjänstens loggfiler ska laddas upp från. Alla loggfiler som innehåller ett loggmeddelande i tidsintervallet laddas upp. Det innebär att åtgärden kan hämta fler loggar än vad som har begärts sedan hela loggfilen alltid laddades upp, men åtgärden bör inte hämta färre loggar än vad som har begärts. Om det utelämnas är standardinställningen att ladda upp alla tillgängliga loggar efter startTime.
identityReference		ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för åtkomst till Azure Blob Storage som anges av containerUrl. Identiteten måste ha skrivåtkomst till Azure Blob Storage-containern.

Svar

Name	Typ	Description
200 OK	UploadBatchServiceLogsResult	Begäran till Batch-tjänsten lyckades. Sidhuvuden client-request-id: string request-id: string
Other Status Codes	BatchError	Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

Upload BatchService Logs

Exempelbegäran

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
BatchError	Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail	Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
ComputeNodeIdentityReference	Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch-felsvar.
UploadBatchServiceLogsConfiguration	Azure Batch-tjänstens loggfiler laddar upp konfigurationen för en beräkningsnod.
UploadBatchServiceLogsResult	Resultatet av att ladda upp Batch-tjänstloggfiler från en specifik beräkningsnod.

BatchError

Objekt

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name	Typ	Description
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message	ErrorMessage	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values	BatchErrorDetail[]	En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Objekt

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name	Typ	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

ComputeNodeIdentityReference

Objekt

Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

Name	Typ	Description
resourceId	string	ARM-resurs-ID för den användartilldelade identiteten.

ErrorMessage

Objekt

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name	Typ	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

UploadBatchServiceLogsConfiguration

Objekt

Azure Batch-tjänstens loggfiler laddar upp konfigurationen för en beräkningsnod.

Name	Typ	Description
containerUrl	string	URL:en för containern i Azure Blob Storage som batchtjänstloggfilerna ska laddas upp till. Om en användartilldelad hanterad identitet inte används måste URL:en innehålla en signatur för delad åtkomst (SAS) som beviljar skrivbehörighet till containern. SAS-varaktigheten måste ge tillräckligt med tid för att uppladdningen ska slutföras. Starttiden för SAS är valfri och rekommenderas att inte anges.
endTime	string (date-time)	Slutet av det tidsintervall som batchtjänstens loggfiler ska laddas upp från. Alla loggfiler som innehåller ett loggmeddelande i tidsintervallet laddas upp. Det innebär att åtgärden kan hämta fler loggar än vad som har begärts sedan hela loggfilen alltid laddades upp, men åtgärden bör inte hämta färre loggar än vad som har begärts. Om det utelämnas är standardinställningen att ladda upp alla tillgängliga loggar efter startTime.
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för åtkomst till Azure Blob Storage som anges av containerUrl. Identiteten måste ha skrivåtkomst till Azure Blob Storage-containern.
startTime	string (date-time)	Början av det tidsintervall som batchtjänstens loggfiler ska laddas upp från. Alla loggfiler som innehåller ett loggmeddelande i tidsintervallet laddas upp. Det innebär att åtgärden kan hämta fler loggar än vad som har begärts sedan hela loggfilen alltid laddades upp, men åtgärden bör inte hämta färre loggar än vad som har begärts.

UploadBatchServiceLogsResult

Objekt

Resultatet av att ladda upp Batch-tjänstloggfiler från en specifik beräkningsnod.

Name	Typ	Description
numberOfFilesUploaded	integer (int32)	Antalet loggfiler som ska laddas upp.
virtualDirectoryName	string	Den virtuella katalogen i Azure Blob Storage-containern som Batch Service-loggfilerna ska laddas upp till. Det virtuella katalognamnet är en del av blobnamnet för varje loggfil som laddas upp och det är byggt baserat poolId, nodeId och en unik identifierare.