ListFiles - DataWorks: Central de Documentação do Alibaba Cloud

Consulta uma lista de arquivos chamando ListFiles.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
FileFolderPath	string	Não	O caminho da pasta onde o arquivo está armazenado.	Business_process/my_first_business_process/MaxCompute/ods_layer
ProjectId	integer	Não	O ID do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do espaço de trabalho para obter o ID do espaço de trabalho. Você deve especificar este parâmetro ou o parâmetro ProjectIdentifier para determinar o espaço de trabalho do DataWorks para esta chamada de API.	10000
Keyword	string	Não	A palavra-chave do nome do arquivo. Há suporte para correspondência aproximada. Você pode inserir uma palavra-chave para consultar todos os arquivos cujos nomes contenham a palavra-chave.	ods
ProjectIdentifier	string	Não	O nome do espaço de trabalho do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do espaço de trabalho para obter o nome do espaço de trabalho. Você deve especificar este parâmetro ou o parâmetro ProjectId para determinar o espaço de trabalho do DataWorks para esta chamada de API.	dw_project
PageNumber	integer	Não	O número da página para paginação.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valor máximo: 100.	10
UseType	string	Não	O módulo funcional ao qual o arquivo pertence. Valores válidos: NORMAL: Data Studio. MANUAL: nó manual. MANUAL_BIZ: workflow manual. SKIP: agendamento de dry run no Data Studio. ADHOCQUERY: consulta ad hoc. COMPONENT: gerenciamento de componentes.	NORMAL
FileTypes	string	Não	O tipo de código do arquivo. Os códigos comuns e seus tipos de arquivo correspondentes incluem 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (nó combinado), 99 (nó virtual), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (verificação de objeto OSS), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (sincronização em tempo real), 1002 (nó interno do PAI), 1089 (nó entre locatários), 1091 (desenvolvimento Hologres), 1093 (Hologres SQL), 1100 (nó de atribuição), 1106 (nó foreach), 1221 (PyODPS 3).	10,23
Owner	string	Não	O proprietário do arquivo.	3726346****
NodeId	integer	Não	O ID do nó de agendamento. Você pode chamar a operação ListNodes para obter o ID do nó.	123541234
NeedContent	boolean	Não	Especifica se o resultado da consulta inclui o conteúdo do arquivo. Para arquivos com conteúdo grande, a latência de transmissão de rede pode ser significativa.	false
NeedAbsoluteFolderPath	boolean	Não	Especifica se o resultado da consulta inclui o caminho da pasta onde o arquivo está armazenado.	false
ExactFileName	string	Não	O nome do arquivo para correspondência exata. O nome do arquivo no resultado da consulta corresponde exatamente a este valor de parâmetro.	ods_create.sql
FileIdIn	string	Não	A lista de IDs de arquivo. Os IDs de arquivo no resultado da consulta podem ser apenas um subconjunto desta lista. Um máximo de 50 IDs de arquivo pode ser especificado por vez.	78237,816123
LastEditUser	string	Não	O ID da Alibaba Cloud do usuário que atualizou o arquivo pela última vez.	11233***
CommitStatus	integer	Não	O status de commit atual do arquivo. Valores válidos: 0 (o código mais recente não foi submetido a commit) e 1 (o código mais recente foi submetido a commit).	1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
HttpStatusCode	integer	O código de status HTTP.	200
ErrorMessage	string	A mensagem de erro.	The connection does not exist.
RequestId	string	O ID da solicitação. Você pode usar este ID para solucionar problemas.	0000-ABCD-****
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.	true
Data	object	Os detalhes dos dados retornados.
PageNumber	integer	O número da página dos dados retornados.	1
PageSize	integer	O número de entradas por página.	10
TotalCount	integer	O número total de entradas que atendem às condições.	13
Files	array<object>	Os detalhes do arquivo.
	object	As informações do arquivo.
CommitStatus	integer	O status de commit atual do arquivo. Valores válidos: 0 (o código mais recente não foi submetido a commit) e 1 (o código mais recente foi submetido a commit).	1
AutoParsing	boolean	Indica se o recurso de análise automática está ativado para o arquivo. Valores válidos: true: O arquivo analisa o código automaticamente. false: O arquivo não analisa o código automaticamente. Este parâmetro corresponde à opção "Análise de Código" quando você seleciona "Mesmo Ciclo" em "Configuração de Agendamento > Dependências de Agendamento" para uma tarefa do Data Studio no console do DataWorks.	true
Owner	string	O ID de usuário da Alibaba Cloud do proprietário do arquivo.	3872572****
CreateTime	integer	O timestamp de quando o arquivo foi criado, em milissegundos.	1593950832000
FileType	integer	O tipo de arquivo. Diferentes tipos de arquivo possuem códigos diferentes. Para mais informações, consulte nós do DataWorks.	10
CurrentVersion	integer	A versão mais recente do arquivo.	2
BizId	integer	[Descontinuado] O ID do workflow ao qual o arquivo pertence. Este campo foi descontinuado. Use o campo BusinessId em seu lugar.	300000
LastEditUser	string	O ID da Alibaba Cloud do usuário que atualizou o arquivo pela última vez.	382762****
FileName	string	O nome do arquivo.	ods_user_info_d
ConnectionName	string	O nome da fonte de dados usada quando a tarefa correspondente ao arquivo é executada.	odps_source
UseType	string	O módulo funcional ao qual o arquivo pertence. Valores válidos: NORMAL: Data Studio. MANUAL: nó manual. MANUAL_BIZ: workflow manual. SKIP: agendamento de dry run no Data Studio. ADHOCQUERY: consulta ad hoc. COMPONENT: gerenciamento de componentes.	NORMAL
FileFolderId	string	O ID da pasta onde o arquivo está armazenado.	2735c2****
FileId	integer	O ID do arquivo.	10000001
ParentId	integer	Se o arquivo atual for um arquivo interno de um nó combinado, este campo indica o ID do arquivo do nó combinado correspondente.	-1
CreateUser	string	O ID de usuário da Alibaba Cloud do criador do arquivo.	382762****
IsMaxCompute	boolean	Se o arquivo atual for um arquivo de recurso do MaxCompute, este campo indica se o arquivo de recurso precisa ser carregado no MaxCompute. Este parâmetro precisa ser configurado apenas quando o arquivo for um arquivo de recurso do MaxCompute.	false
BusinessId	integer	O ID do workflow ao qual o arquivo pertence.	300000
FileDescription	string	A descrição do arquivo.	my test datastudio file
LastEditTime	integer	O timestamp da última edição do arquivo, em milissegundos.	1593950832000
Content	string	[Descontinuado] Este parâmetro foi descontinuado. Você pode chamar a operação GetFile para consultar o conteúdo do arquivo.	SHOW TABLES;
NodeId	integer	O ID da tarefa de agendamento gerada no sistema de agendamento após o arquivo ser submetido a commit.	300001
AbsoluteFolderPath	string	O caminho da pasta onde o arquivo está armazenado.	Business_process/my_first_business_process/MaxCompute/ods_layer

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist",
  "RequestId": "0000-ABCD-****",
  "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": "382762****",
        "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,
        "AbsoluteFolderPath": "Business_process/my_first_business_process/MaxCompute/ods_layer"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.	Acesso negado. Autorize o acesso.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.