CreateFile - - Centro de documentación de Alibaba Cloud

Crea un archivo en DataStudio. Esta operación no permite crear archivos para nodos de Data Integration.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda ejecutar esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	CreateFile	La operación que desea realizar. Establezca el valor en CreateFile.
FileFolderPath	String	Sí	Workflow/1/MaxCompute/Folder 1/Folder 2	La ruta del archivo.
ProjectId	Long	Sí	10000	El ID del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Workspace para obtener el ID. Debe configurar este parámetro o ProjectIdentifier para determinar el espacio de trabajo de DataWorks al que se aplica la operación.
FileName	String	Sí	Nombre del archivo	El nombre del archivo.
FileDescription	String	No	Descripción del archivo	La descripción del archivo.
FileType	Integer	Sí	10	El tipo de código del archivo. Valores válidos: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 24 (ODPS Script), 99 (carga cero), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (inspección de objetos OSS), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (sincronización en tiempo real), 1089 (colaboración entre inquilinos), 1091 (desarrollo Hologres), 1093 (Hologres SQL), 1100 (asignación) y 1221 (PyODPS 3). Puede llamar a la operación ListFileType para consultar el tipo de código del archivo.
Owner	String	No	1000000000001	El ID de la cuenta de Alibaba Cloud del propietario del archivo. Si no se configura este parámetro, se usa de forma predeterminada el ID de la cuenta de Alibaba Cloud del usuario que ejecuta la operación.
Content	String	No	SHOW TABLES;	El código del archivo. El formato del código varía según el tipo de archivo. Para ver el formato de código de un tipo específico, vaya a Operation Center, busque un nodo de ese tipo y abra el grafo acíclico dirigido (DAG) del nodo. Haga clic con el botón derecho en el nodo dentro del DAG y seleccione View Code.
AutoRerunTimes	Integer	No	3	El número de reejecuciones automáticas permitidas tras un error. Valor máximo: 10.
AutoRerunIntervalMillis	Integer	No	120000	El intervalo entre reejecuciones automáticas después de que ocurre un error. Unidad: milisegundos. Valor máximo: 1800000 (30 minutos). Este parámetro corresponde al parámetro Rerun Interval que se muestra después de seleccionar la casilla Auto Rerun upon Error en la sección Schedule de la pestaña Properties en la consola de DataWorks. El intervalo que se especifica en la consola de DataWorks se mide en minutos. Preste atención a la conversión entre unidades de tiempo al llamar a la operación.
RerunMode	String	No	ALL_ALLOWED	Especifica si el nodo correspondiente al archivo puede reejecutarse. Valores válidos: ALL_ALLOWED: El nodo puede reejecutarse independientemente de si se ejecuta correctamente o falla. FAILURE_ALLOWED: El nodo solo puede reejecutarse después de fallar. ALL_DENIED: El nodo no puede reejecutarse bajo ninguna circunstancia, haya sido exitoso o haya fallado. Este parámetro corresponde al parámetro Rerun en la sección Schedule de la pestaña Properties en la consola de DataWorks.
Stop	Boolean	No	false	Especifica si se debe suspender la programación del nodo. Valores válidos: true false Este parámetro corresponde al parámetro Recurrence en la sección Schedule de la pestaña Properties en la consola de DataWorks.
ParaValue	String	No	a=x b=y	Los parámetros de programación del nodo. Separe varios parámetros con espacios. Este parámetro corresponde a la sección Parameters de la pestaña Properties en la consola de DataWorks. Para obtener más información sobre las configuraciones de los parámetros de programación, consulte Configure scheduling parameters.
StartEffectDate	Long	No	1671608450000	La hora de inicio de la programación automática. Establezca el valor como una marca de tiempo UNIX que represente el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC. Configurar este parámetro equivale a especificar una hora de inicio para el parámetro Validity Period en la sección Schedule de la pestaña Properties en la consola de DataWorks.
EndEffectDate	Long	No	1671694850000	La hora de finalización de la programación automática. Establezca el valor como una marca de tiempo UNIX que represente el número de milisegundos transcurridos desde el 1 de enero de 1970, 00:00:00 UTC. Configurar este parámetro equivale a especificar una hora de finalización para el parámetro Validity Period en la sección Schedule de la pestaña Properties en la consola de DataWorks.
CronExpress	String	No	00 05 00 ?	La expresión CRON que representa la política de programación periódica del nodo. Este parámetro corresponde al parámetro Cron Expression en la sección Schedule de la pestaña Properties en la consola de DataWorks. Después de configurar los parámetros Scheduling Cycle y Run At en la consola de DataWorks, el sistema genera el valor del parámetro Cron Expression. Ejemplos: Expresión CRON para un nodo programado para ejecutarse a las 05:30 todos los días: `00 30 05 ?` Expresión CRON para un nodo programado para ejecutarse en el minuto quince de cada hora: `00 15 00-23/1 ?` Expresión CRON para un nodo programado para ejecutarse cada 10 minutos: `00 00/10 * ?` Expresión CRON para un nodo programado para ejecutarse cada 10 minutos de 08:00 a 17:00 todos los días: `00 00-59/10 8-17 * ?` Expresión CRON para un nodo programado para ejecutarse a las 00:20 el primer día de cada mes: `00 20 00 1 * ?` Expresión CRON para un nodo programado para ejecutarse cada tres meses a partir de las 00:10 del 1 de enero: `00 10 00 1 1-12/3 ?` Expresión CRON para un nodo programado para ejecutarse a las 00:05 cada martes y viernes: `00 05 00 2.5` El sistema de programación de DataWorks impone los siguientes límites a las expresiones CRON: El intervalo mínimo especificado en una expresión CRON para programar un nodo es de 5 minutos. La hora más temprana especificada en una expresión CRON para programar un nodo diariamente es las 00:05.
CycleType	String	No	DAY	El tipo de ciclo de programación. Valores válidos: NOT_DAY y DAY. El valor NOT_DAY indica que el nodo se programa por minuto u hora. El valor DAY indica que el nodo se programa por día, semana o mes. Este parámetro corresponde al parámetro Scheduling Cycle en la sección Schedule de la pestaña Properties en la consola de DataWorks.
DependentType	String	No	NONE	El tipo de dependencia de programación entre ciclos del nodo. Valores válidos: SELF: La instancia generada para el nodo en el ciclo actual depende de la instancia generada para el nodo en el ciclo anterior. CHILD: La instancia generada para el nodo en el ciclo actual depende de las instancias generadas para los nodos descendientes en el nivel más cercano del nodo en el ciclo anterior. USER_DEFINE: La instancia generada para el nodo en el ciclo actual depende de las instancias generadas para uno o más nodos especificados en el ciclo anterior. NONE: No se ha seleccionado ningún tipo de dependencia de programación entre ciclos para el nodo. USER_DEFINE_AND_SELF: La instancia generada para el nodo en el ciclo actual depende de la instancia generada para el nodo en el ciclo anterior y de las instancias generadas para uno o más nodos especificados en el ciclo anterior. CHILD_AND_SELF: La instancia generada para el nodo en el ciclo actual depende de las instancias generadas para los nodos descendientes en el nivel más cercano del nodo en el ciclo anterior y de la instancia generada para el nodo en el ciclo anterior.
DependentNodeIdList	String	No	abc	Los ID de los nodos que generan instancias en el ciclo anterior de las cuales depende el nodo actual.
InputList	String	Sí	project_root,project.file1,project.001_out	El nombre de salida del archivo padre del cual depende el archivo actual. Si especifica varios nombres de salida, sepárelos con comas (,). Este parámetro corresponde al parámetro Output Name of Ancestor Node que se muestra después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la consola de DataWorks.
ProjectIdentifier	String	No	dw_project	El nombre del espacio de trabajo de DataWorks. Inicie sesión en la consola de DataWorks y vaya a la página Workspace para obtener el nombre del espacio de trabajo. Debe configurar este parámetro o ProjectId para determinar el espacio de trabajo de DataWorks al que se aplica la operación.
ResourceGroupIdentifier	String	No	group_375827434852437	El identificador del resource group que se utiliza para ejecutar el nodo. Puede llamar a la operación ListResourceGroups para consultar los resource groups disponibles en el espacio de trabajo. El parámetro Identifier en la respuesta de la operación indica el identificador de un resource group disponible.
ResourceGroupId	Long	No	375827434852437	Este parámetro está obsoleto. No lo utilice. El ID del resource group que se utiliza para ejecutar el nodo. Este parámetro corresponde al parámetro Resource Group en la sección Resource Group de la pestaña Properties en la consola de DataWorks. Debe configurar este parámetro o ResourceGroupIdentifier para determinar el resource group que se usará para ejecutar el nodo. Puede llamar a la operación ListResourceGroups para consultar los resource groups disponibles en el espacio de trabajo. Al llamar a la operación, establezca ResourceGroupType en 1. El parámetro de respuesta Id indica el ID de un resource group disponible.
ConnectionName	String	No	odps_source	El nombre del origen de datos para el cual se ejecuta el nodo. Puede llamar a la operación UpdateDataSource para consultar los orígenes de datos disponibles en el espacio de trabajo.
AutoParsing	Boolean	No	true	Especifica si se debe habilitar la función de análisis automático para el archivo. Valores válidos: true false Este parámetro corresponde al parámetro Automatic Parsing From Code Before Node Committing que se muestra después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la consola de DataWorks.
SchedulerType	String	No	NORMAL	El tipo de programación del nodo. Valores válidos: NORMAL: El nodo es un nodo de activación automática. MANUAL: El nodo es un nodo de activación manual. Los nodos de activación manual no pueden activarse automáticamente. Corresponden a los nodos en el panel Manually Triggered Workflows. PAUSE: El nodo es un nodo pausado. SKIP: El nodo es un nodo de ejecución simulada. Los nodos de ejecución simulada se inician según lo programado, pero el sistema establece su estado como exitoso al comenzar a ejecutarlos.
AdvancedSettings	String	No	{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}	Las configuraciones avanzadas del nodo. Este parámetro solo es válido para un nodo EMR Spark Streaming o un nodo EMR Streaming SQL. Corresponde a la pestaña Advanced Settings del nodo en la consola de DataWorks. El valor de este parámetro debe estar en formato JSON.
StartImmediately	Boolean	No	true	Especifica si se debe ejecutar inmediatamente un nodo después de desplegarlo en el entorno de producción. Este parámetro solo es válido para un nodo EMR Spark Streaming o un nodo EMR Streaming SQL. Corresponde al parámetro Start Method en la sección Schedule de la pestaña Configure en la consola de DataWorks.
InputParameters	String	No	[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]	Los parámetros de entrada del nodo. El valor de este parámetro debe estar en formato JSON. Para obtener más información sobre los parámetros de entrada, consulte el parámetro InputContextParameterList en la sección Response parameters de la operación GetFile. Este parámetro corresponde a la tabla Input Parameters en la sección Input and Output Parameters de la pestaña Properties en la consola de DataWorks.
OutputParameters	String	No	[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]	Los parámetros de salida del nodo. El valor de este parámetro debe estar en formato JSON. Para obtener más información sobre los parámetros de salida, consulte el parámetro OutputContextParameterList en la sección Response parameters de la operación GetFile. Este parámetro corresponde a la tabla Output Parameters en la sección Input and Output Parameters de la pestaña Properties en la consola de DataWorks.
IgnoreParentSkipRunningProperty	Boolean	No	false	Especifica si se debe usar la propiedad de ejecución simulada del ciclo anterior. Valores válidos: true false
CreateFolderIfNotExists	Boolean	No	false	Especifica si se debe crear automáticamente el directorio especificado por el parámetro FileFolderPath si este no existe. Valores válidos: true: El sistema crea automáticamente el directorio si no existe. false: El sistema no crea automáticamente el directorio si no existe. En este caso, la llamada falla.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	Integer	200	El código de estado HTTP.
Data	Long	1000001	El ID del archivo creado.
RequestId	String	0000-ABCD-EFG	El ID de la solicitud.
ErrorMessage	String	The connection does not exist.	El mensaje de error.
Success	Boolean	true	Indica si la solicitud fue exitosa. Valores válidos: true false
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	El código de error.

Ejemplos

Solicitudes de ejemplo

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>

Respuestas exitosas de ejemplo

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
429	Throttling.Api	The request for this resource has exceeded your available limit.	El número de solicitudes para el recurso ha excedido el límite superior.
429	Throttling.System	The DataWorks system is busy. Try again later.	El sistema de DataWorks está ocupado. Inténtelo de nuevo más tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Se han enviado demasiadas solicitudes en un periodo corto. Inténtelo de nuevo más tarde.
500	InternalError.System	An internal system error occurred. Try again later.	Ha ocurrido un error interno. Inténtelo de nuevo más tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ha ocurrido un error interno. Inténtelo de nuevo más tarde.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.