Cria um arquivo no DataStudio. Não é possível usar esta operação para criar arquivos de nós do Data Integration.
Depuração
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Exemplo |
Descrição |
|
Action |
String |
Sim |
CreateFile |
Operação a ser executada. Defina o valor como CreateFile. |
|
FileFolderPath |
String |
Sim |
Workflow/1/MaxCompute/Folder 1/Folder 2 |
Caminho do arquivo. |
|
ProjectId |
Long |
Sim |
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 ProjectIdentifier para identificar o workspace do DataWorks onde a operação será aplicada. |
|
FileName |
String |
Sim |
Nome do arquivo |
Nome do arquivo. |
|
FileDescription |
String |
Não |
Descrição do arquivo |
Descrição do arquivo. |
|
FileType |
Integer |
Sim |
10 |
Tipo de código do arquivo. Valores válidos: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 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). Chame a operação ListFileType para consultar o tipo de código do arquivo. |
|
Owner |
String |
Não |
1000000000001 |
ID da conta Alibaba Cloud do proprietário do arquivo. Se este parâmetro não for configurado, o sistema usará por padrão o ID da conta Alibaba Cloud do usuário que chama a operação. |
|
Content |
String |
Não |
SHOW TABLES; |
Código do arquivo. O formato varia conforme o tipo de arquivo. Para visualizar o formato de um tipo específico, acesse o Operation Center, localize um nó desse tipo e abra o grafo acíclico direcionado (DAG) correspondente. Clique com o botão direito no nó no DAG e selecione View Code. |
|
AutoRerunTimes |
Integer |
Não |
3 |
Número de reexecuções automáticas permitidas após erro. Valor máximo: 10. |
|
AutoRerunIntervalMillis |
Integer |
Não |
120000 |
Intervalo entre reexecuções automáticas após erro. Unidade: milissegundos. Valor máximo: 1800000 (30 minutos). 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. Atenha-se à conversão de unidades de tempo ao chamar a operação. |
|
RerunMode |
String |
Não |
ALL_ALLOWED |
Define se o nó correspondente ao arquivo pode ser reexecutado. Valores válidos:
Este parâmetro corresponde ao parâmetro Rerun na seção Schedule da aba Properties no console do DataWorks. |
|
Stop |
Boolean |
Não |
false |
Define se o agendamento do nó deve ser suspenso. Valores válidos:
Este parâmetro corresponde ao parâmetro Recurrence na seção Schedule da aba Properties no console do DataWorks. |
|
ParaValue |
String |
Não |
a=x b=y |
Parâmetros de agendamento do nó. Separe múltiplos parâmetros com espaços. Este parâmetro corresponde à seção Parameters da aba Properties no console do DataWorks. Para mais informações sobre configurações de parâmetros de agendamento, consulte Configurar parâmetros de agendamento. |
|
StartEffectDate |
Long |
Não |
1671608450000 |
Hora de início do agendamento automático. Defina o valor como um timestamp UNIX representando os milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Configurar este parâmetro equivale a definir uma hora de início para o parâmetro Validity Period na seção Schedule da aba Properties no console do DataWorks. |
|
EndEffectDate |
Long |
Não |
1671694850000 |
Hora de término do agendamento automático. Defina o valor como um timestamp UNIX representando os milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Configurar este parâmetro equivale a definir uma hora de término para o parâmetro Validity Period na seção Schedule da aba Properties no console do DataWorks. |
|
CronExpress |
String |
Não |
00 05 00 ? |
Expressão CRON que define a política de agendamento periódico do nó. Corresponde ao parâmetro Cron Expression na seção Schedule da aba Properties no console do DataWorks. Após configurar Scheduling Cycle e Run At no console, o sistema gera o valor de Cron Expression. Exemplos:
O sistema de agendamento do DataWorks impõe os seguintes limites às expressões CRON:
|
|
CycleType |
String |
Não |
DAY |
Tipo de ciclo de agendamento. Valores válidos: NOT_DAY e DAY. NOT_DAY indica agendamento por minuto ou hora. DAY indica agendamento por dia, semana ou mês. Corresponde ao parâmetro Scheduling Cycle na seção Schedule da aba Properties no console do DataWorks. |
|
DependentType |
String |
Não |
NONE |
Tipo de dependência de agendamento entre ciclos do nó. Valores válidos:
|
|
DependentNodeIdList |
String |
Não |
abc |
IDs dos nós que geram instâncias no ciclo anterior das quais o nó atual depende. |
|
InputList |
String |
Sim |
project_root,project.file1,project.001_out |
Nome de saída do arquivo pai do qual o arquivo atual depende. Separe múltiplos nomes de saída por vírgulas (,). Corresponde ao parâmetro Output Name of Ancestor Node, exibido após selecionar Same Cycle na seção Dependencies da aba Properties no console do DataWorks. |
|
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. Configure este parâmetro ou ProjectId para identificar o workspace do DataWorks onde a operação será aplicada. |
|
ResourceGroupIdentifier |
String |
Não |
group_375827434852437 |
Identificador do grupo de recursos usado para executar o nó. Chame a operação ListResourceGroups para consultar os grupos disponíveis no workspace. O parâmetro Identifier na resposta indica o identificador de um grupo de recursos disponível. |
|
ResourceGroupId |
Long |
Não |
375827434852437 |
Parâmetro obsoleto. Não utilize. ID do grupo de recursos usado para executar o nó. Corresponde ao parâmetro Resource Group na seção Resource Group da aba Properties no console do DataWorks. Configure este parâmetro ou ResourceGroupIdentifier para determinar o grupo de recursos de execução. Chame a operação ListResourceGroups para consultar os grupos disponíveis no workspace. Ao chamar a operação, defina ResourceGroupType como 1. O parâmetro de resposta Id indica o ID de um grupo de recursos disponível. |
|
ConnectionName |
String |
Não |
odps_source |
Nome da fonte de dados usada pelo nó. Chame a operação UpdateDataSource para consultar as fontes de dados disponíveis no workspace. |
|
AutoParsing |
Boolean |
Não |
true |
Define se a análise automática deve ser ativada para o arquivo. Valores válidos:
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. |
|
SchedulerType |
String |
Não |
NORMAL |
Tipo de agendamento do nó. Valores válidos:
|
|
AdvancedSettings |
String |
Não |
{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"} |
Configurações avançadas do nó. Válido apenas para nós EMR Spark Streaming ou EMR Streaming SQL. Corresponde à aba Advanced Settings do nó no console do DataWorks. O valor deve estar no formato JSON. |
|
StartImmediately |
Boolean |
Não |
true |
Define se o nó deve ser executado imediatamente após a implantação no ambiente de produção. Válido apenas para nós EMR Spark Streaming ou EMR Streaming SQL. Corresponde ao parâmetro Start Method na seção Schedule da aba Configure no console do DataWorks. |
|
InputParameters |
String |
Não |
[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}] |
Parâmetros de entrada do nó. O valor deve estar no formato JSON. Para mais informações, consulte o parâmetro InputContextParameterList na seção Response parameters da operação GetFile. Corresponde à tabela Input Parameters na seção Input and Output Parameters da aba Properties no console do DataWorks. |
|
OutputParameters |
String |
Não |
[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}] |
Parâmetros de saída do nó. O valor deve estar no formato JSON. Para mais informações, consulte o parâmetro OutputContextParameterList na seção Response parameters da operação GetFile. Corresponde à tabela Output Parameters na seção Input and Output Parameters da aba Properties no console do DataWorks. |
|
IgnoreParentSkipRunningProperty |
Boolean |
Não |
false |
Define se a propriedade de execução simulada (dry-run) do ciclo anterior deve ser utilizada. Valores válidos:
|
|
CreateFolderIfNotExists |
Boolean |
Não |
false |
Define se o diretório especificado por FileFolderPath deve ser criado automaticamente caso não exista. Valores válidos: true: cria o diretório automaticamente se ele não existir. false: não cria o diretório automaticamente. Nesse caso, a chamada falha. |
Parâmetros de resposta
|
Parâmetro |
Tipo |
Exemplo |
Descrição |
|
HttpStatusCode |
Integer |
200 |
Código de status HTTP. |
|
Data |
Long |
1000001 |
ID do arquivo criado. |
|
RequestId |
String |
0000-ABCD-EFG |
ID da solicitação. |
|
ErrorMessage |
String |
The connection does not exist. |
Mensagem de erro. |
|
Success |
Boolean |
true |
Indica se a solicitação foi bem-sucedida. Valores válidos:
|
|
ErrorCode |
String |
Invalid.Tenant.ConnectionNotExists |
Código de erro. |
Exemplos
Exemplos de solicitações
http(s)://[Endpoint]/?Action=CreateFile
&FileFolderPath=Workflow/1/MaxCompute/Folder 1/Folder 2
&ProjectId=10000
&FileName=File name
&FileDescription=File description
&FileType=10
&Owner=1000000000001
&Content=SHOW TABLES;
&AutoRerunTimes=3
&AutoRerunIntervalMillis=120000
&RerunMode=ALL_ALLOWED
&Stop=false
&ParaValue=a=x b=y
&StartEffectDate=1671608450000
&EndEffectDate=1671694850000
&CronExpress=00 05 00 * * ?
&CycleType=DAY
&DependentType=NONE
&DependentNodeIdList=abc
&InputList=project_root,project.file1,project.001_out
&ProjectIdentifier=dw_project
&ResourceGroupIdentifier=group_375827434852437
&ResourceGroupId=375827434852437
&ConnectionName=odps_source
&AutoParsing=true
&SchedulerType=NORMAL
&AdvancedSettings={"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}
&StartImmediately=true
&InputParameters=[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]
&OutputParameters=[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]
&IgnoreParentSkipRunningProperty=false
&CreateFolderIfNotExists=false
&<Common request parameters>
Exemplos de respostas de sucesso
Formato XML
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateFileResponse>
<HttpStatusCode>200</HttpStatusCode>
<Data>1000001</Data>
<RequestId>0000-ABCD-EFG</RequestId>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
</CreateFileResponse>
Formato JSON
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"Data" : 1000001,
"RequestId" : "0000-ABCD-EFG",
"ErrorMessage" : "The connection does not exist.",
"Success" : true,
"ErrorCode" : "Invalid.Tenant.ConnectionNotExists"
}
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 permitido. |
|
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. |
Frequência de solicitações excessiva. 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.