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

Consulta la información 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

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dataworks:*

get

*All Resource

*

Ninguna

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 dirigirse a la página de Administración de espacios de trabajo para obtener el ID del espacio de trabajo. Debe configurar este parámetro o el parámetro ProjectIdentifier para determinar el espacio de trabajo de DataWorks al que se aplica la operación.	10000
ProjectIdentifier	string	No	El nombre del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks y dirigirse a la página de Administración de espacios de trabajo para obtener el nombre del espacio de trabajo. Debe configurar este parámetro o el parámetro ProjectId para determinar el espacio de trabajo de DataWorks al que se aplica la operación.	dw_project
FileId	integer	No	El ID del archivo. Puede llamar a la operación ListFiles para obtener el ID.	100000001
NodeId	integer	No	El ID del nodo programado. Puede llamar a la operación ListFiles para obtener el ID del nodo.	200000001

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
HttpStatusCode	integer	El código de estado HTTP devuelto.	200
ErrorMessage	string	El mensaje de error devuelto.	The connection does not exist.
RequestId	string	El ID de la solicitud. Puede utilizar el ID para solucionar problemas.	0000-ABCD-EFG****
ErrorCode	string	El código de error devuelto.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realiza correctamente. false: La solicitud falla.	true
Data	object	Los detalles del archivo.
File	object	La información básica del archivo.
CommitStatus	integer	Indica si se ha confirmado el código más reciente en el archivo. Valores válidos: 0 y 1. El valor 0 indica que el código más reciente del archivo no está confirmado. El valor 1 indica que el código más reciente del archivo está confirmado.	0
AutoParsing	boolean	Indica si la función de análisis automático está habilitada para el archivo. Valores válidos: true: La función de análisis automático está habilitada para el archivo. false: La función de análisis automático no está habilitada para el archivo. Este parámetro corresponde al parámetro Analizar código que se muestra después de seleccionar Mismo ciclo en la sección Dependencias de la pestaña Propiedades en la consola de DataWorks.	true
Owner	string	El ID de la cuenta de Alibaba Cloud que utiliza el propietario del archivo.	7775674356****
CreateTime	integer	La hora en que se creó el archivo. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970 a las 00:00:00 UTC.	1593879116000
FileType	integer	El tipo de código del archivo. El código de los archivos varía según el tipo de archivo. Para obtener más información, consulte Nodos de DataWorks.	10
CurrentVersion	integer	El número de la última versión enviada del archivo.	3
BizId	integer	El ID del flujo de trabajo al que pertenece el archivo. Este parámetro está obsoleto y ha sido reemplazado por el parámetro BusinessId.	1000001
LastEditUser	string	El ID de la cuenta de Alibaba Cloud utilizada para modificar el archivo por última vez.	62465892****
FileName	string	El nombre del archivo.	ods_user_info_d
ConnectionName	string	El nombre del origen de datos utilizado para ejecutar la tarea correspondiente al archivo.	odps_source
UseType	string	El módulo al que pertenece el archivo. Valores válidos: NORMAL: El archivo se utiliza para Data Studio. MANUAL: El archivo se utiliza para un nodo activado manualmente. MANUAL_BIZ: El archivo se utiliza para un flujo de trabajo activado manualmente. SKIP: El archivo se utiliza para un nodo de Data Studio de ejecución de prueba. ADHOCQUERY: El archivo se utiliza para una consulta ad hoc. COMPONENT: El archivo se utiliza para la gestión de componentes.	NORMAL
FileFolderId	string	El ID de la carpeta a la que pertenece el archivo.	2735c2****
ParentId	integer	El ID del archivo de grupo de nodos al que pertenece el archivo actual. Este parámetro solo se devuelve si el archivo actual es un archivo interno del archivo de grupo de nodos.	-1
CreateUser	string	El ID de la cuenta de Alibaba Cloud utilizada para crear el archivo.	424732****
IsMaxCompute	boolean	Indica si el archivo debe cargarse en MaxCompute. Este parámetro solo se aplica a los archivos de recursos de MaxCompute.	true
BusinessId	integer	El ID del flujo de trabajo al que pertenece el archivo.	1000001
FileDescription	string	La descripción del archivo.	My first DataWorks file
DeletedStatus	string	El estado del archivo. Valores válidos: NORMAL: El archivo no está eliminado. RECYCLE_BIN: El archivo se encuentra en la papelera de reciclaje. DELETED: El archivo está eliminado.	RECYCLE
LastEditTime	integer	La hora en que se modificó el archivo por última vez. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970 a las 00:00:00 UTC.	1593879116000
Content	string	El código en el archivo.	SHOW TABLES;
NodeId	integer	El ID del nodo activado automáticamente que se genera en el sistema de programación después de confirmar el archivo.	300001
AdvancedSettings	string	Las configuraciones avanzadas del nodo. Este parámetro es válido para un nodo EMR. Este parámetro corresponde a la pestaña Configuración avanzada en el panel de navegación derecho de la pestaña de configuración del nodo en la consola de DataWorks. Nota No puede configurar parámetros avanzados para los nodos EMR Shell. Para obtener información sobre los parámetros avanzados de cada tipo de nodo EMR, consulte Desarrollar tareas de EMR.	{"priority":"1","ENABLE_SPARKSQL_JDBC":false,"FLOW_SKIP_SQL_ANALYZE":false,"queue":"default"}
FileId	integer	El ID del archivo.	100000001
NodeConfiguration	object	Las configuraciones de programación del archivo.
RerunMode	string	Indica si el nodo que corresponde al archivo se puede volver a ejecutar. Valores válidos: ALL_ALLOWED: El nodo se puede volver a ejecutar independientemente de si se ejecuta correctamente o falla. FAILURE_ALLOWED: El nodo solo se puede volver a ejecutar después de que falla. ALL_DENIED: El nodo no se puede volver a ejecutar independientemente de si se ejecuta correctamente o falla. Este parámetro corresponde al parámetro Volver a ejecutar en la sección Programación de la pestaña Propiedades en la consola de DataWorks.	ALL_ALLOWED
SchedulerType	string	El tipo de programación del nodo. Valores válidos: NORMAL: El nodo es un nodo activado automáticamente. MANUAL: El nodo es un nodo activado manualmente. Los nodos activados manualmente no se pueden activar automáticamente. Corresponden a los nodos en el panel Flujos de trabajo activados manualmente. PAUSE: El nodo es un nodo en pausa. SKIP: El nodo es un nodo de ejecución de prueba. Los nodos de ejecución de prueba se inician según lo programado, pero el sistema establece el estado de los nodos como exitoso al comenzar a ejecutarlos.	NORMAL
Stop	boolean	Indica si la programación del nodo está suspendida. Valores válidos: true: La programación del nodo está suspendida. false: La programación del nodo no está suspendida. Este parámetro corresponde al parámetro Recurrencia en la sección Programación de la pestaña Propiedades en la consola de DataWorks.	false
ParaValue	string	Los parámetros de programación del nodo. Este parámetro corresponde a la sección Parámetros de la pestaña Propiedades en la consola de DataWorks. Para obtener más información sobre las configuraciones de los parámetros de programación, consulte Configurar parámetros de programación.	a=x b=y
StartEffectDate	integer	La hora de inicio de la programación automática. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970 a las 00:00:00 UTC. Este parámetro corresponde al parámetro Período de validez en la sección Programación de la pestaña Propiedades en la consola de DataWorks.	936923400000
EndEffectDate	integer	La hora de finalización de la programación automática. Este valor es una marca de tiempo UNIX que representa el número de milisegundos transcurridos desde el 1 de enero de 1970 a las 00:00:00 UTC. Este parámetro corresponde al parámetro Período de validez en la sección Programación de la pestaña Propiedades en la consola de DataWorks.	4155787800000
CycleType	string	El tipo de ciclo de programación. Valores válidos: NOT_DAY y DAY. El valor NOT_DAY indica que el nodo está programado para ejecutarse por minuto u hora. El valor DAY indica que el nodo está programado para ejecutarse por día, semana o mes. Este parámetro corresponde al parámetro Ciclo de programación en la sección Programación de la pestaña Propiedades en la consola de DataWorks.	DAY
DependentNodeIdList	string	El ID del nodo del que depende el nodo correspondiente al archivo cuando el parámetro DependentType se establece en USER_DEFINE. Los ID múltiples se separan con comas (,). El valor de este parámetro es equivalente al ID del nodo que especificó después de seleccionar Ciclo anterior y establecer Dependencia en Otros nodos en la sección Dependencias de la pestaña Propiedades en la consola de DataWorks.	5,10,15,20
ResourceGroupId	integer	El ID del grupo de recursos que se utiliza para ejecutar el nodo. Puede llamar a la operación ListResourceGroups para consultar los grupos de recursos disponibles en el espacio de trabajo.	375827434852437
DependentType	string	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 selecciona ningún tipo de dependencia de programación entre ciclos para el nodo.	USER_DEFINE
AutoRerunTimes	integer	El número de reejecuciones automáticas permitidas después de que ocurre un error.	3
AutoRerunIntervalMillis	integer	El intervalo entre reejecuciones automáticas después de que ocurre un error. Unidad: milisegundos. Este parámetro corresponde al parámetro Intervalo de reejecución que se muestra después de seleccionar la casilla de verificación Reejecución automática tras error en la sección Programación de la pestaña Propiedades en la consola de DataWorks. El intervalo que especifica en la consola de DataWorks se mide en minutos. Preste atención a la conversión entre las unidades de tiempo al llamar a la operación.	120000
CronExpress	string	La expresión CRON que representa la política de programación periódica del nodo.	00 05 00 * * ?
InputList	array<object>	Los nombres de salida de los archivos principales de los que depende el archivo actual.
	object	La información de salida del archivo ascendente.
Input	string	El nombre de salida del archivo principal del que depende el archivo actual. Este parámetro corresponde al parámetro Nombre de salida del nodo ancestro bajo Nodos principales después de seleccionar Mismo ciclo en la sección Dependencias de la pestaña Propiedades en la consola de DataWorks.	project.001_out
ParseType	string	El modo de la dependencia del archivo de configuración. Valores válidos: MANUAL: Las dependencias de programación se configuran manualmente. AUTO: Las dependencias de programación se analizan automáticamente.	MANUAL
OutputList	array<object>	Los nombres de salida del archivo actual. Este parámetro corresponde al parámetro Nombre de salida bajo Salida después de seleccionar Mismo ciclo en la sección Dependencias de la pestaña Propiedades en la consola de DataWorks.
	object	La información de salida del archivo.
RefTableName	string	El nombre de la tabla de salida del archivo actual. Este parámetro corresponde al parámetro Nombre de la tabla de salida bajo Salida después de seleccionar Mismo ciclo en la sección Dependencias de la pestaña Propiedades en la consola de DataWorks.	ods_user_info_d
Output	string	El nombre de salida del archivo actual. Este parámetro corresponde al parámetro Nombre de salida bajo Salida después de seleccionar Mismo ciclo en la sección Dependencias de la pestaña Propiedades en la consola de DataWorks.	dw_project.002_out
StartImmediately	boolean	Indica si un nodo se ejecuta inmediatamente después de desplegar el nodo 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. Este parámetro corresponde al parámetro Método de inicio en la sección Programación de la pestaña Configurar en la consola de DataWorks.	true
InputParameters	array<object>	Los parámetros de contexto de entrada del nodo. Este parámetro corresponde a la tabla Parámetros de entrada en la sección Parámetros de entrada y salida de la pestaña Propiedades en la consola de DataWorks.
	object	El resultado devuelto.
ParameterName	string	El nombre del parámetro de entrada del nodo. En el código, puede utilizar el método ${...} para hacer referencia al parámetro de entrada del nodo. Este parámetro corresponde al parámetro Nombre del parámetro en la tabla Parámetros de entrada en la sección Parámetros de entrada y salida de la pestaña Propiedades en la consola de DataWorks.	input
ValueSource	string	El origen del valor del parámetro de entrada del nodo. Este parámetro corresponde al parámetro Origen del valor en la tabla Parámetros de entrada en la sección Parámetros de entrada y salida de la pestaña Propiedades en la consola de DataWorks.	project_001.parent_node:outputs
OutputParameters	array<object>	Los parámetros de contexto de salida del nodo. Este parámetro corresponde a la tabla Parámetros de salida en la sección Parámetros de entrada y salida de la pestaña Propiedades en la consola de DataWorks.
	object	El resultado devuelto.
ParameterName	string	El nombre del parámetro de salida del nodo. Este parámetro corresponde al parámetro Nombre del parámetro en la tabla Parámetros de salida en la sección Parámetros de entrada y salida de la pestaña Propiedades en la consola de DataWorks.	output
Value	string	La expresión del parámetro de contexto de salida del nodo. Este parámetro corresponde al parámetro Valor en la tabla Parámetros de salida en la sección Parámetros de entrada y salida de la pestaña Propiedades en la consola de DataWorks.	${bizdate}
Type	string	El tipo de parámetro de salida del nodo. Valores válidos: 1: indica una constante. 2: indica una variable. 3: indica una variable de paso directo desde un nodo de parámetros. Este parámetro corresponde al parámetro Tipo en la tabla Parámetros de salida en la sección Parámetros de entrada y salida de la pestaña Propiedades en la consola de DataWorks.	1
Description	string	La descripción del parámetro de salida del nodo.	It's a context output parameter.
ApplyScheduleImmediately	string	Indica si las configuraciones de programación surten efecto inmediatamente después del despliegue.	true
IgnoreParentSkipRunningProperty	string	Indica si se debe omitir la propiedad de ejecución de prueba de los nodos ancestros del nodo que corresponde al archivo. Este parámetro corresponde al parámetro Omitir la propiedad de ejecución de prueba del nodo ancestro que se muestra después de configurar el parámetro Dependencia en la sección Dependencias de la pestaña Propiedades en la consola de DataWorks.	true
Timeout	integer	El período de tiempo de espera.	1
ImageId	string	El ID de la imagen personalizada.	m-bp1h4b5a8ogkbll2f3tr
ResourceDownloadLink	object	La URL de descarga del recurso.
downloadLink	string	La URL de descarga del 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": "62465892****",
      "FileName": "ods_user_info_d",
      "ConnectionName": "odps_first",
      "UseType": "NORMAL",
      "FileFolderId": "2735c2****",
      "ParentId": -1,
      "CreateUser": "424732****",
      "IsMaxCompute": true,
      "BusinessId": 1000001,
      "FileDescription": "Mi primer archivo de DataWorks",
      "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": "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
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.
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.