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

Consulta la instantánea de datos del punto de extensión en el momento en que se activó un evento de punto de extensión, según el ID de mensaje de un mensaje de DataWorks.

Descripción de la operación

Antes de comenzar: Active DataWorks Enterprise Edition o Ultimate Edition antes de llamar a esta operación. Si la edición no está activada, el servicio devuelve un error 403 Forbidden.Access.

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
MessageId	string	Sí	El ID del mensaje de DataWorks. Después de que se activa un evento de punto de extensión, puede obtener el ID del mensaje a partir del mensaje de evento recibido.	8abcb91f-d266-4073-b907-2ed67****1
ProjectId	integer	Sí	El ID del espacio de trabajo de DataWorks. Puede obtener el ID del espacio de trabajo al analizar el mensaje de DataWorks.	10000

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
RequestId	string	El ID único de la solicitud, que se puede utilizar para la solución de problemas.	8abcb91f-d266-4073-b907-2ed670378ed1
EventDetail	object	La instantánea de datos en el momento en que se activó el evento de punto de extensión. Los distintos tipos de eventos de mensaje tienen diferentes campos válidos en la instantánea de datos. Para obtener más detalles, consulte las descripciones de campos de cada evento de mensaje.
FileExecutionCommand	object	La instantánea cuando se ejecuta el código del archivo. Este campo solo es válido cuando el tipo de mensaje es IDE_FILE_EXECUTE_BEFORE.
FileId	integer	El ID del archivo.	1234123
DataSourceName	string	El identificador único del origen de datos asociado con el archivo.	odps_source
Content	string	El código del archivo que generó esta versión del archivo.	SHOW TABLES;
FileType	integer	El tipo de archivo. Los distintos tipos de archivo tienen diferente código. Para obtener más información, consulte Nodos de DataWorks.	10
DeletedFile	object	La información de la instantánea cuando se elimina un archivo. Este campo solo es válido cuando el tipo de mensaje es IDE_FILE_DELETE_BEFORE.
Owner	string	El propietario del archivo.	7384234****
FileType	integer	El tipo de archivo. Los distintos tipos de archivo tienen diferente código. Para obtener más información, consulte Nodos de DataWorks.	10
CurrentVersion	integer	La versión más reciente del archivo.	1
BusinessId	integer	El ID del flujo de trabajo al que pertenece el archivo.	74328
FileName	string	El nombre del archivo.	hello_dataworks.sql
DataSourceName	string	El identificador único del origen de datos asociado con el archivo.	odps_source
UseType	string	El módulo funcional al que pertenece el archivo. Valores válidos: NORMAL: Data Studio. MANUAL: tarea manual. MANUAL_BIZ: flujo de trabajo manual. SKIP: programación de ejecución de prueba en Data Studio. ADHOCQUERY: consulta ad hoc. COMPONENT: gestión de componentes.	NORMAL
FolderId	string	El ID de la carpeta a la que pertenece el archivo. Puede llamar a la operación GetFolder para consultar los detalles del archivo por ID de carpeta.	aldurie78l2falure
ParentFileId	integer	El ID de nodo del nodo de bucle o nodo de recorrido al que pertenece el archivo.	1234122
Content	string	El código del archivo que generó esta versión del archivo.	SHOW TABLES;
NodeId	integer	El ID del nodo de programación.	421429
FileId	integer	El ID del archivo.	1234123
CommittedFile	object	La instantánea cuando se confirma o despliega un archivo. Este campo solo es válido cuando el tipo de mensaje es IDE_FILE_SUBMIT_BEFORE o IDE_FILE_DEPLOY_BEFORE.
FileId	integer	El ID del archivo.	1234123
Content	string	El código del archivo que generó esta versión del archivo.	SHOW TABLES;
Committor	string	El ID de usuario de Alibaba Cloud que generó esta versión del archivo.	7384234****
FileType	integer	El tipo de archivo. Los distintos tipos de archivo tienen diferente código. Para obtener más información, consulte Nodos de DataWorks.	10
ChangeType	string	El tipo de cambio de esta versión del archivo. Valores válidos: CREATE, UPDATE y DELETE.	UPDATE
FileName	string	El nombre del archivo.	hello_dataworks.sql
NodeId	integer	El ID del nodo de programación.	421429
Comment	string	La descripción de esta versión del archivo.	Second version submission
UseType	string	El módulo funcional al que pertenece el archivo. Valores válidos: NORMAL: Data Studio. MANUAL: tarea manual. MANUAL_BIZ: flujo de trabajo manual. SKIP: programación de ejecución de prueba en Data Studio. ADHOCQUERY: consulta ad hoc. COMPONENT: gestión de componentes.	NORMAL
FilePropertyContent	object	Las propiedades adicionales del archivo.
DataSourceName	string	El identificador único del origen de datos asociado con el archivo.	odps_source
ParentFileId	integer	El ID de nodo del nodo de bucle o nodo de recorrido al que pertenece el archivo.	1234122
BusinessId	integer	El ID del flujo de trabajo al que pertenece el archivo.	74328
CurrentVersion	integer	La versión más reciente del archivo.	1
Owner	string	El propietario del archivo.	7384234****
FolderId	string	El ID de la carpeta a la que pertenece el archivo. Puede llamar a la operación GetFolder para consultar los detalles del archivo por ID de carpeta.	aldurie78l2falure
NodeConfiguration	object	La configuración de programación del archivo.
RerunMode	string	La propiedad de reejecución. Valores válidos: ALL_ALLOWED: El nodo se puede reejecutar independientemente de si se ejecuta correctamente o falla. FAILURE_ALLOWED: El nodo solo se puede reejecutar después de que falla. ALL_DENIED: El nodo no se puede reejecutar independientemente de si se ejecuta correctamente o falla. Este parámetro corresponde a la configuración "Configuración de programación > Propiedades de tiempo > Propiedades de reejecución" de una tarea de Data Studio 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 manual que no se programa de forma regular. Esto corresponde a los nodos en un flujo de trabajo manual. PAUSE: tarea en pausa. SKIP: tarea de ejecución de prueba que se programa de forma regular, pero que se establece directamente como exitosa cuando comienza la programación.	NORMAL
ParaValue	string	Los parámetros de programación. Este parámetro corresponde a la configuración "Configuración de programación > Parámetros" de una tarea de Data Studio en la consola de DataWorks. Para obtener más información, consulte Parámetros de programación.	a=x b=y
CycleType	string	El tipo del ciclo de programación. Valores válidos: NOT_DAY (minuto u hora) y DAY (día, semana o mes). Este parámetro corresponde a la configuración "Configuración de programación > Propiedades de tiempo > Ciclo de programación" de una tarea de Data Studio en la consola de DataWorks.	DAY
DependentNodeIdList	string	Los ID de los nodos de los que depende el archivo actual cuando la configuración del parámetro DependentType se establece en USER_DEFINE. Separe varios ID de nodo con comas (,). Este parámetro corresponde a la configuración "Configuración de programación > Dependencias de programación > Dependencias entre ciclos (Ciclo anterior)" de una tarea de Data Studio en la consola de DataWorks, cuando la dependencia se establece en "Otros nodos".	5,10,15,20
ResourceGroupId	integer	El grupo de recursos utilizado cuando se ejecuta la tarea después de desplegar el archivo. Puede llamar a la operación ListResourceGroups para obtener la lista de grupos de recursos disponibles para el espacio de trabajo.	375827434852437
AutoRerunTimes	integer	El número de reejecuciones automáticas.	3
AutoRerunIntervalMillis	integer	El intervalo entre reejecuciones automáticas, en milisegundos.	120000
CronExpress	string	La expresión cron de programación.	00 05 00 * * ?
InputList	array<object>	Las salidas de los archivos precedentes de las que depende el archivo.
	object	La información sobre la salida del archivo precedente de la que depende el archivo.
Input	string	El nombre de salida del archivo precedente del que depende el archivo. Este parámetro corresponde al "Nombre de salida del nodo precedente" en la configuración "Configuración de programación > Dependencias de programación > Depende de nodos precedentes" de una tarea de Data Studio en la consola de DataWorks.	dw_project_root
ParseType	string	El método utilizado para configurar las dependencias de archivos. Valores válidos: MANUAL: configuración manual. AUTO: análisis automático.	MANUAL
OutputList	array<object>	Las salidas del archivo. Este parámetro corresponde a la configuración "Configuración de programación > Dependencias de programación > Nombre de salida del nodo actual" de una tarea de Data Studio en la consola de DataWorks.
	object	La información de salida del archivo.
RefTableName	string	El nombre de la tabla de salida del archivo. Este parámetro corresponde al "Nombre de la tabla de salida" en la configuración "Configuración de programación > Dependencias de programación > Nombre de salida del nodo actual" de una tarea de Data Studio en la consola de DataWorks.	ods_user_info_d
Output	string	El nombre de salida del archivo. Este parámetro corresponde al "Nombre de salida" en la configuración "Configuración de programación > Dependencias de programación > Nombre de salida del nodo actual" de una tarea de Data Studio en la consola de DataWorks.	dw_project.002_out
DependentType	string	El método de dependencia del ciclo anterior. Valores válidos: SELF: la dependencia se establece en el nodo actual. CHILD: la dependencia se establece en los nodos secundarios de primer nivel. USER_DEFINE: la dependencia se establece en otros nodos. NONE: no se selecciona ninguna dependencia, lo que significa que el nodo no depende del ciclo anterior.	USER_DEFINE
TableModel	object	La instantánea cuando se confirma o despliega una tabla. Este campo solo es válido cuando el tipo de mensaje es IDE_TABLE_SUBMIT_BEFORE o IDE_TABLE_DEPLOY_BEFORE.
Env	string	El entorno al que pertenece la tabla. Valores válidos: DEV: entorno de desarrollo. PROD: entorno de producción.	DEV
LifeCycle	integer	El ciclo de vida de la tabla. Unidad: días.	7
TableName	string	El nombre de la tabla.	tb_hello
DataSourceName	string	El identificador único del origen de datos al que pertenece la tabla.	odps_source
Columns	array<object>	La lista de columnas.
	object	La información de la columna.
ColumnName	string	El nombre de la columna.	ID
ColumnType	string	El tipo de la columna.	BIGINT
IsPartitionColumn	boolean	Indica si la columna es una columna de partición. Valores válidos: true: La columna es una columna de partición. false: La columna no es una columna de partición.	false
Comment	string	El comentario de la columna.	ID
Comment	string	El comentario de la tabla.	A new table
Location	string	La información de ubicación de la tabla externa.	hdfs://path/to/object

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "8abcb91f-d266-4073-b907-2ed670378ed1",
  "EventDetail": {
    "FileExecutionCommand": {
      "FileId": 1234123,
      "DataSourceName": "odps_source",
      "Content": "SHOW TABLES;",
      "FileType": 10
    },
    "DeletedFile": {
      "Owner": "7384234****",
      "FileType": 10,
      "CurrentVersion": 1,
      "BusinessId": 74328,
      "FileName": "hello_dataworks.sql",
      "DataSourceName": "odps_source",
      "UseType": "NORMAL",
      "FolderId": "aldurie78l2falure",
      "ParentFileId": 1234122,
      "Content": "SHOW TABLES;",
      "NodeId": 421429,
      "FileId": 1234123
    },
    "CommittedFile": {
      "FileId": 1234123,
      "Content": "SHOW TABLES;",
      "Committor": "7384234****",
      "FileType": 10,
      "ChangeType": "UPDATE",
      "FileName": "hello_dataworks.sql",
      "NodeId": 421429,
      "Comment": "Second version submission",
      "UseType": "NORMAL",
      "FilePropertyContent": {
        "DataSourceName": "odps_source",
        "ParentFileId": 1234122,
        "BusinessId": 74328,
        "CurrentVersion": 1,
        "Owner": "7384234****",
        "FolderId": "aldurie78l2falure"
      },
      "NodeConfiguration": {
        "RerunMode": "ALL_ALLOWED",
        "SchedulerType": "NORMAL",
        "ParaValue": "a=x b=y",
        "CycleType": "DAY",
        "DependentNodeIdList": "5,10,15,20",
        "ResourceGroupId": 375827434852437,
        "AutoRerunTimes": 3,
        "AutoRerunIntervalMillis": 120000,
        "CronExpress": "00 05 00 * * ?",
        "InputList": [
          {
            "Input": "dw_project_root",
            "ParseType": "MANUAL"
          }
        ],
        "OutputList": [
          {
            "RefTableName": "ods_user_info_d",
            "Output": "dw_project.002_out"
          }
        ],
        "DependentType": "USER_DEFINE"
      }
    },
    "TableModel": {
      "Env": "DEV",
      "LifeCycle": 7,
      "TableName": "tb_hello",
      "DataSourceName": "odps_source",
      "Columns": [
        {
          "ColumnName": "ID",
          "ColumnType": "BIGINT",
          "IsPartitionColumn": false,
          "Comment": "ID"
        }
      ],
      "Comment": "Una tabla nueva",
      "Location": "hdfs://path/to/object"
    }
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	InternalError.UserId.Missing	An internal system error occurred. Try again later.
500	InternalError.System	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.