ListTaskFlowsByPage - - Centre de documentation Alibaba Cloud

Consulte les détails des flux de tâches par page.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

dms:ListTaskFlowsByPage

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Remarque Pour consulter l'identifiant du locataire, accédez à la console Data Management (DMS) et placez le pointeur sur la photo de profil dans le coin supérieur droit. Pour plus d'informations, consultez Afficher les informations sur le locataire actuel.	3***
ScenarioId	integer	Non	Condition de filtrage, identifiant du scénario d'application.	12***
DagIdList	array	Non	Condition de filtrage, liste des identifiants de flux de tâches.
	integer	Non	Condition de filtrage, identifiant du flux de tâches.	4512
SearchKey	string	Non	Le mot-clé utilisé pour rechercher des noms de flux de tâches.	Nœud de test
PageIndex	integer	Non	Le numéro de la page à renvoyer.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer sur chaque page.	20

La relation entre les conditions de filtrage est AND.

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	6CB28697-BFE2-5739-9228-3971990E982C
ErrorCode	string	Le code d'erreur renvoyé en cas d'échec de la requête.	UnknownError
ErrorMessage	string	Le message d'erreur renvoyé en cas d'échec de la requête.	UnknownError
Success	boolean	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true
TaskFlowList	object
TaskFlow	array<object>	Les détails des flux de tâches renvoyés.
	object
Id	integer	The ID of the task flow.	7***
DagName	string	The name of the task flow.	poc_task_test
Description	string	The description of the task flow.	test
CreatorId	string	The ID of the user who created the task flow.	51****
CreatorNickName	string	The username of the user who created the task flow.	Creator_NickName
DagOwnerNickName	string	The username of the owner of the task flow.	Owner_NickName
DeployId	integer	The ID of the last deployment record of the task flow.	65***
Status	integer	The status of the task flow. Valid values: 0: invalid 1: scheduling disabled 2: waiting to be scheduled	1
LatestInstanceStatus	integer	The status of the last execution of the task flow. Valid values: 0: invalid 1: scheduling disabled 2: waiting to be scheduled	0
LatestInstanceTime	string	The time when the last execution record was created.	2022-04-13
ScenarioId	string	The ID of the application scenario.	1245
CronSwitch	boolean	Whether to enable scheduled scheduling.	false
CronStr	string	Scheduled Cron.	0 0 1 * * ? *
ScheduleParam	string	Event scheduling configuration, JSON string format.	{\"triggerType\":\"1\",\"specificTime\":'2022-11-15 11:59'}
TriggerType	integer	The trigger type. Valid values: 0: Periodic scheduling 1: Run manually	0
CronType	integer	Scheduling cycle type. Valid values: 2: Hourly scheduling 3: Daily scheduling 4: Weekly scheduling 5: Monthly scheduling	2
CronBeginDate	string	The start time of scheduled scheduling. The task flow is not scheduled before this point in time.	1970-01-01
CronEndDate	string	The end time of scheduled scheduling. The task flow is not scheduled after this point in time.	2023-01-01
TimeZoneId	string	Time zone setting. Default value: East 8(Asia/Shanghai).	Asia/Shanghai
DagOwnerId	string	The user ID of the task flow owner.	12***89
TotalCount	integer	Le nombre total d'entrées renvoyées.	24

Exemples

JSON format

{
  "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
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.