Compute Node - Upload Batch Service Logs

Usługa:

Batch Service

Wersja interfejsu API:

2024-07-01.20.0

Przekaż pliki dziennika usługi Azure Batch z określonego węzła obliczeniowego do usługi Azure Blob Storage.
Jest to przeznaczone do zbierania plików dziennika usługi Azure Batch w zautomatyzowany sposób z węzłów obliczeniowych, jeśli występuje błąd i chcesz eskalować do pomocy technicznej platformy Azure. Pliki dziennika usługi Azure Batch powinny być udostępniane pomocy technicznej platformy Azure, aby ułatwić debugowanie problemów z usługą Batch.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL dla wszystkich żądań usługi Azure Batch.
nodeId	path	True	string	Identyfikator węzła obliczeniowego, z którego chcesz przekazać pliki dziennika usługi Azure Batch.
poolId	path	True	string	Identyfikator puli zawierającej węzeł obliczeniowy.
api-version	query	True	string	Wersja interfejsu API klienta.
timeout	query		integer (int32)	Maksymalny czas przetwarzania żądania przez serwer w sekundach. Wartość domyślna to 30 sekund. Jeśli wartość jest większa niż 30, zostanie użyta wartość domyślna.

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
client-request-id		string (uuid)	Tożsamość żądania wygenerowanego przez obiekt wywołujący w postaci identyfikatora GUID bez dekoracji, takiej jak nawiasy klamrowe, np. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Czy serwer powinien zwrócić identyfikator żądania klienta w odpowiedzi.
ocp-date		string (date-time-rfc1123)	Czas wystawienia żądania. Biblioteki klienckie zazwyczaj ustawiają tę wartość na bieżący czas zegara systemowego; ustaw go jawnie, jeśli bezpośrednio wywołujesz interfejs API REST.

Treść żądania

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

Nazwa	Wymagane	Typ	Opis
containerUrl	True	string	Adres URL kontenera w usłudze Azure Blob Storage, do którego mają być przekazywane pliki dziennika usługi Batch. Jeśli tożsamość zarządzana przypisana przez użytkownika nie jest używana, adres URL musi zawierać sygnaturę dostępu współdzielonego udzielając uprawnień do zapisu w kontenerze. Czas trwania sygnatury dostępu współdzielonego musi zapewnić wystarczającą ilość czasu na zakończenie przekazywania. Godzina rozpoczęcia sygnatury dostępu współdzielonego jest opcjonalna i zalecana, aby nie została określona.
startTime	True	string (date-time)	Początek zakresu czasu, od którego ma być przekazywany plik dziennika usługi Batch. Każdy plik dziennika zawierający komunikat dziennika w zakresie czasu zostanie przekazany. Oznacza to, że operacja może pobrać więcej dzienników niż zażądano od czasu, gdy cały plik dziennika jest zawsze przekazywany, ale operacja nie powinna pobierać mniej dzienników niż zażądano.
endTime		string (date-time)	Koniec zakresu czasu, od którego ma być przekazywany plik dziennika usługi Batch. Każdy plik dziennika zawierający komunikat dziennika w zakresie czasu zostanie przekazany. Oznacza to, że operacja może pobrać więcej dzienników niż zażądano od czasu, gdy cały plik dziennika jest zawsze przekazywany, ale operacja nie powinna pobierać mniej dzienników niż zażądano. Jeśli pominięto, wartością domyślną jest przekazanie wszystkich dzienników dostępnych po dokonaniu startTime.
identityReference		ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do usługi Azure Blob Storage określonej przez kontenerUrl. Tożsamość musi mieć dostęp do zapisu do kontenera usługi Azure Blob Storage.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	UploadBatchServiceLogsResult	Żądanie do usługi Batch zakończyło się pomyślnie. Nagłówki client-request-id: string request-id: string
Other Status Codes	BatchError	Błąd usługi Batch.

Zabezpieczenia

azure_auth

Microsoft Entra OAuth 2.0 — przepływ kodu uwierzytelniania

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Typ: apiKey
W: header

Przykłady

Upload BatchService Logs

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
BatchError	Odebrano odpowiedź o błędzie z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.
ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.
UploadBatchServiceLogsConfiguration	Pliki dziennika usługi Azure Batch przekazują konfigurację węzła obliczeniowego.
UploadBatchServiceLogsResult	Wynik przekazywania plików dziennika usługi Batch z określonego węzła obliczeniowego.

BatchError

Objekt

Odebrano odpowiedź o błędzie z usługi Azure Batch.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	ErrorMessage	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.
values	BatchErrorDetail[]	Kolekcja par klucz-wartość zawierająca dodatkowe szczegóły dotyczące błędu.

BatchErrorDetail

Objekt

Element dodatkowych informacji zawartych w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
key	string	Identyfikator określający znaczenie właściwości Value.
value	string	Dodatkowe informacje zawarte w odpowiedzi na błąd.

ComputeNodeIdentityReference

Objekt

Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, która będzie używana przez węzeł obliczeniowy.

Nazwa	Typ	Opis
resourceId	string	Identyfikator zasobu usługi ARM tożsamości przypisanej przez użytkownika.

ErrorMessage

Objekt

Komunikat o błędzie odebrany w odpowiedzi na błąd usługi Azure Batch.

Nazwa	Typ	Opis
lang	string	Kod języka komunikatu o błędzie
value	string	Tekst wiadomości.

UploadBatchServiceLogsConfiguration

Objekt

Pliki dziennika usługi Azure Batch przekazują konfigurację węzła obliczeniowego.

Nazwa	Typ	Opis
containerUrl	string	Adres URL kontenera w usłudze Azure Blob Storage, do którego mają być przekazywane pliki dziennika usługi Batch. Jeśli tożsamość zarządzana przypisana przez użytkownika nie jest używana, adres URL musi zawierać sygnaturę dostępu współdzielonego udzielając uprawnień do zapisu w kontenerze. Czas trwania sygnatury dostępu współdzielonego musi zapewnić wystarczającą ilość czasu na zakończenie przekazywania. Godzina rozpoczęcia sygnatury dostępu współdzielonego jest opcjonalna i zalecana, aby nie została określona.
endTime	string (date-time)	Koniec zakresu czasu, od którego ma być przekazywany plik dziennika usługi Batch. Każdy plik dziennika zawierający komunikat dziennika w zakresie czasu zostanie przekazany. Oznacza to, że operacja może pobrać więcej dzienników niż zażądano od czasu, gdy cały plik dziennika jest zawsze przekazywany, ale operacja nie powinna pobierać mniej dzienników niż zażądano. Jeśli pominięto, wartością domyślną jest przekazanie wszystkich dzienników dostępnych po dokonaniu startTime.
identityReference	ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do usługi Azure Blob Storage określonej przez kontenerUrl. Tożsamość musi mieć dostęp do zapisu do kontenera usługi Azure Blob Storage.
startTime	string (date-time)	Początek zakresu czasu, od którego ma być przekazywany plik dziennika usługi Batch. Każdy plik dziennika zawierający komunikat dziennika w zakresie czasu zostanie przekazany. Oznacza to, że operacja może pobrać więcej dzienników niż zażądano od czasu, gdy cały plik dziennika jest zawsze przekazywany, ale operacja nie powinna pobierać mniej dzienników niż zażądano.

UploadBatchServiceLogsResult

Objekt

Wynik przekazywania plików dziennika usługi Batch z określonego węzła obliczeniowego.

Nazwa	Typ	Opis
numberOfFilesUploaded	integer (int32)	Liczba plików dziennika, które zostaną przekazane.
virtualDirectoryName	string	Katalog wirtualny w kontenerze usługi Azure Blob Storage, do którego zostaną przekazane pliki dziennika usługi Batch. Nazwa katalogu wirtualnego jest częścią nazwy obiektu blob dla każdego przekazanego pliku dziennika i jest utworzona na podstawie poolId, nodeId i unikatowy identyfikator.