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

Consulta el estado de una tarea de sincronización en tiempo real o de una solución de sincronización de datos.

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	Sí	El ID del espacio de trabajo de DataWorks. Puede iniciar sesión en la consola de DataWorks e ir a la página de administración del espacio de trabajo para consultar el ID. Debe configurar este parámetro para especificar el espacio de trabajo de DataWorks al que se aplica la operación de la API.	10000
TaskType	string	Sí	El tipo de objeto que desea consultar. Valores válidos: DI_REALTIME: tarea de sincronización en tiempo real DI_SOLUTION: solución de sincronización de datos	DI_REALTIME
FileId	integer	Sí	Si establece el parámetro TaskType en DI_REALTIME, establezca el parámetro FileId en el ID de archivo de la tarea de sincronización en tiempo real que desea consultar. Si establece el parámetro TaskType en DI_SOLUTION, establezca el parámetro FileId en el ID de la solución de sincronización de datos que desea consultar. Puede llamar a la operación ListFiles para consultar el ID de archivo de la tarea de sincronización en tiempo real o de la solución de sincronización de datos.	100

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true false	true
RequestId	string	El ID de la solicitud.	0bc1411515937635973****
Data	object	El estado de la tarea de sincronización en tiempo real o de la solución de sincronización de datos.
Status	string	Si el parámetro TaskType se establece en DI_REALTIME, el parámetro Status indica el estado de la tarea de sincronización en tiempo real. Valores válidos: PAUSE, NORUN, RUN, KILLING y WAIT. Si el parámetro TaskType se establece en DI_SOLUTION, el parámetro Status indica el estado de la solución de sincronización de datos. Valores válidos: success y fail.	RUN
Message	string	La causa del error al obtener el estado de la tarea de sincronización en tiempo real o de la solución de sincronización de datos. Si se obtiene correctamente el estado de la tarea de sincronización en tiempo real o de la solución de sincronización de datos, se devuelve el valor null.	fileId[100] is invalid
Name	string	Si el parámetro TaskType se establece en DI_REALTIME, el parámetro Name indica el nombre de la tarea de sincronización en tiempo real. Si el parámetro TaskType se establece en DI_SOLUTION, se devuelve el valor null.	streamx_name
SolutionInfo	object	Si el parámetro TaskType se establece en DI_REALTIME, se devuelve el valor null. Si el parámetro TaskType se establece en DI_SOLUTION, el parámetro SolutionInfo indica los detalles de la solución de sincronización de datos.
Status	string	El estado de la solución de sincronización de datos.	run
Id	integer	El ID de la solución de sincronización de datos.	100
CreatorName	string	El creador de la solución de sincronización de datos.	dataworks_3h1
StepDetail	array<object>	Los detalles de los pasos de la solución de sincronización de datos.
	object	Los datos devueltos.
Status	string	El estado del paso de la solución de sincronización de datos.	success
StepId	integer	El ID del paso de la solución de sincronización de datos.	1
StepName	string	El nombre del paso de la solución de sincronización de datos.	Create a base table
Info	string	La información de la solución de sincronización de datos.	{\"fusionProps\":{\"dataSource\":[{\"fileName\":\"holo_20221020161613\",\"status\":\"SUCCESS\"}]},\"customProps\":{\"showSN\":true,\"columns\":[{\"dataIndex\":\"fileName\",\"width\":0.8,\"title\":\"Real-time synchronization name\"},{\"dataIndex\":\"status\",\"width\":0.2,\"title\":\"Status\"}]},\"componentName\":\"Table\"}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Success": true,
  "RequestId": "0bc1411515937635973****",
  "Data": {
    "Status": "RUN",
    "Message": "fileId[100] is invalid",
    "Name": "streamx_name",
    "SolutionInfo": {
      "Status": "run",
      "Id": 100,
      "CreatorName": "dataworks_3h1",
      "StepDetail": [
        {
          "Status": "success",
          "StepId": 1,
          "StepName": "Create a base table",
          "Info": "{\\\"fusionProps\\\":{\\\"dataSource\\\":[{\\\"fileName\\\":\\\"holo_20221020161613\\\",\\\"status\\\":\\\"SUCCESS\\\"}]},\\\"customProps\\\":{\\\"showSN\\\":true,\\\"columns\\\":[{\\\"dataIndex\\\":\\\"fileName\\\",\\\"width\\\":0.8,\\\"title\\\":\\\"Nombre de sincronización en tiempo real\\\"},{\\\"dataIndex\\\":\\\"status\\\",\\\"width\\\":0.2,\\\"title\\\":\\\"Estado\\\"}]},\\\"componentName\\\":\\\"Table\\\"}"
        }
      ]
    }
  }
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error
400	Param.Invalid	The parameter is invalid.
500	InternalError.System	An internal error occurred.
403	Forbidden.Access	Access is forbidden.

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.