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

Obtém os detalhes de 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

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
ProjectId	integer	Não	O ID do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do workspace para obter o ID do workspace. Você deve especificar este parâmetro ou o parâmetro ProjectIdentifier para identificar o workspace do DataWorks para esta chamada de API.	10000
ProjectIdentifier	string	Não	O nome do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página de configuração do workspace para obter o nome do workspace. Você deve especificar este parâmetro ou o parâmetro ProjectId para identificar o workspace do DataWorks para esta chamada de API.	dw_project
FileId	integer	Não	O ID do arquivo. Você pode invocar a API ListFiles para consultar o ID do arquivo correspondente.	100000001
NodeId	integer	Não	O ID do nó de agendamento. Você pode invocar a API ListFiles para obter o ID do nó.	200000001

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
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. Usado para solução de problemas quando ocorre uma falha.	0000-ABCD-EFG****
ErrorCode	string	O código de erro.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica se a invocação foi bem-sucedida. Valores válidos: true: A invocação foi bem-sucedida. false: Falha na invocação.	true
Data	object	Os detalhes do arquivo.
File	object	As informações básicas sobre o arquivo.
CommitStatus	integer	O status de commit atual do arquivo. Valores válidos: 0: O código mais recente não foi enviado. 1: O código mais recente foi enviado.	0
AutoParsing	boolean	Indica se a análise automática está ativada para o arquivo. Valores válidos: true: O código no arquivo é analisado automaticamente. false: O código no arquivo não é analisado automaticamente. Este parâmetro corresponde à opção "Análise de Código" no console do DataWorks (https://dataworks.console.alibabacloud.com/console) quando você seleciona "Mesmo Ciclo" em Configuração de Agendamento > Dependência de Agendamento para um job de Desenvolvimento de Dados.	true
Owner	string	O ID de usuário do Alibaba Cloud do proprietário do arquivo.	7775674356****
CreateTime	integer	O carimbo de data e hora UNIX de quando o arquivo foi criado, em milissegundos.	1593879116000
FileType	integer	O tipo de código do arquivo. Diferentes tipos de arquivo usam códigos diferentes. Para mais informações, consulte nós do DataWorks.	10
CurrentVersion	integer	O número da versão mais recente enviada do arquivo.	3
BizId	integer	O ID do processo de negócio ao qual o arquivo pertence. Este campo está obsoleto. Use o campo BusinessId em seu lugar.	1000001
LastEditUser	string	O ID de usuário do Alibaba Cloud do usuário que editou o arquivo pela última vez.	424732****
FileName	string	O nome do arquivo.	ods_user_info_d
ConnectionName	string	O nome da fonte de dados usada ao executar o job correspondente ao arquivo.	odps_source
UseType	string	O módulo de função ao qual o arquivo pertence. Valores válidos: NORMAL: Data Studio. MANUAL: Tarefa acionada manualmente. MANUAL_BIZ: workflow acionado manualmente. SKIP: Agendamento de dry run no Data Studio. ADHOCQUERY: Consulta ad-hoc. COMPONENT: Gerenciamento de componentes.	NORMAL
FileFolderId	string	O ID da pasta à qual o arquivo pertence.	2735c2****
ParentId	integer	Se o arquivo atual for um arquivo interno de um arquivo de nó combinado, este campo identifica o ID do arquivo de nó combinado correspondente.	-1
CreateUser	string	O ID de usuário do Alibaba Cloud do criador do arquivo.	424732****
IsMaxCompute	boolean	Indica se o arquivo de recurso precisa ser carregado no MaxCompute. Configure este parâmetro apenas quando o arquivo for um arquivo de recurso do MaxCompute.	true
BusinessId	integer	O ID do processo de negócio do arquivo.	1000001
FileDescription	string	A descrição do arquivo.	My first DataWorks file
DeletedStatus	string	O status de exclusão do arquivo. Valores válidos: NORMAL: Não excluído. RECYCLE_BIN: Na lixeira. DELETED: Excluído.	RECYCLE
LastEditTime	integer	O carimbo de data e hora UNIX da edição mais recente do arquivo, em milissegundos.	1593879116000
Content	string	O código do arquivo.	SHOW TABLES;
NodeId	integer	O ID da tarefa de agendamento gerada no sistema de agendamento após o envio do arquivo.	300001
AdvancedSettings	string	A configuração avançada do job. Este parâmetro corresponde a "Configurações Avançadas" na barra de navegação à direita na página de edição de um job de Desenvolvimento de Dados EMR no console do DataWorks. Nota Atualmente, os jobs EMR Shell não suportam parâmetros avançados. Para obter detalhes sobre os parâmetros avançados para diferentes tipos de jobs EMR, consulte Desenvolvimento de Jobs EMR.	{\"priority\":\"1\",\"ENABLE_SPARKSQL_JDBC\":false,\"FLOW_SKIP_SQL_ANALYZE\":false,\"queue\":\"default\"}
FileId	integer	O ID do arquivo.	100000001
NodeConfiguration	object	A configuração de agendamento do arquivo.
RerunMode	string	Propriedade de reexecução. Valores válidos: ALL_ALLOWED: O job pode ser reexecutado independentemente de ter sido bem-sucedido ou ter falhado anteriormente. FAILURE_ALLOWED: O job não pode ser reexecutado se tiver sido bem-sucedido anteriormente, mas pode ser reexecutado se tiver falhado anteriormente. ALL_DENIED: O job não pode ser reexecutado independentemente de ter sido bem-sucedido ou ter falhado anteriormente. Este parâmetro corresponde à configuração "Configuração de Agendamento > Propriedades de Tempo > Propriedade de Reexecução" para um job de Desenvolvimento de Dados no console do DataWorks.	ALL_ALLOWED
SchedulerType	string	O tipo de agendamento. Valores válidos: NORMAL: Tarefa de agendamento normal. MANUAL: Tarefa acionada manualmente, que não está incluída no agendamento regular e corresponde a um nó em um workflow acionado manualmente. PAUSE: Tarefa pausada. SKIP: Tarefa de dry run, que está incluída no agendamento regular, mas é imediatamente marcada como bem-sucedida quando agendada.	NORMAL
Stop	boolean	Indica se deve pausar o agendamento. Valores válidos: true: Pausar o agendamento. false: Não pausar o agendamento. Este parâmetro corresponde à configuração "Tipo de Agendamento" em "Configuração de Agendamento > Propriedades de Tempo" para um job de Desenvolvimento de Dados no console do DataWorks, quando está definido como "pausar agendamento".	false
ParaValue	string	Parâmetro de agendamento. Este parâmetro corresponde à configuração "Configuração de Agendamento > Parâmetros" para um job de Desenvolvimento de Dados no console do DataWorks. Você pode consultar a documentação Parâmetros de Agendamento para obter detalhes de configuração.	a=x b=y
StartEffectDate	integer	O carimbo de data e hora UNIX (em milissegundos) que indica quando o agendamento automático começa. Este parâmetro corresponde à hora de início (como um carimbo de data e hora UNIX em milissegundos) configurada em "Configuração de Agendamento > Propriedades de Tempo > Data Efetiva" para um job de Desenvolvimento de Dados no console do DataWorks.	936923400000
EndEffectDate	integer	O carimbo de data e hora UNIX, em milissegundos, quando o agendamento automático para. Este parâmetro corresponde ao carimbo de data e hora UNIX em milissegundos da hora de término configurada na configuração "Configuração de Agendamento > Propriedades de Tempo > Data Efetiva" para um job de Desenvolvimento de Dados no console do DataWorks.	4155787800000
CycleType	string	O tipo de ciclo de agendamento, incluindo NOT_DAY (minuto, hora) e DAY (dia, semana, mês). Este parâmetro corresponde a "Configuração de Agendamento > Propriedades de Tempo > Ciclo de Agendamento" para um job de Desenvolvimento de Dados no console do DataWorks.	DAY
DependentNodeIdList	string	Quando o parâmetro DependentType está definido como USER_DEFINE, este parâmetro especifica os IDs dos nós dos quais o arquivo atual depende. Separe vários IDs de nó com vírgulas (,). Este parâmetro corresponde à configuração quando, no console do DataWorks, a "Configuração de Agendamento > Dependência de Agendamento" de um job de Desenvolvimento de Dados está definida como "Ciclo Anterior" e a opção de dependência está definida como "Outros Nós".	5,10,15,20
ResourceGroupId	integer	O grupo de recursos usado quando o arquivo é publicado como um job e executado. Você pode chamar ListResourceGroups para obter a lista de grupos de recursos disponíveis no workspace.	375827434852437
DependentType	string	O método de dependência do ciclo anterior. Valores válidos: SELF: A dependência é o próprio nó atual. CHILD: A dependência são os nós filhos diretos. USER_DEFINE: A dependência são outros nós especificados. NONE: Nenhuma dependência é selecionada, o que significa que o nó não depende do ciclo anterior.	USER_DEFINE
AutoRerunTimes	integer	O número de reexecuções automáticas após um erro.	3
AutoRerunIntervalMillis	integer	O intervalo de tempo entre reexecuções automáticas após um erro, em milissegundos. Este parâmetro corresponde à configuração "Intervalo de Reexecução" em "Configuração de Agendamento > Propriedades de Tempo > Reexecução Automática em Caso de Erro" para um job de Desenvolvimento de Dados no console do DataWorks. Observe que a unidade de tempo para "Intervalo de Reexecução" no console é em minutos; converta o tempo adequadamente ao invocar a API.	120000
CronExpress	string	A expressão Cron para o agendamento temporizado do arquivo.	00 05 00 * * ?
InputList	array<object>	Informações sobre as saídas dos arquivos upstream dos quais este arquivo depende.
	object	Informações sobre as saídas dos arquivos upstream dos quais este arquivo depende.
Input	string	O nome da saída do arquivo upstream do qual este arquivo depende. Este parâmetro corresponde a "Nome da Saída do Nó Pai" quando "Mesmo Ciclo" é selecionado em "Configuração de Agendamento > Dependência de Agendamento" para um job de Desenvolvimento de Dados no console do DataWorks.	project.001_out
ParseType	string	O método para configurar dependências de arquivo. Valores válidos: MANUAL: Configurado manualmente. AUTO: Analisado automaticamente.	MANUAL
OutputList	array<object>	As informações de saída do arquivo.
	object	As informações de saída do arquivo.
RefTableName	string	O valor de saída do arquivo. Este parâmetro corresponde ao valor na coluna "Tabela de Saída" quando "Mesmo Ciclo" é selecionado em "Configuração de Agendamento > Dependência de Agendamento" para um job de Desenvolvimento de Dados no console do DataWorks.	ods_user_info_d
Output	string	O nome da saída do arquivo. Este parâmetro corresponde ao valor na coluna "Nome da Saída" quando "Mesmo Ciclo" é selecionado em "Configuração de Agendamento > Dependência de Agendamento" para um job de Desenvolvimento de Dados no console do DataWorks.	dw_project.002_out
StartImmediately	boolean	Indica se deve iniciar imediatamente após a publicação. Este parâmetro corresponde à configuração "Método de Início" em "Configuração > Propriedades de Tempo" na barra de navegação à direita na página de edição para jobs de Desenvolvimento de Dados EMR Spark Streaming e EMR Streaming SQL no console do DataWorks.	true
InputParameters	array<object>	Resultado de retorno.
	object	Resultado de retorno.
ParameterName	string	O nome do parâmetro de entrada no contexto do nó. Você pode referenciar este parâmetro no código usando a sintaxe ${...}. Este parâmetro corresponde ao campo "Nome do Parâmetro" em "Configuração de Agendamento > Contexto do Nó > Parâmetros de Entrada Deste Nó" no console do DataWorks.	input
ValueSource	string	A fonte de valor do parâmetro de entrada no contexto do nó. Este parâmetro corresponde ao campo "Fonte de Valor" em "Configuração de Agendamento > Contexto do Nó > Parâmetros de Entrada Deste Nó" no console do DataWorks.	project_001.parent_node:outputs
OutputParameters	array<object>	Resultado de retorno.
	object	Resultado de retorno.
ParameterName	string	O nome do parâmetro de saída no contexto do nó. Este parâmetro corresponde ao campo "Nome do Parâmetro" em "Configuração de Agendamento > Contexto do Nó > Parâmetros de Saída Deste Nó" para um job de Desenvolvimento de Dados no console do DataWorks.	output
Value	string	A expressão do parâmetro de saída no contexto do nó. Este parâmetro corresponde ao campo "Valor" na seção "Configuração de Agendamento > Contexto do Nó > Parâmetros de Saída Deste Nó" para um job de Desenvolvimento de Dados no console do DataWorks.	${bizdate}
Type	string	O tipo de expressão para o parâmetro de saída do contexto do nó. Os valores válidos são os seguintes: 1: constante 2: variável 3: variável de passagem de um nó de parâmetro Este parâmetro corresponde ao campo "Tipo" na seção "Configuração de Agendamento > Contexto do Nó > Parâmetros de Saída Deste Nó" para um job de Desenvolvimento de Dados no console do DataWorks.	1
Description	string	A descrição do parâmetro de saída no contexto do nó.	It's a context output parameter.
ApplyScheduleImmediately	string	Indica se a configuração de agendamento deve ser aplicada imediatamente após a publicação.	true
IgnoreParentSkipRunningProperty	string	Configuração de Agendamento > Ciclo Anterior > Se deve ignorar a propriedade de dry run upstream.	true
Timeout	integer	Definição de tempo limite para a configuração de agendamento.	1
ImageId	string	ID da imagem personalizada.	m-bp1h4b5a8ogkbll2f3tr
ResourceDownloadLink	object	Link para download do recurso.
downloadLink	string	Link para baixar o 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": "424732****\n",
      "FileName": "ods_user_info_d",
      "ConnectionName": "odps_source",
      "UseType": "NORMAL",
      "FileFolderId": "2735c2****",
      "ParentId": -1,
      "CreateUser": "424732****\n",
      "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	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.