Compute Node - List
Выводит список вычислительных узлов в указанном пуле.
GET {batchUrl}/pools/{poolId}/nodes?api-version=2023-11-01.18.0
GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
batch
|
path | True |
string |
Базовый URL-адрес для всех запросов на обслуживание пакетная служба Azure. |
pool
|
path | True |
string |
Идентификатор пула, из которого вы хотите получить список вычислительных узлов. |
api-version
|
query | True |
string |
Версия API клиента. |
$filter
|
query |
string |
Предложение OData $filter. Дополнительные сведения о создании этого фильтра см. в разделе https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. |
|
$select
|
query |
string |
Предложение OData $select. |
|
maxresults
|
query |
integer int32 |
Максимальное количество элементов, возвращаемых в ответе. Можно вернуть не более 1000 вычислительных узлов. |
|
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 напрямую. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Ответ, содержащий список вычислительных узлов. Headers
|
|
Other Status Codes |
Ошибка пакетной службы. |
Безопасность
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
Примеры
Node list
Sample Request
GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2023-11-01.18.0
Sample Response
{
"value": [
{
"id": "tvm-1695681911_1-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2016-11-22T22:22:27.2236818Z",
"lastBootTime": "2016-11-22T22:22:24.4634125Z",
"allocationTime": "2016-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_1-20161122t193202z",
"vmSize": "small",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"startTaskInfo": {
"state": "completed",
"startTime": "2016-11-22T22:22:27.2236818Z",
"endTime": "2016-11-22T22:22:27.567189Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
}
},
{
"id": "tvm-1695681911_2-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2016-11-22T19:37:31.4285526Z",
"lastBootTime": "2016-11-22T19:37:28.623369Z",
"allocationTime": "2016-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_2-20161122t193202z",
"vmSize": "small",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"startTaskInfo": {
"state": "completed",
"startTime": "2016-11-22T19:37:31.4285526Z",
"endTime": "2016-11-22T19:37:31.838028Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
}
},
{
"id": "tvm-1695681911_3-20161122t193202z",
"url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z",
"state": "idle",
"schedulingState": "enabled",
"stateTransitionTime": "2016-11-22T19:36:51.0013378Z",
"lastBootTime": "2016-11-22T19:36:48.21721Z",
"allocationTime": "2016-11-22T19:32:02.8155319Z",
"ipAddress": "1.1.1.1",
"affinityId": "TVM:tvm-1695681911_3-20161122t193202z",
"vmSize": "small",
"totalTasksRun": 0,
"totalTasksSucceeded": 0,
"runningTasksCount": 0,
"runningTaskSlotsCount": 0,
"isDedicated": true,
"startTask": {
"commandLine": "cmd /c echo hello",
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
},
"maxTaskRetryCount": 0,
"waitForSuccess": false
},
"startTaskInfo": {
"state": "completed",
"startTime": "2016-11-22T19:36:51.0013378Z",
"endTime": "2016-11-22T19:36:51.2363447Z",
"exitCode": 0,
"retryCount": 0
},
"nodeAgentInfo": {
"version": "1.2.0.0",
"lastUpdateTime": "2016-11-22T22:22:24.4634125Z"
}
}
]
}
Определения
Имя | Описание |
---|---|
Auto |
область для автоматического пользователя |
Auto |
Задает параметры для автоматического пользователя, который запускает задачу в пакетной службе. |
Batch |
Ответ об ошибке, полученный от службы пакетная служба Azure. |
Batch |
Элемент с дополнительными сведениями, включенными в ответ на ошибку пакетная служба Azure. |
Certificate |
Ссылка на сертификат, устанавливаемый на вычислительные узлы в пуле. |
Certificate |
Расположение хранилища сертификатов на вычислительном узле, в котором устанавливается сертификат. |
Certificate |
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. |
Compute |
Вычислительный узел в пакетной службе. |
Compute |
Конфигурация конечной точки для вычислительного узла. |
Compute |
Ошибка, обнаруженная вычислительным узлом. |
Compute |
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел. |
Compute |
Результат вывода списка вычислительных узлов в пуле. |
Compute |
Текущее состояние вычислительного узла. |
Container |
Частный реестр контейнеров. |
Container |
Расположение рабочего каталога задачи контейнера. |
Elevation |
Уровень повышения прав пользователя. |
Environment |
Переменная среды, задается в процессе задачи. |
Error |
Категория ошибки. |
Error |
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure. |
Image |
Ссылка на образ Azure Виртуальные машины Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех Azure Marketplace ссылок на образы, проверенные пакетная служба Azure, см. операцию "Список поддерживаемых образов". |
Inbound |
Конечная точка входящего трафика на вычислительном узле. |
Inbound |
Протокол конечной точки. |
Name |
Представляет пару "имя-значение". |
Node |
Сведения об агенте вычислительного узла. |
Resource |
Один файл или несколько файлов для скачивания на вычислительный узел. |
Scheduling |
Доступен ли вычислительный узел для планирования задач. |
Start |
Задача, которая выполняется при присоединении узла к пулу в службе пакетная служба Azure либо при перезагрузке или повторном создании образа вычислительного узла. |
Start |
Сведения о startTask, работающем на вычислительном узле. |
Start |
Состояние StartTask на вычислительном узле. |
Task |
Содержит сведения о контейнере, который выполняет задача. |
Task |
Параметры контейнера для задачи. |
Task |
Сведения о выполнении задачи. |
Task |
Результат выполнения задачи. |
Task |
Сведения о сбое задачи. |
Task |
Сведения о задаче, выполняемой на вычислительном узле. |
Task |
Состояние задачи. |
User |
Определение удостоверения пользователя, с которым выполняется задача. |
Virtual |
Сведения о текущем состоянии виртуальной машины. |
AutoUserScope
область для автоматического пользователя
Имя | Тип | Описание |
---|---|---|
pool |
string |
Указывает, что задача выполняется как общая автоматическая учетная запись пользователя, созданная на каждом вычислительном узле в пуле. |
task |
string |
Указывает, что служба должна создать нового пользователя для задачи. |
AutoUserSpecification
Задает параметры для автоматического пользователя, который запускает задачу в пакетной службе.
Имя | Тип | Описание |
---|---|---|
elevationLevel |
Уровень прав автоматического пользователя. |
|
scope |
область для автоматического пользователя |
BatchError
Ответ об ошибке, полученный от службы пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки. Коды инвариантны и предназначены для программного использования. |
message |
Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе. |
|
values |
Коллекция пар "ключ-значение", содержащих дополнительные сведения об ошибке. |
BatchErrorDetail
Элемент с дополнительными сведениями, включенными в ответ на ошибку пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
key |
string |
Идентификатор, указывающий значение свойства Value. |
value |
string |
Дополнительные сведения, включенные в ответ об ошибке. |
CertificateReference
Ссылка на сертификат, устанавливаемый на вычислительные узлы в пуле.
Имя | Тип | Описание |
---|---|---|
storeLocation |
Расположение хранилища сертификатов на вычислительном узле, в котором устанавливается сертификат. |
|
storeName |
string |
Имя хранилища сертификатов на вычислительном узле, в который устанавливается сертификат. |
thumbprint |
string |
Отпечаток сертификата. |
thumbprintAlgorithm |
string |
Алгоритм, с которым связан отпечаток. Это должно быть sha1. |
visibility |
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата. |
CertificateStoreLocation
Расположение хранилища сертификатов на вычислительном узле, в котором устанавливается сертификат.
Имя | Тип | Описание |
---|---|---|
currentuser |
string |
Сертификаты должны быть установлены в хранилище сертификатов CurrentUser. |
localmachine |
string |
Сертификаты должны быть установлены в хранилище сертификатов LocalMachine. |
CertificateVisibility
Какие учетные записи пользователей на вычислительном узле должны иметь доступ к частным данным сертификата.
Имя | Тип | Описание |
---|---|---|
remoteuser |
string |
Сертификат должен быть виден учетным записям пользователей, с помощью которых пользователи удаленно получают доступ к вычислительному узлу. |
starttask |
string |
Сертификат должен быть виден учетной записи пользователя, под которой выполняется StartTask. Обратите внимание, что если областью автопользователя является Пул для начальной задачи и задачи, этот сертификат будет виден и для задачи. |
task |
string |
Сертификат должен быть виден учетным записям пользователей, с которыми выполняются задачи задания. |
ComputeNode
Вычислительный узел в пакетной службе.
Имя | Тип | Описание |
---|---|---|
affinityId |
string |
Идентификатор, который может быть передан при добавлении задачи для запроса на планирование задачи на этом вычислительном узле. |
allocationTime |
string |
Время, когда этот вычислительный узел был выделен пулу. |
certificateReferences |
Список сертификатов, установленных на вычислительном узле. Предупреждение. Это свойство устарело и будет удалено после февраля 2024 г. Вместо этого используйте расширение Azure KeyVault . |
|
endpointConfiguration |
Конфигурация конечной точки для вычислительного узла. |
|
errors |
Список ошибок, которые в настоящее время возникают на вычислительном узле. |
|
id |
string |
Идентификатор вычислительного узла. |
ipAddress |
string |
IP-адрес, который другие узлы могут использовать для связи с этим вычислительным узлом. |
isDedicated |
boolean |
Является ли этот вычислительный узел выделенным вычислительным узлом. Если значение равно false, вычислительный узел является точечным или низкоприоритетным вычислительным узлом. |
lastBootTime |
string |
Время последнего запуска вычислительного узла. |
nodeAgentInfo |
Сведения о версии агента вычислительного узла и времени обновления вычислительного узла до новой версии. |
|
recentTasks |
Список задач, состояние которых недавно изменилось. |
|
runningTaskSlotsCount |
integer |
Общее количество слотов планирования, используемых текущим выполнением задач заданий на вычислительном узле. Это относится к задачам диспетчера заданий и обычным задачам, но не к задачам подготовки, освобождению задания или запуску. |
runningTasksCount |
integer |
Общее число текущих задач задания на вычислительном узле. Это относится к задачам диспетчера заданий и обычным задачам, но не к задачам подготовки, освобождению задания или запуску. |
schedulingState |
Доступен ли вычислительный узел для планирования задач. |
|
startTask |
Задача, указанная для выполнения на вычислительном узле при присоединении к пулу. |
|
startTaskInfo |
Сведения о выполнении StartTask на вычислительном узле. |
|
state |
Текущее состояние вычислительного узла. |
|
stateTransitionTime |
string |
Время, когда вычислительный узел перешел в свое текущее состояние. |
totalTasksRun |
integer |
Общее число заданий, выполненных на вычислительном узле. Это относится к задачам диспетчера заданий и обычным задачам, но не к задачам подготовки, освобождению задания или запуску. |
totalTasksSucceeded |
integer |
Общее число задач задания, успешно завершенных (с exitCode 0) на вычислительном узле. Это относится к задачам диспетчера заданий и обычным задачам, но не к задачам подготовки, освобождению задания или запуску. |
url |
string |
URL-адрес вычислительного узла. |
virtualMachineInfo |
Сведения о текущем состоянии виртуальной машины. |
|
vmSize |
string |
Размер виртуальной машины, на котором размещен вычислительный узел. |
ComputeNodeEndpointConfiguration
Конфигурация конечной точки для вычислительного узла.
Имя | Тип | Описание |
---|---|---|
inboundEndpoints |
Список входящих конечных точек, доступных на вычислительном узле. |
ComputeNodeError
Ошибка, обнаруженная вычислительным узлом.
Имя | Тип | Описание |
---|---|---|
code |
string |
Идентификатор ошибки вычислительного узла. Коды инвариантны и предназначены для программного использования. |
errorDetails |
Список дополнительных сведений об ошибках, связанных с ошибкой вычислительного узла. |
|
message |
string |
Сообщение, описывающее ошибку вычислительного узла, предназначенное для отображения в пользовательском интерфейсе. |
ComputeNodeIdentityReference
Ссылка на назначенное пользователем удостоверение, связанное с пулом пакетной службы, который будет использовать вычислительный узел.
Имя | Тип | Описание |
---|---|---|
resourceId |
string |
Идентификатор ресурса ARM для удостоверения, назначаемого пользователем. |
ComputeNodeListResult
Результат вывода списка вычислительных узлов в пуле.
Имя | Тип | Описание |
---|---|---|
odata.nextLink |
string |
URL-адрес для получения следующего набора результатов. |
value |
Список вычислительных узлов. |
ComputeNodeState
Текущее состояние вычислительного узла.
Имя | Тип | Описание |
---|---|---|
creating |
string |
Пакетная служба получила базовую виртуальную машину из Службы вычислений Azure, но еще не начала присоединяться к пулу. |
idle |
string |
Вычислительный узел в настоящее время не выполняет задачу. |
leavingpool |
string |
Вычислительный узел покидает пул, потому что пользователь явно удалил его, или из-за того, что размер пула изменяется или выполняется автоматическое масштабирование. |
offline |
string |
Вычислительный узел в настоящее время не выполняет задачу, и планирование новых задач на вычислительном узле отключено. |
preempted |
string |
Точечный или низкоприоритетный вычислительный узел был вытеснен. Задачи, которые выполнялись на вычислительном узле при его упрещении, будут перенесены, когда станет доступен другой вычислительный узел. |
rebooting |
string |
Вычислительный узел перезагружается. |
reimaging |
string |
Вычислительный узел повторно создается. |
running |
string |
Вычислительный узел выполняет одну или несколько задач (кроме StartTask). |
starting |
string |
Пакетная служба запускается на базовой виртуальной машине. |
starttaskfailed |
string |
Сбой StartTask на вычислительном узле (и исчерпаны все повторные попытки), и задано значение waitForSuccess. Вычислительный узел не подходит для выполнения задач. |
unknown |
string |
Пакетная служба потеряла связь с вычислительным узлом и не знает своего истинного состояния. |
unusable |
string |
Вычислительный узел не может использоваться для выполнения задачи из-за ошибок. |
waitingforstarttask |
string |
StartTask запущена на вычислительном узле, но параметр waitForSuccess установлен, а StartTask еще не завершен. |
ContainerRegistry
Частный реестр контейнеров.
Имя | Тип | Описание |
---|---|---|
identityReference |
Ссылка на назначенное пользователем удостоверение, используемое для доступа к Реестр контейнеров Azure вместо имени пользователя и пароля. |
|
password |
string |
Пароль для входа на сервер реестра. |
registryServer |
string |
URL-адрес реестра. |
username |
string |
Имя пользователя для входа на сервер реестра. |
ContainerWorkingDirectory
Расположение рабочего каталога задачи контейнера.
Имя | Тип | Описание |
---|---|---|
containerImageDefault |
string |
Используйте рабочий каталог, определенный в образе контейнера. Помните, что этот каталог не будет содержать файлы ресурсов, скачанные пакетной службой. |
taskWorkingDirectory |
string |
Используйте стандартный рабочий каталог задачи пакетной службы, который будет содержать файлы ресурсов задачи, заполненные пакетной службой. |
ElevationLevel
Уровень повышения прав пользователя.
Имя | Тип | Описание |
---|---|---|
admin |
string |
Пользователь является пользователем с повышенным уровнем доступа и работает с полными разрешениями администратора. |
nonadmin |
string |
Пользователь является обычным пользователем без повышенных прав доступа. |
EnvironmentSetting
Переменная среды, задается в процессе задачи.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя переменной среды. |
value |
string |
Значение переменной среды. |
ErrorCategory
Категория ошибки.
Имя | Тип | Описание |
---|---|---|
servererror |
string |
Ошибка связана с внутренней проблемой сервера. |
usererror |
string |
Ошибка связана с проблемой пользователя, например неправильной настройкой. |
ErrorMessage
Сообщение об ошибке, полученное в ответе об ошибке пакетная служба Azure.
Имя | Тип | Описание |
---|---|---|
lang |
string |
Код языка сообщения об ошибке |
value |
string |
Текст сообщения. |
ImageReference
Ссылка на образ Azure Виртуальные машины Marketplace или образ коллекции вычислений Azure. Чтобы получить список всех Azure Marketplace ссылок на образы, проверенные пакетная служба Azure, см. операцию "Список поддерживаемых образов".
Имя | Тип | Описание |
---|---|---|
exactVersion |
string |
Конкретная версия образа платформы или образа Marketplace, используемого для создания узла. Это поле, доступное только для чтения, отличается от "version" только в том случае, если для параметра version при создании пула было задано значение "latest". |
offer |
string |
Тип предложения образа Azure Виртуальные машины Marketplace. |
publisher |
string |
Издатель образа Azure Виртуальные машины Marketplace. |
sku |
string |
Номер SKU образа Azure Виртуальные машины Marketplace. |
version |
string |
Версия образа Azure Виртуальные машины Marketplace. |
virtualMachineImageId |
string |
Идентификатор ресурса ARM образа коллекции вычислений Azure. Вычислительные узлы в пуле будут созданы с помощью этого идентификатора образа. Это форма /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} или /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleryName/images/{imageDefinitionName} для всегда используется последняя версия образа. |
InboundEndpoint
Конечная точка входящего трафика на вычислительном узле.
Имя | Тип | Описание |
---|---|---|
backendPort |
integer |
Номер внутреннего порта конечной точки. |
frontendPort |
integer |
Номер общедоступного порта конечной точки. |
name |
string |
Имя конечной точки. |
protocol |
Протокол конечной точки. |
|
publicFQDN |
string |
Общедоступное полное доменное имя вычислительного узла. |
publicIPAddress |
string |
Общедоступный IP-адрес вычислительного узла. |
InboundEndpointProtocol
Протокол конечной точки.
Имя | Тип | Описание |
---|---|---|
tcp |
string |
Используйте TCP для конечной точки. |
udp |
string |
Используйте UDP для конечной точки. |
NameValuePair
Представляет пару "имя-значение".
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя в паре "имя-значение". |
value |
string |
Значение в паре "имя-значение". |
NodeAgentInformation
Сведения об агенте вычислительного узла.
Имя | Тип | Описание |
---|---|---|
lastUpdateTime |
string |
Время обновления агента вычислительного узла на вычислительном узле. |
version |
string |
Версия агента пакетного вычислительного узла, работающего на вычислительном узле. |
ResourceFile
Один файл или несколько файлов для скачивания на вычислительный узел.
Имя | Тип | Описание |
---|---|---|
autoStorageContainerName |
string |
Имя контейнера хранилища в учетной записи автоматического хранения. |
blobPrefix |
string |
Префикс большого двоичного объекта, используемый при скачивании BLOB-объектов из контейнера службы хранилища Azure. Будут загружены только большие двоичные объекты, имена которых начинаются с указанного префикса. |
fileMode |
string |
Атрибут режима разрешений файла в восьмеричном формате. |
filePath |
string |
Расположение на вычислительном узле, куда нужно скачать файлы, относительно рабочего каталога задачи. |
httpUrl |
string |
URL-адрес для скачивания файла. |
identityReference |
Ссылка на назначенное пользователем удостоверение, используемое для доступа к Хранилище BLOB-объектов Azure, указанному storageContainerUrl или httpUrl. |
|
storageContainerUrl |
string |
URL-адрес контейнера BLOB-объектов в Хранилище BLOB-объектов Azure. |
SchedulingState
Доступен ли вычислительный узел для планирования задач.
Имя | Тип | Описание |
---|---|---|
disabled |
string |
Новые задачи не будут планироваться на вычислительном узле. Задачи, уже запущенные на вычислительном узле, могут по-прежнему выполняться до завершения. Все вычислительные узлы начинаются с включенного планирования. |
enabled |
string |
Задачи можно планировать на вычислительном узле. |
StartTask
Задача, которая выполняется при присоединении узла к пулу в службе пакетная служба Azure либо при перезагрузке или повторном создании образа вычислительного узла.
Имя | Тип | Описание |
---|---|---|
commandLine |
string |
Командная строка StartTask. |
containerSettings |
Параметры для контейнера, в котором выполняется StartTask. |
|
environmentSettings |
Список параметров переменных среды для StartTask. |
|
maxTaskRetryCount |
integer |
Максимальное количество повторных попыток задачи. |
resourceFiles |
Список файлов, которые пакетная служба скачает на вычислительный узел перед запуском командной строки. Существует максимальный размер списка файлов ресурсов. При превышении максимального размера запрос завершится ошибкой и кодом ошибки ответа будет RequestEntityTooLarge. В этом случае размер коллекции ResourceFiles должен быть уменьшен. Это можно сделать с помощью .zip файлов, пакетов приложений или контейнеров Docker. |
|
userIdentity |
Удостоверение пользователя, с которым выполняется StartTask. |
|
waitForSuccess |
boolean |
Указывает, должна ли пакетная служба ожидать успешного завершения StartTask (т. е. выхода с кодом выхода 0) перед планированием задач на вычислительном узле. |
StartTaskInformation
Сведения о startTask, работающем на вычислительном узле.
Имя | Тип | Описание |
---|---|---|
containerInfo |
Сведения о контейнере, в котором выполняется задача. |
|
endTime |
string |
Время остановки запуска StartTask. |
exitCode |
integer |
Код выхода программы, указанной в командной строке StartTask. |
failureInfo |
Сведения, описывающие сбой задачи, если таковые есть. |
|
lastRetryTime |
string |
Самое последнее время, когда началась повторная попытка задачи. |
result |
Результат выполнения задачи. |
|
retryCount |
integer |
Количество повторных попыток выполнения задачи пакетной службой. |
startTime |
string |
Время начала выполнения StartTask. |
state |
Состояние StartTask на вычислительном узле. |
StartTaskState
Состояние StartTask на вычислительном узле.
Имя | Тип | Описание |
---|---|---|
completed |
string |
StartTask завершился с кодом выхода 0, или startTask завершился сбоем и достигнут предел повторных попыток, или процесс StartTask не был запущен из-за ошибок подготовки задачи (например, сбой загрузки файла ресурсов). |
running |
string |
StartTask в настоящее время выполняется. |
TaskContainerExecutionInformation
Содержит сведения о контейнере, который выполняет задача.
Имя | Тип | Описание |
---|---|---|
containerId |
string |
Идентификатор контейнера. |
error |
string |
Подробные сведения об ошибке о контейнере. |
state |
string |
Состояние контейнера. |
TaskContainerSettings
Параметры контейнера для задачи.
Имя | Тип | Описание |
---|---|---|
containerRunOptions |
string |
Дополнительные параметры команды создания контейнера. |
imageName |
string |
Образ, используемый для создания контейнера, в котором будет выполняться задача. |
registry |
Частный реестр, содержащий образ контейнера. |
|
workingDirectory |
Расположение рабочего каталога задачи контейнера. |
TaskExecutionInformation
Сведения о выполнении задачи.
Имя | Тип | Описание |
---|---|---|
containerInfo |
Сведения о контейнере, в котором выполняется задача. |
|
endTime |
string |
Время завершения задачи. |
exitCode |
integer |
Код выхода программы, указанной в командной строке задачи. |
failureInfo |
Сведения, описывающие сбой задачи, если таковые есть. |
|
lastRequeueTime |
string |
Последнее время, когда задача была повторно поставлена в очередь пакетной службой в результате запроса пользователя. |
lastRetryTime |
string |
Самое последнее время, когда началась повторная попытка выполнения задачи. |
requeueCount |
integer |
Количество повторных вызовов задачи пакетной службой в результате запроса пользователя. |
result |
Результат выполнения задачи. |
|
retryCount |
integer |
Количество повторных попыток выполнения задачи пакетной службой. |
startTime |
string |
Время запуска задачи. |
TaskExecutionResult
Результат выполнения задачи.
Имя | Тип | Описание |
---|---|---|
failure |
string |
Во время обработки задачи произошла ошибка. Возможно, сбой произошел до запуска процесса задачи, во время выполнения процесса задачи или после завершения процесса задачи. |
success |
string |
Задача успешно выполнена. |
TaskFailureInformation
Сведения о сбое задачи.
Имя | Тип | Описание |
---|---|---|
category |
Категория ошибки задачи. |
|
code |
string |
Идентификатор ошибки задачи. Коды инвариантны и предназначены для программного использования. |
details |
Список дополнительных сведений, связанных с ошибкой. |
|
message |
string |
Сообщение с описанием ошибки задачи, предназначенной для отображения в пользовательском интерфейсе. |
TaskInformation
Сведения о задаче, выполняемой на вычислительном узле.
Имя | Тип | Описание |
---|---|---|
executionInfo |
Сведения о выполнении задачи. |
|
jobId |
string |
Идентификатор задания, которому принадлежит задача. |
subtaskId |
integer |
Идентификатор подзадачности, если задача является задачей с несколькими экземплярами. |
taskId |
string |
Идентификатор задачи. |
taskState |
Текущее состояние задачи. |
|
taskUrl |
string |
URL-адрес задачи. |
TaskState
Состояние задачи.
Имя | Тип | Описание |
---|---|---|
active |
string |
Задача поставлена в очередь и может выполняться, но в настоящее время не назначена вычислительному узлу. Задача переходит в это состояние при ее создании, при включении после отключения или при ожидании повторных попыток после неудачного запуска. |
completed |
string |
Задача больше не может выполняться, как правило, из-за того, что задача успешно завершена или задача завершилась неудачно и исчерпан предел повторных попыток. Задача также помечается как завершенная, если произошла ошибка при запуске задачи или когда задача была завершена. |
preparing |
string |
Задача назначена вычислительному узлу, но ожидает завершения необходимой задачи подготовки задания на вычислительном узле. Если задача подготовки задания завершается успешно, задача переместится к выполнению. Если задача подготовки задания завершается сбоем, задача вернется к активной и сможет быть назначена другому вычислительному узлу. |
running |
string |
Задача выполняется на вычислительном узле. Сюда входит подготовка на уровне задачи, например скачивание файлов ресурсов или развертывание пакетов, указанных в задаче. Это не обязательно означает, что командная строка задачи начала выполнение. |
UserIdentity
Определение удостоверения пользователя, с которым выполняется задача.
Имя | Тип | Описание |
---|---|---|
autoUser |
Автоматический пользователь, под которым выполняется задача. |
|
username |
string |
Имя удостоверения пользователя, с которым выполняется задача. |
VirtualMachineInfo
Сведения о текущем состоянии виртуальной машины.
Имя | Тип | Описание |
---|---|---|
imageReference |
Ссылка на образ Marketplace виртуальной машины Azure. |
|
scaleSetVmResourceId |
string |
Идентификатор ресурса текущей виртуальной машины масштабируемого набора виртуальных машин вычислительного узла. Определяется только в том случае, если учетная запись пакетной службы была создана со свойством poolAllocationMode, равным UserSubscription. |