DescribeHistoryTasks - Tair (Redis® OSS-Compatible) - Centre de documentation Alibaba Cloud

Consulte la liste des tâches du centre des tâches.

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.

kvstore:DescribeHistoryTasks

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Non	L'identifiant de la région. Vous pouvez appeler l'opération DescribeRegions pour obtenir la liste la plus récente des régions.	cn-beijing
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 10 à 100. Valeur par défaut : 10.	10
PageNumber	integer	Non	Le numéro de la page. La numérotation des pages commence à 1. Valeur par défaut : 1.	1
InstanceType	string	Non	Définissez la valeur sur Instance.	Instance
Status	string	Non	L'état de la tâche. Valeurs valides : Scheduled Running Succeed Failed Cancelling Canceled Waiting Remarque Ce paramètre est vide par défaut, ce qui indique que les tâches de tous les états sont interrogées. Séparez les différents états par des virgules (,).	Scheduled
InstanceId	string	Non	L'identifiant de l'instance. Ce paramètre est vide par défaut, ce qui indique que vous pouvez spécifier un nombre illimité d'identifiants d'instance. Séparez les différents identifiants d'instance par des virgules (,). Vous pouvez spécifier jusqu'à 30 identifiants d'instance.	r-uf62br2491p5l****
TaskId	string	Non	L'identifiant de la tâche. Ce paramètre est vide par défaut, ce qui indique que vous pouvez spécifier un nombre illimité d'identifiants de tâche. Séparez les différents identifiants de tâche par des virgules (,). Vous pouvez spécifier jusqu'à 30 identifiants de tâche.	t-83br18hloy3faf****
TaskType	string	Non	Le type de tâche. Ce paramètre est vide par défaut, ce qui indique que vous pouvez spécifier un nombre illimité de types de tâche. ModifyInsSpec DeleteInsNode AddInsNode HaSwitch RestartIns CreateIns ModifyInsConfig Remarque Séparez les différents types de tâche par des virgules (,).	ModifyInsSpec
FromStartTime	string	Oui	Le début de la plage horaire à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. L'heure de début peut être antérieure de 30 jours maximum à l'heure actuelle.	2022-01-02T11:31:03Z
ToStartTime	string	Oui	La fin de la plage horaire à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure doit être en UTC. Seules les tâches dont l'heure de début est antérieure ou égale à l'heure spécifiée par ce paramètre sont interrogées.	2022-02-02T11:31:03Z
FromExecTime	integer	Non	La durée d'exécution minimale d'une tâche. Ce paramètre est utilisé pour filtrer les tâches dont la durée d'exécution est supérieure à la durée d'exécution minimale. Unité : secondes. La valeur par défaut est 0, ce qui indique qu'aucune limite n'est imposée.	0
ToExecTime	integer	Non	La durée d'exécution maximale d'une tâche. Ce paramètre est utilisé pour filtrer les tâches dont la durée d'exécution est inférieure ou égale à la durée d'exécution maximale. Unité : secondes. La valeur par défaut est 0, ce qui indique qu'aucune limite n'est imposée.	0

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageNumber	integer	Le numéro de la page renvoyée.	1
RequestId	string	L'identifiant de la requête.	5D622714-AEDD-4609-9167-F5DDD3D1****
PageSize	integer	Le nombre maximal d'entrées renvoyées par page.	10
TotalCount	integer	Le nombre total de tâches qui répondent à ces contraintes sans prendre en compte la pagination.	5
Items	array<object>	Les objets de tâche interrogés.
	object
Status	string	L'état de la tâche. Scheduled Running Succeed Failed Cancelling Canceled Waiting	Running
TaskId	string	L'identifiant de la tâche.	t-83br18hloy3faf****
CurrentStepName	string	Le nom de l'étape en cours. Si ce paramètre est laissé vide, la tâche n'est pas démarrée.	exec_task
StartTime	string	L'heure de début de la tâche. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.	2022-02-03T11:31:03Z
EndTime	string	L'heure de fin de la tâche. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.	2022-02-03T12:06:17Z
TaskType	string	Le type de tâche. ModifyInsSpec DeleteInsNode AddInsNode HaSwitch RestartIns CreateIns ModifyInsConfig	ModifyInsSpec
RemainTime	integer	Le temps restant estimé pour terminer la tâche. Unité : secondes. Une valeur de 0 indique que la tâche est terminée.	1000
Progress	number	La progression de la tâche. Valeurs valides : 0 à 100.	79.0
RegionId	string	L'identifiant de la région.	cn-shanghai
InstanceType	string	Le type d'instance. La valeur renvoyée est Instance.	Instance
InstanceId	string	L'identifiant de l'instance.	r-bp1zxszhcgatnx****
InstanceName	string	Le nom de l'instance.	dba-tair-test-qcloud
DbType	string	Le type de base de données. La valeur renvoyée est redis.	redis
Product	string	Le produit. La valeur renvoyée est kvstore.	kvstore
TaskDetail	string	Les détails de la tâche. Les détails varient en fonction du type de tâche.	{\"callerUid\":\"test\"}
ReasonCode	string	La raison pour laquelle la tâche en cours a été initiée.	Mise à niveau de la version mineure
ActionInfo	string	Un ensemble d'actions autorisées pouvant être effectuées sur la tâche. Le système fait correspondre le nom de l'étape en cours et l'état de la tâche aux actions disponibles spécifiées par ActionInfo. Si aucune action correspondante n'est trouvée, l'état actuel de la tâche ne prend en charge aucune action. Exemple : `{"steps": [ { "step_name": "exec_task", // Le nom de l'étape, qui correspond à CurrentStepName. "action_info": { // Les actions prises en charge pour cette étape. "Waiting": [ // L'état, qui correspond à Status. "modifySwitchTime" // L'action. Plusieurs actions sont prises en charge. ] } }, { "step_name": "init_task", // Le nom de l'étape. "action_info": { // Les actions prises en charge pour cette étape. "Running": [ // L'état. "cancel", // L'action. "pause" ] } } ] }` Le système peut prendre en charge les actions suivantes : retry cancel modifySwitchTime : modifie l'heure de basculement ou de restauration.	{"steps":[{"action_info":{"Waiting":["modifySwitchTime"]},"step_name":"exec_task"}]}
Uid	string	L'identifiant de l'utilisateur auquel appartiennent les ressources.	141345906006****
CallerSource	string	L'identifiant de l'utilisateur qui a effectué la requête. Si CallerSource est défini sur User, CallerUid indique l'identifiant unique (UID) de l'utilisateur.	141345906006****
CallerUid	string	La source de la requête. Valeurs valides : System User	User

Exemples

JSON format

{
  "PageNumber": 1,
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "PageSize": 10,
  "TotalCount": 5,
  "Items": [
    {
      "Status": "Running",
      "TaskId": "t-83br18hloy3faf****",
      "CurrentStepName": "exec_task",
      "StartTime": "2022-02-03T11:31:03Z",
      "EndTime": "2022-02-03T12:06:17Z",
      "TaskType": "ModifyInsSpec",
      "RemainTime": 1000,
      "Progress": 79,
      "RegionId": "cn-shanghai",
      "InstanceType": "Instance",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceName": "dba-tair-test-qcloud",
      "DbType": "redis",
      "Product": "kvstore",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "ReasonCode": "小版本升级",
      "ActionInfo": "{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}",
      "Uid": "141345906006****",
      "CallerSource": "141345906006****",
      "CallerUid": "User"
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time

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

Notes de version

Consultez Notes de version pour la liste complète.