ListTasksInTaskFlow - Data Management - Centro de documentación de Alibaba Cloud

Consulta las tareas en un flujo de tareas especificado.

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

dms:ListTasksInTaskFlow

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Nota Para ver el ID del inquilino, mueva el puntero sobre la foto de perfil en la esquina superior derecha de la consola de Data Management (DMS). Para obtener más información, consulte Ver información sobre el inquilino actual.	3***
DagId	integer	Sí	El ID del flujo de tareas. Puede llamar a la operación ListTaskFlow o ListLhTaskFlowAndScenario para consultar el ID del flujo de tareas.	32***

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud. Puede usar este ID para localizar registros y solucionar problemas.	8B36B063-6B7D-5595-9FCF-3844B7B7ACD4
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	The task flow does not exist or you do not have the required permissions
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
Tasks	object
Task	array<object>	Las tareas en el flujo de tareas.
	object	Los detalles de la tarea.
NodeName	string	El nombre del nodo.	Cross-Database Spark SQL-1
NodeType	string	El tipo de nodo. Para obtener más información sobre los valores válidos para este parámetro, consulte Parámetro NodeType.	SPARK_SQL
NodeContent	string	La configuración del nodo.	{ "dbId":123456, // ID de la base de datos "sql":"/* Escriba SQL con la sintaxis de la base de datos seleccionada para el nodo actual */", // Instrucción SQL "dbType":"polardb" // Tipo de base de datos }
TimeVariables	string	Las variables de tiempo configuradas para el nodo.	{ "variables":[ // "variables" es un valor fijo { "name":"var", // name especifica el nombre de la variable "pattern":"yyyy-MM-dd\|+0m+0h-2d+0w+0M+1y" // Consulte la siguiente explicación } ] }
NodeConfig	string	La configuración avanzada del nodo.	{ "rerun":{ // Valor fijo obligatorio "rerunEnable":true, // Especifica si se debe habilitar la reejecución "rerunCount":1, // Número de reejecuciones "rerunInterval":10 // Intervalo de reejecución } }
NodeOutput	string	Las variables de salida de la tarea.	{ "outputs":[ { /* Configuración de extracción de variables { "row":0, // Fila. -1 indica todas las filas. "column":-1, // Columna. -1 indica todas las columnas. /* Delimitador Cuando se seleccionan todas las filas o todas las columnas, debe especificar un conector. El valor de retorno de la variable es una cadena. / "combiner":"," } / "extractMethod":"{\"row\":0,\"column\":-1,\"combiner\":\",\"}", "variableName":"var", // Nombre de la variable "description":"Para demostración" // Descripción de la variable } ] }
GraphParam	string	La posición del nodo en el grafo acíclico dirigido (DAG).	{\"x\":435,\"y\":192,\"layoutType\":\"Horizontal\"}
NodeId	string	El ID del nodo.	92***

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "8B36B063-6B7D-5595-9FCF-3844B7B7ACD4",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "The task flow does not exist or you do not have the permission.",
  "Success": true,
  "Tasks": {
    "Task": [
      {
        "NodeName": "Cross-Database Spark SQL-1",
        "NodeType": "SPARK_SQL",
        "NodeContent": "{     \"dbId\":123456, // 数据库Id     \"sql\":\"/* 请使用当前节点所选择的数据库语法编写SQL */\", // sql语句     \"dbType\":\"polardb\" // 数据库类型 }",
        "TimeVariables": "{   \"variables\":[     // \"variables\"为固定值     {       \"name\":\"var\", // name指定变量名       \"pattern\":\"yyyy-MM-dd|+0m+0h-2d+0w+0M+1y\" // 见后面解释     }   ] }",
        "NodeConfig": "{     \"rerun\":{ // 必填固定值         \"rerunEnable\":true, // 是否开启重跑         \"rerunCount\":1, // 重跑次数         \"rerunInterval\":10 // 重跑间隔     } }",
        "NodeOutput": "{     \"outputs\":[         {             /*             变量提取设置             {                 \"row\":0, // 行，-1为所有行                 \"column\":-1, // 列，-1为所有列                 /*                 分隔符                 当选中所有行或所有列时，需要指定连接符。变量返回值为字符串                 */                 \"combiner\":\",\"              }             */             \"extractMethod\":\"{\\\"row\\\":0,\\\"column\\\":-1,\\\"combiner\\\":\\\",\\\"}\",              \"variableName\":\"var\", // 变量名             \"description\":\"For demo\" // 变量介绍         }     ] }",
        "GraphParam": "{\\\"x\\\":435,\\\"y\\\":192,\\\"layoutType\\\":\\\"Horizontal\\\"}",
        "NodeId": "92***"
      }
    ]
  }
}

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.