Modifier les paramètres de sauvegarde - - Centre de documentation Alibaba Cloud

Avant d'appeler cette opération, vérifiez que les conditions suivantes sont remplies :

L'instance n'est pas une instance en lecture seule.
L'instance est dans l'état Running.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	ModifyBackupPolicy	Opération à effectuer. Définissez la valeur sur ModifyBackupPolicy.
DBInstanceId	String	Yes	rm-uf6wjk5xxxxxxx	ID de l'instance. Appelez l'opération DescribeDBInstances pour obtenir les ID des instances.
BackupPolicyMode	String	No	DataBackupPolicy	Type de sauvegarde à effectuer. Valeurs possibles : DataBackupPolicy : sauvegarde des données LogBackupPolicy : sauvegarde des journaux
PreferredBackupTime	String	No	00:00Z-01:00Z	Heure de début de la sauvegarde. Spécifiez l'heure au format ISO 8601 HH:mmZ-HH:mmZ (UTC). Remarque Ce paramètre est obligatoire si le paramètre BackupPolicyMode est défini sur DataBackupPolicy. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
PreferredBackupPeriod	String	No	Monday	Cycle de sauvegarde. Sélectionnez au moins deux jours de la semaine et séparez-les par des virgules (,). Valeurs possibles : Monday Tuesday Wednesday Thursday Friday Saturday Sunday Remarque Configurez la politique de sauvegarde à l'aide de ce paramètre et du paramètre BackupInterval. Par exemple, si vous définissez ce paramètre sur Saturday,Sunday et le paramètre BackupInterval sur 30, une sauvegarde est effectuée toutes les 30 minutes chaque samedi et dimanche. Ce paramètre est obligatoire si le paramètre BackupPolicyMode est défini sur DataBackupPolicy. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
BackupRetentionPeriod	String	No	7	Durée de conservation des fichiers de sauvegarde des données, en jours. Valeurs possibles : 7 à 730. Remarque Ce paramètre est obligatoire si le paramètre BackupPolicyMode est défini sur DataBackupPolicy. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
BackupLog	String	No	Enable	Active ou désactive la sauvegarde des journaux. Valeurs possibles : Enable Disabled Remarque Ce paramètre est obligatoire si le paramètre BackupPolicyMode est défini sur DataBackupPolicy. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
LogBackupRetentionPeriod	String	No	7	Durée de conservation des fichiers de sauvegarde des journaux, en jours. Valeurs possibles : 7 à 730. La durée de conservation des sauvegardes de journaux ne peut pas dépasser celle des sauvegardes de données. Remarque Si vous activez la sauvegarde des journaux, vous pouvez spécifier sa durée de conservation. Ce paramètre n'est pris en charge que par les instances exécutant MySQL et PostgreSQL. Ce paramètre s'applique si le paramètre BackupPolicyMode est défini sur DataBackupPolicy ou LogBackupPolicy.
EnableBackupLog	String	No	1	Active ou désactive la sauvegarde des journaux. Valeurs possibles : True ou 1 : la sauvegarde des journaux est activée. False ou 0 : la sauvegarde des journaux est désactivée. Remarque Ce paramètre est obligatoire si le paramètre BackupPolicyMode est défini sur LogBackupPolicy. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur LogBackupPolicy.
LocalLogRetentionHours	String	No	18	Durée de conservation des fichiers de sauvegarde des journaux sur l'instance, en heures. Valeurs possibles : 0 à 168. La valeur 0 signifie que les fichiers de sauvegarde des journaux ne sont pas conservés sur l'instance. La valeur 168 correspond à 7 × 24 heures. Remarque Ce paramètre est obligatoire si le paramètre BackupPolicyMode est défini sur LogBackupPolicy. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur LogBackupPolicy.
LocalLogRetentionSpace	String	No	30	Espace de stockage maximal autorisé pour les fichiers de sauvegarde des journaux sur l'instance, en pourcentage. Si l'espace utilisé dépasse cette valeur, ApsaraDB RDS supprime les anciens fichiers de sauvegarde des journaux jusqu'à ce que l'utilisation retombe sous le seuil défini. Valeurs possibles : 0 à 50. Vous pouvez conserver la valeur par défaut. Remarque Ce paramètre est obligatoire si le paramètre BackupPolicyMode est défini sur LogBackupPolicy. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur LogBackupPolicy.
HighSpaceUsageProtection	String	No	Enable	Indique si ApsaraDB RDS doit supprimer de force les fichiers de sauvegarde des journaux lorsque l'utilisation du stockage de l'instance dépasse 80 % ou lorsque l'espace libre est inférieur à 5 Go. Valeurs possibles : Enable et Disable. Vous pouvez conserver la valeur par défaut. Remarque Ce paramètre est obligatoire si le paramètre BackupPolicyMode est défini sur LogBackupPolicy. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur LogBackupPolicy.
LogBackupFrequency	String	No	LogInterval	Fréquence de sauvegarde des journaux de l'instance. Valeurs possibles : La valeur LogInterval déclenche une sauvegarde des journaux toutes les 30 minutes. La valeur par défaut correspond à la fréquence de sauvegarde des données. Remarque La valeur LogInterval n'est prise en charge que par les instances exécutant SQL Server. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
CompressType	String	No	4	Format de compression des sauvegardes. Valeurs possibles : 0 : aucune compression. 1 : compression zlib en fichiers .tar.gz. 2 : compression zlib parallèle. 4 : compression QuickLZ en fichiers .xb.gz. Ce format n'est pris en charge que par les instances exécutant MySQL 5.6 ou MySQL 5.7. Il permet la restauration de bases de données et de tables individuelles. Pour plus d'informations, consultez la rubrique Restaurer des bases de données et des tables individuelles d'une instance ApsaraDB RDS for MySQL. 8 : compression QuickLZ en fichiers .xb.gz. Ce format n'est pris en charge que par les instances exécutant MySQL 8.0. Il ne permet pas la restauration de bases de données et de tables individuelles. Remarque Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
ArchiveBackupRetentionPeriod	String	No	365	Durée de conservation des fichiers de sauvegarde archivés, en jours. La valeur par défaut 0 désactive l'archivage des sauvegardes. Valeurs possibles : 30 à 1095. Remarque Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
ArchiveBackupKeepPolicy	String	No	ByMonth	Période de rétention des fichiers de sauvegarde archivés. Le nombre de fichiers conservés durant cette période est déterminé par le paramètre ArchiveBackupKeepCount. Valeur par défaut : 0. Valeurs possibles : ByMonth ByWeek KeepAll Remarque Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
ArchiveBackupKeepCount	Integer	No	1	Nombre de fichiers de sauvegarde archivés à conserver. Valeur par défaut : 1. Valeurs possibles : De 1 à 31 si le paramètre ArchiveBackupKeepPolicy est défini sur ByMonth. De 1 à 7 si le paramètre ArchiveBackupKeepPolicy est défini sur ByWeek. Remarque Ce paramètre n'est pas requis si le paramètre ArchiveBackupKeepPolicy est défini sur KeepAll. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
ReleasedKeepPolicy	String	No	None	Politique de conservation des fichiers de sauvegarde archivés après la libération de l'instance. Valeur par défaut : None. Valeurs possibles : None : aucun fichier de sauvegarde archivé n'est conservé. Lastest : seul le fichier de sauvegarde archivé le plus récent est conservé. All : tous les fichiers de sauvegarde archivés sont conservés. Remarque Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
LogBackupLocalRetentionNumber	Integer	No	60	Nombre de fichiers journaux binaires à conserver sur l'instance. Valeur par défaut : 60. Valeurs possibles : 6 à 100. Remarque Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur LogBackupPolicy. Pour les instances MySQL, vous pouvez définir ce paramètre sur -1 pour conserver un nombre illimité de fichiers journaux binaires sur l'instance.
Category	String	No	Standard	Active ou désactive la fonctionnalité de sauvegarde flash (quelques secondes). Cette fonctionnalité permet à ApsaraDB RDS d'effectuer une sauvegarde en quelques secondes. Valeurs possibles : Flash : la fonctionnalité de sauvegarde flash est activée. Standard : la fonctionnalité de sauvegarde flash est désactivée. Remarque Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
BackupInterval	String	No	30	Fréquence des sauvegardes instantanées (snapshot) sur l'instance. Valeurs possibles : -1 : aucune fréquence spécifiée. 30 : sauvegarde instantanée toutes les 30 minutes. 60 : sauvegarde instantanée toutes les 60 minutes. 120 : sauvegarde instantanée toutes les 120 minutes. 240 : sauvegarde instantanée toutes les 240 minutes. 480 : sauvegarde instantanée toutes les 480 minutes. Remarque Configurez la politique de sauvegarde à l'aide de ce paramètre et du paramètre PreferredBackupPeriod. Par exemple, si vous définissez le paramètre PreferredBackupPeriod sur Saturday,Sunday et le paramètre BackupInterval sur -1, une sauvegarde instantanée est effectuée chaque samedi et dimanche. Pour les instances PostgreSQL, le paramètre BackupInterval n'est pris en charge qu'avec des disques SSD standard ou ESSD (Enhanced SSD). Pour les instances SQL Server, le paramètre BackupInterval n'est pris en charge que si la fonctionnalité de sauvegarde instantanée est activée. Pour plus d'informations, consultez la rubrique Activer les sauvegardes instantanées pour une instance ApsaraDB RDS for SQL Server. Si le paramètre Category est défini sur Flash, le paramètre BackupInterval est ignoré. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
BackupMethod	String	No	Physical	Méthode de sauvegarde de l'instance. Valeurs possibles : Physical : sauvegarde physique Snapshot : sauvegarde instantanée Valeur par défaut : Physical. Remarque Ce paramètre ne s'applique qu'aux instances SQL Server équipées de disques SSD standard ou ESSD. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
EnableIncrementDataBackup	Boolean	No	false	Active ou désactive la sauvegarde incrémentielle des données. Valeurs possibles : false : la sauvegarde incrémentielle est désactivée (valeur par défaut). true : la sauvegarde incrémentielle est activée. Remarque Ce paramètre ne s'applique qu'aux instances SQL Server équipées de disques SSD standard ou ESSD. Ce paramètre ne s'applique que si le paramètre BackupPolicyMode est défini sur DataBackupPolicy.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	DA147739-AEAD-4417-9089-65E9B1D8240D	ID de la requête.
CompressType	String	4	Format de compression des sauvegardes. Valeurs possibles : 0 : aucune compression. 1 : compression zlib. 2 : compression zlib parallèle. 4 : compression QuickLZ permettant la restauration de bases de données et de tables individuelles. 8 : compression QuickLZ ne permettant pas la restauration de bases de données ou de tables individuelles. Cette valeur n'est prise en charge que par les instances exécutant MySQL 8.0.
LocalLogRetentionSpace	String	30	Espace de stockage maximal autorisé pour les fichiers de sauvegarde des journaux sur l'instance.
LogBackupLocalRetentionNumber	Integer	60	Nombre de fichiers journaux binaires conservés sur l'instance.
DBInstanceID	String	rm-uf6wjk5xxxxxxx	ID de l'instance.
EnableBackupLog	String	1	Indique si la sauvegarde des journaux est activée. Valeurs possibles : 1 : la sauvegarde des journaux est activée. 0 : la sauvegarde des journaux est désactivée.
LocalLogRetentionHours	Integer	18	Durée de conservation des fichiers de sauvegarde des journaux sur l'instance, en heures.
HighSpaceUsageProtection	String	Disable	Indique si ApsaraDB RDS supprime de force les fichiers de sauvegarde des journaux lorsque l'utilisation du stockage de l'instance dépasse 80 % ou lorsque l'espace libre est inférieur à 5 Go.

Exemples

Exemple de requête

http(s)://rds.aliyuncs.com/?Action=ModifyBackupPolicy
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<Common request parameters>

Exemple de réponse réussie

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyBackupPolicyResponse>
      <HighSpaceUsageProtection>Disable</HighSpaceUsageProtection>
	<DBInstanceID>rm-bp1z3xxxxx</DBInstanceID>
	<RequestId>E4BF5598-ED12-4406-AAA4-F375428BE741</RequestId>
	<LocalLogRetentionHours>18</LocalLogRetentionHours>
	<EnableBackupLog>1</EnableBackupLog>
	<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
    <LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
</ModifyBackupPolicyResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HighSpaceUsageProtection" : "Disable",
  "DBInstanceID" : "rm-bp1z3xxxxx",
  "RequestId" : "E4BF5598-ED12-4406-AAA4-F375428BE741",
  "LocalLogRetentionHours" : "18",
  "EnableBackupLog" : "1",
  "LocalLogRetentionSpace" : "30",
  "LogBackupLocalRetentionNumber" : 60
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	InvalidLogBackupFrequency.Malformed	Invalid log backup frequency.	La valeur du paramètre LogBackupFrequency n'est pas valide. Vérifiez la configuration du paramètre.
400	InvalidBackupRetentionPeriod.Malformed	The specified backup retention period is invalid.	Aucune période de rétention des sauvegardes n'est spécifiée. Spécifiez une période de rétention comprise entre 1 et 30 jours.
400	BackupPropertyNotFound	Backup policy not found	Aucune politique de sauvegarde n'a été trouvée.
400	OperationDenied.SwitchToSnapshot	Snapshot backup does not support cross region storage at present. Please turn off cross region backup before switching to snapshot backup mode.	Les fichiers de sauvegarde instantanée ne peuvent pas être stockés dans une région différente de celle de l'instance. Désactivez la sauvegarde inter-régions avant d'activer la sauvegarde instantanée.
403	IncorrectCategory	Current Instance type does not support Category.	Le type d'instance actuel ne prend pas en charge le paramètre Category.
403	OperationDenied.SwitchSnapshotToPhysical	Only physical backup to snapshot backup is supported.	Seul le passage de la sauvegarde physique à la sauvegarde instantanée est pris en charge.
403	OperationDenied.ModifyBackupSwitchOff	The switch is not turned on. It is forbidden to modify the backup mode.	La fonctionnalité de sauvegarde inter-régions n'est pas activée.
403	OperationDenied.ApiForbiddenForLogBackupFrequency	When the instance is a snapshot backup, the log backup frequency is not allowed to be consistent with the data backup.	La fréquence de sauvegarde des journaux ne peut pas être identique à celle des données lorsque la sauvegarde instantanée est activée.
403	OperationDenied.NotSupportedBackupMethod	When the storage is larger than 4000 GB, only snapshot backup is supported.	Seule la sauvegarde instantanée est prise en charge lorsque le stockage dépasse 4 000 Go.
403	OperationDenied.ApiForbidden	Operation is not permitted.	L'opération n'est pas autorisée.

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.