Compute Node - Upload Batch Service Logs

Service:

Batch Service

API Version:

2023-11-01.18.0

Nahrajte soubory protokolu služby Azure Batch ze zadaného výpočetního uzlu do Azure Blob Storage.
Je to pro automatické shromažďování souborů protokolu služby Azure Batch z výpočetních uzlů, pokud dochází k chybě a chcete eskalovat na podpora Azure. Soubory protokolu služby Azure Batch by se měly sdílet s podpora Azure, které pomáhají při ladění problémů se službou Batch.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
batchUrl	path	True	string	Základní adresa URL pro všechny požadavky Azure Batch služby.
nodeId	path	True	string	ID výpočetního uzlu, ze kterého chcete nahrát soubory protokolu služby Azure Batch.
poolId	path	True	string	ID fondu, který obsahuje výpočetní uzel.
api-version	query	True	string	Verze rozhraní API klienta.
timeout	query		integer int32	Maximální doba, kterou může server strávit zpracováním požadavku( v sekundách). Výchozí hodnota je 30 sekund.

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
client-request-id		string uuid	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Určuje, jestli má server v odpovědi vrátit client-request-id.
ocp-date		string date-time-rfc1123	Čas, kdy byla žádost vydána. Klientské knihovny obvykle nastavit na aktuální systémový čas hodin; pokud voláte rozhraní REST API přímo, explicitně ho nastavte.

Text požadavku

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

Name	Vyžadováno	Typ	Description
containerUrl	True	string	Adresa URL kontejneru v rámci Azure Blob Storage, do kterého chcete nahrát soubory protokolu služby Batch. Pokud se spravovaná identita přiřazená uživatelem nepoužívá, musí adresa URL obsahovat sdílený přístupový podpis (SAS) udělující oprávnění k zápisu do kontejneru. Doba trvání SAS musí umožňovat dostatek času na dokončení nahrávání. Počáteční čas sas je volitelný a doporučuje se ho nezadát.
startTime	True	string	Začátek časového rozsahu, ze kterého se mají nahrát soubory protokolu služby Batch. Nahraje se jakýkoli soubor protokolu obsahující zprávu protokolu v časovém rozsahu. To znamená, že operace může načíst více protokolů, než bylo požadováno, protože se vždy nahraje celý soubor protokolu, ale operace by neměla načíst méně protokolů, než bylo požadováno.
endTime		string	Konec časového rozsahu, ze kterého se mají nahrát soubory protokolu služby Batch. Nahraje se jakýkoli soubor protokolu obsahující zprávu protokolu v časovém rozsahu. To znamená, že operace může načíst více protokolů, než bylo požadováno, protože se vždy nahraje celý soubor protokolu, ale operace by neměla načíst méně protokolů, než bylo požadováno. Pokud tento parametr vynecháte, ve výchozím nastavení se nahrají všechny protokoly, které jsou k dispozici po startTime.
identityReference		ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem, která se použije pro přístup k Azure Blob Storage určené parametrem containerUrl. Identita musí mít oprávnění k zápisu do kontejneru Azure Blob Storage.

Odpovědi

Name	Typ	Description
200 OK	UploadBatchServiceLogsResult	Požadavek na službu Batch byl úspěšný. Headers client-request-id: string request-id: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Zabezpečení

azure_auth

Microsoft Entra tok ověřovacího kódu OAuth 2.0

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

Scopes

Name	Description
user_impersonation	Zosobnění uživatelského účtu

Authorization

Type: apiKey
In: header

Příklady

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
}

Definice

Name	Description
BatchError	Služba Azure Batch obdržela chybovou odpověď.
BatchErrorDetail	Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.
ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.
ErrorMessage	Chybová zpráva přijatá v Azure Batch chybovou odpověď.
UploadBatchServiceLogsConfiguration	Soubory protokolu služby Azure Batch nahrávají konfiguraci pro výpočetní uzel.
UploadBatchServiceLogsResult	Výsledek nahrání souborů protokolu služby Batch z konkrétního výpočetního uzlu.

BatchError

Služba Azure Batch obdržela chybovou odpověď.

Name	Typ	Description
code	string	Identifikátor chyby. Kódy jsou neutrální a mají být využívány programově.
message	ErrorMessage	Zpráva popisující chybu, která má být vhodná k zobrazení v uživatelském rozhraní.
values	BatchErrorDetail[]	Kolekce párů klíč-hodnota obsahující další podrobnosti o chybě.

BatchErrorDetail

Položka s dalšími informacemi, které jsou součástí Azure Batch chybové odpovědi.

Name	Typ	Description
key	string	Identifikátor určující význam value vlastnost.
value	string	Další informace zahrnuté v chybové odpovědi.

ComputeNodeIdentityReference

Odkaz na identitu přiřazenou uživatelem přidruženou k fondu služby Batch, který bude výpočetní uzel používat.

Name	Typ	Description
resourceId	string	ID prostředku ARM identity přiřazené uživatelem.

ErrorMessage

Chybová zpráva přijatá v Azure Batch chybovou odpověď.

Name	Typ	Description
lang	string	Kód jazyka chybové zprávy
value	string	Text zprávy

UploadBatchServiceLogsConfiguration

Soubory protokolu služby Azure Batch nahrávají konfiguraci pro výpočetní uzel.

Name	Typ	Description
containerUrl	string	Adresa URL kontejneru v rámci Azure Blob Storage, do kterého chcete nahrát soubory protokolu služby Batch. Pokud se spravovaná identita přiřazená uživatelem nepoužívá, musí adresa URL obsahovat sdílený přístupový podpis (SAS) udělující oprávnění k zápisu do kontejneru. Doba trvání SAS musí umožňovat dostatek času na dokončení nahrávání. Počáteční čas sas je volitelný a doporučuje se ho nezadát.
endTime	string	Konec časového rozsahu, ze kterého se mají nahrát soubory protokolu služby Batch. Nahraje se jakýkoli soubor protokolu obsahující zprávu protokolu v časovém rozsahu. To znamená, že operace může načíst více protokolů, než bylo požadováno, protože se vždy nahraje celý soubor protokolu, ale operace by neměla načíst méně protokolů, než bylo požadováno. Pokud tento parametr vynecháte, ve výchozím nastavení se nahrají všechny protokoly, které jsou k dispozici po startTime.
identityReference	ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem, která se použije pro přístup k Azure Blob Storage určené parametrem containerUrl. Identita musí mít oprávnění k zápisu do kontejneru Azure Blob Storage.
startTime	string	Začátek časového rozsahu, ze kterého se mají nahrát soubory protokolu služby Batch. Nahraje se jakýkoli soubor protokolu obsahující zprávu protokolu v časovém rozsahu. To znamená, že operace může načíst více protokolů, než bylo požadováno, protože se vždy nahraje celý soubor protokolu, ale operace by neměla načíst méně protokolů, než bylo požadováno.

UploadBatchServiceLogsResult

Výsledek nahrání souborů protokolu služby Batch z konkrétního výpočetního uzlu.

Name	Typ	Description
numberOfFilesUploaded	integer	Počet souborů protokolu, které se nahrají.
virtualDirectoryName	string	Virtuální adresář v rámci Azure Blob Storage kontejneru, do kterého se nahrají soubory protokolu služby Batch. Název virtuálního adresáře je součástí názvu objektu blob pro každý nahraný soubor protokolu a je sestavený na základě poolId, nodeId a jedinečný identifikátor.