ModifyBackupPolicy - - Centre de documentation Alibaba Cloud

Modifie la stratégie de sauvegarde d'une instance MongoDB.

Description de l'opération

La géo-redondance est disponible uniquement pour les instances de jeu de réplicas et les instances de cluster fragmenté qui utilisent des disques cloud.

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.

dds:ModifyBackupPolicy

update

*Instance

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance.	dds-bp16cb162771****
PreferredBackupTime	string	Non	La plage horaire pour effectuer une sauvegarde. Spécifiez l'heure au format HH:mmZ-HH:mmZ. L'heure est exprimée en temps universel coordonné (UTC). Remarque La plage horaire doit être d'une heure.	03:00Z-04:00Z
PreferredBackupPeriod	string	Non	Le cycle de sauvegarde. Valeurs valides : Monday Tuesday Wednesday Thursday Friday Saturday Sunday Important Pour garantir la sécurité des données, sauvegardez l'instance MongoDB au moins deux fois par semaine. Remarque Pour spécifier plusieurs cycles de sauvegarde, séparez-les par des virgules (,).	Monday,Wednesday,Friday,Sunday
BackupRetentionPeriod	integer	Non	Le nombre de jours de conservation des sauvegardes complètes. Remarque Pour les instances créées avant le 10 septembre 2021, la période de conservation par défaut est de 7 jours. Pour les instances créées après le 10 septembre 2021, la période de conservation par défaut est de 30 jours.	30
EnableBackupLog	integer	Non	Indique si la sauvegarde des journaux doit être activée. Valeurs valides : 0 : Désactive la sauvegarde des journaux. Il s'agit de la valeur par défaut. 1 : Active la sauvegarde des journaux. Important Vous ne pouvez pas désactiver la sauvegarde des journaux pour les instances de cluster fragmenté.	0
LogBackupRetentionPeriod	integer	Non	Le nombre de jours de conservation des sauvegardes de journaux. Valeur par défaut : 7. Valeurs valides : de 7 à 730.	7
SnapshotBackupType	string	Non	Le type de sauvegarde d'instantané. Valeurs valides : Flash : sauvegarde de niveau seconde. Standard : sauvegarde conventionnelle. Il s'agit de la valeur par défaut.	Standard
BackupInterval	string	Non	La fréquence des sauvegardes haute fréquence. Valeurs valides : -1 : La sauvegarde haute fréquence est désactivée. 30 : toutes les 30 minutes. 60 : toutes les heures. 120 : toutes les 2 heures. 180 : toutes les 3 heures. 240 : toutes les 4 heures. 360 : toutes les 6 heures. 480 : toutes les 8 heures. 720 : toutes les 12 heures. Remarque Si vous définissez SnapshotBackupType sur Standard, la valeur de ce paramètre est -1. La sauvegarde haute fréquence ne prend effet que si vous définissez SnapshotBackupType sur Flash et que vous attribuez à ce paramètre une valeur supérieure à 0.	-1
HighFrequencyBackupRetention	integer	Non	Le nombre de jours de conservation des sauvegardes haute fréquence. Avant de spécifier ce paramètre, vous devez définir le paramètre BackupInterval. La période de conservation par défaut est d'un jour.	1
BackupRetentionPolicyOnClusterDeletion	integer	Non	La stratégie de conservation des sauvegardes lors de la libération de l'instance. 0 : Tous les jeux de sauvegarde de l'instance sont supprimés lors de la libération de l'instance. 1 : Une sauvegarde automatique est effectuée lors de la libération de l'instance, et cette sauvegarde est conservée à long terme. 2 : Une sauvegarde automatique est effectuée lors de la libération de l'instance, et tous les jeux de sauvegarde de l'instance sont conservés à long terme. Pour plus d'informations, consultez Conservation des sauvegardes à long terme.	2
CrossBackupType	string	Non	La stratégie pour les sauvegardes géo-redondantes. Valeurs valides : update : Modifie la stratégie de géo-redondance. delete : Supprime la stratégie de géo-redondance. Remarque Ce paramètre est requis si vous activez la géo-redondance.	update
SrcRegion	string	Non	L'identifiant de la région de l'instance. Remarque Ce paramètre est requis si vous restaurez une instance supprimée. Ce paramètre est requis si vous activez la géo-redondance.	cn-beijing
DestRegion	string	Non	L'identifiant de la région de la sauvegarde géo-redondante. Remarque Ce paramètre est requis si vous activez la géo-redondance.	cn-hangzhou
CrossRetentionType	string	Non	La stratégie de conservation pour les sauvegardes géo-redondantes. Valeurs valides : delay : Conserve la sauvegarde pendant une période spécifiée. never : Conserve la sauvegarde de façon permanente. Remarque Ce paramètre est requis si vous activez la géo-redondance.	delay
CrossRetentionValue	integer	Non	Le nombre de jours de conservation des sauvegardes géo-redondantes. Valeurs valides : de 3 à 1825. Remarque Ce paramètre est requis si vous activez la géo-redondance. Ce paramètre est requis si vous définissez CrossRetentionType sur delay.	7
CrossBackupPeriod	string	Non	Les jours de la semaine pour effectuer des sauvegardes géo-redondantes. Valeurs valides : Monday Tuesday Wednesday Thursday Friday Saturday Sunday Remarque Ce paramètre est requis si vous activez la géo-redondance. Pour spécifier plusieurs jours, séparez-les par des virgules (,). Si vous définissez la méthode de sauvegarde sur sauvegarde conventionnelle, les jours de la semaine spécifiés par ce paramètre doivent être un sous-ensemble des jours de la semaine spécifiés par PreferredBackupPeriod.	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
EnableCrossLogBackup	integer	Non	Indique si la sauvegarde interrégionale des journaux doit être activée. Valeurs valides : Remarque Ce paramètre est requis si vous activez la géo-redondance. 1 : Active la sauvegarde interrégionale des journaux. Cette valeur est requise pour les instances de cluster fragmenté. Cette valeur est également requise pour les instances de jeu de réplicas si vous souhaitez activer la récupération à un point dans le temps géo-redondante. 0 : Désactive la sauvegarde interrégionale des journaux.	1
CrossLogRetentionType	string	Non	La stratégie de conservation pour les sauvegardes interrégionales des journaux. Valeurs valides : delay : Conserve la sauvegarde pendant une période spécifiée. never : Conserve la sauvegarde de façon permanente. Remarque Ce paramètre est requis si vous activez la géo-redondance.	delay
CrossLogRetentionValue	integer	Non	Le nombre de jours de conservation des sauvegardes interrégionales des journaux. Valeurs valides : de 3 à 1825. La valeur doit être inférieure ou égale à la valeur de CrossRetentionValue. Remarque Ce paramètre est requis si vous activez la géo-redondance.	3
InstanceType	string	Non	Le type d'instance. Valeurs valides : replicate sharding Remarque Ce paramètre est requis lorsque vous restaurez une instance supprimée. Ce paramètre est requis lorsque vous clonez une instance à partir d'une sauvegarde géo-redondante.	replicate
PreserveOneEachHour	boolean	Non	Indique si la sauvegarde clairsemée horaire doit être activée. Valeurs valides : true : Si la fréquence de sauvegarde est en minutes, tous les instantanés générés au cours de la dernière heure sont conservés. Pour les instantanés générés il y a plus d'une heure mais moins de 24 heures, seul le premier instantané généré après chaque heure pleine est conservé. false : Tous les instantanés sont conservés pendant la période de conservation des sauvegardes haute fréquence.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	644A359C-B871-4DD3-97B5-ED91EF5809C2

Exemples

JSON format

{
  "RequestId": "644A359C-B871-4DD3-97B5-ED91EF5809C2"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidPreferredBackupPeriod.Malformed	Specified parameter PreferredBackupPeriod is not valid.
400	InvalidPreferredBackupTime.Malformed	Specified parameter PreferredBackupTime is not valid.

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

Notes de version

Consultez Notes de version pour la liste complète.