ListFiles - - Centro de documentación de Alibaba Cloud

Consulta una lista de archivos.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que ejecute esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListFiles	La operación que desea ejecutar.
FileFolderPath	String	No	Workflow/My first workflow/MaxCompute/ods	La ruta de la carpeta a la que pertenecen los archivos.
ProjectId	Long	No	10000	El ID del espacio de trabajo de DataWorks. Inicie sesión en la DataWorks console y vaya a la página Workspace para obtener el ID. Debe configurar este parámetro o el parámetro ProjectIdentifier para determinar el espacio de trabajo de DataWorks al que se aplica la operación.
Keyword	String	No	ods	La palabra clave en los nombres de archivo. Se utiliza para realizar una coincidencia aproximada. Especifique una palabra clave para consultar todos los archivos cuyos nombres la contengan.
ProjectIdentifier	String	No	dw_project	El nombre del espacio de trabajo de DataWorks. Inicie sesión en la DataWorks console y vaya a la página Workspace para obtener el nombre del espacio de trabajo. Debe configurar este parámetro o el parámetro ProjectId para determinar el espacio de trabajo de DataWorks al que se aplica la operación.
PageNumber	Integer	No	1	El número de página.
PageSize	Integer	No	10	El número de entradas por página. Valores válidos: de 1 a 100. Valor predeterminado: 10.
UseType	String	No	NORMAL	El módulo al que pertenece el archivo. Valores válidos: NORMAL: El archivo se utiliza para DataStudio. MANUAL: El archivo se utiliza para un nodo activado manualmente. MANUAL_BIZ: El archivo se utiliza para un flujo de trabajo activado manualmente. SKIP: El archivo se utiliza para un nodo de ejecución simulada en DataStudio. ADHOCQUERY: El archivo se utiliza para una consulta ad hoc. COMPONENT: El archivo se utiliza para un fragmento de código.
FileTypes	String	No	10,23	El tipo de código del archivo. Valores válidos: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (grupo de nodos), 99 (carga cero), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (inspección de objetos OSS), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (sincronización en tiempo real), 1002 (nodo interno PAI), 1089 (colaboración entre inquilinos), 1091 (desarrollo Hologres), 1093 (Hologres SQL), 1100 (asignación), 1106 (for-each) y 1221 (PyODPS 3).
Owner	String	No	3726346****	El propietario del archivo.
NodeId	Long	No	123541234	El ID del nodo programado. Puede llamar a la operación ListNodes para consultar el ID del nodo.
NeedContent	Boolean	No	false	Especifica si se debe incluir el contenido del archivo en los resultados de la consulta. Un archivo con gran cantidad de datos puede provocar un retraso prolongado en la transmisión de red.
NeedAbsoluteFolderPath	Boolean	No	false	Especifica si se debe incluir la ruta de la carpeta a la que pertenece el archivo en los resultados de la consulta.
ExactFileName	String	No	ods_create.sql	El nombre exacto del archivo. El nombre del archivo en los resultados de la consulta debe coincidir exactamente con el valor de este parámetro.
FileIdIn	String	No	78237,816123	La lista de IDs de archivo. El conjunto de IDs de archivo en los resultados de la consulta solo puede ser un subconjunto de la lista especificada por este parámetro. Puede especificar hasta 50 IDs de archivo a la vez.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	Integer	200	El código de estado HTTP.
ErrorMessage	String	The connection does not exist.	El mensaje de error.
RequestId	String	0000-ABCD-EFG	El ID de la solicitud.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	El código de error.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true false
Data	Object		Los archivos devueltos.
PageNumber	Integer	1	El número de página.
PageSize	Integer	10	El número de entradas por página.
TotalCount	Integer	13	El número total de entradas devueltas.
Files	Array of File		Los detalles de los archivos.
CommitStatus	Integer	1	Indica si se confirmó el código más reciente del archivo. Valores válidos: 0 y 1. El valor 0 indica que el código más reciente del archivo no se confirmó. El valor 1 indica que el código más reciente del archivo sí se confirmó.
AutoParsing	Boolean	true	Indica si la función de análisis automático está habilitada para el archivo. Valores válidos: true false Este parámetro corresponde al parámetro Automatic Parsing From Code Before Node Committing que se muestra después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la DataWorks console.
Owner	String	3872572****	El ID de la cuenta de Alibaba Cloud que utiliza el propietario del archivo.
CreateTime	Long	1593950832000	La hora en que se creó el archivo. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC.
FileType	Integer	10	El tipo de código del archivo. Valores válidos: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (carga cero), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (inspección de objetos OSS), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (sincronización en tiempo real), 1089 (colaboración entre inquilinos), 1091 (desarrollo Hologres), 1093 (Hologres SQL), 1100 (asignación) y 1221 (PyODPS 3).
CurrentVersion	Integer	2	El número de la versión más reciente del archivo.
BizId	Long	300000	El ID del flujo de trabajo al que pertenece el archivo. Este parámetro está obsoleto y ha sido reemplazado por el parámetro BusinessId.
LastEditUser	String	38748246285727	El ID de la cuenta de Alibaba Cloud que se utilizó para modificar el archivo por última vez.
FileName	String	ods_user_info_d	El nombre del archivo.
ConnectionName	String	odps_source	El nombre del origen de datos que se utiliza para ejecutar el nodo correspondiente al archivo.
UseType	String	NORMAL	El módulo al que pertenece el archivo. Valores válidos: NORMAL: El archivo se utiliza para DataStudio. MANUAL: El archivo se utiliza para un nodo activado manualmente. MANUAL_BIZ: El archivo se utiliza para un flujo de trabajo activado manualmente. SKIP: El archivo se utiliza para un nodo de ejecución simulada en DataStudio. ADHOCQUERY: El archivo se utiliza para una consulta ad hoc. COMPONENT: El archivo se utiliza para un fragmento de código.
FileFolderId	String	2735c2****	El ID de la carpeta a la que pertenece el archivo.
FileId	Long	10000001	El ID del archivo.
ParentId	Long	-1	El ID del archivo de grupo de nodos al que pertenece el archivo actual. Este parámetro se devuelve solo si el archivo actual es un archivo interno del archivo de grupo de nodos.
CreateUser	String	382762****	El ID de la cuenta de Alibaba Cloud que se utilizó para crear el archivo.
IsMaxCompute	Boolean	false	Indica si el archivo necesita cargarse en MaxCompute cuando se trata de un archivo de recursos de MaxCompute. Este parámetro se devuelve solo si el archivo es un archivo de recursos de MaxCompute.
BusinessId	Long	300000	El ID del flujo de trabajo al que pertenece el archivo.
FileDescription	String	my test datastudio file	La descripción del archivo.
LastEditTime	Long	1593950832000	La hora en que se modificó el archivo por última vez. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC.
Content	String	SHOW TABLES;	Este parámetro está obsoleto. Puede llamar a la operación GetFile para consultar los detalles del archivo.
NodeId	Long	300001	El ID del nodo activado automáticamente que se genera en el sistema de programación después de confirmar el archivo.
AbsoluteFolderPath	String	Workflow/My first workflow/MaxCompute/ods	La ruta de la carpeta a la que pertenece el archivo.

Ejemplos

Solicitudes de ejemplo

http(s)://[Endpoint]/?Action=ListFiles
&FileFolderPath=Workflow/My first workflow/MaxCompute/ods
&ProjectId=10000
&Keyword=ods
&ProjectIdentifier=dw_project
&PageNumber=1
&PageSize=10
&UseType=NORMAL
&FileTypes=10,23
&Owner=3726346****
&NodeId=123541234
&<Common request parameters>

Respuestas exitosas de ejemplo

XML formato

HTTP/1.1 200 OK
Content-Type:application/xml

<ListFilesResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0000-ABCD-EFG</RequestId>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>13</TotalCount>
        <Files>
            <CommitStatus>1</CommitStatus>
            <AutoParsing>true</AutoParsing>
            <Owner>3872572****</Owner>
            <CreateTime>1593950832000</CreateTime>
            <FileType>10</FileType>
            <CurrentVersion>2</CurrentVersion>
            <BizId>300000</BizId>
            <LastEditUser>38748246285727</LastEditUser>
            <FileName>ods_user_info_d</FileName>
            <ConnectionName>odps_source</ConnectionName>
            <UseType>NORMAL</UseType>
            <FileFolderId>2735c2****</FileFolderId>
            <FileId>10000001</FileId>
            <ParentId>-1</ParentId>
            <CreateUser>382762****</CreateUser>
            <IsMaxCompute>false</IsMaxCompute>
            <BusinessId>300000</BusinessId>
            <FileDescription>my test datastudio file</FileDescription>
            <LastEditTime>1593950832000</LastEditTime>
            <Content>SHOW TABLES;</Content>
            <NodeId>300001</NodeId>
        </Files>
    </Data>
</ListFilesResponse>

JSON formato

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "ErrorMessage" : "The connection does not exist.",
  "RequestId" : "0000-ABCD-EFG",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true,
  "Data" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 13,
    "Files" : {
      "CommitStatus" : 1,
      "AutoParsing" : true,
      "Owner" : "3872572****",
      "CreateTime" : 1593950832000,
      "FileType" : 10,
      "CurrentVersion" : 2,
      "BizId" : 300000,
      "LastEditUser" : 38748246285727,
      "FileName" : "ods_user_info_d",
      "ConnectionName" : "odps_source",
      "UseType" : "NORMAL",
      "FileFolderId" : "2735c2****",
      "FileId" : 10000001,
      "ParentId" : -1,
      "CreateUser" : "382762****",
      "IsMaxCompute" : false,
      "BusinessId" : 300000,
      "FileDescription" : "my test datastudio file",
      "LastEditTime" : 1593950832000,
      "Content" : "SHOW TABLES;",
      "NodeId" : 300001
    }
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
429	Throttling.Api	The request for this resource has exceeded your available limit.	El número de solicitudes para el recurso ha excedido el límite superior.
429	Throttling.System	The DataWorks system is busy. Try again later.	El sistema de DataWorks está ocupado. Inténtelo de nuevo más tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Se han enviado demasiadas solicitudes en un periodo corto. Inténtelo de nuevo más tarde.
500	InternalError.System	An internal system error occurred. Try again later.	Ocurrió un error interno del sistema. Inténtelo de nuevo más tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ocurrió un error interno del sistema. Inténtelo de nuevo más tarde.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.