Compute Node - Upload Batch Service Logs

Reference

Služba:: Batch Service

Verze rozhraní API:: 2024-07-01.20.0

Nahrajte soubory protokolu služby Azure Batch ze zadaného výpočetního uzlu do služby Azure Blob Storage.
To je pro shromažďování souborů protokolu služby Azure Batch automatizovaným způsobem z výpočetních uzlů, pokud dochází k chybě a chcete eskalovat podporu Azure. Soubory protokolu služby Azure Batch by se měly sdílet s podporou Azure, aby pomohly s laděním problémů se službou Batch.

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

S volitelnými parametry:

POST {batchUrl}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?timeout={timeout}&api-version=2024-07-01.20.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 služby Azure Batch.
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, po kterou může server strávit zpracováním požadavku v sekundách. Výchozí hodnota je 30 sekund. Pokud je hodnota větší než 30, použije se výchozí hodnota.

Hlavička požadavku

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

Name	Typ	Description
client-request-id	string (uuid)	Identita požadavku vygenerovaná volajícím ve formě identifikátoru GUID bez dekorace, jako jsou složené závorky, například 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Určuje, jestli má server v odpovědi vrátit ID požadavku klienta.
ocp-date	string (date-time-rfc1123)	Čas vydání žádosti. Klientské knihovny obvykle nastavily aktuální systémový čas; explicitně ji nastavte, pokud voláte přímo rozhraní REST API.

Text požadavku

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

Name	Vyžadováno	Typ	Description
containerUrl	True	string	Adresa URL kontejneru ve službě Azure Blob Storage, do které se mají nahrát soubory protokolu služby Batch. Pokud se nepoužívá spravovaná identita přiřazená uživatelem, musí adresa URL obsahovat sdílený přístupový podpis (SAS), který kontejneru uděluje oprávnění k zápisu. Doba trvání SAS musí umožňovat dostatek času na dokončení nahrávání. Počáteční čas sdíleného přístupového podpisu je volitelný a doporučuje se ho nezadá.
startTime	True	string (date-time)	Začátek časového rozsahu, od kterého se mají nahrát soubory protokolu služby Batch Service. Všechny soubory protokolu obsahující zprávu protokolu v časovém rozsahu se nahrají. 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 (date-time)	Konec časového rozsahu, ze kterého se mají nahrát soubory protokolu služby Batch. Všechny soubory protokolu obsahující zprávu protokolu v časovém rozsahu se nahrají. 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, výchozí hodnota je nahrát všechny protokoly, které jsou k dispozici po spuštění.
identityReference		ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem, která se má použít pro přístup ke službě Azure Blob Storage určené parametrem containerUrl. Identita musí mít přístup 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ý. Hlavičky client-request-id: string request-id: string
Other Status Codes	BatchError	Chyba ze služby Batch.

Name

Typ

Description

200 OK

UploadBatchServiceLogsResult

Požadavek na službu Batch byl úspěšný.

Hlavičky

client-request-id: string
request-id: string

Other Status Codes

BatchError

Chyba ze služby Batch.

Zabezpečení

azure_auth

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

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Authorization

Typ: apiKey
V: header

Příklady

Upload BatchService Logs

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
BatchError	Odpověď na chybu přijatá ze služby Azure Batch
BatchErrorDetail	Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch
ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem přidruženou k fondu Batch, který bude používat výpočetní uzel.
ErrorMessage	V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.
UploadBatchServiceLogsConfiguration	Soubory protokolu služby Azure Batch nahrají konfiguraci výpočetního uzlu.
UploadBatchServiceLogsResult	Výsledek nahrání souborů protokolu služby Batch z konkrétního výpočetního uzlu.

BatchError

Objekt

Odpověď na chybu přijatá ze služby Azure Batch

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

BatchErrorDetail

Objekt

Položka dalších informací zahrnutých v odpovědi na chybu služby Azure Batch

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

ComputeNodeIdentityReference

Objekt

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

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

ErrorMessage

Objekt

V odpovědi na chybu služby Azure Batch se zobrazila chybová zpráva.

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

UploadBatchServiceLogsConfiguration

Objekt

Soubory protokolu služby Azure Batch nahrají konfiguraci výpočetního uzlu.

Name	Typ	Description
containerUrl	string	Adresa URL kontejneru ve službě Azure Blob Storage, do které se mají nahrát soubory protokolu služby Batch. Pokud se nepoužívá spravovaná identita přiřazená uživatelem, musí adresa URL obsahovat sdílený přístupový podpis (SAS), který kontejneru uděluje oprávnění k zápisu. Doba trvání SAS musí umožňovat dostatek času na dokončení nahrávání. Počáteční čas sdíleného přístupového podpisu je volitelný a doporučuje se ho nezadá.
endTime	string (date-time)	Konec časového rozsahu, ze kterého se mají nahrát soubory protokolu služby Batch. Všechny soubory protokolu obsahující zprávu protokolu v časovém rozsahu se nahrají. 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, výchozí hodnota je nahrát všechny protokoly, které jsou k dispozici po spuštění.
identityReference	ComputeNodeIdentityReference	Odkaz na identitu přiřazenou uživatelem, která se má použít pro přístup ke službě Azure Blob Storage určené parametrem containerUrl. Identita musí mít přístup k zápisu do kontejneru Azure Blob Storage.
startTime	string (date-time)	Začátek časového rozsahu, od kterého se mají nahrát soubory protokolu služby Batch Service. Všechny soubory protokolu obsahující zprávu protokolu v časovém rozsahu se nahrají. 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

Objekt

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

Name	Typ	Description
numberOfFilesUploaded	integer (int32)	Počet souborů protokolu, které se nahrají.
virtualDirectoryName	string	Virtuální adresář v rámci kontejneru služby Azure Blob Storage, do kterého se nahrají soubory protokolů 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 vytvořený na základě id fondu, nodeId a jedinečného identifikátoru.

Sdílet prostřednictvím

Compute Node - Upload Batch Service Logs

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Authorization

Příklady

Upload BatchService Logs

Ukázkový požadavek

Ukázková odpověď

Definice

BatchError

BatchErrorDetail

ComputeNodeIdentityReference

ErrorMessage

UploadBatchServiceLogsConfiguration

UploadBatchServiceLogsResult

Další materiály