Compute Node - Upload Batch Service Logs

Service:

Batch Service

API Version:

2023-11-01.18.0

Przekaż pliki dziennika usługi Azure Batch z określonego węzła obliczeniowego do 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 pomoc techniczna platformy Azure. Pliki dziennika usługi Azure Batch powinny być udostępniane pomoc techniczna platformy Azure, aby ułatwić debugowanie problemów z usługą 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 identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
batchUrl	path	True	string	Podstawowy adres URL wszystkich żądań obsł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, który serwer może poświęcić na przetwarzanie żądania w sekundach. Wartość domyślna to 30 sekund.

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ć wartość client-request-id 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 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ń zapisu do kontenera. Czas trwania sygnatury dostępu współdzielonego musi mieć wystarczającą ilość czasu na zakończenie przekazywania. Godzina rozpoczęcia sygnatury dostępu współdzielonego jest opcjonalna i zaleca się, aby nie została określona.
startTime	True	string	Początek zakresu czasu przekazywania plików 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, ponieważ cały plik dziennika jest zawsze przekazywany, ale operacja nie powinna pobierać mniej dzienników niż zażądano.
endTime		string	Koniec zakresu czasu przekazywania plików 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, ponieważ 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 uruchomieniuTime.
identityReference		ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do Azure Blob Storage określonego przez containerUrl. Tożsamość musi mieć dostęp do zapisu w kontenerze Azure Blob Storage.

Odpowiedzi

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

Zabezpieczenia

azure_auth

Microsoft Entra przepływ kodu uwierzytelniania OAuth 2.0

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Authorization

Type: apiKey
In: header

Przykłady

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
}

Definicje

Nazwa	Opis
BatchError	Odpowiedź o błędzie odebrana z usługi Azure Batch.
BatchErrorDetail	Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.
ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika skojarzonej z pulą usługi Batch, której będzie używać węzeł obliczeniowy.
ErrorMessage	Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.
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

Odpowiedź o błędzie odebrana 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

Element dodatkowych informacji zawartych w odpowiedzi Azure Batch błędu.

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

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

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

ErrorMessage

Komunikat o błędzie odebrany w odpowiedzi Azure Batch błędu.

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

UploadBatchServiceLogsConfiguration

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

Nazwa	Typ	Opis
containerUrl	string	Adres URL kontenera w 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ń zapisu do kontenera. Czas trwania sygnatury dostępu współdzielonego musi mieć wystarczającą ilość czasu na zakończenie przekazywania. Godzina rozpoczęcia sygnatury dostępu współdzielonego jest opcjonalna i zaleca się, aby nie została określona.
endTime	string	Koniec zakresu czasu przekazywania plików 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, ponieważ 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 uruchomieniuTime.
identityReference	ComputeNodeIdentityReference	Odwołanie do tożsamości przypisanej przez użytkownika w celu uzyskania dostępu do Azure Blob Storage określonego przez containerUrl. Tożsamość musi mieć dostęp do zapisu w kontenerze Azure Blob Storage.
startTime	string	Początek zakresu czasu przekazywania plików 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, ponieważ cały plik dziennika jest zawsze przekazywany, ale operacja nie powinna pobierać mniej dzienników niż zażądano.

UploadBatchServiceLogsResult

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

Nazwa	Typ	Opis
numberOfFilesUploaded	integer	Liczba plików dziennika, które zostaną przekazane.
virtualDirectoryName	string	Katalog wirtualny w Azure Blob Storage kontenerze, 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 tworzona na podstawie identyfikatora poolId, nodeId i unikatowego identyfikatora.