Compute Node - List

參考

Service:: Batch Service

API Version:: 2023-11-01.18.0

列出指定集區中的計算節點。

GET {batchUrl}/pools/{poolId}/nodes?api-version=2023-11-01.18.0

With optional parameters:

GET {batchUrl}/pools/{poolId}/nodes?$filter={$filter}&$select={$select}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
poolId	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"

名稱	類型	Description
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，請明確設定它。

回應

名稱	類型	Description
200 OK	ComputeNodeListResult	包含計算節點清單的回應。 Headers client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Batch 服務的錯誤。

名稱

類型

Description

200 OK

ComputeNodeListResult

包含計算節點清單的回應。

Headers

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

Other Status Codes

BatchError

Batch 服務的錯誤。

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

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

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

Authorization

Type: apiKey
In: header

範例

Node list

Sample Request

HTTP

GET account.region.batch.azure.com/pools/poolId/nodes?api-version=2023-11-01.18.0

Sample Response

Status code:: 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"
      }
    }
  ]
}

定義

名稱	Description
AutoUserScope	自動用戶的範圍
AutoUserSpecification	指定在 Batch 服務上執行工作之自動用戶的參數。
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
CertificateReference	要安裝在集區中計算節點上之憑證的參考。
CertificateStoreLocation	要在其中安裝憑證之計算節點上的證書存儲位置。
CertificateVisibility	計算節點上的哪些用戶帳戶應該可以存取憑證的私人數據。
ComputeNode	Batch 服務中的計算節點。
ComputeNodeEndpointConfiguration	計算節點的端點組態。
ComputeNodeError	計算節點遇到的錯誤。
ComputeNodeIdentityReference	與計算節點將使用之 Batch 集區相關聯的使用者指派身分識別參考。
ComputeNodeListResult	列出集區中計算節點的結果。
ComputeNodeState	計算節點的目前狀態。
ContainerRegistry	私人容器登錄。
ContainerWorkingDirectory	容器Task工作目錄的位置。
ElevationLevel	使用者的提高許可權層級。
EnvironmentSetting	工作進程上要設定的環境變數。
ErrorCategory	錯誤類別。
ErrorMessage	在 Azure Batch 錯誤回應中收到的錯誤訊息。
ImageReference	Azure 虛擬機器 Marketplace 映射或 Azure 計算資源庫映像的參考。若要取得 Azure Batch 所驗證的所有 Azure Marketplace 影像參考清單，請參閱「列出支援的映像」作業。
InboundEndpoint	計算節點上的輸入端點。
InboundEndpointProtocol	端點的通訊協定。
NameValuePair	表示名稱/值組。
NodeAgentInformation	計算節點代理程式的相關信息。
ResourceFile	要下載至計算節點的單一檔案或多個檔案。
SchedulingState	計算節點是否可供工作排程使用。
StartTask	當節點加入 Azure Batch 服務中的集區，或計算節點重新啟動或重新映射時，就會執行的工作。
StartTaskInformation	計算節點上執行的 StartTask 相關信息。
StartTaskState	計算節點上 StartTask 的狀態。
TaskContainerExecutionInformation	包含工作執行所在容器的相關信息。
TaskContainerSettings	Task 的容器設定。
TaskExecutionInformation	工作執行的相關信息。
TaskExecutionResult	工作執行的結果。
TaskFailureInformation	工作失敗的相關信息。
TaskInformation	計算節點上執行之工作的相關信息。
TaskState	工作 (Task) 的狀態。
UserIdentity	執行工作的使用者身分識別定義。
VirtualMachineInfo	虛擬機目前狀態的相關信息。

AutoUserScope

自動用戶的範圍

名稱	類型	Description
pool	string	指定工作會以在集區中的每個計算節點上建立的一般自動使用者帳戶執行。
task	string	指定服務應該為工作建立新的使用者。

AutoUserSpecification

指定在 Batch 服務上執行工作之自動用戶的參數。

名稱	類型	Description
elevationLevel	ElevationLevel	自動使用者的提高許可權層級。預設值為 nonAdmin。
scope	AutoUserScope	自動用戶的範圍預設值為集區。如果集區正在執行 Windows，則當需要更嚴格的工作隔離時，應該指定 Task 的值。例如，如果工作以可能影響其他工作的方式改變登錄，或已在集區上指定憑證，而該集區上不應該由一般工作存取，但應該可供 StartTasks 存取。

BatchError

從 Azure Batch 服務收到的錯誤回應。

名稱	類型	Description
code	string	錯誤的識別碼。程式碼不變，且要以程式設計方式使用。
message	ErrorMessage	描述錯誤的訊息，適用於在使用者介面中顯示。
values	BatchErrorDetail[]	索引鍵/值組的集合，其中包含錯誤的其他詳細數據。

BatchErrorDetail

Azure Batch 錯誤回應中包含的其他信息專案。

名稱	類型	Description
key	string	指定 Value 屬性意義的識別碼。
value	string	錯誤回應中包含的其他資訊。

CertificateReference

要安裝在集區中計算節點上之憑證的參考。

名稱	類型	Description
storeLocation	CertificateStoreLocation	要在其中安裝憑證之計算節點上的證書存儲位置。默認值為 currentuser。此屬性僅適用於使用 Windows 計算節點設定的集區， (使用 cloudServiceConfiguration 建立，或使用 Windows 映像參考) 搭配 virtualMachineConfiguration 來建立。針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而AZ_BATCH_CERTIFICATES_DIR環境變數會提供給工作查詢此位置。對於可見度為『remoteUser』的憑證，會在使用者的主目錄中建立『certs』目錄 (，例如 /home/{user-name}/certs) ，且憑證會放在該目錄中。
storeName	string	要在其中安裝憑證之計算節點上的證書存儲名稱。此屬性僅適用於使用 Windows 計算節點設定的集區， (使用 cloudServiceConfiguration 建立，或使用 Windows 映像參考) 搭配 virtualMachineConfiguration 來建立。常見的市集名稱包括：My、Root、CA、Trust、Disallowed、TrustedPeople、TrustedPublisher、AuthRoot、AddressBook，但也可以使用任何自定義存放區名稱。預設值為 My。
thumbprint	string	憑證的指紋。
thumbprintAlgorithm	string	指紋相關聯的演算法。這必須是sha1。
visibility	CertificateVisibility[]	計算節點上的哪些用戶帳戶應該可以存取憑證的私人數據。您可以在此集合中指定多個可見度。預設值為 [所有帳戶]。

CertificateStoreLocation

要在其中安裝憑證之計算節點上的證書存儲位置。

名稱	類型	Description
currentuser	string	憑證應該安裝到 CurrentUser 證書存儲。
localmachine	string	憑證應該安裝到 LocalMachine 證書存儲。

CertificateVisibility

計算節點上的哪些用戶帳戶應該可以存取憑證的私人數據。

名稱	類型	Description
remoteuser	string	用戶帳戶應該會看到憑證，用戶可從中遠端訪問計算節點。
starttask	string	執行 StartTask 的使用者帳戶應該會看到憑證。請注意，如果 AutoUser 範圍同時是 StartTask 和 Task 的集區，工作也會看到此憑證。
task	string	執行作業工作的用戶帳戶應該會看到憑證。

ComputeNode

Batch 服務中的計算節點。

名稱	類型	Description
affinityId	string	新增Task以要求在此計算節點上排程工作時可傳遞的標識碼。請注意，這隻是軟式親和性。如果目標計算節點在排程工作時忙碌或無法使用，工作將會排程到其他地方。
allocationTime	string	這個計算節點配置給集區的時間。這是一開始配置計算節點的時間，而且在設定後不會變更。計算節點在服務修復或先佔時不會更新。
certificateReferences	CertificateReference[]	安裝在計算節點上的憑證清單。針對 Windows 節點，Batch 服務會將憑證安裝至指定的證書存儲和位置。針對 Linux 計算節點，憑證會儲存在工作工作目錄內的目錄中，而AZ_BATCH_CERTIFICATES_DIR環境變數會提供給工作查詢此位置。對於可見度為『remoteUser』的憑證，會在使用者的主目錄中建立『certs』目錄 (，例如 /home/{user-name}/certs) ，且憑證會放在該目錄中。警告：此屬性已被取代，將在 2024 年 2 月之後移除。請改用 Azure KeyVault 擴充功能。
endpointConfiguration	ComputeNodeEndpointConfiguration	計算節點的端點組態。
errors	ComputeNodeError[]	計算節點目前遇到的錯誤清單。
id	string	計算節點的識別碼。新增至集區的每個計算節點都會獲指派唯一標識符。每當從集區中移除計算節點時，其所有本機檔案都會遭到刪除，而且會回收標識碼，而且可以重複使用給新的計算節點。
ipAddress	string	其他節點可用來與此計算節點通訊的IP位址。新增至集區的每個計算節點都會指派唯一的IP位址。每當從集區中移除計算節點時，其所有本機檔案都會遭到刪除，而且會回收IP位址，而且可以重複使用給新的計算節點。
isDedicated	boolean	這個計算節點是否為專用的計算節點。如果為 false，則計算節點是現成/低優先順序的計算節點。
lastBootTime	string	上次啟動計算節點的時間。如果計算節點狀態無法使用，則此屬性可能不存在。
nodeAgentInfo	NodeAgentInformation	計算節點代理程式版本的相關信息，以及計算節點升級至新版本的時間。 Batch Compute Node 代理程式是在集區中的每個計算節點上執行的程式，並在計算節點上提供 Batch 功能。
recentTasks	TaskInformation[]	最近變更狀態的工作清單。只有當此計算節點上至少有一個工作已於指派給集區之後，才會存在這個屬性。
runningTaskSlotsCount	integer	目前在計算節點上執行作業工作所使用的排程位置總數。這包括作業管理員工作和一般工作，但不包括作業準備、作業發行或啟動工作。
runningTasksCount	integer	計算節點上目前正在執行的作業工作總數。這包括作業管理員工作和一般工作，但不包括作業準備、作業發行或啟動工作。
schedulingState	SchedulingState	計算節點是否可供工作排程使用。
startTask	StartTask	在加入集區時，在計算節點上執行的指定工作。批次會在節點上觸發復原作業時重試工作。復原作業的範例包括 (，但不限於重新啟動狀況不良的節點時) ，或計算節點因主機失敗而消失。由於復原作業的重試與無關，且不會計入 maxTaskRetryCount。即使 maxTaskRetryCount 為 0，也可能會因為復原作業而發生內部重試。因此，所有工作都應該具有等冪性。這表示工作必須容許中斷並重新啟動，而不會造成任何損毀或重複的數據。長時間執行工作的最佳做法是使用某種形式的檢查點檢查。在某些情況下，即使計算節點未重新啟動，StartTask 仍可能會重新執行。請特別小心避免 StartTasks 從 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

計算節點的端點組態。

名稱	類型	Description
inboundEndpoints	InboundEndpoint[]	計算節點上可存取的輸入端點清單。

ComputeNodeError

計算節點遇到的錯誤。

名稱	類型	Description
code	string	計算節點錯誤的識別碼。程式碼不變，且要以程式設計方式使用。
errorDetails	NameValuePair[]	與計算節點錯誤相關的其他錯誤詳細數據清單。
message	string	描述計算節點錯誤的訊息，適用於在使用者介面中顯示。

ComputeNodeIdentityReference

與計算節點將使用之 Batch 集區相關聯的使用者指派身分識別參考。

名稱	類型	Description
resourceId	string	使用者指派身分識別的 ARM 資源識別碼。