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

Consulta la información de una instancia.

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
InstanceId	integer	Sí	El ID de la instancia. Puede llamar a la operación ListInstances para consultar el ID.	1234
ProjectEnv	string	Sí	El entorno del espacio de trabajo. Valores válidos: PROD: entorno de producción y DEV: entorno de desarrollo. Valores válidos: PROD : 生产环境 DEV : 开发环境	PROD

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los parámetros de respuesta.
HttpStatusCode	integer	El código de estado HTTP.	200
RequestId	string	El ID de la solicitud.	E6F0DBDD-5AD****
ErrorMessage	string	El mensaje de error que se devuelve cuando falla la programación de la instancia.	test
Success	boolean	Indica si la solicitud se realizó correctamente.	true
ErrorCode	string	El código de error.	0
Data	object	Los detalles de la instancia.
Status	string	El estado de la tarea. Valores válidos: NOT_RUN(1): sin ejecutar; WAIT_TIME(2): en espera de la hora programada; WAIT_RESOURCE(3): despachado al motor de ejecución y en espera en la cola de recursos; RUNNING(4): en ejecución; CHECKING(7): ejecución finalizada y enviada a Data Quality para validación; CHECKING_CONDITION(8): ejecución finalizada y condiciones de rama en comprobación; WAIT_TRIGGER(9): en espera de un disparador, estado al que entran los nodos basados en disparadores después de esperar la hora programada; FAILURE(5): fallido; SUCCESS(6): exitoso.	NOT_RUN
CycTime	integer	La hora de programación de la instancia.	1590422400000
BeginRunningTime	integer	La hora en que la instancia comenzó a ejecutarse.	1590416703313
FinishTime	integer	La hora en que se completó la ejecución de la instancia.	1590416703313
CreateTime	integer	La hora en que se generó la instancia.	1590416703313
DagId	integer	El ID del flujo de trabajo.	338450167
Priority	integer	La prioridad 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 del nodo que genera la instancia. Valores válidos: NORMAL(0): El nodo es un nodo de activación automática. El sistema de programación ejecuta el nodo periódicamente. MANUAL(1): El nodo es un nodo de activación manual. El sistema de programación no ejecuta el nodo periódicamente. PAUSE(2): El nodo es un nodo congelado. El sistema de programación ejecuta el nodo periódicamente, pero establece el estado del nodo en fallido cuando comienza a ejecutarlo. SKIP(3): El nodo es un nodo de ejecución de prueba. El sistema de programación ejecuta el nodo periódicamente, pero establece el estado del nodo en exitoso cuando comienza a ejecutarlo. SKIP_UNCHOOSE(4): El nodo es un nodo no seleccionado en un flujo de trabajo temporal. Este tipo de nodo solo existe en flujos de trabajo temporales. El sistema de programación establece el estado del nodo en exitoso cuando comienza a ejecutarlo. SKIP_CYCLE(5): El nodo es un nodo que está programado por semana o mes y está esperando a que llegue la hora de programación. El sistema de programación ejecuta el nodo periódicamente, pero establece el estado del nodo en exitoso cuando comienza a ejecutarlo. CONDITION_UNCHOOSE(6): El nodo no está seleccionado por su nodo de rama ancestro y se ejecuta como un nodo de ejecución de prueba. REALTIME_DEPRECATED(7): El nodo tiene instancias que se generan en tiempo real pero están obsoletas. El sistema de programación establece el estado del nodo en exitoso.	NORMAL(0)
ParamValues	string	Los parámetros relacionados con el nodo.	bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif
Connection	string	La cadena de conexión.	odps_first
BaselineId	integer	El ID de la línea base.	123123
DqcType	integer	Indica si la instancia está asociada con una regla de monitoreo en Data Quality. Valores válidos: 0: La instancia está asociada con una regla de monitoreo en Data Quality. 1: La instancia no está asociada con una regla de monitoreo en Data Quality.	1
DagType	string	El tipo de flujo de trabajo. Valores válidos: DAILY(0): flujo de trabajo programado diariamente; MANUAL(1): flujo de trabajo de tareas de activación manual; SMOKE_TEST(2): flujo de trabajo de pruebas de humo; SUPPLY_DATA(3): flujo de trabajo de relleno de datos; MANUAL_FLOW(4): flujo de datos o flujo de trabajo de PAI ejecutado manualmente, como la ejecución de un flujo de trabajo en el IDE; BUSINESS_PROCESS_DAG(5): DAG de flujo de trabajo manual.	DAILY
BusinessId	integer	El ID del flujo de trabajo.	123
TaskRerunTime	integer	El número de veces que la instancia aún se puede volver a ejecutar. Este valor puede estar vacío o ser un entero mayor o igual que 0. Un valor vacío indica que el nodo correspondiente no tiene configuradas reejecuciones automáticas. Un valor de 0 indica que la instancia no se puede volver a ejecutar. Un entero positivo n indica que la instancia aún se puede volver a ejecutar n veces. Por ejemplo, 1 significa que queda una reejecución y 2 significa que quedan dos reejecuciones. El valor inicial es el número de reejecuciones automáticas configurado para el nodo correspondiente más 1.	0
PeriodNumber	integer	El número de secuencia del ciclo. Este parámetro indica el número de secuencia del ciclo de la instancia en el día actual.	1
ModifyTime	integer	La hora en que la instancia se modificó por última vez.	1590416703313
Repeatability	boolean	Indica si la instancia se puede volver a ejecutar.	true
RepeatInterval	integer	El intervalo en el que se vuelve a ejecutar el nodo después de que falla la ejecución. Unidad: milisegundos.	60000
InstanceId	integer	El ID de la instancia.	11713307578
BeginWaitResTime	integer	La hora en que la instancia comenzó a esperar recursos.	1590416703313
RelatedFlowId	integer	El ID del flujo de trabajo al que pertenece el nodo.	123123
Bizdate	integer	La fecha de negocio de la instancia. En la mayoría de los casos, el valor es un día anterior a la hora en que se ejecutó la instancia.	1590336000000
NodeName	string	El nombre del nodo.	kzh
BeginWaitTimeTime	integer	La hora en que la instancia comenzó a esperar para ser programada.	1590416703313
DqcDescription	string	La expresión de filtro de tabla y partición en Data Quality asociada con el nodo.	[{"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 creador de la instancia.	111
Owner	string	El propietario de la instancia.	111

Ejemplos

Respuesta exitosa

JSON Formato

{
  "HttpStatusCode": 200,
  "RequestId": "E6F0DBDD-5AD****",
  "ErrorMessage": "test",
  "Success": true,
  "ErrorCode": "0",
  "Data": {
    "Status": "NOT_RUN",
    "CycTime": 1590422400000,
    "BeginRunningTime": 1590416703313,
    "FinishTime": 1590416703313,
    "CreateTime": 1590416703313,
    "DagId": 338450167,
    "Priority": 1,
    "TaskType": "NORMAL(0)",
    "ParamValues": "bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif",
    "Connection": "odps_first",
    "BaselineId": 123123,
    "DqcType": 1,
    "DagType": "DAILY",
    "BusinessId": 123,
    "TaskRerunTime": 0,
    "PeriodNumber": 1,
    "ModifyTime": 1590416703313,
    "Repeatability": true,
    "RepeatInterval": 60000,
    "InstanceId": 11713307578,
    "BeginWaitResTime": 1590416703313,
    "RelatedFlowId": 123123,
    "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": "111",
    "Owner": "111"
  }
}

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.