你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Compute Node - List

参考

服务:: Batch Service

API 版本:: 2024-07-01.20.0

列出指定池中的计算节点。

GET {batchUrl}/pools/{poolId}/nodes?api-version=2024-07-01.20.0

具有可选参数:

GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI 参数

名称	在	必需	类型	说明
batchUrl	path	True	string	所有 Azure Batch 服务请求的基本 URL。
poolId	path	True	string	要从中列出计算节点的池的 ID。
api-version	query	True	string	客户端 API 版本。
$filter	query		string	OData $filter 子句。有关构造此筛选器的详细信息，请参阅 https://docs.microsoft.com/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 秒。如果该值大于 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	ComputeNodeListResult	包含计算节点列表的响应。标头 client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 服务中的错误。

名称

类型

说明

200 OK

ComputeNodeListResult

包含计算节点列表的响应。

标头

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

Other Status Codes

BatchError

Batch 服务中的错误。

安全性

azure_auth

Microsoft Entra OAuth 2.0 身份验证代码流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

Authorization

类型: apiKey
在: header

示例

Node list

示例请求

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2024-07-01.20.0

示例响应

状态代码:: 200

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

定义

名称	说明
AutoUserScope	自动用户的范围
AutoUserSpecification	指定在 Batch 服务上运行 Task 的自动用户的参数。
BatchError	从 Azure Batch 服务收到的错误响应。
BatchErrorDetail	Azure Batch 错误响应中包含的附加信息项。
CertificateReference	对要安装在池中的计算节点上的证书的引用。
CertificateStoreLocation	要在其中安装证书的计算节点上证书存储的位置。
CertificateVisibility	计算节点上的哪些用户帐户应有权访问证书的专用数据。
ComputeNode	Batch 服务中的计算节点。
ComputeNodeEndpointConfiguration	计算节点的终结点配置。
ComputeNodeError	计算节点遇到的错误。
ComputeNodeIdentityReference	对与计算节点将使用的 Batch 池关联的用户分配标识的引用。
ComputeNodeListResult	列出池中的计算节点的结果。
ComputeNodeState	计算节点的当前状态。
ContainerHostBatchBindMountEntry	要装载到任务容器的路径和装载模式的条目。
ContainerHostDataPath	将装载到容器任务的容器的路径。
ContainerRegistry	专用容器注册表。
ContainerWorkingDirectory	容器任务工作目录的位置。
ElevationLevel	用户的提升级别。
EnvironmentSetting	要对任务进程设置的环境变量。
ErrorCategory	错误的类别。
ErrorMessage	Azure Batch 错误响应中收到的错误消息。
ImageReference	对 Azure 虚拟机市场映像或 Azure 计算库映像的引用。若要获取 Azure Batch 验证的所有 Azure 市场映像引用的列表，请参阅“列出支持的映像”操作。
InboundEndpoint	计算节点上的入站终结点。
InboundEndpointProtocol	终结点的协议。
NameValuePair	表示名称/值对。
NodeAgentInformation	有关计算节点代理的信息。
ResourceFile	要下载到计算节点的单个文件或多个文件。
SchedulingState	计算节点是否可用于任务计划。
StartTask	当节点加入 Azure Batch 服务中的池或重新启动或重新映像计算节点时运行的任务。
StartTaskInformation	有关在计算节点上运行的 StartTask 的信息。
StartTaskState	计算节点上 StartTask 的状态。
TaskContainerExecutionInformation	包含有关任务正在执行的容器的信息。
TaskContainerSettings	任务的容器设置。
TaskExecutionInformation	有关任务执行的信息。
TaskExecutionResult	任务执行的结果。
TaskFailureInformation	有关任务失败的信息。
TaskInformation	有关在计算节点上运行的任务的信息。
TaskState	任务的状态。
UserIdentity	运行任务的用户标识的定义。
VirtualMachineInfo	有关虚拟机的当前状态的信息。

AutoUserScope

自动用户的范围

名称	类型	说明
pool	string	指定任务作为在池中的每个计算节点上创建的通用自动用户帐户运行。
task	string	指定服务应为任务创建新用户。

AutoUserSpecification

指定在 Batch 服务上运行 Task 的自动用户的参数。

名称	类型	说明
elevationLevel	ElevationLevel	自动用户的提升级别。默认值为 nonAdmin。
scope	AutoUserScope	自动用户的范围默认值为池。如果池正在运行 Windows，则应指定任务值（如果需要在任务之间进行更严格的隔离）。例如，如果任务以可能影响其他任务的方式改变注册表，或者已在池中指定了证书，而该池中不应通过正常任务访问，但应可由 StartTasks 访问。

BatchError

从 Azure Batch 服务收到的错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
message	ErrorMessage	描述错误的消息，旨在适合在用户界面中显示。
values	BatchErrorDetail[]	包含有关错误的更多详细信息的键值对的集合。

BatchErrorDetail

Azure Batch 错误响应中包含的附加信息项。

名称	类型	说明
key	string	指定 Value 属性含义的标识符。
value	string	错误响应附带的其他信息。

CertificateReference

对要安装在池中的计算节点上的证书的引用。

名称	类型	说明
storeLocation	CertificateStoreLocation	要在其中安装证书的计算节点上证书存储的位置。默认值为 currentuser。此属性仅适用于使用 Windows 计算节点配置的池。对于 Linux 计算节点，证书存储在 Task 工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“证书”目录，并将证书置于该目录中。
storeName	string	要在其中安装证书的计算节点上的证书存储的名称。此属性仅适用于使用 Windows 计算节点配置的池。常见的存储名称包括：My、Root、CA、Trust、Trustallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook，但也可以使用任何自定义存储名称。默认值为“我的”。
thumbprint	string	证书的指纹。
thumbprintAlgorithm	string	指纹关联的算法。这必须是 sha1。
visibility	CertificateVisibility[]	计算节点上的哪些用户帐户应有权访问证书的专用数据。可以在此集合中指定多个可见性。默认值为所有帐户。

CertificateStoreLocation

要在其中安装证书的计算节点上证书存储的位置。

名称	类型	说明
currentuser	string	证书应安装到 CurrentUser 证书存储。
localmachine	string	证书应安装到 LocalMachine 证书存储。

CertificateVisibility

计算节点上的哪些用户帐户应有权访问证书的专用数据。

名称	类型	说明
remoteuser	string	证书应该对用户远程访问计算节点的用户帐户可见。
starttask	string	证书应该对运行 StartTask 的用户帐户可见。请注意，如果 AutoUser 作用域是 StartTask 和 Task 的池，则此证书也将对任务可见。
task	string	证书应该对运行作业任务的用户帐户可见。

ComputeNode

Batch 服务中的计算节点。

名称	类型	说明
affinityId	string	添加任务以请求在此计算节点上计划任务时传递的标识符。请注意，这只是软相关性。如果目标计算节点在计划任务时繁忙或不可用，则任务将在其他位置进行计划。
allocationTime	string	此计算节点分配给池的时间。这是计算节点最初分配的时间，设置后不会更改。当计算节点被服务治愈或抢占时，它不会更新。
certificateReferences	CertificateReference[]	在计算节点上安装的证书列表。对于 Windows 节点，Batch 服务会将证书安装到指定的证书存储和位置。对于 Linux 计算节点，证书存储在 Task 工作目录中的目录中，并向任务提供环境变量AZ_BATCH_CERTIFICATES_DIR以查询此位置。对于可见性为“remoteUser”的证书，将在用户的主目录中（例如 /home/{user-name}/certs）中创建一个“证书”目录，并将证书置于该目录中。警告：此属性已弃用，将在 2024 年 2 月之后删除。请改用 Azure KeyVault 扩展。
endpointConfiguration	ComputeNodeEndpointConfiguration	计算节点的终结点配置。
errors	ComputeNodeError[]	计算节点当前遇到的错误列表。
id	string	计算节点的 ID。添加到池的每个计算节点都分配有唯一 ID。每当从池中删除计算节点时，都会删除其所有本地文件，并回收 ID，并可以重新用于新的计算节点。
ipAddress	string	其他节点可用于与此计算节点通信的 IP 地址。添加到池的每个计算节点都分配有唯一的 IP 地址。每当从池中删除计算节点时，都会删除其所有本地文件，并回收 IP 地址，并可以重新用于新的计算节点。
isDedicated	boolean	此计算节点是否为专用计算节点。如果为 false，则计算节点是现成/低优先级计算节点。
lastBootTime	string	上次启动计算节点的时间。如果计算节点状态不可用，则此属性可能不存在。
nodeAgentInfo	NodeAgentInformation	有关计算节点代理版本以及计算节点升级到新版本的时间的信息。 Batch 计算节点代理是在池中的每个计算节点上运行的程序，并在计算节点上提供 Batch 功能。
recentTasks	TaskInformation[]	最近更改其状态的任务列表。仅当至少一个任务已在此计算节点上运行，因为该任务已分配给池，此属性才存在。
runningTaskSlotsCount	integer	当前在计算节点上运行作业任务的计划槽总数。这包括作业管理器任务和常规任务，但不包括作业准备、作业发布或启动任务。
runningTasksCount	integer	计算节点上当前正在运行的作业任务的总数。这包括作业管理器任务和常规任务，但不包括作业准备、作业发布或启动任务。
schedulingState	SchedulingState	计算节点是否可用于任务计划。
startTask	StartTask	指定要在计算节点上运行的任务，因为它加入池。当在节点上触发恢复操作时，Batch 将重试任务。恢复操作的示例包括（但不限于）在重新启动运行不正常的节点或计算节点因主机故障而消失时。由于恢复操作而进行的重试与 maxTaskRetryCount 无关，并且不计入 maxTaskRetryCount。即使 maxTaskRetryCount 为 0，也可能发生由于恢复操作而导致的内部重试。因此，所有任务都应是幂等的。这意味着任务需要容忍中断和重启，而不会导致任何损坏或重复数据。长时间运行的任务的最佳做法是使用某种形式的检查点。在某些情况下，即使计算节点未重新启动，StartTask 也可能重新运行。应特别注意避免 StartTaskss 从 StartTask 工作目录创建分离进程或安装/启动服务，因为这会阻止 Batch 重新运行 StartTask。
startTaskInfo	StartTaskInformation	有关在计算节点上执行 StartTask 的运行时信息。
state	ComputeNodeState	计算节点的当前状态。现成/低优先级计算节点已被抢占。当计算节点被抢占时在计算节点上运行的任务将在另一个计算节点可用时重新计划。
stateTransitionTime	string	计算节点进入其当前状态的时间。
totalTasksRun	integer	计算节点上完成的作业任务总数。这包括作业管理器任务和常规任务，但不包括作业准备、作业发布或启动任务。
totalTasksSucceeded	integer	计算节点上成功完成的作业任务总数（带有 exitCode 0）。这包括作业管理器任务和常规任务，但不包括作业准备、作业发布或启动任务。
url	string	计算节点的 URL。
virtualMachineInfo	VirtualMachineInfo	有关虚拟机的当前状态的信息。
vmSize	string	托管计算节点的虚拟机的大小。有关池中虚拟机的可用大小的信息，请参阅为 Azure Batch 池中的计算节点选择 VM 大小（https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes）。

ComputeNodeEndpointConfiguration

计算节点的终结点配置。

名称	类型	说明
inboundEndpoints	InboundEndpoint[]	计算节点上可访问的入站终结点的列表。

ComputeNodeError

计算节点遇到的错误。

名称	类型	说明
code	string	计算节点错误的标识符。代码是固定的，旨在以编程方式使用。
errorDetails	NameValuePair[]	与计算节点错误相关的其他错误详细信息的列表。
message	string	描述计算节点错误的消息，旨在适合在用户界面中显示。

ComputeNodeIdentityReference

对与计算节点将使用的 Batch 池关联的用户分配标识的引用。

名称	类型	说明
resourceId	string	用户分配标识的 ARM 资源 ID。