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

Consulta los detalles de los flujos de tareas por página.

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

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, vaya a la consola de Data Management (DMS) y pase el puntero sobre la foto de perfil en la esquina superior derecha. Para obtener más información, consulte Ver información sobre el inquilino actual.	3***
ScenarioId	integer	No	Condición de filtro: ID del escenario de aplicación.	12***
DagIdList	array	No	Condición de filtro: lista de ID de flujos de tareas.
	integer	No	Condición de filtro: ID del flujo de tareas.	4512
SearchKey	string	No	La palabra clave que se utiliza para buscar nombres de flujos de tareas.	测试节点
PageIndex	integer	No	El número de la página a devolver.	1
PageSize	integer	No	El número de entradas a devolver en cada página.	20

La relación entre las condiciones de filtro es AND.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	6CB28697-BFE2-5739-9228-3971990E982C
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
TaskFlowList	object
TaskFlow	array<object>	Los detalles de los flujos de tareas devueltos.
	object
Id	integer	El ID del flujo de tareas.	7***
DagName	string	El nombre del flujo de tareas.	poc_task_test
Description	string	La descripción del flujo de tareas.	test
CreatorId	string	El ID del usuario que creó el flujo de tareas.	51****
CreatorNickName	string	El nombre de usuario del creador del flujo de tareas.	Creator_NickName
DagOwnerNickName	string	El nombre de usuario del propietario del flujo de tareas.	Owner_NickName
DeployId	integer	El ID del último registro de despliegue del flujo de tareas.	65***
Status	integer	El estado del flujo de tareas. Valores válidos: 0: no válido 1: programación deshabilitada 2: en espera de programación	1
LatestInstanceStatus	integer	El estado de la última ejecución del flujo de tareas. Valores válidos: 0: no válido 1: programación deshabilitada 2: en espera de programación	0
LatestInstanceTime	string	La hora en que se creó el último registro de ejecución.	2022-04-13
ScenarioId	string	El ID del escenario de aplicación.	1245
CronSwitch	boolean	Indica si se debe habilitar la programación automática.	false
CronStr	string	Expresión cron programada.	0 0 1 * * ? *
ScheduleParam	string	Configuración de programación de eventos, en formato de cadena JSON.	{\"triggerType\":\"1\",\"specificTime\":'2022-11-15 11:59'}
TriggerType	integer	El tipo de activador. Valores válidos: 0: Programación periódica 1: Ejecución manual	0
CronType	integer	Tipo de ciclo de programación. Valores válidos: 2: Programación horaria 3: Programación diaria 4: Programación semanal 5: Programación mensual	2
CronBeginDate	string	La hora de inicio de la programación automática. El flujo de tareas no se programa antes de este momento.	1970-01-01
CronEndDate	string	La hora de finalización de la programación automática. El flujo de tareas no se programa después de este momento.	2023-01-01
TimeZoneId	string	Configuración de zona horaria. Valor predeterminado: East 8(Asia/Shanghai).	Asia/Shanghai
DagOwnerId	string	El ID de usuario del propietario del flujo de tareas.	12***89
TotalCount	integer	El número total de entradas devueltas.	24

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "6CB28697-BFE2-5739-9228-3971990E982C",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TaskFlowList": {
    "TaskFlow": [
      {
        "Id": 0,
        "DagName": "poc_task_test",
        "Description": "test",
        "CreatorId": "51****",
        "CreatorNickName": "Creator_NickName",
        "DagOwnerNickName": "Owner_NickName",
        "DeployId": 0,
        "Status": 1,
        "LatestInstanceStatus": 0,
        "LatestInstanceTime": "2022-04-13",
        "ScenarioId": "1245",
        "CronSwitch": false,
        "CronStr": "0 0 1 * * ? *",
        "ScheduleParam": "{\\\"triggerType\\\":\\\"1\\\",\\\"specificTime\\\":'2022-11-15 11:59'}",
        "TriggerType": 0,
        "CronType": 2,
        "CronBeginDate": "1970-01-01",
        "CronEndDate": "2023-01-01",
        "TimeZoneId": "Asia/Shanghai",
        "DagOwnerId": "12***89"
      }
    ]
  },
  "TotalCount": 24
}

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.