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

Consulta as informações sobre um arquivo.

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

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectId	integer	Não	O ID do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página Gerenciamento de Workspaces para obter o ID do workspace. Você deve configurar este parâmetro ou o parâmetro ProjectIdentifier para determinar o workspace do DataWorks ao qual a operação é aplicada.	10000
ProjectIdentifier	string	Não	O nome do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página Gerenciamento de Workspaces para obter o nome do workspace. Você deve configurar este parâmetro ou o parâmetro ProjectId para determinar o workspace do DataWorks ao qual a operação é aplicada.	dw_project
FileId	integer	Não	O ID do arquivo. Você pode chamar a operação ListFiles para obter o ID.	100000001
NodeId	integer	Não	O ID do nó que é agendado. Você pode chamar a operação ListFiles para obter o ID do nó.	200000001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
HttpStatusCode	integer	O código de status HTTP retornado.	200
ErrorMessage	string	A mensagem de erro retornada.	The connection does not exist.
RequestId	string	O ID da solicitação. Você pode usar o ID para solucionar problemas.	0000-ABCD-EFG****
ErrorCode	string	O código de erro retornado.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Data	object	Os detalhes do arquivo.
File	object	As informações básicas sobre o arquivo.
CommitStatus	integer	Indica se o código mais recente do arquivo foi submetido. Valores válidos: 0 e 1. O valor 0 indica que o código mais recente no arquivo não foi submetido. O valor 1 indica que o código mais recente no arquivo foi submetido.	0
AutoParsing	boolean	Indica se o recurso de análise automática está ativado para o arquivo. Valores válidos: true: O recurso de análise automática está ativado para o arquivo. false: O recurso de análise automática não está ativado para o arquivo. Este parâmetro corresponde ao parâmetro Analisar Código que é exibido após a seleção de Mesmo Ciclo na seção Dependências da guia Propriedades no console do DataWorks.	true
Owner	string	O ID da conta Alibaba Cloud usada pelo proprietário do arquivo.	7775674356****
CreateTime	integer	A hora em que o arquivo foi criado. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1593879116000
FileType	integer	O tipo de código do arquivo. O código dos arquivos varia de acordo com o tipo de arquivo. Para mais informações, consulte Nós do DataWorks.	10
CurrentVersion	integer	O número da versão mais recente submetida do arquivo.	3
BizId	integer	O ID do workflow ao qual o arquivo pertence. Este parâmetro foi descontinuado e substituído pelo parâmetro BusinessId.	1000001
LastEditUser	string	O ID da conta Alibaba Cloud usada para modificar o arquivo pela última vez.	62465892****
FileName	string	O nome do arquivo.	ods_user_info_d
ConnectionName	string	O nome da fonte de dados usada para executar a tarefa correspondente ao arquivo.	odps_source
UseType	string	O módulo ao qual o arquivo pertence. Valores válidos: NORMAL: O arquivo é usado para o Data Studio. MANUAL: O arquivo é usado para um nó acionado manualmente. MANUAL_BIZ: O arquivo é usado para um workflow acionado manualmente. SKIP: O arquivo é usado para um nó de dry-run do Data Studio. ADHOCQUERY: O arquivo é usado para uma consulta ad hoc. COMPONENT: O arquivo é usado para gerenciamento de componentes.	NORMAL
FileFolderId	string	O ID da pasta à qual o arquivo pertence.	2735c2****
ParentId	integer	O 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.	-1
CreateUser	string	O ID da conta Alibaba Cloud usada para criar o arquivo.	424732****
IsMaxCompute	boolean	Indica se o arquivo precisa ser carregado no MaxCompute. Este parâmetro se aplica apenas a arquivos de recursos do MaxCompute.	true
BusinessId	integer	O ID do workflow ao qual o arquivo pertence.	1000001
FileDescription	string	A descrição do arquivo.	My first DataWorks file
DeletedStatus	string	O status do arquivo. Valores válidos: NORMAL: O arquivo não foi excluído. RECYCLE_BIN: O arquivo está armazenado na lixeira. DELETED: O arquivo foi excluído.	RECYCLE
LastEditTime	integer	A hora em que o arquivo foi modificado pela última vez. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1593879116000
Content	string	O código no arquivo.	SHOW TABLES;
NodeId	integer	O ID do nó acionado automaticamente que é gerado no sistema de agendamento após o arquivo ser submetido.	300001
AdvancedSettings	string	As configurações avançadas do nó. Este parâmetro é válido para um nó EMR. Este parâmetro corresponde à guia Configurações Avançadas no painel de navegação à direita na guia de configuração do nó no console do DataWorks. Nota Você não pode configurar parâmetros avançados para nós EMR Shell. Para obter informações sobre os parâmetros avançados de cada tipo de nó EMR, consulte Desenvolver tarefas EMR.	{"priority":"1","ENABLE_SPARKSQL_JDBC":false,"FLOW_SKIP_SQL_ANALYZE":false,"queue":"default"}
FileId	integer	O ID do arquivo.	100000001
NodeConfiguration	object	As configurações de agendamento do arquivo.
RerunMode	string	Indica se o nó que corresponde ao arquivo pode ser reexecutado. Valores válidos: ALL_ALLOWED: O nó pode ser reexecutado independentemente de ter sido executado com sucesso ou ter falhado. FAILURE_ALLOWED: O nó pode ser reexecutado apenas após falhar na execução. ALL_DENIED: O nó não pode ser reexecutado independentemente de ter sido executado com sucesso ou ter falhado. Este parâmetro corresponde ao parâmetro Reexecutar na seção Agendamento da guia Propriedades no console do DataWorks.	ALL_ALLOWED
SchedulerType	string	O tipo de agendamento do nó. Valores válidos: NORMAL: O nó é um nó acionado automaticamente. MANUAL: O nó é um nó acionado manualmente. Nós acionados manualmente não podem ser acionados automaticamente. Eles correspondem aos nós no painel Workflows Acionados Manualmente. PAUSE: O nó é um nó pausado. SKIP: O nó é um nó de dry-run. Os nós de dry-run são iniciados conforme agendado, mas o sistema define o status dos nós como bem-sucedido quando começa a executá-los.	NORMAL
Stop	boolean	Indica se o agendamento do nó está suspenso. Valores válidos: true: O agendamento do nó está suspenso. false: O agendamento do nó não está suspenso. Este parâmetro corresponde ao parâmetro Recorrência na seção Agendamento da guia Propriedades no console do DataWorks.	false
ParaValue	string	Os parâmetros de agendamento do nó. Este parâmetro corresponde à seção Parâmetros da guia Propriedades no console do DataWorks. Para mais informações sobre as configurações dos parâmetros de agendamento, consulte Configurar parâmetros de agendamento.	a=x b=y
StartEffectDate	integer	A hora de início do agendamento automático. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Este parâmetro corresponde ao parâmetro Período de Validade na seção Agendamento da guia Propriedades no console do DataWorks.	936923400000
EndEffectDate	integer	A hora de término do agendamento automático. Este valor é um carimbo de data/hora UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Este parâmetro corresponde ao parâmetro Período de Validade na seção Agendamento da guia Propriedades no console do DataWorks.	4155787800000
CycleType	string	O tipo do ciclo de agendamento. Valores válidos: NOT_DAY e DAY. O valor NOT_DAY indica que o nó está agendado para ser executado por minuto ou hora. O valor DAY indica que o nó está agendado para ser executado por dia, semana ou mês. Este parâmetro corresponde ao parâmetro Ciclo de Agendamento na seção Agendamento da guia Propriedades no console do DataWorks.	DAY
DependentNodeIdList	string	O ID do nó do qual o nó correspondente ao arquivo depende quando o parâmetro DependentType é definido como USER_DEFINE. Vários IDs são separados por vírgulas (,). O valor deste parâmetro é equivalente ao ID do nó que você especificou após selecionar Ciclo Anterior e definir Dependente de como Outros Nós na seção Dependências da guia Propriedades no console do DataWorks.	5,10,15,20
ResourceGroupId	integer	O ID do grupo de recursos que é usado para executar o nó. Você pode chamar a operação ListResourceGroups para consultar os grupos de recursos disponíveis no workspace.	375827434852437
DependentType	string	O tipo de dependência de agendamento entre ciclos do nó. Valores válidos: SELF: A instância gerada para o nó no ciclo atual depende da instância gerada para o nó no ciclo anterior. CHILD: A instância gerada para o nó no ciclo atual depende das instâncias geradas para os nós descendentes no nível mais próximo do nó no ciclo anterior. USER_DEFINE: A instância gerada para o nó no ciclo atual depende das instâncias geradas para um ou mais nós especificados no ciclo anterior. NONE: Nenhum tipo de dependência de agendamento entre ciclos está selecionado para o nó.	USER_DEFINE
AutoRerunTimes	integer	O número de reexecuções automáticas permitidas após a ocorrência de um erro.	3
AutoRerunIntervalMillis	integer	O intervalo entre reexecuções automáticas após a ocorrência de um erro. Unidade: milissegundos. Este parâmetro corresponde ao parâmetro Intervalo de Reexecução que é exibido após a seleção da caixa de seleção Reexecutar Automaticamente em Caso de Erro na seção Agendamento da guia Propriedades no console do DataWorks. O intervalo especificado no console do DataWorks é medido em minutos. Preste atenção à conversão entre as unidades de tempo ao chamar a operação.	120000
CronExpress	string	A expressão CRON que representa a política de agendamento periódico do nó.	00 05 00 * * ?
InputList	array<object>	Os nomes de saída dos arquivos pai dos quais o arquivo atual depende.
	object	As informações de saída do arquivo upstream.
Input	string	O nome de saída do arquivo pai do qual o arquivo atual depende. Este parâmetro corresponde ao parâmetro Nome de Saída do Nó Ancestral em Nós Pais após a seleção de Mesmo Ciclo na seção Dependências da guia Propriedades no console do DataWorks.	project.001_out
ParseType	string	O modo da dependência do arquivo de configuração. Valores válidos: MANUAL: As dependências de agendamento são configuradas manualmente. AUTO: As dependências de agendamento são analisadas automaticamente.	MANUAL
OutputList	array<object>	Os nomes de saída do arquivo atual. Este parâmetro corresponde ao parâmetro Nome de Saída em Saída após a seleção de Mesmo Ciclo na seção Dependências da guia Propriedades no console do DataWorks.
	object	As informações de saída do arquivo.
RefTableName	string	O nome da tabela de saída do arquivo atual. Este parâmetro corresponde ao parâmetro Nome da Tabela de Saída em Saída após a seleção de Mesmo Ciclo na seção Dependências da guia Propriedades no console do DataWorks.	ods_user_info_d
Output	string	O nome de saída do arquivo atual. Este parâmetro corresponde ao parâmetro Nome de Saída em Saída após a seleção de Mesmo Ciclo na seção Dependências da guia Propriedades no console do DataWorks.	dw_project.002_out
StartImmediately	boolean	Indica se um nó é executado imediatamente após ser implantado no ambiente de produção. Este parâmetro é válido apenas para um nó EMR Spark Streaming ou um nó EMR Streaming SQL. Este parâmetro corresponde ao parâmetro Método de Início na seção Agendamento da guia Configurar no console do DataWorks.	true
InputParameters	array<object>	Parâmetros de contexto de entrada do nó. Este parâmetro corresponde à tabela Parâmetros de Entrada na seção Parâmetros de Entrada e Saída da guia Propriedades no console do DataWorks.
	object	O resultado retornado.
ParameterName	string	O nome do parâmetro de entrada do nó. No código, você pode usar o método ${...} para referenciar o parâmetro de entrada do nó. Este parâmetro corresponde ao parâmetro Nome do Parâmetro na tabela Parâmetros de Entrada na seção Parâmetros de Entrada e Saída da guia Propriedades no console do DataWorks.	input
ValueSource	string	A fonte de valor do parâmetro de entrada do nó. Este parâmetro corresponde ao parâmetro Fonte de Valor na tabela Parâmetros de Entrada na seção Parâmetros de Entrada e Saída da guia Propriedades no console do DataWorks.	project_001.parent_node:outputs
OutputParameters	array<object>	Parâmetros de contexto de saída do nó. Este parâmetro corresponde à tabela Parâmetros de Saída na seção Parâmetros de Entrada e Saída da guia Propriedades no console do DataWorks.
	object	O resultado retornado.
ParameterName	string	O nome do parâmetro de saída do nó. Este parâmetro corresponde ao parâmetro Nome do Parâmetro na tabela Parâmetros de Saída na seção Parâmetros de Entrada e Saída da guia Propriedades no console do DataWorks.	output
Value	string	A expressão do parâmetro de contexto de saída do nó. Este parâmetro corresponde ao parâmetro Valor na tabela Parâmetros de Saída na seção Parâmetros de Entrada e Saída da guia Propriedades no console do DataWorks.	${bizdate}
Type	string	O tipo do parâmetro de saída do nó. Valores válidos: 1: indica uma constante. 2: indica uma variável. 3: indica uma variável de passagem de um nó de parâmetro. Este parâmetro corresponde ao parâmetro Tipo na tabela Parâmetros de Saída na seção Parâmetros de Entrada e Saída da guia Propriedades no console do DataWorks.	1
Description	string	A descrição do parâmetro de saída do nó.	It's a context output parameter.
ApplyScheduleImmediately	string	Indica se as configurações de agendamento entram em vigor imediatamente após a implantação.	true
IgnoreParentSkipRunningProperty	string	Indica se deve ignorar a propriedade de dry-run dos nós ancestrais do nó que corresponde ao arquivo. Este parâmetro corresponde ao parâmetro Ignorar a propriedade de dry-run do nó ancestral que é exibido após a configuração do parâmetro Dependente de na seção Dependências da guia Propriedades no console do DataWorks.	true
Timeout	integer	O período de tempo limite.	1
ImageId	string	O ID da imagem personalizada.	m-bp1h4b5a8ogkbll2f3tr
ResourceDownloadLink	object	A URL de download do recurso.
downloadLink	string	A URL de download do recurso.	http://xx

Exemplos

Resposta de sucesso

JSON formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true,
  "Data": {
    "File": {
      "CommitStatus": 0,
      "AutoParsing": true,
      "Owner": "7775674356****",
      "CreateTime": 1593879116000,
      "FileType": 10,
      "CurrentVersion": 3,
      "BizId": 1000001,
      "LastEditUser": "62465892****",
      "FileName": "ods_user_info_d",
      "ConnectionName": "odps_source",
      "UseType": "NORMAL",
      "FileFolderId": "2735c2****",
      "ParentId": -1,
      "CreateUser": "424732****",
      "IsMaxCompute": true,
      "BusinessId": 1000001,
      "FileDescription": "My first DataWorks file",
      "DeletedStatus": "RECYCLE",
      "LastEditTime": 1593879116000,
      "Content": "SHOW TABLES;",
      "NodeId": 300001,
      "AdvancedSettings": "{\\\"priority\\\":\\\"1\\\",\\\"ENABLE_SPARKSQL_JDBC\\\":false,\\\"FLOW_SKIP_SQL_ANALYZE\\\":false,\\\"queue\\\":\\\"default\\\"}",
      "FileId": 100000001
    },
    "NodeConfiguration": {
      "RerunMode": "ALL_ALLOWED",
      "SchedulerType": "NORMAL",
      "Stop": false,
      "ParaValue": "a=x b=y",
      "StartEffectDate": 936923400000,
      "EndEffectDate": 4155787800000,
      "CycleType": "DAY",
      "DependentNodeIdList": "5,10,15,20",
      "ResourceGroupId": 375827434852437,
      "DependentType": "USER_DEFINE",
      "AutoRerunTimes": 3,
      "AutoRerunIntervalMillis": 120000,
      "CronExpress": "00 05 00 * * ?",
      "InputList": [
        {
          "Input": "project.001_out",
          "ParseType": "MANUAL"
        }
      ],
      "OutputList": [
        {
          "RefTableName": "ods_user_info_d",
          "Output": "dw_project.002_out"
        }
      ],
      "StartImmediately": true,
      "InputParameters": [
        {
          "ParameterName": "input",
          "ValueSource": "project_001.parent_node:outputs"
        }
      ],
      "OutputParameters": [
        {
          "ParameterName": "output",
          "Value": "${bizdate}",
          "Type": "1",
          "Description": "It's a context output parameter."
        }
      ],
      "ApplyScheduleImmediately": "true",
      "IgnoreParentSkipRunningProperty": "true",
      "Timeout": 1,
      "ImageId": "m-bp1h4b5a8ogkbll2f3tr"
    },
    "ResourceDownloadLink": {
      "downloadLink": "http://xx"
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
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.
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.