Compute Node - Upload Batch Service Logs

  • Ссылка
Service:
Batch Service
API Version:
2023-11-01.18.0

Отправьте пакетная служба Azure файлы журнала службы с указанного вычислительного узла в Хранилище BLOB-объектов Azure.
Это предназначено для автоматического сбора пакетная служба Azure файлов журнала службы с вычислительных узлов, если возникает ошибка и вы хотите перерасти до поддержка Azure. Файлы журналов пакетная служба Azure служб должны предоставляться поддержка Azure, чтобы упростить отладку проблем с пакетной службой.

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

Параметры URI

Имя В Обязательно Тип Описание
batchUrl
 path True

string

Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure.
nodeId
 path True

string

Идентификатор вычислительного узла, с которого требуется отправить файлы журнала службы пакетная служба Azure.
poolId
 path True

string

Идентификатор пула, содержащего вычислительный узел.
api-version
 query True

string

Версия API клиента.
timeout
 query

integer

int32

Максимальное время, которое сервер может потратить на обработку запроса, в секундах. По умолчанию это 30 секунд.

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

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

Имя Обязательно Тип Описание
client-request-id

string

uuid

Удостоверение запроса, созданное вызывающим абонентом, в виде GUID без оформления, например фигурных скобок, например 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Указывает, должен ли сервер возвращать client-request-id в ответе.
ocp-date

string

date-time-rfc1123

Время отправки запроса. Клиентские библиотеки обычно устанавливают текущее системное время; Задайте его явным образом, если вы вызываете REST API напрямую.

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

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

Имя Обязательно Тип Описание
containerUrl True

string

URL-адрес контейнера в Хранилище BLOB-объектов Azure, в который нужно отправить файлы журналов пакетной службы.
Если управляемое удостоверение, назначаемое пользователем, не используется, URL-адрес должен содержать подписанный URL-адрес (SAS), предоставляющий разрешения на запись в контейнер. Длительность SAS должна предоставить достаточно времени для завершения отправки. Время начала sas является необязательным и не рекомендуется указывать.
startTime True

string

Начало диапазона времени для отправки файлов журналов пакетной службы.
Будет отправлен любой файл журнала, содержащий сообщение журнала в диапазоне времени. Это означает, что операция может получить больше журналов, чем было запрошено, так как весь файл журнала всегда отправляется, но операция не должна извлекать меньше журналов, чем было запрошено.
endTime

string

Конец диапазона времени для отправки файлов журналов пакетной службы.
Будет отправлен любой файл журнала, содержащий сообщение журнала в диапазоне времени. Это означает, что операция может получить больше журналов, чем было запрошено, так как весь файл журнала всегда отправляется, но операция не должна извлекать меньше журналов, чем было запрошено. Если этот параметр опущен, по умолчанию отправляется все журналы, доступные после значения startTime.
identityReference

ComputeNodeIdentityReference

Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, указанному containerUrl.
Удостоверение должно иметь доступ на запись к контейнеру Хранилище BLOB-объектов Azure.

Ответы

Имя Тип Описание
200 OK

UploadBatchServiceLogsResult

Запрос к пакетной службе выполнен успешно.

Headers

  • client-request-id: string
  • request-id: string
Other Status Codes

BatchError

Ошибка пакетной службы.

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

azure_auth

Microsoft Entra поток кода проверки подлинности OAuth 2.0

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

Scopes

Имя Описание
user_impersonation Олицетворение учетной записи пользователя

Authorization

Type: apiKey
In: header

Примеры

Upload BatchService Logs

Sample Request

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
}

Определения

Имя Описание
BatchError

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

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

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

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

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

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

BatchError

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

Имя Тип Описание
code

string

Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
message

ErrorMessage

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

BatchErrorDetail[]

Коллекция пар "ключ-значение", содержащая дополнительные сведения об ошибке.

BatchErrorDetail

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

Имя Тип Описание
key

string

Идентификатор, указывающий значение свойства Value.
value

string

Дополнительные сведения, включенные в ответ об ошибке.

ComputeNodeIdentityReference

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

Имя Тип Описание
resourceId

string

Идентификатор ресурса ARM для удостоверения, назначаемого пользователем.

ErrorMessage

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

Имя Тип Описание
lang

string

Код языка сообщения об ошибке
value

string

Текст сообщения.

UploadBatchServiceLogsConfiguration

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

Имя Тип Описание
containerUrl

string

URL-адрес контейнера в Хранилище BLOB-объектов Azure, в который нужно отправить файлы журналов пакетной службы.
Если управляемое удостоверение, назначаемое пользователем, не используется, URL-адрес должен содержать подписанный URL-адрес (SAS), предоставляющий разрешения на запись в контейнер. Длительность SAS должна предоставить достаточно времени для завершения отправки. Время начала sas является необязательным и не рекомендуется указывать.
endTime

string

Конец диапазона времени для отправки файлов журналов пакетной службы.
Будет отправлен любой файл журнала, содержащий сообщение журнала в диапазоне времени. Это означает, что операция может получить больше журналов, чем было запрошено, так как весь файл журнала всегда отправляется, но операция не должна извлекать меньше журналов, чем было запрошено. Если этот параметр опущен, по умолчанию отправляется все журналы, доступные после значения startTime.
identityReference

ComputeNodeIdentityReference

Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, указанному containerUrl.
Удостоверение должно иметь доступ на запись к контейнеру Хранилище BLOB-объектов Azure.
startTime

string

Начало диапазона времени для отправки файлов журналов пакетной службы.
Будет отправлен любой файл журнала, содержащий сообщение журнала в диапазоне времени. Это означает, что операция может получить больше журналов, чем было запрошено, так как весь файл журнала всегда отправляется, но операция не должна извлекать меньше журналов, чем было запрошено.

UploadBatchServiceLogsResult

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

Имя Тип Описание
numberOfFilesUploaded

integer

Количество файлов журнала, которые будут отправлены.
virtualDirectoryName

string

Виртуальный каталог в Хранилище BLOB-объектов Azure контейнере, в который будут отправлены файлы журналов пакетной службы.
Имя виртуального каталога является частью имени большого двоичного объекта для каждого отправленного файла журнала. Оно создается на основе poolId, nodeId и уникального идентификатора.