File - Get From Task

服務:

Batch Service

API 版本:

2023-11-01.18.0

傳回指定之工作檔案的內容。

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?api-version=2023-11-01.18.0

含選擇性參數:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files/{filePath}?timeout={timeout}&api-version=2023-11-01.18.0

URI 參數

名稱	位於	必要	類型	Description
batchUrl	path	True	string	所有 Azure Batch 服務要求的基底 URL。
filePath	path	True	string	您想要取得內容之 Task 檔案的路徑。
jobId	path	True	string	包含Task之作業的標識碼。
taskId	path	True	string	您要擷取其檔案的工作標識碼。
api-version	query	True	string	用戶端 API 版本。
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，請明確設定它。
ocp-range		string	要擷取的位元組範圍。 默認值是擷取整個檔案。 格式為 bytes=startRange-endRange。
If-Modified-Since		string date-time-rfc1123	時間戳，表示用戶端已知資源的上次修改時間。 只有在服務上的資源自指定時間以來已修改時，才會執行作業。
If-Unmodified-Since		string date-time-rfc1123	時間戳，表示用戶端已知資源的上次修改時間。 只有在服務上的資源自指定時間之後尚未修改時，才會執行作業。

回應

名稱	類型	Description
200 OK	object	包含檔案內容的回應。 Media Types: "application/json", "application/octet-stream" 標題 client-request-id: string request-id: string ETag: string Last-Modified: string ocp-creation-time: string ocp-batch-file-isdirectory: boolean ocp-batch-file-url: string ocp-batch-file-mode: string Content-Type: string Content-Length: integer
Other Status Codes	BatchError	Batch 服務的錯誤。 Media Types: "application/json", "application/octet-stream"

安全性

azure_auth

Microsoft Entra OAuth 2.0 驗證碼流程

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

Authorization

類型: apiKey
位於: header

範例

Get File From Task

範例要求

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/task1/files/wd\testFile.txt?api-version=2023-11-01.18.0

範例回覆

狀態碼:

200

"This is actually a byte stream. This request/response is being presented as a string for readability in the example"

定義

名稱	Description
BatchError	從 Azure Batch 服務收到的錯誤回應。
BatchErrorDetail	Azure Batch 錯誤回應中包含的其他信息專案。
ErrorMessage	Azure Batch 錯誤回應中收到的錯誤訊息。

BatchError

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

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

BatchErrorDetail

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

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

ErrorMessage

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

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