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

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	ListFiles	A operação a ser executada.
FileFolderPath	String	Não	Workflow/My first workflow/MaxCompute/ods	Caminho da pasta à qual os arquivos pertencem.
ProjectId	Long	Não	10000	ID do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Workspace para obter o ID. Configure este parâmetro ou o parâmetro ProjectIdentifier para determinar o workspace do DataWorks ao qual a operação se aplica.
Keyword	String	Não	ods	Palavra-chave nos nomes dos arquivos, usada para correspondência aproximada. Especifique uma palavra-chave para consultar todos os arquivos cujos nomes a contenham.
ProjectIdentifier	String	Não	dw_project	Nome do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Workspace para obter o nome do workspace. Configure este parâmetro ou o parâmetro ProjectId para determinar o workspace do DataWorks ao qual a operação se aplica.
PageNumber	Integer	Não	1	Número da página.
PageSize	Integer	Não	10	Número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
UseType	String	Não	NORMAL	Módulo ao qual o arquivo pertence. Valores válidos: NORMAL: arquivo usado no DataStudio. MANUAL: arquivo usado em um nó acionado manualmente. MANUAL_BIZ: arquivo usado em um fluxo de trabalho acionado manualmente. SKIP: arquivo usado em um nó de execução simulada no DataStudio. ADHOCQUERY: arquivo usado para uma consulta ad hoc. COMPONENT: arquivo usado como snippet.
FileTypes	String	Não	10,23	Tipo de código do arquivo. Valores válidos: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (grupo de nós), 99 (carga zero), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (inspeção de objetos OSS), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (sincronização em tempo real), 1002 (nó interno PAI), 1089 (colaboração entre tenants), 1091 (desenvolvimento Hologres), 1093 (Hologres SQL), 1100 (atribuição), 1106 (for-each) e 1221 (PyODPS 3).
Owner	String	Não	3726346****	Proprietário do arquivo.
NodeId	Long	Não	123541234	ID do nó agendado. Chame a operação ListNodes para consultar o ID do nó.
NeedContent	Boolean	Não	false	Define se o conteúdo do arquivo deve ser incluído nos resultados da consulta. Arquivos com grande volume de dados podem causar atrasos significativos na transmissão pela rede.
NeedAbsoluteFolderPath	Boolean	Não	false	Define se o caminho da pasta à qual o arquivo pertence deve ser incluído nos resultados da consulta.
ExactFileName	String	Não	ods_create.sql	Nome exato do arquivo. O nome do arquivo nos resultados da consulta deve ser exatamente igual ao valor deste parâmetro.
FileIdIn	String	Não	78237,816123	Lista de IDs de arquivos. O conjunto de IDs de arquivos nos resultados da consulta será apenas um subconjunto da lista especificada por este parâmetro. É possível especificar até 50 IDs de arquivos por vez.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	Código de status HTTP.
ErrorMessage	String	The connection does not exist.	Mensagem de erro.
RequestId	String	0000-ABCD-EFG	ID da solicitação.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	Código de erro.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
Data	Object		Arquivos retornados.
PageNumber	Integer	1	Número da página.
PageSize	Integer	10	Número de entradas por página.
TotalCount	Integer	13	Número total de entradas retornadas.
Files	Array of File		Detalhes dos arquivos.
CommitStatus	Integer	1	Indica se o código mais recente do arquivo foi enviado (committed). Valores válidos: 0 e 1. O valor 0 indica que o código mais recente não foi enviado. O valor 1 indica que o código mais recente foi enviado.
AutoParsing	Boolean	true	Indica se o recurso de análise automática está ativado para o arquivo. Valores válidos: true false Este parâmetro corresponde ao parâmetro Automatic Parsing From Code Before Node Committing exibido após selecionar Same Cycle na seção Dependencies da aba Properties no console do DataWorks.
Owner	String	3872572****	ID da conta Alibaba Cloud usada pelo proprietário do arquivo.
CreateTime	Long	1593950832000	Horário de criação do arquivo. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.
FileType	Integer	10	Tipo de código do arquivo. Valores válidos: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (carga zero), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (inspeção de objetos OSS), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (sincronização em tempo real), 1089 (colaboração entre tenants), 1091 (desenvolvimento Hologres), 1093 (Hologres SQL), 1100 (atribuição) e 1221 (PyODPS 3).
CurrentVersion	Integer	2	Número da versão mais recente do arquivo.
BizId	Long	300000	ID do fluxo de trabalho ao qual o arquivo pertence. Este parâmetro foi descontinuado e substituído pelo parâmetro BusinessId.
LastEditUser	String	38748246285727	ID da conta Alibaba Cloud usada para modificar o arquivo pela última vez.
FileName	String	ods_user_info_d	Nome do arquivo.
ConnectionName	String	odps_source	Nome da fonte de dados usada para executar o nó correspondente ao arquivo.
UseType	String	NORMAL	Módulo ao qual o arquivo pertence. Valores válidos: NORMAL: arquivo usado no DataStudio. MANUAL: arquivo usado em um nó acionado manualmente. MANUAL_BIZ: arquivo usado em um fluxo de trabalho acionado manualmente. SKIP: arquivo usado em um nó de execução simulada no DataStudio. ADHOCQUERY: arquivo usado para uma consulta ad hoc. COMPONENT: arquivo usado como snippet.
FileFolderId	String	2735c2****	ID da pasta à qual o arquivo pertence.
FileId	Long	10000001	ID do arquivo.
ParentId	Long	-1	ID do arquivo de grupo de nós ao qual o arquivo atual pertence. Este parâmetro é retornado apenas se o arquivo atual for um arquivo interno do arquivo de grupo de nós.
CreateUser	String	382762****	ID da conta Alibaba Cloud usada para criar o arquivo.
IsMaxCompute	Boolean	false	Indica se o arquivo precisa ser carregado no MaxCompute caso seja um arquivo de recurso do MaxCompute. Este parâmetro é retornado apenas se o arquivo for um arquivo de recurso do MaxCompute.
BusinessId	Long	300000	ID do fluxo de trabalho ao qual o arquivo pertence.
FileDescription	String	my test datastudio file	Descrição do arquivo.
LastEditTime	Long	1593950832000	Horário da última modificação do arquivo. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.
Content	String	SHOW TABLES;	Parâmetro descontinuado. Chame a operação GetFile para consultar os detalhes do arquivo.
NodeId	Long	300001	ID do nó acionado automaticamente gerado no sistema de agendamento após o envio do arquivo.
AbsoluteFolderPath	String	Workflow/My first workflow/MaxCompute/ods	Caminho da pasta à qual o arquivo pertence.

Exemplos

Exemplos de solicitações

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>

Exemplos de respostas de sucesso

Formato XML

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>

Formato JSON

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 erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
429	Throttling.Api	The request for this resource has exceeded your available limit.	O número de solicitações para o recurso excedeu o limite superior.
429	Throttling.System	The DataWorks system is busy. Try again later.	O sistema do DataWorks está ocupado. Tente novamente mais tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Muitas solicitações foram enviadas em um curto período. Tente novamente mais tarde.
500	InternalError.System	An internal system error occurred. Try again later.	Ocorreu um erro interno do sistema. Tente novamente mais tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ocorreu um erro interno do sistema. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.