DescribeTasks - PolarDB - Centre de documentation Alibaba Cloud

Obtient la liste des tâches d'une instance.

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.

polardbx:DescribeTasks

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	Le nom de l'instance.	pxc-hzjasd****
StartTime	string	Oui	L'heure de début de la tâche.	2021-11-01
EndTime	string	Oui	L'heure de fin de la tâche.	2021-11-04
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : de 5 à 1000.	20
PageNumber	integer	Non	Le numéro de page.	30
RegionId	string	Oui	L'identifiant de la région.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	D6045D78-C119-5A17-9DEA-0F810394E008
PageNumber	integer	Le numéro de page.	1
PageRecordCount	integer	Le nombre d'entrées par page.	30
TotalRecordCount	integer	Le nombre total d'entrées.	2
Items	array<object>	La liste des éléments de résultat.
	object
Status	string	L'état de la tâche. Valeurs valides : RUNNING : la tâche est en cours d'exécution. FAILED : la tâche a échoué et a été interrompue.	RUNNING
FinishTime	string	L'heure de fin de la tâche, au format yyyy-MM-dd'T'HH:mm:ss'Z'.	2021-10-20T20:00:00Z
Progress	string	La progression de la tâche, en pourcentage (%).	80
BeginTime	string	L'heure de début de la tâche, au format yyyy-MM-dd'T'HH:mm:ss'Z'.	2021-10-20T19:40:00Z
TaskErrorCode	string	Le code d'erreur de la tâche en échec.	TaskErrorCode
DBName	string	Le nom de la base de données associée à la tâche. Ce paramètre est généralement vide.	DBName
ProgressInfo	string	Les informations détaillées sur la progression de la tâche. Ce paramètre est généralement vide.	ProgressInfo
ScaleOutToken	string	L'identifiant de mise à l'échelle si la tâche est une tâche de mise à l'échelle. Il s'agit d'une clé unique dans le backend.	FEA5DC20-6D8A-5979-97AA-FC57546ADC20
TaskId	string	L'identifiant de la tâche.	20089398
TaskErrorMessage	string	Le message d'erreur de la tâche en échec.	TaskErrorMessage
TaskAction	string	L'action de la tâche, qui correspond à la clé unique du type de tâche dans le backend.	multi_scale_out

Exemples

JSON format

{
  "RequestId": "D6045D78-C119-5A17-9DEA-0F810394E008",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 2,
  "Items": [
    {
      "Status": "RUNNING",
      "FinishTime": "2021-10-20T20:00:00Z",
      "Progress": "80",
      "BeginTime": "2021-10-20T19:40:00Z",
      "TaskErrorCode": "TaskErrorCode",
      "DBName": "DBName",
      "ProgressInfo": "ProgressInfo",
      "ScaleOutToken": "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
      "TaskId": "20089398",
      "TaskErrorMessage": "TaskErrorMessage",
      "TaskAction": "multi_scale_out"
    }
  ]
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.