Nodes - Upload Node Logs

Служба:: Batch Service

Версия API:: 2025-06-01

Upload Azure Batch service log files из указанного Compute Node в Azure Blob Storage.
Это предназначено для автоматического сбора файлов журналов Azure Batch из Compute Nodes, если вы столкнулись с ошибкой и хотите обратиться в поддержку Azure. Файлы журнала пакетной службы Azure должны предоставляться в службу поддержки Azure, чтобы помочь в отладке проблем с пакетной службой.

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2025-06-01

С использованием необязательных параметров:

POST {endpoint}/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs?api-version=2025-06-01&timeOut={timeOut}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Конечная точка учетной записи пакетной службы (например, https://batchaccount.eastus2.batch.azure.com).
nodeId	path	True	string	ID вычислительного узла, для которого вы хотите получить файл протокола удалённого рабочего стола.
poolId	path	True	string	Идентификатор пула, содержащего вычислительный узел.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
timeOut	query		integer (int32)	Максимальное время, которое сервер может тратить на обработку запроса в секундах. Значение по умолчанию — 30 секунд. Если значение превышает 30, вместо этого используется стандартное значение.".

Заголовок запроса

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

Имя	Тип	Описание
client-request-id	string	Удостоверение запроса, созданное вызывающим пользователем, в виде GUID без украшений, таких как фигурные скобки, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Должен ли сервер возвращать идентификатор client-request-id в ответе.
ocp-date	string (date-time-rfc7231)	Время выдачи запроса. Клиентские библиотеки обычно задают это в текущее время системных часов; задайте его явным образом, если вы вызываете REST API напрямую.

Текст запроса

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

Имя	Обязательно	Тип	Описание
containerUrl	True	string (uri)	URL контейнера в Azure Blob Storage, куда можно загрузить файл(ы) журнала Batch Service. Если управляемая идентификация, назначенная пользователем, не используется ссылка, URL должна содержать подпись общего доступа (SAS), предоставляющая разрешения на запись контейнера. Длительность SAS должна дать достаточно времени для завершения загрузки. Время начала SAS является необязательным и рекомендуется не указывать.
startTime	True	string (date-time)	Начало временного диапазона, из которого можно загрузить файл(ы) журнала Batch Service. Любой лог-файл с лог-сообщением в указанном временном диапазоне будет загружен. Это означает, что операция может получить больше журналов, чем было запрошено, поскольку весь файл журнала всегда загружается, но операция не должна получать меньше журналов, чем было запрошено.
endTime		string (date-time)	Конечный временной диапазон, из которого можно загрузить файл(ы) журнала Batch Service. Любой лог-файл с лог-сообщением в указанном временном диапазоне будет загружен. Это означает, что операция может получить больше журналов, чем было запрошено, поскольку весь файл журнала всегда загружается, но операция не должна получать меньше журналов, чем было запрошено. Если его опущено, по умолчанию загружаются все доступные логи после стартового времени.
identityReference		BatchNodeIdentityReference	Ссылка на назначенную пользователю идентичность для доступа к Azure Blob Storage, указанной в containerUrl. Идентичность должна иметь доступ к записи в контейнер хранения Azure Blob.

Ответы

Имя	Тип	Описание
200 OK	UploadBatchServiceLogsResult	Запрос выполнен успешно. Заголовки ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

UploadBatchServiceLogsResult

Запрос выполнен успешно.

Заголовки

ETag: string
Last-Modified: string
client-request-id: string
request-id: string

Other Status Codes

BatchError

Непредвиденное сообщение об ошибке.

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя	Описание
https://batch.core.windows.net//.default

Примеры

Upload BatchService Logs

Образец запроса

HTTP

POST {endpoint}/pools/poolId/nodes/tvm-1695681911_1-20161121t182739z/uploadbatchservicelogs?api-version=2025-06-01



{
  "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2025-12-09T18%3A51%3A00Z&sp=w&sv=2025-05-31&sr=c&sig",
  "startTime": "2025-11-27T00:00:00Z"
}

Пример ответа

Код состояния:: 200

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

Определения

Имя	Описание
BatchError	Ответ об ошибке, полученный из пакетной службы Azure.
BatchErrorDetail	Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.
BatchErrorMessage	Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.
BatchNodeIdentityReference	Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
UploadBatchServiceLogsOptions	Файлы журнала пакетной службы Azure передают параметры для вычислительного узла.
UploadBatchServiceLogsResult	Результат отправки файлов журнала пакетной службы с определенного вычислительного узла.

BatchError

Объект

Ответ об ошибке, полученный из пакетной службы Azure.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
message	BatchErrorMessage	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
values	BatchErrorDetail[]	Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

Объект

Элемент дополнительных сведений, включенных в ответ на ошибку пакетной службы Azure.

Имя	Тип	Описание
key	string	Идентификатор, указывающий значение свойства Value.
value	string	Дополнительные сведения, включенные в ответ на ошибку.

BatchErrorMessage

Объект

Сообщение об ошибке, полученное в ответе на ошибку пакетной службы Azure.

Имя	Тип	Описание
lang	string	Языковой код сообщения об ошибке.
value	string	Текст сообщения.

BatchNodeIdentityReference

Объект

Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.

Имя	Тип	Описание
resourceId	string (arm-id)	Идентификатор ресурса ARM назначенного пользователем удостоверения.

UploadBatchServiceLogsOptions

Объект

Файлы журнала пакетной службы Azure передают параметры для вычислительного узла.

Имя	Тип	Описание
containerUrl	string (uri)	URL контейнера в Azure Blob Storage, куда можно загрузить файл(ы) журнала Batch Service. Если управляемая идентификация, назначенная пользователем, не используется ссылка, URL должна содержать подпись общего доступа (SAS), предоставляющая разрешения на запись контейнера. Длительность SAS должна дать достаточно времени для завершения загрузки. Время начала SAS является необязательным и рекомендуется не указывать.
endTime	string (date-time)	Конечный временной диапазон, из которого можно загрузить файл(ы) журнала Batch Service. Любой лог-файл с лог-сообщением в указанном временном диапазоне будет загружен. Это означает, что операция может получить больше журналов, чем было запрошено, поскольку весь файл журнала всегда загружается, но операция не должна получать меньше журналов, чем было запрошено. Если его опущено, по умолчанию загружаются все доступные логи после стартового времени.
identityReference	BatchNodeIdentityReference	Ссылка на назначенную пользователю идентичность для доступа к Azure Blob Storage, указанной в containerUrl. Идентичность должна иметь доступ к записи в контейнер хранения Azure Blob.
startTime	string (date-time)	Начало временного диапазона, из которого можно загрузить файл(ы) журнала Batch Service. Любой лог-файл с лог-сообщением в указанном временном диапазоне будет загружен. Это означает, что операция может получить больше журналов, чем было запрошено, поскольку весь файл журнала всегда загружается, но операция не должна получать меньше журналов, чем было запрошено.

UploadBatchServiceLogsResult

Объект

Результат отправки файлов журнала пакетной службы с определенного вычислительного узла.

Имя	Тип	Описание
numberOfFilesUploaded	integer (int32)	Количество файлов журналов, которые будут загружены.
virtualDirectoryName	string	Виртуальный каталог в контейнере хранения Azure Blob, в который будет загружен файл(ы) журнала Batch Service. Имя виртуального каталога является частью имени blob для каждого загружаемого файла журнала и строится на основе poolId, nodeId и уникального идентификатора.