DescribeBackups - ApsaraDB RDS - Centre de documentation Alibaba Cloud

Consulte la liste des jeux de sauvegarde d'une instance RDS.

Description de l'opération

Moteurs pris en charge

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

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.

rds:DescribeBackups

get

Instance de base de données.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez appeler l'opération DescribeDBInstances pour obtenir l'identifiant de l'instance.	rm-uf6wjk5****
BackupId	string	Non	L'identifiant du jeu de sauvegarde.	327329803
BackupStatus	string	Non	L'état du jeu de sauvegarde. Valeurs valides :	Success
BackupMode	string	Non	Le mode de sauvegarde. Valeurs valides :	Automated
StartTime	string	Non	Le début de la plage de temps à interroger. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mmZ. L'heure doit être en UTC.	2011-06-01T16:00Z
EndTime	string	Non	La fin de la plage de temps à interroger. L'heure de fin doit être postérieure à l'heure de début. Spécifiez l'heure selon la norme ISO 8601 au format yyyy-MM-ddTHH:mmZ. L'heure doit être en UTC. Remarque Nous vous recommandons de spécifier une plage de temps aussi courte que possible pour éviter tout dépassement de délai.	2011-06-15T16:00Z
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 30 50 100 Valeur par défaut : 30.	30
PageNumber	integer	Non	Le numéro de la page à renvoyer. Valeurs valides : tout entier positif non nul. Valeur par défaut : 1.	1
BackupType	string	Non	Le type de sauvegarde. Valeurs valides : FullBackup : sauvegarde complète IncrementalBackup : sauvegarde incrémentielle	FullBackup

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Items	object
Backup	array<object>	Les jeux de sauvegarde renvoyés.
	array<object>	Les détails des jeux de sauvegarde renvoyés.
BackupDownloadLinkByDB	object
BackupDownloadLinkByDB	array<object>	Un tableau composé d'URL à partir desquelles vous pouvez télécharger les jeux de sauvegarde de bases de données individuelles.
	object
DataBase	string	Le nom de la base de données.	dbs
DownloadLink	string	L'URL publique à partir de laquelle vous pouvez télécharger le jeu de sauvegarde.	https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
IntranetDownloadLink	string	L'URL interne à partir de laquelle vous pouvez télécharger le jeu de sauvegarde.	https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1
BackupDownloadURL	string	L'URL utilisée pour télécharger le jeu de sauvegarde via Internet. Si le jeu de sauvegarde ne peut pas être téléchargé, la valeur null est renvoyée. Remarque Par exemple, si le paramètre BackupMethod d'une instance ApsaraDB RDS for SQL Server est défini sur Snapshot, une chaîne nulle est renvoyée.	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****
BackupEndTime	string	L'heure de fin de la tâche de sauvegarde. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mmZ. L'heure est affichée en UTC.	2019-02-13T12:20:00Z
BackupId	string	L'identifiant du jeu de sauvegarde.	321020562
BackupInitiator	string	L'initiateur de la tâche de sauvegarde. Valeurs valides :	System
BackupIntranetDownloadURL	string	L'URL utilisée pour télécharger le jeu de sauvegarde via un réseau interne. Si le jeu de sauvegarde ne peut pas être téléchargé, la valeur null est renvoyée. Remarque Par exemple, si le paramètre BackupMethod d'une instance ApsaraDB RDS for SQL Server est défini sur Snapshot, une chaîne null est renvoyée.	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****
BackupMethod	string	La méthode utilisée pour générer le jeu de sauvegarde. Valeurs valides : Logical : sauvegarde logique Physical : sauvegarde physique Snapshot : sauvegarde par instantané	Physical
BackupMode	string	Le mode de sauvegarde du jeu de sauvegarde. Valeurs valides : Automated Manual	Automated
BackupSize	integer	La taille du fichier de sauvegarde des données. Unité : octets.	2167808
BackupStartTime	string	L'heure de début de la sauvegarde. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mmZ. L'heure est affichée en UTC.	2019-02-03T12:20:00Z
BackupStatus	string	L'état du jeu de sauvegarde.	Success
BackupType	string	Le type de sauvegarde du jeu de sauvegarde. Valeurs valides : FullBackup IncrementalBackup	FullBackup
Checksum	string	La somme de contrôle. La valeur de ce paramètre est calculée à l'aide de l'algorithme CRC64.	1835830439****
ConsistentTime	integer	Le point dans le temps auquel les données du jeu de sauvegarde sont cohérentes. La valeur renvoyée par ce paramètre est un horodatage. Remarque Si l'instance exécute MySQL 5.6, un horodatage est renvoyé. Sinon, la valeur 0 est renvoyée.	1576506856
CopyOnlyBackup	string	Le mode de sauvegarde du jeu de sauvegarde. Valeurs valides : 0 : le mode standard. Ce mode prend en charge les sauvegardes complètes et les sauvegardes incrémentielles. 1 : le mode de copie uniquement. Ce mode prend en charge uniquement les sauvegardes complètes. Remarque Ce paramètre est renvoyé uniquement lorsque l'instance exécute SQL Server.	0
DBInstanceId	string	L'identifiant de l'instance.	rm-uf6wjk5****
Encryption	string	Les informations de chiffrement du jeu de sauvegarde.	{}
Engine	string	Le type de moteur de base de données. Valeurs valides : MySQL SQLServer PostgreSQL MariaDB	MySQL
EngineVersion	string	La version du moteur de base de données.	8.0
HostInstanceID	string	L'identifiant de l'instance qui génère le jeu de sauvegarde. Ce paramètre est utilisé pour indiquer si l'instance qui génère le jeu de sauvegarde est une instance principale ou une instance secondaire.	5882781
IsAvail	integer	Indique si le jeu de sauvegarde est disponible. Valeurs valides : 0 : Le jeu de sauvegarde est indisponible. 1 : Le jeu de sauvegarde est disponible.	1
MetaStatus	string	L'état du jeu de sauvegarde utilisé pour restaurer des bases de données ou des tables individuelles. Valeurs valides : OK : Le fichier de sauvegarde de données est normal. LARGE : Le fichier de sauvegarde de données contient un nombre anormalement élevé de tables. Il ne peut pas être utilisé pour restaurer des bases de données ou des tables individuelles. EMPTY : Le fichier de sauvegarde de données est généré à partir d'une tâche de sauvegarde ayant échoué. Remarque Si une chaîne vide est renvoyée, le fichier de sauvegarde de données ne peut pas être utilisé pour restaurer des bases de données ou des tables individuelles.	OK
StorageClass	string	La classe de stockage du jeu de sauvegarde. Valeurs valides : 0 : stockage standard 1 : stockage d'archives	0
StoreStatus	string	Indique si le jeu de sauvegarde peut être supprimé. Valeurs valides : Enabled : Le jeu de sauvegarde peut être supprimé. Disabled : Le jeu de sauvegarde ne peut pas être supprimé.	Disabled
ExpectExpireTime	string	La date d'expiration du jeu de sauvegarde, au format yyyy-MM-ddTHH:mmZ (heure UTC). Remarque Cette valeur est renvoyée uniquement pour les sauvegardes d'une base de données unique des instances SQL Server lorsque le nombre de jours de rétention des sauvegardes est configuré.	2025-06-17T12:10:23Z
PageNumber	string	Le numéro de la page renvoyée.	1
PageRecordCount	string	Le nombre de jeux de sauvegarde sur la page actuelle.	30
RequestId	string	L'identifiant de la requête.	1A6D328C-84B8-40DC-BF49-6C73984D7494
TotalEcsSnapshotSize	integer	La taille de la chaîne d'instantanés de l'instance. Unité : octets.	0
TotalRecordCount	string	Le nombre total d'entrées renvoyées.	100

Exemples

JSON format

{
  "Items": {
    "Backup": [
      {
        "BackupDownloadLinkByDB": {
          "BackupDownloadLinkByDB": [
            {
              "DataBase": "dbs",
              "DownloadLink": "https://cn-hangzhou.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1",
              "IntranetDownloadLink": "https://cn-hangzhou-internal.bak.rds.aliyuncs.com/custins53664665/hins18676859_2021072909473127987849.zip?Expires=****&dbList=tb1"
            }
          ]
        },
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/****",
        "BackupEndTime": "2019-02-13T12:20:00Z",
        "BackupId": "321020562",
        "BackupInitiator": "System",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/****",
        "BackupMethod": "Physical",
        "BackupMode": "Automated",
        "BackupSize": 2167808,
        "BackupStartTime": "2019-02-03T12:20:00Z",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "Checksum": "1835830439****",
        "ConsistentTime": 1576506856,
        "CopyOnlyBackup": "0",
        "DBInstanceId": "rm-uf6wjk5****",
        "Encryption": "{}",
        "Engine": "MySQL",
        "EngineVersion": "8.0",
        "HostInstanceID": "5882781",
        "IsAvail": 1,
        "MetaStatus": "OK",
        "StorageClass": "0",
        "StoreStatus": "Disabled",
        "ExpectExpireTime": "2025-06-17T12:10:23Z"
      }
    ]
  },
  "PageNumber": "1",
  "PageRecordCount": "30",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "TotalEcsSnapshotSize": 0,
  "TotalRecordCount": "100"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidRestoreTime.Malformed	The requested restoreTime param is invalid, or the requested restoreTime is not within the scope of the instance backup.	Le paramètre restoreTime demandé n'est pas valide, ou le restoreTime demandé ne se situe pas dans la plage de sauvegarde de l'instance.
400	InvalidPageNumbers.Malformed	Specified page number is not valid.	Le numéro de page n'existe pas.
400	InvalidStartTime.Format	Specified start time is not valid.	L'heure de début spécifiée n'est pas valide.
400	InvalidEndTime.Format	Specified end time is not valid.	L'opération a échoué. Le format de l'heure de fin est incorrect. Le format doit être au format GMT standard : AAAA-MM-JJThh:mmZ. Exemple : 2012-06-11T15:00Z.
400	InvalidParameterCombination	The end time must be greater than the start time	L'heure de fin doit être postérieure à l'heure de début.
400	InvalidDBinstanceClass.ValueNotSupported	The specified parameter DBinstanceClass is invalid.
400	InvalidBackupSetLocation.Format	Specified backup set location is not valid.	L'emplacement du jeu de sauvegarde spécifié n'est pas valide.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	Les opérations individuelles ne sont pas autorisées pour les instances de forfait.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Le résultat de tarification du plan de prix est introuvable.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	Vous n'avez pas effectué la vérification de votre identité et n'êtes pas éligible pour effectuer des achats. Connectez-vous à la console Dépenses et Coûts pour effectuer la vérification de votre identité.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Le crédit disponible de votre compte est inférieur à 0. Rechargez votre compte avant de tenter un achat.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	L'appel au service des produits a échoué.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Alibaba Cloud prévoit d'optimiser et d'ajuster la région actuelle. Les services cloud dans cette région seront interrompus. Pour assurer la continuité de vos activités et une migration fluide des données, vous ne pouvez pas passer de nouvelles commandes d'achat pour le moment. Merci de votre compréhension et de votre soutien.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	Le module que vous avez acheté n'est pas valide. Achetez un module valide.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	La région a été mise hors service.
400	Price.CommoditySys	Commodity system call exception.	Une exception s'est produite lors de l'appel au système de produits.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	La période d'abonnement que vous avez sélectionnée n'est pas valide. Sélectionnez une période valide.
400	pay.noCreditCard	Account not bound to credit card.	Aucune carte de crédit n'est disponible.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	Une commande impayée existe pour le service que vous avez sélectionné. Payez ou annulez la commande existante avant d'en passer une nouvelle.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	Aucun mode de paiement n'est spécifié pour le compte. Ajoutez un mode de paiement.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Vos informations de base sont incomplètes. Complétez vos informations de base avant d'effectuer cette opération.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Une exception s'est produite sur votre compte. Contactez le service client pour plus de détails.
400	Api.NotSupport	Specified api is not supported.	L'opération d'API actuelle n'est pas prise en charge.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	Une balise de blocage de commande existe. Contactez votre distributeur pour résoudre ce problème.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	Le DBInstanceId spécifié n'existe pas.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	La spécification actuelle de l'instance ne prend pas en charge ce type de stockage.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	Le paramètre d'entrée n'est pas valide.
400	KmsApiError	User secret key invalid.	La clé utilisateur n'est pas valide.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.	Votre compte Alibaba Cloud n'existe pas, ou votre AccessKey a expiré.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	L'exécution de la commande SQL a échoué ou a expiré.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	La version actuelle du moteur de base de données de l'instance ne prend pas en charge l'archivage des données froides.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	La version actuelle du noyau ne prend pas en charge l'archivage des données froides.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	La spécification de l'instance actuelle ne prend pas en charge cette opération.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	Le nom de l'adresse de connexion est en double. Définissez à nouveau la chaîne de connexion.
400	RequiredParam.NotFound	Required input param is not found.	Des paramètres requis sont manquants.
400	Parameters.Invalid	Parameter error, please check the parameters.	Le paramètre est incorrect. Vérifiez le paramètre.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	La stratégie de sauvegarde actuelle ne prend pas en charge cette opération.
400	InvalideStatus.Format	The instance status does not support this operation.	L'état de l'instance ne prend pas en charge cette opération.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	La stratégie de conservation des données de sauvegarde archivées après la libération de l'instance n'est pas valide.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	Le type de moteur de base de données de l'instance ne prend pas en charge cette opération.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	Cette opération n'est pas prise en charge pour les instances de type réseau VPC.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	L'image de l'instance de base de données existe déjà.
400	UnsupportedClassCode	The specified DB instance class stops selling.	Le type d'instance n'est plus disponible à l'achat.
400	InvalidBackupSet	The specified database does not exist in the backup set.	La base de données spécifiée n'existe pas dans le jeu de sauvegarde.
400	OrdTCommodityQueryError	Failed to query for product.	Échec de l'interrogation du produit.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	L'instance a été libérée. Vérifiez l'instance avant de passer la commande.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	La région spécifiée n'est pas valide.
500	ExternalFailure	The request processing has failed due to external service failure.	La requête adressée au service a échoué. Réessayez plus tard.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	La demande de service a échoué. Réessayez plus tard ou contactez le support.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	Le traitement de la requête a échoué en raison d'une défaillance du service API RDS.
403	InvalidMaxRecordsPerPage.Malformed	Specified record number is not valid.	Le numéro d'enregistrement spécifié est incorrect.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	L'état actuel de l'instance ne prend pas en charge cette opération.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	Une commande impayée existe pour l'instance actuelle. Payez la commande et réessayez.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	La capacité cible pour la réduction de capacité ne peut pas être inférieure à l'utilisation actuelle du stockage.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	Les disques cloud SSD ne prennent pas en charge cette opération. Effectuez une mise à niveau vers ESSD.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	Les autorisations de l'utilisateur ne prennent pas en charge cette opération.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	Le VSwitchId spécifié a un format incorrect ou est vide.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	La version mineure actuelle du moteur ne prend pas en charge cette opération.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	Aucune région d'inventaire n'est disponible.
403	NotInFlowController	Sorry,no permission.	Cette fonctionnalité n'est pas disponible. Vous n'avez pas l'autorisation de l'utiliser car vous n'êtes pas un utilisateur du cloud d'entreprise.
403	InvalidKmsKey	Kms key is disabled.	La clé KMS est désactivée.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	Le niveau actuel de l'instance de base de données ne prend pas en charge cette opération.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.	L'instance spécifiée n'existe pas ou n'est pas prise en charge.
404	InvalidDBInstance.NotFound	The specified instance does not exist or is not supported.	L'instance spécifiée est introuvable. Vérifiez si l'instance est valide.
404	Request.NotFound	The requested resource is not available.	La ressource demandée n'est pas disponible.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	L'instance actuelle n'est pas autorisée à accéder à Key Management Service.
404	HostInfo.NotFound	The specified host info is not found.	Les informations d'hôte spécifiées n'existent pas.

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

Notes de version

Consultez Notes de version pour la liste complète.