Nodes - Upload Node Logs

服務:: Batch Service

API 版本:: 2025-06-01

從指定的計算節點上傳 Azure Batch 服務日誌檔到 Azure Blob 儲存。
這是用來自動從計算節點收集 Azure 批次服務日誌檔，如果你遇到錯誤並想升級到 Azure 支援。 Azure Batch 服務記錄檔應該與 Azure 支援共用，以協助偵錯 Batch 服務的問題。

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 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string (uri)	Batch 帳戶端點（例如：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"

名稱	類型	Description
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"

名稱	必要	類型	Description
containerUrl	True	string (uri)	Azure Blob 儲存中要上傳批次服務日誌檔案的容器網址。若未使用使用者指派的管理身份，該 URL 必須包含共享存取簽章（SAS），賦予容器寫入權限。 SAS 持續時間必須足夠讓上傳完成。 SAS的開始時間為可選，建議不要特別說明。
startTime	True	string (date-time)	這是上傳批次服務日誌檔案的時間範圍起點。任何包含該時間範圍內日誌訊息的日誌檔案都會被上傳。這表示操作可能擷取的日誌數量超過請求數量，因為整個日誌檔案都會被上傳，但操作不應擷取的日誌數量少於請求的數量。
endTime		string (date-time)	上傳批次服務日誌檔案的時間範圍。任何包含該時間範圍內日誌訊息的日誌檔案都會被上傳。這表示操作可能擷取的日誌數量超過請求數量，因為整個日誌檔案都會被上傳，但操作不應擷取的日誌數量少於請求的數量。若省略，預設會上傳所有在開始時間之後可用的日誌。
identityReference		BatchNodeIdentityReference	這是用來存取 Azure Blob Storage 的使用者指派身份的參考，該身份由 containerUrl 指定。身份必須有寫入 Azure Blob Storage 容器的權限。

回應

名稱	類型	Description
200 OK	UploadBatchServiceLogsResult	要求已成功。標題 ETag: string Last-Modified: string client-request-id: string request-id: string
Other Status Codes	BatchError	未預期的錯誤回應。

名稱

類型

Description

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

範圍

名稱	Description
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
}

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
BatchErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。
BatchNodeIdentityReference	與計算節點將使用的 Batch 集區相關聯的使用者指派身分識別參考。
UploadBatchServiceLogsOptions	Azure Batch 服務記錄檔會上傳計算節點的參數。
UploadBatchServiceLogsResult	從特定計算節點上傳 Batch 服務記錄檔的結果。

BatchError

Object

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

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

BatchErrorDetail

Object

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

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

BatchErrorMessage

Object

Azure Batch 錯誤回應中收到的錯誤訊息。

名稱	類型	Description
lang	string	錯誤訊息的語言代碼。
value	string	訊息的文字。

BatchNodeIdentityReference

Object

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

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

UploadBatchServiceLogsOptions

Object

Azure Batch 服務記錄檔會上傳計算節點的參數。

名稱	類型	Description
containerUrl	string (uri)	Azure Blob 儲存中要上傳批次服務日誌檔案的容器網址。若未使用使用者指派的管理身份，該 URL 必須包含共享存取簽章（SAS），賦予容器寫入權限。 SAS 持續時間必須足夠讓上傳完成。 SAS的開始時間為可選，建議不要特別說明。
endTime	string (date-time)	上傳批次服務日誌檔案的時間範圍。任何包含該時間範圍內日誌訊息的日誌檔案都會被上傳。這表示操作可能擷取的日誌數量超過請求數量，因為整個日誌檔案都會被上傳，但操作不應擷取的日誌數量少於請求的數量。若省略，預設會上傳所有在開始時間之後可用的日誌。
identityReference	BatchNodeIdentityReference	這是用來存取 Azure Blob Storage 的使用者指派身份的參考，該身份由 containerUrl 指定。身份必須有寫入 Azure Blob Storage 容器的權限。
startTime	string (date-time)	這是上傳批次服務日誌檔案的時間範圍起點。任何包含該時間範圍內日誌訊息的日誌檔案都會被上傳。這表示操作可能擷取的日誌數量超過請求數量，因為整個日誌檔案都會被上傳，但操作不應擷取的日誌數量少於請求的數量。

UploadBatchServiceLogsResult

Object

從特定計算節點上傳 Batch 服務記錄檔的結果。

名稱	類型	Description
numberOfFilesUploaded	integer (int32)	上傳的日誌檔案數量。
virtualDirectoryName	string	Azure Blob 儲存容器中的虛擬目錄，批次服務日誌檔案將被上傳到那裡。虛擬目錄名稱是每個上傳日誌檔案的 blob 名稱的一部分，並基於 poolId、nodeID 及唯一識別碼建置。

共用方式為

Nodes - Upload Node Logs

URI 參數

要求標頭

要求本文

回應

安全性

OAuth2Auth

範圍

範例

Upload BatchService Logs

範例要求

範例回覆

定義

BatchError

BatchErrorDetail

BatchErrorMessage

BatchNodeIdentityReference

UploadBatchServiceLogsOptions

UploadBatchServiceLogsResult