File - List From Task

Referencia

Servicio:: Batch Service

Versión de la API:: 2023-11-01.18.0

Enumera los archivos del directorio de una tarea en su nodo de proceso.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
batchUrl	path	True	string	Dirección URL base de todas las solicitudes de servicio de Azure Batch.
jobId	path	True	string	Identificador del trabajo que contiene la tarea.
taskId	path	True	string	Identificador de la tarea cuyos archivos desea enumerar.
api-version	query	True	string	Versión de la API de cliente.
$filter	query		string	Una cláusula de $filter OData. Para obtener más información sobre cómo construir este filtro, vea https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.
maxresults	query		integer int32	Número máximo de elementos que se van a devolver en la respuesta. Se puede devolver un máximo de 1000 archivos.
recursive	query		boolean	Indica si se van a enumerar elementos secundarios del directorio Task. Este parámetro se puede usar en combinación con el parámetro de filtro para enumerar un tipo específico de archivos.
timeout	query		integer int32	Tiempo máximo que el servidor puede dedicar a procesar la solicitud, en segundos. El valor predeterminado es 30 segundos.

Encabezado de la solicitud

Media Types: "application/json; odata=minimalmetadata"

Nombre	Tipo	Description
client-request-id	string uuid	La identidad de solicitud generada por el autor de la llamada, en forma de GUID sin decoración como llaves, por ejemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id	boolean	Si el servidor debe devolver el client-request-id en la respuesta.
ocp-date	string date-time-rfc1123	Hora a la que se emitió la solicitud. Normalmente, las bibliotecas cliente establecen esto en la hora actual del reloj del sistema; establézcalo explícitamente si llama directamente a la API REST.

Respuestas

Nombre	Tipo	Description
200 OK	NodeFileListResult	Respuesta que contiene la lista de archivos. Encabezados client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	Error del servicio Batch.

Nombre

Tipo

Description

200 OK

NodeFileListResult

Respuesta que contiene la lista de archivos.

Encabezados

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

Other Status Codes

BatchError

Error del servicio Batch.

Seguridad

azure_auth

flujo de código de autenticación de OAuth 2.0 Microsoft Entra

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	Suplantación de su cuenta de usuario

Authorization

Tipo: apiKey
En: header

Ejemplos

File list from task

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

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

Definiciones

Nombre	Description
BatchError	Respuesta de error recibida del servicio Azure Batch.
BatchErrorDetail	Elemento de información adicional incluida en una respuesta de error Azure Batch.
ErrorMessage	Mensaje de error recibido en una respuesta de error Azure Batch.
FileProperties	Propiedades de un archivo en un nodo de ejecución.
NodeFile	Información sobre un archivo o directorio en un nodo de proceso.
NodeFileListResult	Resultado de enumerar los archivos en un nodo de ejecución o los archivos asociados a una tarea en un nodo de ejecución.

BatchError

Respuesta de error recibida del servicio Azure Batch.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
message	ErrorMessage	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
values	BatchErrorDetail[]	Colección de pares clave-valor que contiene detalles adicionales sobre el error.

BatchErrorDetail

Elemento de información adicional incluida en una respuesta de error Azure Batch.

Nombre	Tipo	Description
key	string	Identificador que especifica el significado de la propiedad Value.
value	string	La información adicional incluida con la respuesta de error.

ErrorMessage

Mensaje de error recibido en una respuesta de error Azure Batch.

Nombre	Tipo	Description
lang	string	Código de idioma del mensaje de error
value	string	Texto del mensaje.

FileProperties

Propiedades de un archivo en un nodo de ejecución.

Nombre	Tipo	Description
contentLength	integer	Longitud del archivo.
contentType	string	El tipo de contenido del archivo.
creationTime	string	Hora de creación del archivo. La hora de creación no se devuelve para los archivos en nodos de proceso de Linux.
fileMode	string	Atributo de modo de archivo en formato octal. El modo de archivo solo se devuelve para archivos en nodos de proceso de Linux.
lastModified	string	Hora a la que se modificó por última vez el archivo.

NodeFile

Información sobre un archivo o directorio en un nodo de proceso.

Nombre	Tipo	Description
isDirectory	boolean	Indica si el objeto representa un directorio.
name	string	Ruta de acceso al archivo.
properties	FileProperties	Las propiedades del archivo.
url	string	URL del archivo.

NodeFileListResult

Resultado de enumerar los archivos en un nodo de ejecución o los archivos asociados a una tarea en un nodo de ejecución.

Nombre	Tipo	Description
odata.nextLink	string	Dirección URL para obtener el siguiente conjunto de resultados.
value	NodeFile[]	Lista de archivos.

Compartir a través de

File - List From Task

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Authorization

Ejemplos

File list from task

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BatchError

BatchErrorDetail

ErrorMessage

FileProperties

NodeFile

NodeFileListResult

Recursos adicionales