GetFile - - Centro de documentación de Alibaba Cloud

Consulta la información de un archivo.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que ejecute 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í	GetFile	La operación que desea ejecutar.
ProjectId	Long	No	10000	El ID del espacio de trabajo de DataWorks. Inicie sesión en la DataWorks console y vaya a la página Workspace 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.
ProjectIdentifier	String	No	dw_project	El nombre del espacio de trabajo de DataWorks. Inicie sesión en la DataWorks console y vaya a la página Workspace 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.
FileId	Long	No	100000001	El ID del archivo. Llame a la operación ListFiles para obtener el ID del archivo.
NodeId	Long	No	200000001	El ID del nodo programado. Llame a la operación ListFiles para obtener el ID del nodo.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
HttpStatusCode	Integer	200	El código de estado HTTP.
ErrorMessage	String	The connection does not exist.	El mensaje de error.
RequestId	String	0000-ABCD-EFG****	El ID de la solicitud.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	El código de error.
Success	Boolean	true	Indica si la solicitud se completó correctamente. Valores válidos: true false
Data	Object		Los detalles del archivo.
File	Object		La información básica del archivo.
CommitStatus	Integer	0	Indica si se confirmó el código más reciente del archivo. Valores válidos: 0 y 1. El valor 0 indica que el código más reciente del archivo no se confirmó. El valor 1 indica que el código más reciente del archivo sí se confirmó.
AutoParsing	Boolean	true	Indica si la función de análisis automático está habilitada para el archivo. Valores válidos: true false Este parámetro corresponde al parámetro Analyze Code que se muestra después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la DataWorks console.
Owner	String	7775674356****	El ID de la cuenta de Alibaba Cloud del propietario del archivo.
CreateTime	Long	1593879116000	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.
FileType	Integer	10	El tipo de código del archivo. 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 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment) y 1221 (PyODPS 3).
CurrentVersion	Integer	3	El número de la versión más reciente del archivo.
BizId	Long	1000001	El ID del flujo de trabajo al que pertenece el archivo. Este parámetro está obsoleto y fue reemplazado por el parámetro BusinessId.
LastEditUser	String	62465892****	El ID de la cuenta de Alibaba Cloud que modificó el archivo por última vez.
FileName	String	ods_user_info_d	El nombre del archivo.
ConnectionName	String	odps_source	El nombre del origen de datos que se utiliza para ejecutar el nodo correspondiente al archivo.
UseType	String	NORMAL	El módulo al que pertenece el archivo. Valores válidos: NORMAL: El archivo se utiliza para DataStudio. 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 DataStudio en modo de prueba (dry-run). ADHOCQUERY: El archivo se utiliza para una consulta ad hoc. COMPONENT: El archivo se utiliza para un fragmento de código.
FileFolderId	String	2735c2****	El ID de la carpeta a la que pertenece el archivo.
ParentId	Long	-1	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.
CreateUser	String	424732****	El ID de la cuenta de Alibaba Cloud que se utilizó para crear el archivo.
IsMaxCompute	Boolean	true	Indica si el archivo debe cargarse en MaxCompute. Este parámetro solo se devuelve si el archivo es un archivo de recursos de MaxCompute.
BusinessId	Long	1000001	El ID del flujo de trabajo al que pertenece el archivo.
FileDescription	String	My first DataWorks file	La descripción del archivo.
DeletedStatus	String	RECYCLE	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.
LastEditTime	Long	1593879116000	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.
Content	String	SHOW TABLES;	El código contenido en el archivo.
NodeId	Long	300001	El ID del nodo activado automáticamente que se genera en el sistema de programación después de confirmar el archivo.
AdvancedSettings	String	{"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 DataWorks console. El valor de este parámetro debe estar en formato JSON.
FileId	Long	100000001	El ID del archivo.
NodeConfiguration	Object		Las configuraciones de programación del archivo.
RerunMode	String	ALL_ALLOWED	Indica si el nodo correspondiente al archivo puede volver a ejecutarse. Valores válidos: ALL_ALLOWED: El nodo puede volver a ejecutarse independientemente de si se ejecutó correctamente o falló. FAILURE_ALLOWED: El nodo solo puede volver a ejecutarse después de fallar. ALL_DENIED: El nodo no puede volver a ejecutarse independientemente de si se ejecutó correctamente o falló. Este parámetro corresponde al parámetro Rerun en la sección Schedule de la pestaña Properties en la DataWorks console.
SchedulerType	String	NORMAL	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 pueden activarse automáticamente y corresponden a los nodos del panel Manually Triggered Workflows. PAUSE: El nodo es un nodo pausado. SKIP: El nodo es un nodo de prueba (dry-run). Estos nodos se inician según lo programado, pero el sistema establece su estado como exitoso al comenzar a ejecutarlos.
Stop	Boolean	false	Indica si la programación del nodo está suspendida. 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 DataWorks console.
ParaValue	String	a=x b=y	Los parámetros de programación del nodo. Este parámetro corresponde a la sección Scheduling Parameter de la pestaña Properties en la DataWorks console. Para obtener más información sobre las configuraciones de los parámetros de programación, consulte Configure scheduling parameters.
StartEffectDate	Long	936923400000	El inicio del intervalo de tiempo para 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. 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 DataWorks console.
EndEffectDate	Long	4155787800000	El final del intervalo de tiempo para 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. 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 DataWorks console.
CycleType	String	DAY	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 Scheduling Cycle en la sección Schedule de la pestaña Properties en la DataWorks console.
DependentNodeIdList	String	5,10,15,20	El ID del nodo del cual depende el nodo correspondiente al archivo cuando el parámetro DependentType se establece en USER_DEFINE. Varios ID se separan con comas (,). El valor de este parámetro equivale al ID del nodo que especificó después de seleccionar Previous Cycle y establecer Depend On en Other Nodes en la sección Dependencies de la pestaña Properties en la DataWorks console.
ResourceGroupId	Long	375827434852437	El ID del resource group que se utiliza para ejecutar el nodo correspondiente al archivo. Llame a la operación ListResourceGroups para consultar los resource groups disponibles en el espacio de trabajo.
DependentType	String	USER_DEFINE	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 específicos en el ciclo anterior. NONE: No se seleccionó ningún tipo de dependencia de programación entre ciclos para el nodo.
AutoRerunTimes	Integer	3	El número de reejecuciones automáticas permitidas después de que ocurre un error.
AutoRerunIntervalMillis	Integer	120000	El intervalo entre reejecuciones automáticas después de que ocurre un error. Unidad: milisegundo. 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 DataWorks console. El intervalo que especifique 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.
CronExpress	String	00 05 00 ?	La expresión CRON que representa la directiva de programación periódica del nodo.
InputList	Array of NodeInputOutput		Los nombres de salida de los archivos principales de los cuales depende el archivo actual.
Input	String	project.001_out	El nombre de salida del archivo principal del cual depende el archivo actual. Este parámetro corresponde al parámetro Output Name of Ancestor Node bajo Parent Nodes después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la DataWorks console.
ParseType	String	MANUAL	El modo de 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.
OutputList	Array of NodeInputOutput		Los nombres de salida del archivo actual. Este parámetro corresponde al parámetro Output Name bajo Output después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la DataWorks console.
RefTableName	String	ods_user_info_d	El nombre de la tabla de salida del archivo actual. Este parámetro corresponde al parámetro Output Table Name bajo Output después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la DataWorks console.
Output	String	dw_project.002_out	El nombre de salida del archivo actual. Este parámetro corresponde al parámetro Output Name bajo Output después de seleccionar Same Cycle en la sección Dependencies de la pestaña Properties en la DataWorks console.
StartImmediately	Boolean	true	Indica si un nodo se ejecuta inmediatamente después de desplegarse 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 DataWorks console.
InputParameters	Array of InputContextParameter		Parámetros de entrada del nodo. Este parámetro corresponde a la tabla Input Parameters en la sección Input and Output Parameters de la pestaña Properties en la DataWorks console.
ParameterName	String	input	El nombre del parámetro de entrada del nodo. En el código, puede usar el método ${...} para hacer referencia al parámetro de entrada del nodo. Este parámetro corresponde al parámetro Parameter Name en la tabla Input Parameters dentro de la sección Input and Output Parameters de la pestaña Properties en la DataWorks console.
ValueSource	String	project_001.parent_node:outputs	El origen del valor del parámetro de entrada del nodo. Este parámetro corresponde al parámetro Value Source en la tabla Input Parameters dentro de la sección Input and Output Parameters de la pestaña Properties en la DataWorks console.
OutputParameters	Array of OutputContextParameter		Parámetros de salida del nodo. Este parámetro corresponde a la tabla Output Parameters en la sección Input and Output Parameters de la pestaña Properties en la DataWorks console.
ParameterName	String	output	El nombre del parámetro de salida del nodo. Este parámetro corresponde al parámetro Parameter Name en la tabla Output Parameters dentro de la sección Input and Output Parameters de la pestaña Properties en la DataWorks console.
Value	String	${bizdate}	El valor del parámetro de salida del nodo. Este parámetro corresponde al parámetro Value en la tabla Output Parameters dentro de la sección Input and Output Parameters de la pestaña Properties en la DataWorks console.
Type	String	1	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. Este parámetro corresponde al parámetro Type en la tabla Output Parameters dentro de la sección Input and Output Parameters de la pestaña Properties en la DataWorks console.
Description	String	It's a context output parameter.	La descripción del parámetro de salida del nodo.

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

XML formato

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>

JSON formato

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 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.	Ocurrió un error interno del sistema. Inténtelo de nuevo más tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ocurrió un error interno del sistema. Inténtelo de nuevo más tarde.

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