GetFile - : 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	GetFile	A operação a ser executada.
ProjectId	Long	Não	10000	O ID do workspace do DataWorks. Faça login no console do DataWorks e acesse a página Workspace para obter o ID do workspace. Configure este parâmetro ou o parâmetro ProjectIdentifier para determinar o workspace do DataWorks ao qual a operação se aplica.
ProjectIdentifier	String	Não	dw_project	O 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.
FileId	Long	Não	100000001	O ID do arquivo. Chame a operação ListFiles para obter o ID do arquivo.
NodeId	Long	Não	200000001	O ID do nó agendado. Chame a operação ListFiles para obter o ID do nó.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	O código de status HTTP.
ErrorMessage	String	The connection does not exist.	A mensagem de erro.
RequestId	String	0000-ABCD-EFG****	O ID da solicitação.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	O código de erro.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
Data	Object		Os detalhes do arquivo.
File	Object		As informações básicas sobre o arquivo.
CommitStatus	Integer	0	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 Analyze Code exibido após selecione Same Cycle na seção Dependencies da aba Properties no console do DataWorks.
Owner	String	7775674356****	O ID da conta Alibaba Cloud usada pelo proprietário do arquivo.
CreateTime	Long	1593879116000	O 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	O tipo de código do arquivo. Valores válidos: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 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	3	O número da versão mais recente do arquivo.
BizId	Long	1000001	O ID do fluxo de trabalho ao qual o arquivo pertence. Este parâmetro foi descontinuado e substituído pelo parâmetro BusinessId.
LastEditUser	String	62465892****	O ID da conta Alibaba Cloud usada na última modificação do arquivo.
FileName	String	ods_user_info_d	O nome do arquivo.
ConnectionName	String	odps_source	O nome da fonte de dados usada para execute o nó correspondente ao arquivo.
UseType	String	NORMAL	O módulo ao qual o arquivo pertence. Valores válidos: NORMAL: O arquivo é usado no DataStudio. MANUAL: O arquivo é usado em um nó acionado manualmente. MANUAL_BIZ: O arquivo é usado em um fluxo de trabalho acionado manualmente. SKIP: O arquivo é usado em um nó de simulação (dry-run) do DataStudio. ADHOCQUERY: O arquivo é usado para uma consulta ad hoc. COMPONENT: O arquivo é usado como um snippet.
FileFolderId	String	2735c2****	O ID da pasta à qual o arquivo pertence.
ParentId	Long	-1	O ID do arquivo de grupo de nós ao qual o arquivo atual pertence. Este parâmetro só é retornado se o arquivo atual for um arquivo interno do arquivo de grupo de nós.
CreateUser	String	424732****	O ID da conta Alibaba Cloud usada para crie o arquivo.
IsMaxCompute	Boolean	true	Indica se o arquivo precisa ser carregado no MaxCompute. Este parâmetro só é retornado se o arquivo for um arquivo de recurso do MaxCompute.
BusinessId	Long	1000001	O ID do fluxo de trabalho ao qual o arquivo pertence.
FileDescription	String	My first DataWorks file	A descrição do arquivo.
DeletedStatus	String	RECYCLE	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.
LastEditTime	Long	1593879116000	O 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;	O código contido no arquivo.
NodeId	Long	300001	O ID do nó acionado automaticamente gerado no sistema de agendamento após o envio do arquivo.
AdvancedSettings	String	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}	As configurações avançadas do nó. Este parâmetro é válido apenas para um nó EMR Spark Streaming ou EMR Streaming SQL. Ele corresponde à aba Advanced Settings do nó no console do DataWorks. O valor deste parâmetro deve estar no formato JSON.
FileId	Long	100000001	O ID do arquivo.
NodeConfiguration	Object		As configurações de agendamento do arquivo.
RerunMode	String	ALL_ALLOWED	Indica se o nó correspondente 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ó só pode ser reexecutado após uma falha. 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 Rerun na seção Schedule da aba Properties no console do DataWorks.
SchedulerType	String	NORMAL	O tipo de agendamento do nó. Valores válidos: NORMAL: O nó é acionado automaticamente. MANUAL: O nó é acionado manualmente. Nós acionados manualmente não podem ser disparados automaticamente e correspondem aos nós no painel Manually Triggered Workflows. PAUSE: O nó está pausado. SKIP: O nó é uma simulação (dry-run). Nós de simulação são iniciados conforme o agendamento, mas o sistema defina seu status como bem-sucedido assim que começam a ser executados.
Stop	Boolean	false	Indica se o agendamento do nó está suspenso. Valores válidos: true false Este parâmetro corresponde ao parâmetro Recurrence na seção Schedule da aba Properties no console do DataWorks.
ParaValue	String	a=x b=y	Os parâmetros de agendamento do nó. Este parâmetro corresponde à seção Scheduling Parameter da aba Properties no console do DataWorks. Para obter mais informações sobre as configurações de parâmetros de agendamento, consulte Configurar parâmetros de agendamento.
StartEffectDate	Long	936923400000	O início do intervalo de tempo para agendamento automático. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Configurar este parâmetro equivale a especifique um horário de início para o parâmetro Validity Period na seção Schedule da aba Properties no console do DataWorks.
EndEffectDate	Long	4155787800000	O fim do intervalo de tempo para agendamento automático. Este valor é um timestamp UNIX que representa o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Configurar este parâmetro equivale a especifique um horário de término para o parâmetro Validity Period na seção Schedule da aba Properties no console do DataWorks.
CycleType	String	DAY	O tipo de ciclo de agendamento. Valores válidos: NOT_DAY e DAY. O valor NOT_DAY indica que o nó está agendado para execução por minuto ou hora. O valor DAY indica que o nó está agendado para execução diária, semanal ou mensal. Este parâmetro corresponde ao parâmetro Scheduling Cycle na seção Schedule da aba Properties no console do DataWorks.
DependentNodeIdList	String	5,10,15,20	O ID do nó do qual o nó correspondente ao arquivo depende quando o parâmetro DependentType está definido como USER_DEFINE. Vários IDs são separados por vírgulas (,). O valor deste parâmetro equivale ao ID do nó especificado após selecione Previous Cycle e defina Depend On como Other Nodes na seção Dependencies da aba Properties no console do DataWorks.
ResourceGroupId	Long	375827434852437	O ID do grupo de recursos usado para execute o nó correspondente ao arquivo. Chame a operação ListResourceGroups para consultar os grupos de recursos disponíveis no workspace.
DependentType	String	USER_DEFINE	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 mesmo 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 de nível mais próximo 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 específicos no ciclo anterior. NONE: Nenhum tipo de dependência de agendamento entre ciclos foi selecionado para o nó.
AutoRerunTimes	Integer	3	O número de reexecuções automáticas permitidas após a ocorrência de um erro.
AutoRerunIntervalMillis	Integer	120000	O intervalo entre reexecuções automáticas após a ocorrência de um erro. Unidade: milissegundo. Este parâmetro corresponde ao parâmetro Rerun interval exibido após marcar a caixa de seleção Auto Rerun upon Error na seção Schedule da aba Properties no console do DataWorks. O intervalo especificado no console do DataWorks é medido em minutos. Atenção à conversão entre as unidades de tempo ao chamar a operação.
CronExpress	String	00 05 00 ?	A expressão CRON que representa a política de agendamento periódico do nó.
InputList	Array of NodeInputOutput		Os nomes de saída dos arquivos pai dos quais o arquivo atual depende.
Input	String	project.001_out	O nome de saída do arquivo pai do qual o arquivo atual depende. Este parâmetro corresponde ao parâmetro Output Name of Ancestor Node em Parent Nodes após selecione Same Cycle na seção Dependencies da aba Properties no console do DataWorks.
ParseType	String	MANUAL	O modo de configuração da dependência do arquivo. Valores válidos: MANUAL: As dependências de agendamento são configuradas manualmente. AUTO: As dependências de agendamento são analisadas automaticamente.
OutputList	Array of NodeInputOutput		Os nomes de saída do arquivo atual. Este parâmetro corresponde ao parâmetro Output Name em Output após selecione Same Cycle na seção Dependencies da aba Properties no console do DataWorks.
RefTableName	String	ods_user_info_d	O nome da tabela de saída do arquivo atual. Este parâmetro corresponde ao parâmetro Output Table Name em Output após selecione Same Cycle na seção Dependencies da aba Properties no console do DataWorks.
Output	String	dw_project.002_out	O nome de saída do arquivo atual. Este parâmetro corresponde ao parâmetro Output Name em Output após selecione Same Cycle na seção Dependencies da aba Properties no console do DataWorks.
StartImmediately	Boolean	true	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 EMR Streaming SQL. Ele corresponde ao parâmetro Start Method na seção Schedule da aba Configure no console do DataWorks.
InputParameters	Array of InputContextParameter		Parâmetros de entrada do nó. Este parâmetro corresponde à tabela Input Parameters na seção Input and Output Parameters da aba Properties no console do DataWorks.
ParameterName	String	input	O nome do parâmetro de entrada do nó. No código, use o método ${...} para referenciar o parâmetro de entrada do nó. Este parâmetro corresponde ao parâmetro Parameter Name na tabela Input Parameters da seção Input and Output Parameters da aba Properties no console do DataWorks.
ValueSource	String	project_001.parent_node:outputs	A origem do valor do parâmetro de entrada do nó. Este parâmetro corresponde ao parâmetro Value Source na tabela Input Parameters da seção Input and Output Parameters da aba Properties no console do DataWorks.
OutputParameters	Array of OutputContextParameter		Parâmetros de saída do nó. Este parâmetro corresponde à tabela Output Parameters na seção Input and Output Parameters da aba Properties no console do DataWorks.
ParameterName	String	output	O nome do parâmetro de saída do nó. Este parâmetro corresponde ao parâmetro Parameter Name na tabela Output Parameters da seção Input and Output Parameters da aba Properties no console do DataWorks.
Value	String	${bizdate}	O valor do parâmetro de saída do nó. Este parâmetro corresponde ao parâmetro Value na tabela Output Parameters da seção Input and Output Parameters da aba Properties no console do DataWorks.
Type	String	1	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 (pass-through). Este parâmetro corresponde ao parâmetro Type na tabela Output Parameters da seção Input and Output Parameters da aba Properties no console do DataWorks.
Description	String	It's a context output parameter.	A descrição do parâmetro de saída do nó.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=GetFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=100000001
&NodeId=200000001
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

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

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" : {
    "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" : "{\"queue\":\"default\",\"SPARK_CONF\":\"--conf spark.driver.memory=2g\"}",
      "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."
      }
    }
  }
}

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.	Foram enviadas solicitações excessivas em um curto período. Tente novamente mais tarde.
500	InternalError.System	An internal system error occurred. Try again later.	Ocorreu um erro interno. Tente novamente mais tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ocorreu um erro interno. Tente novamente mais tarde.

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