Compute Node - Upload Batch Service Logs

Service:

Batch Service

API Version:

2023-11-01.18.0

Upload Azure Batch servicelogboekbestanden van het opgegeven rekenknooppunt naar Azure Blob Storage.
Dit is voor het automatisch verzamelen van logboekbestanden van Azure Batch service van rekenknooppunten als u een fout ondervindt en wilt escaleren naar ondersteuning voor Azure. De logboekbestanden van de Azure Batch service moeten worden gedeeld met ondersteuning voor Azure om te helpen bij het oplossen van problemen met de Batch-service.

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-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
nodeId	path	True	string	De id van het rekenknooppunt van waaruit u de logboekbestanden van de Azure Batch-service wilt uploaden.
poolId	path	True	string	De id van de pool die het rekenknooppunt bevat.
api-version	query	True	string	Client-API-versie.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de client-request-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel dit expliciet in als u de REST API rechtstreeks aanroept.

Aanvraagbody

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

Name	Vereist	Type	Description
containerUrl	True	string	De URL van de container in Azure Blob Storage waarnaar u het batchservicelogboekbestand(en) uploadt. Als een door de gebruiker toegewezen beheerde identiteit niet wordt gebruikt, moet de URL een Shared Access Signature (SAS) bevatten die schrijfmachtigingen voor de container verleent. De SAS-duur moet voldoende tijd hebben om het uploaden te voltooien. De begintijd voor SAS is optioneel en wordt aanbevolen om niet te worden opgegeven.
startTime	True	string	Het begin van het tijdsbereik voor het uploaden van batchservicelogboekbestanden. Elk logboekbestand met een logboekbericht in het tijdsbereik wordt geüpload. Dit betekent dat de bewerking mogelijk meer logboeken ophaalt dan is aangevraagd omdat het hele logboekbestand altijd is geüpload, maar dat de bewerking niet minder logboeken ophaalt dan is aangevraagd.
endTime		string	Het einde van het tijdsbereik voor het uploaden van batchservicelogboekbestanden. Elk logboekbestand met een logboekbericht in het tijdsbereik wordt geüpload. Dit betekent dat de bewerking mogelijk meer logboeken ophaalt dan is aangevraagd omdat het hele logboekbestand altijd is geüpload, maar dat de bewerking niet minder logboeken ophaalt dan is aangevraagd. Als u dit weglaat, is de standaardinstelling om alle logboeken te uploaden die beschikbaar zijn na de startTime.
identityReference		ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage opgegeven door containerUrl. De identiteit moet schrijftoegang hebben tot de Azure Blob Storage container.

Antwoorden

Name	Type	Description
200 OK	UploadBatchServiceLogsResult	De aanvraag voor de Batch-service is geslaagd. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Upload BatchService Logs

Sample Request

HTTP

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
}

Definities

Name	Description
BatchError	Een foutbericht dat is ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ComputeNodeIdentityReference	De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch antwoord.
UploadBatchServiceLogsConfiguration	De Azure Batch-servicelogboekbestanden uploaden configuratie voor een rekenknooppunt.
UploadBatchServiceLogsResult	Het resultaat van het uploaden van logboekbestanden van de Batch-service vanaf een specifiek rekenknooppunt.

BatchError

Een foutbericht dat is ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende details over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.

ComputeNodeIdentityReference

De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.

Name	Type	Description
resourceId	string	De ARM-resource-id van de door de gebruiker toegewezen identiteit.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch antwoord.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

UploadBatchServiceLogsConfiguration

De Azure Batch-servicelogboekbestanden uploaden configuratie voor een rekenknooppunt.

Name	Type	Description
containerUrl	string	De URL van de container in Azure Blob Storage waarnaar u het batchservicelogboekbestand(en) uploadt. Als een door de gebruiker toegewezen beheerde identiteit niet wordt gebruikt, moet de URL een Shared Access Signature (SAS) bevatten die schrijfmachtigingen voor de container verleent. De SAS-duur moet voldoende tijd hebben om het uploaden te voltooien. De begintijd voor SAS is optioneel en wordt aanbevolen om niet te worden opgegeven.
endTime	string	Het einde van het tijdsbereik voor het uploaden van batchservicelogboekbestanden. Elk logboekbestand met een logboekbericht in het tijdsbereik wordt geüpload. Dit betekent dat de bewerking mogelijk meer logboeken ophaalt dan is aangevraagd omdat het hele logboekbestand altijd is geüpload, maar dat de bewerking niet minder logboeken ophaalt dan is aangevraagd. Als u dit weglaat, is de standaardinstelling om alle logboeken te uploaden die beschikbaar zijn na de startTime.
identityReference	ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage opgegeven door containerUrl. De identiteit moet schrijftoegang hebben tot de Azure Blob Storage container.
startTime	string	Het begin van het tijdsbereik voor het uploaden van batchservicelogboekbestanden. Elk logboekbestand met een logboekbericht in het tijdsbereik wordt geüpload. Dit betekent dat de bewerking mogelijk meer logboeken ophaalt dan is aangevraagd omdat het hele logboekbestand altijd is geüpload, maar dat de bewerking niet minder logboeken ophaalt dan is aangevraagd.

UploadBatchServiceLogsResult

Het resultaat van het uploaden van logboekbestanden van de Batch-service vanaf een specifiek rekenknooppunt.

Name	Type	Description
numberOfFilesUploaded	integer	Het aantal logboekbestanden dat wordt geüpload.
virtualDirectoryName	string	De virtuele map in Azure Blob Storage container waarnaar het batchservicelogboekbestand of de logboekbestanden van de Batch-service worden geüpload. De naam van de virtuele map maakt deel uit van de blobnaam voor elk geüpload logboekbestand en is gebouwd op basis van poolId, nodeId en een unieke id.