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

Consulta uma lista de arquivos.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

dataworks:*

get

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
FileFolderPath	string	Não	O caminho da pasta em que o arquivo está localizado.	Business_process/my_first_business_process/MaxCompute/ods_layer
ProjectId	integer	Não	O ID do workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Gerenciamento de Workspace para obter o ID do workspace. Você deve especificar este parâmetro ou o parâmetro ProjectIdentifier para determinar o workspace do DataWorks para a operação de API.	10000
Keyword	string	Não	A palavra-chave no 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 workspace do DataWorks. Você pode fazer logon no console do DataWorks e acessar a página Gerenciamento de Workspace para obter o nome do workspace. Você deve especificar este parâmetro ou o parâmetro ProjectId para determinar o workspace do DataWorks para a operação de API.	dw_project
PageNumber	integer	Não	O número da página a ser retornada.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada 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: Tarefa manual. MANUAL_BIZ: Fluxo de negócios 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 arquivo. O código varia de acordo com o tipo de arquivo. Para mais informações, consulte Tipos de nó do DataWorks. Especifica o tipo de código do arquivo a ser consultado.	10,23
Owner	string	Não	O proprietário do arquivo.	3726346****
NodeId	integer	Não	O ID do nó agendado. 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 uma grande quantidade de conteúdo, a latência de transmissão de rede pode ser alta.	false
NeedAbsoluteFolderPath	boolean	Não	Especifica se o resultado da consulta inclui o caminho da pasta onde o arquivo está localizado.	false
ExactFileName	string	Não	O nome do arquivo para correspondência exata. O nome do arquivo no resultado da consulta deve ser uma correspondência exata com o valor deste parâmetro.	ods_create.sql
FileIdIn	string	Não	A lista de IDs de arquivo. Os IDs de arquivo no resultado da consulta devem ser um subconjunto dos IDs nesta lista. Você pode especificar até 50 IDs de arquivo por vez.	78237,816123
LastEditUser	string	Não	O ID de usuário do Alibaba Cloud do usuário que editou o arquivo pela última vez.	38748246285727

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A 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 o ID para solucionar erros.	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	A lista de arquivos que atendem às condições especificadas.
PageNumber	integer	O número da página retornada.	1
PageSize	integer	O número de entradas retornadas por página.	10
TotalCount	integer	O número total de entradas que atendem às condições especificadas.	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 à configuração Análise de Código que entra em vigor quando você define Dependências de Agendamento como Mesmo Ciclo nas Configurações de Agendamento para uma tarefa do Data Studio no console do DataWorks.	true
Owner	string	O ID de usuário do Alibaba Cloud do proprietário do arquivo.	3872572****
CreateTime	integer	A hora em que o arquivo foi criado. O valor é um carimbo de data/hora UNIX em milissegundos.	1593950832000
FileType	integer	O tipo de arquivo. Diferentes tipos de arquivo correspondem a diferentes tipos de código. Para mais informações, consulte Tipos de nó do DataWorks.	10
CurrentVersion	integer	O número da versão mais recente do arquivo submetida a commit.	2
BizId	integer	[Deprecated] O ID do fluxo de negócios ao qual o arquivo pertence. Use o campo BusinessId em seu lugar.	300000
LastEditUser	string	O ID de usuário do Alibaba Cloud do usuário que editou o arquivo pela última vez.	38748246285727
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: Tarefa manual. MANUAL_BIZ: Fluxo de negócios 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á localizado.	2735c2****
FileId	integer	O ID do arquivo.	10000001
ParentId	integer	O ID do arquivo de nó composto ao qual o arquivo atual pertence. Este campo é retornado apenas se o arquivo atual for um arquivo interno de um arquivo de nó composto.	-1
CreateUser	string	O ID de usuário do Alibaba Cloud do usuário que criou o arquivo.	382762****
IsMaxCompute	boolean	Indica se o arquivo de recurso precisa ser carregado no MaxCompute. Este campo é retornado apenas se o arquivo atual for um arquivo de recurso do MaxCompute. Este campo é válido apenas quando o arquivo é um arquivo de recurso do MaxCompute.	false
BusinessId	integer	O ID do fluxo de negócios ao qual o arquivo pertence.	300000
FileDescription	string	A descrição do arquivo.	my test datastudio file
LastEditTime	integer	A hora em que o arquivo foi editado pela última vez. O valor é um carimbo de data/hora UNIX em milissegundos.	1593950832000
Content	string	[Deprecated] O conteúdo do arquivo. Você pode chamar a operação GetFile para consultar o conteúdo do arquivo.	SHOW TABLES;
NodeId	integer	O ID da tarefa agendada gerada no sistema de agendamento após o commit do arquivo.	300001
AbsoluteFolderPath	string	O caminho da pasta onde o arquivo está localizado.	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": "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,
        "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.	Você não tem as permissões necessárias. Conceda as permissões primeiro.
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.