GetFile - DataWorks - Centro de documentación de Alibaba Cloud

Obtiene los detalles de un archivo.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectId	integer	No	El ID del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks y acceder a la página de configuración del espacio de trabajo para obtener el ID del espacio de trabajo. Debe especificar este parámetro o el parámetro ProjectIdentifier para identificar el espacio de trabajo de DataWorks para esta llamada a la API.	10000
ProjectIdentifier	string	No	El nombre del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks y acceder a la página de configuración del espacio de trabajo para obtener el nombre del espacio de trabajo. Debe especificar este parámetro o el parámetro ProjectId para identificar el espacio de trabajo de DataWorks para esta llamada a la API.	dw_project
FileId	integer	No	El ID del archivo. Puede invocar la API ListFiles para consultar el ID del archivo correspondiente.	100000001
NodeId	integer	No	El ID del nodo de programación. Puede invocar la API ListFiles para obtener el ID del nodo.	200000001

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
HttpStatusCode	integer	Código de estado HTTP.	200
ErrorMessage	string	Mensaje de error.	The connection does not exist.
RequestId	string	ID de solicitud. Se utiliza para la solución de problemas cuando ocurre un error.	0000-ABCD-EFG****
ErrorCode	string	Código de error.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica si la invocación se realizó correctamente. Valores válidos: true: La invocación se realizó correctamente. false: Error en la invocación.	true
Data	object	Detalles del archivo.
File	object	Información básica sobre el archivo.
CommitStatus	integer	El estado de confirmación actual del archivo. Valores válidos: 0: El código más reciente no se ha enviado. 1: El código más reciente se ha enviado.	0
AutoParsing	boolean	Indica si el análisis automático está habilitado para el archivo. Valores válidos: true: El código del archivo se analiza automáticamente. false: El código del archivo no se analiza automáticamente. Este parámetro corresponde a la opción "Análisis de código" en la consola de DataWorks (https://dataworks.console.alibabacloud.com/console) cuando selecciona "Mismo ciclo" en Configuración de programación > Dependencia de programación para un trabajo de desarrollo de datos.	true
Owner	string	ID de usuario de Alibaba Cloud del propietario del archivo.	7775674356****
CreateTime	integer	Marca de tiempo UNIX en la que se creó el archivo, en milisegundos.	1593879116000
FileType	integer	El tipo de código del archivo. Los distintos tipos de archivo utilizan diferente código. Para obtener más información, consulte Nodos de DataWorks.	10
CurrentVersion	integer	Número de versión de la última versión enviada del archivo.	3
BizId	integer	El ID del proceso de negocio al que pertenece el archivo. Este campo está obsoleto. Utilice el campo BusinessId en su lugar.	1000001
LastEditUser	string	El ID de usuario de Alibaba Cloud del usuario que editó el archivo por última vez.	424732****
FileName	string	Nombre del archivo.	ods_user_info_d
ConnectionName	string	El nombre del origen de datos utilizado al ejecutar el trabajo correspondiente al archivo.	odps_source
UseType	string	El módulo de función al que pertenece el archivo. Valores válidos: NORMAL: Data Studio. MANUAL: Tarea activada manualmente. MANUAL_BIZ: Flujo de trabajo activado manualmente. SKIP: Programación de ejecución de prueba en Data Studio. ADHOCQUERY: Consulta ad hoc. COMPONENT: Gestión de componentes.	NORMAL
FileFolderId	string	El ID de la carpeta a la que pertenece el archivo.	2735c2****
ParentId	integer	Si el archivo actual es un archivo interno de un archivo de nodo combinado, este campo identifica el ID del archivo de nodo combinado correspondiente.	-1
CreateUser	string	El ID de usuario de Alibaba Cloud del creador del archivo.	424732****
IsMaxCompute	boolean	Indica si el archivo de recursos debe cargarse en MaxCompute. Configure este parámetro solo cuando el archivo sea un archivo de recursos de MaxCompute.	true
BusinessId	integer	El ID del proceso de negocio del archivo.	1000001
FileDescription	string	La descripción del archivo.	My first DataWorks file
DeletedStatus	string	El estado de eliminación del archivo. Valores válidos: NORMAL: No eliminado. RECYCLE_BIN: En la papelera de reciclaje. DELETED: Eliminado.	RECYCLE
LastEditTime	integer	La marca de tiempo UNIX de la edición más reciente del archivo, en milisegundos.	1593879116000
Content	string	El código del archivo.	SHOW TABLES;
NodeId	integer	El ID de la tarea de programación generada en el sistema de programación después de enviar el archivo.	300001
AdvancedSettings	string	Configuración avanzada del trabajo. Este parámetro corresponde a "Configuración avanzada" en la barra de navegación derecha en la página de edición de un trabajo de desarrollo de datos de EMR en la consola de DataWorks. Nota Actualmente, los trabajos de EMR Shell no admiten parámetros avanzados. Para obtener detalles sobre los parámetros avanzados para los diferentes tipos de trabajos de EMR, consulte Desarrollo de trabajos de EMR.	{\"priority\":\"1\",\"ENABLE_SPARKSQL_JDBC\":false,\"FLOW_SKIP_SQL_ANALYZE\":false,\"queue\":\"default\"}
FileId	integer	El ID del archivo.	100000001
NodeConfiguration	object	La configuración de programación del archivo.
RerunMode	string	Propiedad de reejecución. Valores válidos: ALL_ALLOWED: El trabajo se puede reejecutar independientemente de si previamente se realizó correctamente o falló. FAILURE_ALLOWED: El trabajo no se puede reejecutar si previamente se realizó correctamente, pero se puede reejecutar si previamente falló. ALL_DENIED: El trabajo no se puede reejecutar independientemente de si previamente se realizó correctamente o falló. Este parámetro corresponde a la configuración "Configuración de programación > Propiedades de tiempo > Propiedad de reejecución" para un trabajo de desarrollo de datos en la consola de DataWorks.	ALL_ALLOWED
SchedulerType	string	El tipo de programación. Valores válidos: NORMAL: Tarea de programación normal. MANUAL: Tarea activada manualmente, que no se incluye en la programación regular y corresponde a un nodo en un flujo de trabajo activado manualmente. PAUSE: Tarea en pausa. SKIP: Tarea de ejecución de prueba, que se incluye en la programación regular pero se marca inmediatamente como completada correctamente al programarse.	NORMAL
Stop	boolean	Indica si se debe pausar la programación. Valores válidos: true: Pausar la programación. false: No pausar la programación. Este parámetro corresponde a la configuración "Tipo de programación" en "Configuración de programación > Propiedades de tiempo" para un trabajo de desarrollo de datos en la consola de DataWorks, cuando se establece en "pausar programación".	false
ParaValue	string	Parámetro de programación. Este parámetro corresponde a la configuración "Configuración de programación > Parámetros" para un trabajo de desarrollo de datos en la consola de DataWorks. Puede consultar la documentación de Parámetros de programación para obtener detalles de configuración.	a=x b=y
StartEffectDate	integer	La marca de tiempo UNIX (en milisegundos) que indica cuándo comienza la programación automática. Este parámetro corresponde a la hora de inicio (como marca de tiempo UNIX en milisegundos) configurada en "Configuración de programación > Propiedades de tiempo > Fecha de vigencia" para un trabajo de desarrollo de datos en la consola de DataWorks.	936923400000
EndEffectDate	integer	La marca de tiempo UNIX, en milisegundos, en la que se detiene la programación automática. Este parámetro corresponde a la marca de tiempo UNIX en milisegundos de la hora de finalización configurada en la configuración "Configuración de programación > Propiedades de tiempo > Fecha de vigencia" para un trabajo de desarrollo de datos en la consola de DataWorks.	4155787800000
CycleType	string	El tipo de ciclo de programación, que incluye NOT_DAY (minuto, hora) y DAY (día, semana, mes). Este parámetro corresponde a "Configuración de programación > Propiedades de tiempo > Ciclo de programación" para un trabajo de desarrollo de datos en la consola de DataWorks.	DAY
DependentNodeIdList	string	Cuando el parámetro DependentType se establece en USER_DEFINE, este parámetro especifica los ID de los nodos de los que depende el archivo actual. Separe varios ID de nodo con comas (,). Este parámetro corresponde a la configuración cuando, en la consola de DataWorks, la "Configuración de programación > Dependencia de programación" de un trabajo de desarrollo de datos se establece en "Ciclo anterior" y la opción de dependencia se establece en "Otros nodos".	5,10,15,20
ResourceGroupId	integer	El grupo de recursos utilizado cuando el archivo se publica como trabajo y se ejecuta. Puede llamar a ListResourceGroups para obtener la lista de grupos de recursos disponibles en el espacio de trabajo.	375827434852437
DependentType	string	El método de dependencia del ciclo anterior. Valores válidos: SELF: La dependencia es el propio nodo actual. CHILD: La dependencia son los nodos secundarios directos. USER_DEFINE: La dependencia son otros nodos especificados. NONE: No se selecciona ninguna dependencia, lo que significa que el nodo no depende del ciclo anterior.	USER_DEFINE
AutoRerunTimes	integer	El número de reejecuciones automáticas después de un error.	3
AutoRerunIntervalMillis	integer	El intervalo de tiempo entre reejecuciones automáticas después de un error, en milisegundos. Este parámetro corresponde a la configuración "Intervalo de reejecución" en "Configuración de programación > Propiedades de tiempo > Reejecución automática en caso de error" para un trabajo de desarrollo de datos en la consola de DataWorks. Tenga en cuenta que la unidad de tiempo para el "Intervalo de reejecución" en la consola es minutos; convierta el tiempo en consecuencia al invocar la API.	120000
CronExpress	string	La expresión Cron para la programación temporizada del archivo.	00 05 00 * * ?
InputList	array<object>	Información sobre las salidas de los archivos precedentes de los que depende este archivo.
	object	Información sobre las salidas de los archivos precedentes de los que depende este archivo.
Input	string	El nombre de salida del archivo precedente del que depende este archivo. Este parámetro corresponde a "Nombre de salida del nodo primario" cuando se selecciona "Mismo ciclo" en "Configuración de programación > Dependencia de programación" para un trabajo de desarrollo de datos en la consola de DataWorks.	project.001_out
ParseType	string	El método para configurar las dependencias de archivos. Valores válidos: MANUAL: Configurado manualmente. AUTO: Analizado automáticamente.	MANUAL
OutputList	array<object>	Información de salida del archivo.
	object	Información de salida del archivo.
RefTableName	string	Valor de salida del archivo. Este parámetro corresponde al valor en la columna "Tabla de salida" cuando se selecciona "Mismo ciclo" en "Configuración de programación > Dependencia de programación" para un trabajo de desarrollo de datos en la consola de DataWorks.	ods_user_info_d
Output	string	Nombre de salida del archivo. Este parámetro corresponde al valor en la columna "Nombre de salida" cuando se selecciona "Mismo ciclo" en "Configuración de programación > Dependencia de programación" para un trabajo de desarrollo de datos en la consola de DataWorks.	dw_project.002_out
StartImmediately	boolean	Indica si se debe iniciar inmediatamente después de la publicación. Este parámetro corresponde a la configuración "Método de inicio" en "Configuración > Propiedades de tiempo" en la barra de navegación derecha en la página de edición para los trabajos de desarrollo de datos de EMR Spark Streaming y EMR Streaming SQL en la consola de DataWorks.	true
InputParameters	array<object>	Resultado devuelto.
	object	Resultado devuelto.
ParameterName	string	El nombre del parámetro de entrada en el contexto del nodo. Puede hacer referencia a este parámetro en el código mediante la sintaxis ${...}. Este parámetro corresponde al campo "Nombre del parámetro" en "Configuración de programación > Contexto del nodo > Parámetros de entrada de este nodo" en la consola de DataWorks.	input
ValueSource	string	El origen del valor del parámetro de entrada en el contexto del nodo. Este parámetro corresponde al campo "Origen del valor" en "Configuración de programación > Contexto del nodo > Parámetros de entrada de este nodo" en la consola de DataWorks.	project_001.parent_node:outputs
OutputParameters	array<object>	Resultado devuelto.
	object	Resultado devuelto.
ParameterName	string	El nombre del parámetro de salida en el contexto del nodo. Este parámetro corresponde al campo "Nombre del parámetro" en "Configuración de programación > Contexto del nodo > Parámetros de salida de este nodo" para un trabajo de desarrollo de datos en la consola de DataWorks.	output
Value	string	La expresión del parámetro de salida en el contexto del nodo. Este parámetro corresponde al campo "Valor" en la sección "Configuración de programación > Contexto del nodo > Parámetros de salida de este nodo" para un trabajo de desarrollo de datos en la consola de DataWorks.	${bizdate}
Type	string	El tipo de expresión para el parámetro de salida del contexto del nodo. Los valores válidos son los siguientes: 1: constante 2: variable 3: variable de transferencia desde un nodo de parámetros Este parámetro corresponde al campo "Tipo" en la sección "Configuración de programación > Contexto del nodo > Parámetros de salida de este nodo" para un trabajo de desarrollo de datos en la consola de DataWorks.	1
Description	string	La descripción del parámetro de salida en el contexto del nodo.	It's a context output parameter.
ApplyScheduleImmediately	string	Indica si se debe aplicar la configuración de programación inmediatamente después de la publicación.	true
IgnoreParentSkipRunningProperty	string	Configuración de programación > Ciclo anterior > Si se debe ignorar la propiedad de ejecución de prueba precedente.	true
Timeout	integer	Definición de tiempo de espera para la configuración de programación.	1
ImageId	string	ID de imagen personalizada.	m-bp1h4b5a8ogkbll2f3tr
ResourceDownloadLink	object	Enlace de descarga de recursos.
downloadLink	string	Enlace para descargar el recurso.	http://xx

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "ErrorMessage": "La conexión no existe",
  "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": "Mi primer archivo de DataWorks",
      "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": "Es un parámetro de salida de contexto"
        }
      ],
      "ApplyScheduleImmediately": "true",
      "IgnoreParentSkipRunningProperty": "true",
      "Timeout": 1,
      "ImageId": "m-bp1h4b5a8ogkbll2f3tr"
    },
    "ResourceDownloadLink": {
      "downloadLink": "http://xx"
    }
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
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.	Acceso denegado. Autorice primero.
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 error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.