DescribeDownloadTask - - Centre de documentation Alibaba Cloud

Consulte la liste des tâches de téléchargement avancées pour les instances RDS for MySQL, RDS for PostgreSQL et PolarDB for MySQL.

Description de l'opération

Moteurs applicables

Instances ApsaraDB RDS for MySQL utilisant des disques cloud
ApsaraDB RDS for PostgreSQL
PolarDB for MySQL
MongoDB

Documents connexes

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.

dbs:DescribeDownloadTask

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionCode	string	Oui	L'identifiant de la région où réside l'instance. Pour obtenir l'identifiant de la région, appelez DescribeDBInstanceAttribute.	cn-hangzhou
InstanceName	string	Non	L'identifiant de l'instance. Remarque Ce paramètre est requis.	rm-bp1imnmcjxdz7****
DatasourceId	string	Non	L'identifiant de la source de données dans DBS. Le format est le suivant : ds-${Instance ID}_${Region ID}.	ds-rm-2ze8g2am97624****_cn-hangzhou
BackupSetId	string	Non	L'identifiant du jeu de sauvegarde. Pour obtenir l'identifiant du jeu de sauvegarde, appelez DescribeBackups.	216****
State	string	Non	L'état de la tâche de téléchargement. Valeurs valides : initializing : la tâche est en cours d'initialisation. queueing : la tâche est en file d'attente. running : la tâche est en cours d'exécution. failed : la tâche a échoué. finished : la tâche a réussi. expired : le téléchargement a expiré.	queueing
TaskType	string	Non	Le type de la tâche de téléchargement. Valeurs valides : full : téléchargement d'un jeu de sauvegarde complet. pitr : téléchargement d'une restauration à un point précis dans le temps.	full
StartTime	string	Non	Le début de la plage de temps pour interroger les tâches en fonction de leur heure de création. Il s'agit d'un horodatage UNIX en millisecondes (ms).	1661941554000
EndTime	string	Non	La fin de la plage de temps pour interroger les tâches en fonction de leur heure de création. Il s'agit d'un horodatage UNIX en millisecondes (ms).	1661941556000
PageSize	string	Non	Le nombre d'entrées à retourner sur chaque page.	50
CurrentPage	string	Non	Le numéro de page.	1
OrderDirect	string	Non	Le sens du tri. Valeurs valides : asc : ordre croissant. desc : ordre décroissant. Il s'agit de la valeur par défaut.	desc
OrderColumn	string	Non	Le champ utilisé pour le tri. La valeur par défaut est gmt_create, qui indique l'heure de création.	gmt_create
ClusterName	string	Non	Le nom du cluster fragmenté. Ce paramètre est requis uniquement pour les instances MongoDB.	dds-example

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres retournés.
RequestId	string	L'identifiant de la requête.	5D285EB9-A443-592D-9F3D-A888FAC3****
ErrCode	string	Le code d'erreur.	DBS.InternalError
Success	string	Indique si la requête a réussi. Valeurs valides : true : la requête a réussi. false : la requête a échoué.	true
ErrMessage	string	Le message d'erreur.	instanceName can not be empty
Code	string	Le code d'erreur.	DBS.InternalError
Message	string	Le message d'erreur.	instanceName can not be empty
Data	object	Les détails de la tâche.
PageNumber	integer	Le numéro de page. Il doit être supérieur à 0 et ne pas dépasser la valeur maximale du type de données entier. Valeur par défaut : 1.	1
TotalPages	integer	Le nombre total de pages.	2
Extra	string	Informations supplémentaires sur la tâche utilisée pour sauvegarder les données dans le cloud.	dbtest
TotalElements	integer	Le nombre total de tâches de téléchargement.	1
PageSize	integer	Le nombre d'entrées retournées par page.	10
Content	object
List	array<object>	The task details.
	object	The task details.
TaskId	string	The download task ID.	dt-qxntlvgu****
RegionCode	string	The region ID.	cn-hangzhou
Format	string	The destination format to which the downloaded data is converted. Valid values: csv SQL Parquet	csv
DbList	string	The list of databases.	[dbtest]
BakSetId	string	The ID of the full backup set.	148261****
DownloadStatus	string	The state of the download task. Valid values: initializing: The task is being initialized. queueing: The task is in a queue. running: The task is running. failed: The task failed. finished: The task is successful. expired: The download has expired.	queueing
ExportDataSize	string	The volume of exported data, in bytes.	0
ImportDataSize	string	The volume of processed data, in bytes.	0
BackupSetTime	string	The point in time of the point-in-time download task. This is a UNIX timestamp in milliseconds (ms).	1663162216000
TargetType	string	The type of the download destination. Valid values: OSS URL	URL
TargetPath	string	The destination path of the downloaded data. This parameter is returned when TargetType is set to OSS.	test_db/path
Progress	string	The number of exported tables/The total number of tables to be exported.	0/0
GmtCreate	string	The time when the task was created. This is a UNIX timestamp in milliseconds.	1663321957000

Exemples

JSON format

{
  "RequestId": "5D285EB9-A443-592D-9F3D-A888FAC3****",
  "ErrCode": "DBS.InternalError",
  "Success": "true",
  "ErrMessage": "instanceName can not be empty",
  "Code": "DBS.InternalError",
  "Message": "instanceName can not be empty",
  "Data": {
    "PageNumber": 1,
    "TotalPages": 2,
    "Extra": "dbtest",
    "TotalElements": 1,
    "PageSize": 10,
    "Content": {
      "List": [
        {
          "TaskId": "dt-qxntlvgu****",
          "RegionCode": "cn-hangzhou",
          "Format": "csv",
          "DbList": "[dbtest]",
          "BakSetId": "148261****",
          "DownloadStatus": "queueing",
          "ExportDataSize": "0",
          "ImportDataSize": "0",
          "BackupSetTime": "1663162216000",
          "TargetType": "URL",
          "TargetPath": "test_db/path",
          "Progress": "0/0",
          "GmtCreate": "1663321957000"
        }
      ]
    }
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
403	Request.Forbidden	Have no Permissions

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

Notes de version

Consultez Notes de version pour la liste complète.