CreateBackup - ApsaraDB RDS - Centre de documentation Alibaba Cloud

Crée un jeu de sauvegarde pour une instance RDS.

Description de l'opération

Moteurs pris en charge.

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:CreateBackup

create

*DBInstance.

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

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 l'opération DescribeDBInstances pour obtenir l'identifiant de l'instance.	rm-uf6wjk5****
DBName	string	Non	Les noms des bases de données que vous souhaitez sauvegarder. Séparez plusieurs noms de bases de données par des virgules (,). Remarque Ce paramètre s'applique uniquement lorsque le paramètre BackupStrategy est défini sur db.	rds_mysql
BackupStrategy	string	Non	La stratégie de sauvegarde. Valeurs valides : db : sauvegarde de base de données instance : sauvegarde d'instance Remarque Ce paramètre s'applique uniquement dans les cas suivants : Pour une instance MySQL, ce paramètre s'applique lorsque le paramètre BackupMethod est défini sur Logical. Pour une instance SQL Server, ce paramètre s'applique lorsque le paramètre BackupType est défini sur FullBackup.	db
BackupMethod	string	Non	La méthode de sauvegarde. Valeurs valides : Logical : sauvegarde logique. Cette méthode s'applique uniquement aux instances MySQL qui utilisent des disques locaux. Physical : sauvegarde physique. Cette méthode s'applique aux instances MySQL qui utilisent des disques locaux, ainsi qu'aux instances SQL Server et PostgreSQL. Snapshot : sauvegarde par instantané. Cette méthode s'applique aux instances MySQL qui utilisent des disques cloud, ainsi qu'aux instances SQL Server, PostgreSQL et MariaDB. Valeur par défaut : Physical. Remarque Pour les sauvegardes logiques, la base de données ne peut pas être vide. Les instances MariaDB prennent uniquement en charge les sauvegardes par instantané. Cependant, vous devez définir ce paramètre sur Physical.	Physical
BackupType	string	Non	Le type de sauvegarde d'une instance SQL Server. Valeurs valides : Auto (par défaut) : le système sélectionne automatiquement entre une sauvegarde complète et une sauvegarde incrémentielle. FullBackup : sauvegarde complète Remarque Ce paramètre ne prend effet que lorsque BackupMethod est défini sur Physical.	Auto
BackupRetentionPeriod	integer	Non	Pour les instances SQL Server, vous pouvez spécifier la période de rétention d'un jeu de sauvegardes si BackupStrategy est défini sur db, BackupMethod sur Physical et BackupType sur FullBackup. La valeur doit être un entier compris entre 7 et 730. Une valeur de -1 indique une rétention à long terme. MySQL : La période de rétention des jeux de sauvegardes peut être de 7 à 730 jours, ou -1 pour une rétention à long terme.	7

Paramètres facultatifs

Cette API comporte quatre paramètres facultatifs : BackupMethod, BackupStrategy, BackupType et DBName. Utilisez des combinaisons de paramètres spécifiques en fonction du moteur de base de données et de votre scénario de sauvegarde.

MySQL

Pour une sauvegarde physique ou une sauvegarde par instantané, spécifiez uniquement le paramètre BackupMethod. Par défaut, toutes les bases de données sont sauvegardées. Les sauvegardes d'une base de données unique ne sont pas prises en charge.
Pour une sauvegarde logique :
- Pour la sauvegarde d'une base de données unique, spécifiez les paramètres BackupMethod, BackupStrategy et DBName.
- Pour sauvegarder une instance entière, spécifiez les paramètres BackupMethod et BackupStrategy.

SQL Server

Pour une sauvegarde par instantané, spécifiez uniquement le paramètre BackupMethod. Par défaut, toutes les bases de données sont sauvegardées. Les sauvegardes d'une base de données unique ne sont pas prises en charge.
Pour une sauvegarde physique :
- Pour une sauvegarde complète d'une base de données unique, spécifiez les quatre paramètres facultatifs.
- Pour une sauvegarde complète de l'ensemble de l'instance, spécifiez les paramètres BackupMethod, BackupType et BackupStrategy.
- Pour une sauvegarde incrémentielle ou complète déterminée par le système, spécifiez les paramètres BackupMethod et BackupType.
Les sauvegardes logiques ne sont pas prises en charge.

PostgreSQL

Pour une sauvegarde physique ou une sauvegarde par instantané, spécifiez uniquement le paramètre BackupMethod. Par défaut, toutes les bases de données sont sauvegardées. Les sauvegardes d'une seule base de données ne sont pas prises en charge.
Les sauvegardes logiques ne sont pas prises en charge.

MariaDB

Pour une sauvegarde par instantané, spécifiez uniquement le paramètre BackupMethod. Par défaut, toutes les bases de données sont sauvegardées. Les sauvegardes d'une base de données unique ne sont pas prises en charge.
Les sauvegardes physiques et logiques ne sont pas prises en charge.

Éléments de réponse

Élément	Type	Description	Exemple
	object	Contient les paramètres de réponse.
BackupJobId	string	L'identifiant de la tâche de sauvegarde.	507****
RequestId	string	L'identifiant de la requête.	2C125605-266F-41CA-8AC5-3A643D4F42C5

Exemples

JSON format

{
  "BackupJobId": "507****",
  "RequestId": "2C125605-266F-41CA-8AC5-3A643D4F42C5"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	BackupType.NotSupport	the specified backup type not support	Le type de sauvegarde spécifié n'est pas pris en charge.
400	InvalidBackupMethod.ValueNotSupport	The specified parameter "BackupMethod" is not valid.	La vérification de la méthode de sauvegarde a échoué. Valeurs valides : Logical (sauvegarde logique) et Physical (sauvegarde physique). Valeur par défaut : Physical. La sauvegarde logique ne prend pas en charge les instances sans base de données. ApsaraDB RDS for SQL Server prend uniquement en charge la sauvegarde physique.
400	ReadDBInstanceNotSupport	The operation is not permitted due to type of the instance.	Les instances en lecture seule ne sont pas autorisées à effectuer cette opération.
400	IncorrectDBInstanceLockMode.ValueNotSupported	The Current DB instance lock mode does not support this operation.	L'opération a échoué. Le mode de verrouillage de l'instance de base de données actuelle ne prend pas en charge cette opération.
400	BackupJobExists	A backup job already exists in the specified DB instance.	La sauvegarde existe déjà.
400	InvalidPreferredBackupTime.Format	Specified preferred backup time is not valid.	Le format de la date de sauvegarde prévue est incorrect. Le format doit être le format GMT standard : YYYY-MM-DDThh:mmZ. Exemple : 2012-06-11T15:00Z.
400	InvalidDBName.Format	Specified DB name is not valid.	Le nom de la base de données est invalide. Renommez la base de données. Le nom de la base de données doit être composé de lettres minuscules, de chiffres et de traits de soulignement, commencer par une lettre, se terminer par une lettre ou un chiffre, et comporter jusqu'à 16 caractères.
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	OperationDenied.ApiForbidden	operation not permitted.	L'opération n'est pas autorisée.
403	IncorrectDBInstanceEngine	Current DB Instance engine does not support this operation.	L'opération a échoué. Le moteur de base de données n'est pas pris en charge.
403	IncorrectDBInstanceType	Current DB instance engine and type does not support operations.	L'opération a échoué. Cette opération n'est pas prise en charge dans l'état actuel de l'instance.
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	IncorrectDBInstanceCharacterType	Current DB Instance character_type does not support this operation.	Le jeu de caractères de l'instance de base de données actuelle ne prend pas en charge cette opération.
403	Exceeded.BackupTimes	The backup times exceeds.	Les informations BackupTimes spécifiées ne sont pas valides.
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	InvalidDB.NotFound	Specified db does not exist or DB status does not support this operation.	La base de données spécifiée n'existe pas ou son état ne prend pas en charge cette opération.
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.