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

File - List From Task

  • 参考
Service:
Batch Service
API Version:
2023-11-01.18.0

列出任务在其计算节点上的目录中的文件。

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?api-version=2023-11-01.18.0
With optional parameters: 
GET {batchUrl}/jobs/{jobId}/tasks/{taskId}/files?$filter={$filter}&recursive={recursive}&maxresults={maxresults}&timeout={timeout}&api-version=2023-11-01.18.0

URI 参数

名称 在 必需 类型 说明
batchUrl
 path True

string

所有Azure Batch服务请求的基 URL。
jobId
 path True

string

包含 Task 的作业的 ID。
taskId
 path True

string

要列出其文件的 Task 的 ID。
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-task-files。
maxresults
 query

integer

int32

响应中要返回的最大项数。 最多可以返回 1000 个文件。
recursive
 query

boolean

是否列出 Task 目录的子目录。 此参数可与 filter 参数结合使用，以列出特定类型的文件。
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

NodeFileListResult

包含文件列表的响应。

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

名称 说明
user_impersonation 模拟用户帐户

Authorization

Type: apiKey
In: header

示例

File list from task

Sample Request

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId/files?recursive=False&api-version=2023-11-01.18.0

Sample Response

Status code:
200 
{
  "value": [
    {
      "name": "startup\\ProcessEnv.cmd",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd",
      "isDirectory": false,
      "properties": {
        "creationTime": "2014-09-19T21:56:17.679195Z",
        "lastModified": "2014-09-19T21:56:17.679195Z",
        "contentLength": 1813,
        "contentType": "application/octet-stream"
      }
    },
    {
      "name": "startup\\stderr.txt",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt",
      "isDirectory": false,
      "properties": {
        "creationTime": "2014-09-19T21:56:17.5590855Z",
        "lastModified": "2014-09-19T21:56:17.5590855Z",
        "contentLength": 0,
        "contentType": "application/octet-stream"
      }
    }
  ]
}

定义

名称 说明
BatchError

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

Azure Batch错误响应中包含的其他信息项。
ErrorMessage

Azure Batch错误响应中收到的错误消息。
FileProperties

计算节点上文件的属性。
NodeFile

有关计算节点上的文件或目录的信息。
NodeFileListResult

列出计算节点上的文件或与计算节点上的任务关联的文件的结果。

BatchError

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

名称 类型 说明
code

string

错误的标识符。 代码是固定的，旨在以编程方式使用。
message

ErrorMessage

描述错误的消息，该消息适用于在用户界面中显示。
values

BatchErrorDetail[]

包含有关错误的其他详细信息的键值对的集合。

BatchErrorDetail

Azure Batch错误响应中包含的其他信息项。

名称 类型 说明
key

string

指定 Value 属性的含义的标识符。
value

string

错误响应附带的其他信息。

ErrorMessage

Azure Batch错误响应中收到的错误消息。

名称 类型 说明
lang

string

错误消息的语言代码
value

string

消息的文本。

FileProperties

计算节点上文件的属性。

名称 类型 说明
contentLength

integer

文件的长度。
contentType

string

文件的内容类型。
creationTime

string

文件创建时间。
不会为 Linux 计算节点上的文件返回创建时间。
fileMode

string

八进制格式的文件模式属性。
仅针对 Linux 计算节点上的文件返回文件模式。
lastModified

string

上次修改文件的时间。

NodeFile

有关计算节点上的文件或目录的信息。

名称 类型 说明
isDirectory

boolean

对象是否表示目录。
name

string

文件路径。
properties

FileProperties

文件属性。
url

string

文件的 URL。

NodeFileListResult

列出计算节点上的文件或与计算节点上的任务关联的文件的结果。

名称 类型 说明
odata.nextLink

string

用于获取下一组结果的 URL。
value

NodeFile[]

文件列表。