DescribeBackupPolicy - ApsaraDB RDS - Centre de documentation Alibaba Cloud

Consulte les paramètres de sauvegarde d'une instance ApsaraDB 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:DescribeBackupPolicy

get

*Instance de base de données.

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez appeler DescribeDBInstances pour obtenir l'identifiant de l'instance.	rm-uf6wjk5****
BackupPolicyMode	string	Non	Le type de sauvegarde. Valeurs valides : DataBackupPolicy : sauvegarde des données LogBackupPolicy : sauvegarde des journaux.	DataBackupPolicy
CompressType	string	Non	La méthode de compression de sauvegarde. Valeurs valides : 0 : non compressé 1 : compression zlib 2 : compression zlib parallèle 4 : compression quicklz avec restauration des bases de données et des tables activée 8 : compression quicklz sans prise en charge de la restauration des bases de données et des tables.	1
ReleasedKeepPolicy	string	Non	La politique de conservation des données de sauvegarde archivées pour les instances MySQL supprimées. Valeurs valides : None : Aucune sauvegarde archivée n'est conservée. Lastest : Seule la dernière sauvegarde archivée est conservée. All : Toutes les sauvegardes archivées sont conservées.	Lastest

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
ArchiveBackupKeepCount	string	Le nombre de sauvegardes archivées conservées pour l'instance MySQL.	1
ArchiveBackupKeepPolicy	string	Le cycle de conservation des sauvegardes archivées pour l'instance MySQL.	ByMonth
ArchiveBackupRetentionPeriod	string	Le nombre de jours pendant lesquels les sauvegardes archivées sont conservées pour l'instance MySQL.	365
BackupInterval	string	L'intervalle de sauvegarde. Unité : minutes. Pour les instances MySQL : spécifie la fréquence de sauvegarde par instantané (et non le cycle de sauvegarde par instantané). Pour les instances SQL Server : spécifie la fréquence de sauvegarde des journaux.	30
BackupLog	string	Indique si la sauvegarde des journaux est activée. Valeurs valides : Enable : activé Disabled : désactivé Pour les instances SQL Server : Ce paramètre renvoie Enable uniquement lorsque la fréquence de sauvegarde des journaux de l'instance est de toutes les 5 minutes. Lorsque la fréquence de sauvegarde des journaux de l'instance est de toutes les 30 minutes ou identique à celle de la sauvegarde des données, ce paramètre renvoie Disabled. Utilisez la valeur BackupInterval comme référence.	Enable
BackupMethod	string	La méthode de sauvegarde pour les instances SQL Server avec disques cloud. Valeurs valides : Physical : sauvegarde physique Snapshot : sauvegarde par instantané.	Physical
BackupPriority	integer	Les paramètres de sauvegarde de l'instance secondaire d'une instance SQL Server Enterprise Cluster Edition. Valeurs valides : 1 : Instance secondaire privilégiée 2 : Instance principale forcée Remarque Ce paramètre est renvoyé uniquement lorsque SupportModifyBackupPriority est True.	2
BackupRetentionPeriod	integer	Le nombre de jours pendant lesquels les sauvegardes de données sont conservées.	7
Category	string	Indique si la sauvegarde en quelques secondes est activée pour les instances MySQL et PostgreSQL. Valeurs valides : Flash : activée Standard : désactivée Remarque Ce paramètre prend effet uniquement lorsque le paramètre BackupPolicyMode est défini sur DataBackupPolicy.	Standard
CompressType	string	La méthode de compression de la sauvegarde. Valeurs valides : 0 : non compressé 1 : compression zlib 2 : compression zlib parallèle 4 : compression quicklz avec la restauration des bases de données et des tables activée 8 : compression quicklz sans prise en charge de la restauration des bases de données et des tables.	1
EnableBackupLog	string	Indique si la sauvegarde des journaux est activée. Valeurs valides : 1 : activée 0 : désactivée Pour les instances SQL Server : Ce paramètre renvoie 1 uniquement lorsque la fréquence de sauvegarde des journaux de l'instance est toutes les 5 minutes. Lorsque la fréquence de sauvegarde des journaux de l'instance est toutes les 30 minutes ou identique à celle de la sauvegarde des données, ce paramètre renvoie 0. Utilisez la valeur BackupInterval comme référence.	1
EnableIncrementDataBackup	boolean	Indique si la sauvegarde incrémentielle est activée pour l'instance SQL Server. Valeurs valides : True : activée False : désactivée.	True
IncBackupInterval	integer
EnablePitrProtection	boolean	Indique si la restauration à un instant donné (PITR) est activée pour l'instance MySQL (une version améliorée de la sauvegarde des journaux). Valeurs valides :\n- True : activée\n- False : désactivée\n\n> Pour plus d'informations, consultez Configurer une stratégie de restauration à un instant donné.	True
HighSpaceUsageProtection	string	Indique si les journaux binaires sont supprimés de force lorsque l'utilisation du stockage de l'instance MySQL dépasse 80 % ou que l'espace de stockage restant est inférieur à 5 Go. Valeurs valides : Disable : Les journaux binaires ne sont pas supprimés. Enable : Les journaux binaires sont supprimés.	Enable
LocalLogRetentionHours	integer	Le nombre d'heures pendant lesquelles les sauvegardes de journaux binaires sont conservées localement pour l'instance MySQL.	0
LocalLogRetentionSpace	string	Le pourcentage maximum de stockage local que les sauvegardes de journaux binaires peuvent occuper pour l'instance MySQL.	30
LogBackupFrequency	string	La fréquence de sauvegarde des journaux pour l'instance SQL Server. Valeurs valides : LogInterval : toutes les 30 minutes. Par défaut : identique au cycle de sauvegarde des données PreferredBackupPeriod.	LogInterval
LogBackupLocalRetentionNumber	integer	Le nombre de fichiers de journaux binaires locaux conservés pour l'instance MySQL.	60
LogBackupRetentionPeriod	integer	Le nombre de jours pendant lesquels les sauvegardes de journaux sont conservées.	7
PitrRetentionPeriod	integer	Le nombre de jours pendant lesquels la restauration à un point précis dans le temps est prise en charge pour l'instance MySQL.	7
PreferredBackupPeriod	string	Le cycle de sauvegarde des données. Les valeurs multiples sont séparées par des virgules (,). Valeurs valides : Monday : lundi Tuesday : mardi Wednesday : mercredi Thursday : jeudi Friday : vendredi Saturday : samedi Sunday : dimanche.	Monday,Wednesday,Friday,Sunday
PreferredBackupTime	string	L'heure de sauvegarde des données. Format : HH:mmZ-HH:mmZ (UTC).	15:00Z-16:00Z
PreferredNextBackupTime	string	L'heure de la prochaine sauvegarde. Format : yyyy-MM-ddTHH:mmZ (UTC).	2018-01-19T15:15Z
ReleasedKeepPolicy	string	La stratégie de conservation des données de sauvegarde archivées pour les instances MySQL supprimées. Valeurs valides : None : Aucune sauvegarde archivée n'est conservée. Lastest : Seule la dernière sauvegarde archivée est conservée. All : Toutes les sauvegardes archivées sont conservées.	None
RequestId	string	L'identifiant de la requête.	B87E2AB3-B7C9-4394-9160-7F639F732031
SupportModifyBackupPriority	boolean	Indique si l'instance SQL Server prend en charge la modification de l'option de sauvegarde de l'instance secondaire. Valeurs valides : True : pris en charge False : non pris en charge.	False
SupportReleasedKeep	integer	Un paramètre réservé.	0
SupportVolumeShadowCopy	integer	Indique si l'instance SQL Server prend en charge la sauvegarde par instantané. Valeurs valides : 1 : pris en charge 0 : non pris en charge.	1
SupportsHighFrequencyBackup	integer	Indique si l'instance SQL Server prend en charge la fonctionnalité de sauvegarde des journaux toutes les 5 minutes. Valeurs valides :\n- 0 : non pris en charge\n- 1 : pris en charge.	0
AdvancedDataPolicies	object
AdvancedDataPolicy	array<object>
	object
StrategyId	string
ActionType	string
OnlyPreserveOneEachHour	boolean
RetentionValue	integer
BakType	string
FilterKey	string
FilterValue	string
DestType	string
FilterType	string
SrcRegion	string
OnlyPreserveOneEachDay	boolean
SrcType	string
DestRegion	string
RetentionType	string
AdvancedLogPolicies	object
AdvancedLogPolicy	array<object>
	object
StrategyId	string
ActionType	string
LogRetentionType	string
DestType	string
EnableLogBackup	integer
SrcType	string
SrcRegion	string
LogRetentionValue	integer
DestRegion	string
FilterKey	string
FilterValue	string
AdvancedBackupPolicyEnabled	boolean

Exemples

JSON format

{
  "ArchiveBackupKeepCount": "1",
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "BackupLog": "Enable",
  "BackupMethod": "Physical",
  "BackupPriority": 2,
  "BackupRetentionPeriod": 7,
  "Category": "Standard",
  "CompressType": "1",
  "EnableBackupLog": "1",
  "EnableIncrementDataBackup": true,
  "IncBackupInterval": 0,
  "EnablePitrProtection": true,
  "HighSpaceUsageProtection": "Enable",
  "LocalLogRetentionHours": 0,
  "LocalLogRetentionSpace": "30",
  "LogBackupFrequency": "LogInterval",
  "LogBackupLocalRetentionNumber": 60,
  "LogBackupRetentionPeriod": 7,
  "PitrRetentionPeriod": 7,
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "ReleasedKeepPolicy": "None",
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "SupportModifyBackupPriority": true,
  "SupportReleasedKeep": 0,
  "SupportVolumeShadowCopy": 1,
  "SupportsHighFrequencyBackup": 0,
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "OnlyPreserveOneEachHour": false,
        "RetentionValue": 0,
        "BakType": "",
        "FilterKey": "",
        "FilterValue": "",
        "DestType": "",
        "FilterType": "",
        "SrcRegion": "",
        "OnlyPreserveOneEachDay": false,
        "SrcType": "",
        "DestRegion": "",
        "RetentionType": ""
      }
    ]
  },
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "LogRetentionType": "",
        "DestType": "",
        "EnableLogBackup": 0,
        "SrcType": "",
        "SrcRegion": "",
        "LogRetentionValue": 0,
        "DestRegion": "",
        "FilterKey": "",
        "FilterValue": ""
      }
    ]
  },
  "AdvancedBackupPolicyEnabled": false
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IO.Exception	IO exception, retry later.	Une exception d'E/S s'est produite.
400	InternalFailure	Internal failure, retry later.	Le traitement de la requête a échoué en raison d'une erreur, d'une exception ou d'une défaillance inconnue.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	L'opération a échoué. Le paramètre OwnerAccount est invalide. Vérifiez la valeur du paramètre.
400	InvalidEngine.Malformed	Specified engine is not valid.	La validation du type de base de données a échoué. Valeurs valides pour le type de base de données : MySQL, SQL Server, PostgreSQL et PPAS.
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	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	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	L'instance spécifiée est introuvable. Vérifiez si l'instance est valide.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.	L'instance spécifiée n'existe pas ou n'est pas prise en charge.
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	Request.NotFound	The requested resource is not available.	La ressource demandée n'est pas disponible.
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.