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

Consulta la información de una instancia de flujo de trabajo.

Descripción de la operación

Debe adquirir DataWorks Basic Edition o una edición superior para utilizar esta función.

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
Id	integer	Sí	El ID de la instancia de flujo de trabajo.	1234

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	22C97E95-F023-56B5-8852-B1A77A17XXXX
WorkflowInstance	object	La información de la instancia de flujo de trabajo.
Id	integer	El ID de la instancia de flujo de trabajo.	1234
WorkflowId	integer	El ID del flujo de trabajo al que pertenece la instancia.	1234
WorkflowTaskInstanceId	integer	El ID de la instancia de tarea correspondiente a la instancia de flujo de trabajo.	1234
UnifiedWorkflowInstanceId	integer	El ID unificado de la instancia de flujo de trabajo. Este campo tiene el mismo valor para todas las instancias de flujo de trabajo con la misma fecha de negocio dentro de un mismo activador.	1234
Name	string	El nombre de la instancia de flujo de trabajo.	WorkInstance1
Type	string	El tipo de la instancia de flujo de trabajo. Valores válidos: Normal: ejecución programada Manual: nodo activado manualmente SmokeTest: prueba SupplementData: relleno de datos ManualWorkflow: flujo de trabajo activado manualmente TriggerWorkflow: flujo de trabajo activado	Normal
Status	string	El estado de la instancia de flujo de trabajo. Valores válidos: NotRun: la instancia no se ha ejecutado. Running: la instancia se está ejecutando. WaitTime: la instancia está esperando a que llegue la hora de programación. CheckingCondition: se están comprobando las condiciones de rama para la instancia. WaitResource: la instancia está esperando recursos. Failure: la instancia no se pudo ejecutar. Success: la instancia se ejecutó correctamente. Checking: se está comprobando la calidad de los datos de la instancia.	Success
BizDate	integer	La fecha de negocio.	1710239005403
StartedTime	integer	La hora en que la instancia comenzó a ejecutarse.	1710239005403
FinishedTime	integer	La hora en que la instancia terminó de ejecutarse.	1710239005403
ProjectId	integer	El ID del espacio de trabajo.	100
EnvType	string	El entorno del espacio de trabajo. Valores válidos: Prod: entorno de producción Dev: entorno de desarrollo	Prod
Owner	string	El ID de la cuenta del propietario del flujo de trabajo.	1000
CreateTime	integer	La hora de creación.	1710239005403
ModifyTime	integer	La hora de modificación.	1710239005403
CreateUser	string	El ID de la cuenta del creador.	1000
ModifyUser	string	El ID de la cuenta del usuario que realizó la modificación.	1000
WorkflowParameters	string	Los parámetros del flujo de trabajo.	Scheduled workflow： key1=value1 key2=value2 Manual workflow： {"key1":"value1", "key2": "value2"}
Tags	array<object>	Las etiquetas de la tarea.
	object
Key	string	La clave de una etiqueta.	key1
Value	string	El valor de una etiqueta.	value1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "22C97E95-F023-56B5-8852-B1A77A17XXXX",
  "WorkflowInstance": {
    "Id": 1234,
    "WorkflowId": 1234,
    "WorkflowTaskInstanceId": 1234,
    "UnifiedWorkflowInstanceId": 1234,
    "Name": "WorkInstance1",
    "Type": "Normal",
    "Status": "Success",
    "BizDate": 1710239005403,
    "StartedTime": 1710239005403,
    "FinishedTime": 1710239005403,
    "ProjectId": 100,
    "EnvType": "Prod",
    "Owner": "1000",
    "CreateTime": 1710239005403,
    "ModifyTime": 1710239005403,
    "CreateUser": "1000",
    "ModifyUser": "1000",
    "WorkflowParameters": "周期工作流：\nkey1=value1 key2=value2\n手动业务流程：\n{\"key1\":\"value1\", \"key2\": \"value2\"}",
    "Tags": [
      {
        "Key": "key1",
        "Value": "value1"
      }
    ]
  }
}

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.