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

Consulta una lista de instancias.

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:*

list

*All resources.

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
ProjectEnv	string	Sí	El entorno de ejecución. Valores válidos: PROD (entorno de producción) y DEV (entorno de desarrollo). Valores válidos: PROD : Entorno de producción. DEV : Entorno de desarrollo.	PROD
NodeId	integer	No	El ID del nodo. Puede llamar a ListNodes para consultar el ID del nodo.	100000000000
NodeName	string	No	El nombre del nodo. Puede llamar a ListNodes para consultar el nombre del nodo.	openmr_8****
Owner	string	No	El ID del propietario, que es el UID de la cuenta de administrador del espacio de trabajo. Puede iniciar sesión en la consola de administración de Alibaba Cloud y ver el UID de la cuenta en Gestión de seguridad, dentro de Gestión de cuentas.	193379****
ProjectId	integer	Sí	El ID del espacio de trabajo. Puede llamar a ListProjects para consultar el ID del espacio de trabajo.	12345
BizName	string	No	El nombre del flujo de trabajo. Puede llamar a ListBusiness para consultar la información del flujo de trabajo.	test_bizName
ProgramType	string	No	El tipo de nodo. Puede llamar a ListNodes para consultar el tipo de nodo.	ODPS_SQL
PageNumber	integer	No	El número de página. Valores válidos: 1 a 100.	1
PageSize	integer	No	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
DagId	integer	No	El ID del DAG. Puede ser el ID del DAG devuelto por operaciones de API como RunCycleDagNodes para reprocesamiento de datos, RunSmokeTest para pruebas de humo y RunManualDagNodes para flujos de trabajo manuales.	11111
Bizdate	string	No	La marca de tiempo de los datos para consultar la lista de instancias. Formato: yyyy-MM-dd HH:mm:ss.	2020-02-02 00:00:00
BeginBizdate	string	No	La marca de tiempo de inicio de los datos para consultar la lista de instancias. Formato: yyyy-MM-dd HH:mm:ss.	2020-02-02 00:00:00
EndBizdate	string	No	La marca de tiempo de fin de los datos para consultar la lista de instancias. Formato: yyyy-MM-dd HH:mm:ss.	2020-02-03 00:00:00
Status	string	No	El estado de la tarea. Valores válidos: NOT_RUN: La tarea no se ha ejecutado. WAIT_TIME: La tarea está esperando la hora programada especificada por DueTime o CycTime. WAIT_RESOURCE: La tarea está esperando recursos. RUNNING: La tarea está en ejecución. CHECKING: La tarea se ha enviado al módulo de calidad de datos para su validación. CHECKING_CONDITION: Se están comprobando las condiciones de la rama. FAILURE: La tarea ha fallado. SUCCESS: La tarea se completó correctamente.	NOT_RUN
OrderBy	string	No	La regla de ordenación para los resultados devueltos. Valores válidos: CREATE_TIME_DESC: ordena los resultados en orden descendente por hora de creación. INSTANCE_ID_DESC: ordena los resultados en orden descendente por ID de instancia. Este es el valor predeterminado. Valores válidos: CREATE_TIME_DESC : Ordenar por hora de creación en orden descendente. INSTANCE_ID_DESC : Ordenar por ID de instancia en orden descendente.	INSTANCE_ID_DESC

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	La respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
RequestId	string	El ID de la solicitud. Puede utilizar este ID para localizar registros y solucionar problemas.	E6F0DBDD-5AD****
ErrorMessage	string	El mensaje de error.	The project does not exist.
ErrorCode	string	El código de error.	Invalid.Tenant.ProjectNotExists
Success	boolean	Indica si la llamada se realizó correctamente. Valores válidos: true: La llamada se realizó correctamente. false: La llamada falló.	true
Data	object	La lista de instancias.
PageNumber	integer	El número de página.	1
PageSize	integer	El número de entradas por página. Valor predeterminado: 10. Valor máximo: 100.	10
TotalCount	integer	El número total de instancias.	66
Instances	array<object>	La información de las instancias.
	object	Los datos devueltos.
Status	string	El estado de la tarea. Valores válidos: NOT_RUN (1): La tarea no se ha ejecutado. WAIT_TIME (2): La tarea está esperando la hora programada. WAIT_RESOURCE (3): La tarea está esperando recursos. Se ha enviado al motor de ejecución y está en cola para su programación. RUNNING (4): La tarea está en ejecución. CHECKING (7): La tarea ha terminado de ejecutarse y se ha enviado al módulo de calidad de datos para su validación. CHECKING_CONDITION (8): La tarea ha terminado de ejecutarse y se están comprobando sus condiciones de rama. WAIT_TRIGGER (9): La tarea está esperando un activador. Un nodo basado en activadores entra en este estado después del período de espera. FAILURE (5): La tarea ha fallado. SUCCESS (6): La tarea se completó correctamente.	NOT_RUN
CycTime	integer	La hora de ejecución de la tarea programada. El valor es una marca de tiempo de 13 dígitos, como `1590422400000`.	1590422400000
BeginRunningTime	integer	La hora en que la instancia comenzó a ejecutarse. El valor es una marca de tiempo de 13 dígitos, como `1590416703313`.	1590416703313
FinishTime	integer	La hora de finalización de la tarea programada. El valor es una marca de tiempo de 13 dígitos, como `1590416703313`.	1590416703313
ErrorMessage	string	[Obsoleto] El mensaje de error de la instancia. Puede llamar a la operación GetInstanceLog para obtener la información de error de la tarea ejecutada.	error message
CreateTime	integer	La hora en que se creó la instancia. El valor es una marca de tiempo de 13 dígitos, como `1590416703313`.	1590416703313
DagId	integer	El ID del DAG.	33845
Priority	integer	La prioridad de ejecución de la instancia. Valores válidos: 1, 3, 5, 7 y 8. Un valor mayor indica una prioridad más alta. Valor predeterminado: 1.	1
TaskType	string	El tipo de programación de la instancia de tarea. Valores válidos: NORMAL (0): tarea programada normal. La tarea se programa de forma regular. MANUAL (1): tarea manual. La tarea no se programa de forma regular. PAUSE (2): tarea congelada. La tarea se programa de forma regular, pero se marca inmediatamente como fallida cuando comienza la programación. SKIP (3): tarea de ejecución de prueba. La tarea se programa de forma regular, pero se marca inmediatamente como correcta cuando comienza la programación. SKIP_UNCHOOSE (4): tarea no seleccionada en un flujo de trabajo temporal. Este tipo solo existe en flujos de trabajo temporales y se marca inmediatamente como correcta cuando comienza la programación. SKIP_CYCLE (5): tarea semanal o mensual cuyo ciclo de ejecución no ha llegado. La tarea se programa de forma regular, pero se marca inmediatamente como correcta cuando comienza la programación. CONDITION_UNCHOOSE (6): tarea no seleccionada por una rama. La instancia ascendente contiene un nodo de rama (IF), pero el nodo descendente no es seleccionado por esa rama y se configura como una tarea de ejecución de prueba. REALTIME_DEPRECATED (7): instancia periódica caducada generada en tiempo real. Este tipo de tarea se marca inmediatamente como correcta.	NORMAL(0)
ParamValues	string	La información de los parámetros.	bizdate=$bizdate tbods=$tbods
Connection	string	La cadena de conexión.	odps_source
BaselineId	integer	El ID de la línea base.	123123
DqcType	integer	El tipo de asociación de DQC. Valores válidos: 0: asociado con DQC. 1: no asociado con DQC.	1
DagType	string	El tipo de flujo de trabajo. Valores válidos: DAILY (0): flujo de trabajo de programación diaria. MANUAL (1): flujo de trabajo de tareas manuales. SMOKE_TEST (2): flujo de trabajo de pruebas de humo. SUPPLY_DATA (3): flujo de trabajo de reprocesamiento de datos. MANUAL_FLOW (4): flujo de trabajo de DataFlow o PAI ejecutado manualmente, como la ejecución de un flujo de trabajo en el IDE. BUSINESS_PROCESS_DAG (5): flujo de trabajo de procesos de negocio manuales.	DAILY
BusinessId	integer	El ID del flujo de trabajo.	123
TaskRerunTime	integer	El número de veces que se puede volver a ejecutar la instancia. El valor puede estar vacío o ser un número entero mayor o igual a 0. Si el valor está vacío, la función de reejecución automática no está configurada para el nodo. Si el valor es 0, la instancia no se puede volver a ejecutar. Si el valor es un número entero mayor que 0 (supuesto como n), la instancia se puede volver a ejecutar n veces. Por ejemplo, si el valor es 1, el recuento de reejecuciones restantes es 1. Si el valor es 2, el recuento de reejecuciones restantes es 2, y así sucesivamente. El valor inicial es el número de reejecuciones automáticas definidas para el nodo más 1.	0
ModifyTime	integer	La hora de la última modificación de la tarea programada. El valor es una marca de tiempo de 13 dígitos, como `1590416703313`.	1590416703313
Repeatability	boolean	Indica si la instancia de tarea se puede ejecutar repetidamente.	true
RepeatInterval	integer	El intervalo de reejecución después de que falla una tarea programada. Unidad: milisegundos.	60000
InstanceId	integer	El ID de la instancia.	1234
BeginWaitResTime	integer	La hora en que la instancia de tarea comenzó a esperar recursos. El valor es una marca de tiempo de 13 dígitos, como `1590416703313`.	1590416703313
RelatedFlowId	integer	El ID del flujo de trabajo asociado.	123456
Bizdate	integer	La marca de tiempo de los datos de la tarea programada. Por lo general, es el día anterior a la ejecución de la tarea. El valor es una marca de tiempo de 13 dígitos, como `1590336000000`.	1590336000000
NodeName	string	El nombre del nodo.	kzh
BeginWaitTimeTime	integer	La hora en que la instancia de tarea comenzó a esperar su programación. El valor es una marca de tiempo de 13 dígitos, como `1590416703313`.	1590416703313
DqcDescription	string	La cadena de reglas de partición de DQC.	[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\u003d$[yyyy-mm-dd-1]"}]
NodeId	integer	El ID del nodo.	33115
CreateUser	string	El usuario que activó la instancia. Por ejemplo, si el usuario Test activa una instancia de reprocesamiento de datos, el valor es Test.	Test

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "The project does not exist.",
  "ErrorCode": "Invalid.Tenant.ProjectNotExists",
  "Success": true,
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 66,
    "Instances": [
      {
        "Status": "NOT_RUN",
        "CycTime": 1590422400000,
        "BeginRunningTime": 1590416703313,
        "FinishTime": 1590416703313,
        "ErrorMessage": "error message",
        "CreateTime": 1590416703313,
        "DagId": 33845,
        "Priority": 1,
        "TaskType": "NORMAL(0)",
        "ParamValues": "bizdate=$bizdate tbods=$tbods",
        "Connection": "odps_source",
        "BaselineId": 123123,
        "DqcType": 1,
        "DagType": "DAILY",
        "BusinessId": 123,
        "TaskRerunTime": 0,
        "ModifyTime": 1590416703313,
        "Repeatability": true,
        "RepeatInterval": 60000,
        "InstanceId": 1234,
        "BeginWaitResTime": 1590416703313,
        "RelatedFlowId": 123456,
        "Bizdate": 1590336000000,
        "NodeName": "kzh",
        "BeginWaitTimeTime": 1590416703313,
        "DqcDescription": "[{\"projectName\":\"ztjy_dim\",\"tableName\":\"dim_user_agent_manage_area_a\",\"partition\":\"ds\\u003d$[yyyy-mm-dd-1]\"}]",
        "NodeId": 33115,
        "CreateUser": "Test"
      }
    ]
  }
}

Códigos de error

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.