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

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. 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	DescribeBackupPolicy	Opération à effectuer. Définissez la valeur sur DescribeBackupPolicy.
DBInstanceId	String	Yes	rm-uf6wjk5xxxxxxx	ID de l'instance.
BackupPolicyMode	String	No	DataBackupPolicy	Type de sauvegarde. Valeurs possibles : DataBackupPolicy : sauvegarde des données LogBackupPolicy : sauvegarde des journaux
CompressType	String	No	1	Méthode de compression des données de sauvegarde. Valeurs possibles : 0 : Les données de sauvegarde ne sont pas compressées. 1 : Les données de sauvegarde sont compressées avec zlib. 2 : Les données de sauvegarde sont compressées avec zlib en utilisant plusieurs threads en parallèle pour chaque sauvegarde. 4 : Les données de sauvegarde sont compressées avec QuickLZ et permettent de restaurer des bases de données et des tables individuelles. 8 : Les données de sauvegarde sont compressées avec QuickLZ mais ne permettent pas de restaurer des bases de données ou des tables individuelles. Cette valeur est disponible uniquement pour les instances exécutant MySQL 8.0.
ReleasedKeepPolicy	String	No	Lastest	Politique de conservation des fichiers de sauvegarde archivés en cas de libération de l'instance. Valeurs possibles : None : Aucun fichier de sauvegarde archivé n'est conservé. Lastest : Seul le dernier fichier de sauvegarde archivé est conservé. All : Tous les fichiers de sauvegarde archivés sont conservés.

Paramètres de réponse

Parameter	Type	Example	Description
LogBackupRetentionPeriod	Integer	7	Nombre de jours de conservation des fichiers de sauvegarde des journaux.
ArchiveBackupKeepPolicy	String	ByMonth	Cycle de conservation des fichiers de sauvegarde archivés.
ArchiveBackupKeepCount	String	1	Nombre de fichiers de sauvegarde archivés conservés.
LocalLogRetentionHours	Integer	0	Nombre d'heures de conservation des fichiers de sauvegarde des journaux sur l'instance.
BackupRetentionPeriod	Integer	7	Nombre de jours de conservation des fichiers de sauvegarde des données.
RequestId	String	B87E2AB3-B7C9-4394-9160-7F639F732031	ID de la requête.
PreferredBackupPeriod	String	Monday,Wednesday,Friday,Sunday	Cycle de sauvegarde souhaité. Séparez les valeurs par des virgules (,). Valeurs possibles : Monday Tuesday Wednesday Thursday Friday Saturday Sunday
CompressType	String	1	Méthode de compression des données de sauvegarde. Valeurs possibles : 0 : Les données de sauvegarde ne sont pas compressées. 1 : Les données de sauvegarde sont compressées avec zlib. 2 : Les données de sauvegarde sont compressées avec zlib en utilisant plusieurs threads en parallèle pour chaque sauvegarde. 4 : Les données de sauvegarde sont compressées avec QuickLZ et permettent de restaurer des bases de données et des tables individuelles. 8 : Les données de sauvegarde sont compressées avec QuickLZ mais ne permettent pas de restaurer des bases de données ou des tables individuelles. Cette valeur est disponible uniquement pour les instances exécutant MySQL 8.0.
SupportReleasedKeep	Integer	0	Paramètre réservé.
LocalLogRetentionSpace	String	30	Utilisation maximale du disque autorisée pour les fichiers de sauvegarde des journaux sur l'instance.
SupportVolumeShadowCopy	Integer	1	Indique si l'instance prend en charge les sauvegardes instantanées. Valeurs possibles : 1 : L'instance prend en charge les sauvegardes instantanées. 0 : L'instance ne prend pas en charge les sauvegardes instantanées. Remarque Ce paramètre est renvoyé uniquement pour les instances exécutant SQL Server.
BackupMethod	String	Physical	Méthode de sauvegarde de l'instance. Valeurs possibles : Physical : sauvegarde physique Snapshot : sauvegarde instantanée Remarque Ce paramètre est renvoyé uniquement lorsque l'instance exécute SQL Server et utilise des disques SSD standard ou des disques ESSD (Enhanced SSD).
LogBackupFrequency	String	LogInterval	Fréquence de sauvegarde des journaux. Valeurs possibles : LogInterval : Les sauvegardes des journaux sont effectuées toutes les 30 minutes. Valeur par défaut : identique à la valeur du paramètre PreferredBackupPeriod. Remarque Le paramètre LogBackupFrequency est renvoyé uniquement pour les instances exécutant SQL Server.
PreferredNextBackupTime	String	2018-01-19T15:15Z	Heure de la prochaine sauvegarde. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mmZ et est affichée en UTC.
HighSpaceUsageProtection	String	Enable	Indique si la fonctionnalité de suppression des sauvegardes de journaux est activée. Si l'utilisation du disque dépasse 80 % ou si l'espace disque restant est inférieur à 5 Go sur l'instance, cette fonctionnalité supprime les fichiers journaux binaires. Valeurs possibles : Disable Enable
ArchiveBackupRetentionPeriod	String	365	Nombre de jours de conservation des fichiers de sauvegarde archivés.
BackupInterval	String	30	Intervalle de sauvegarde. Unité : minutes. Si l'instance exécute MySQL, l'intervalle correspond à la valeur du paramètre Heure de début de la sauvegarde instantanée (et non au paramètre Période de sauvegarde instantanée) dans la console ApsaraDB RDS. Pour plus d'informations, consultez Sauvegarder une instance ApsaraDB RDS for MySQL. Si l'instance exécute SQL Server, l'intervalle correspond à la fréquence de sauvegarde des journaux.
ReleasedKeepPolicy	String	None	Politique de conservation des fichiers de sauvegarde archivés en cas de libération de l'instance. Valeurs possibles : None : Aucun fichier de sauvegarde archivé n'est conservé. Lastest : Seul le dernier fichier de sauvegarde archivé est conservé. All : Tous les fichiers de sauvegarde archivés sont conservés.
PreferredBackupTime	String	15:00Z-16:00Z	Heure de la sauvegarde des données. L'heure suit la norme ISO 8601 au format HH:mmZ-HH:mmZ et est affichée en UTC.
LogBackupLocalRetentionNumber	Integer	60	Nombre de fichiers journaux binaires conservés sur l'instance.
Category	String	Standard	Indique si la fonctionnalité de sauvegarde en quelques secondes est activée. Cette fonctionnalité permet à ApsaraDB RDS de terminer une sauvegarde en quelques secondes. Valeurs possibles : Flash : La fonctionnalité de sauvegarde en quelques secondes est activée. Standard : La fonctionnalité de sauvegarde en quelques secondes est désactivée. Remarque Ce paramètre prend effet uniquement lorsque le paramètre BackupPolicyMode est défini sur DataBackupPolicy.
EnableBackupLog	String	1	Indique si la fonctionnalité de sauvegarde des journaux est activée. Valeurs possibles : 1 : La fonctionnalité de sauvegarde des journaux est activée. 0 : La fonctionnalité de sauvegarde des journaux est désactivée.
BackupLog	String	Enable	Indique si la fonctionnalité de sauvegarde des journaux est activée. Valeurs possibles : Enable Disabled
EnableIncrementDataBackup	Boolean	True	Indique si la sauvegarde incrémentielle est activée. Valeurs possibles : True : La sauvegarde incrémentielle est activée. False : La sauvegarde incrémentielle est désactivée.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

XML format

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

<DescribeBackupPolicyResponse>
<Category>Standard</Category>
<ArchiveBackupRetentionPeriod>0</ArchiveBackupRetentionPeriod>
<RequestId>292884FE-D689-47A2-9829-C05E63366201</RequestId>
<Duplication/>
<ReleasedKeepPolicy>None</ReleasedKeepPolicy>
<ArchiveBackupKeepPolicy>ByMonth</ArchiveBackupKeepPolicy>
<PreferredBackupTime>00:00Z-01:00Z</PreferredBackupTime>
<LocalLogRetentionHours>18</LocalLogRetentionHours>
<PreferredNextBackupTime>2021-01-07T00:40Z</PreferredNextBackupTime>
<HighSpaceUsageProtection>Enable</HighSpaceUsageProtection>
<CompressType>1</CompressType>
<LogBackupFrequency>LogInterval</LogBackupFrequency>
<PreferredBackupPeriod>Tuesday,Thursday,Saturday</PreferredBackupPeriod>
<ArchiveBackupKeepCount>1</ArchiveBackupKeepCount>
<LogBackupRetentionPeriod>7</LogBackupRetentionPeriod>
<LogBackupLocalRetentionNumber>60</LogBackupLocalRetentionNumber>
<BackupLog>Enable</BackupLog>
<EnableBackupLog>1</EnableBackupLog>
<SupportReleasedKeep>0</SupportReleasedKeep>
<SupportVolumeShadowCopy>1</SupportVolumeShadowCopy>
<LocalLogRetentionSpace>30</LocalLogRetentionSpace>
<BackupRetentionPeriod>10</BackupRetentionPeriod>
<DuplicationContent/>
<BackupInterval>30</BackupInterval>
</DescribeBackupPolicyResponse>

JSON format

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

{
  "Category" : "Standard",
  "ArchiveBackupRetentionPeriod" : 0,
  "RequestId" : "292884FE-D689-47A2-9829-C05E63366201",
  "Duplication" : "",
  "ReleasedKeepPolicy" : "None",
  "ArchiveBackupKeepPolicy" : "ByMonth",
  "PreferredBackupTime" : "00:00Z-01:00Z",
  "LocalLogRetentionHours" : "18",
  "PreferredNextBackupTime" : "2021-01-07T00:40Z",
  "HighSpaceUsageProtection" : "Enable",
  "CompressType" : "1",
  "LogBackupFrequency" : "LogInterval",
  "PreferredBackupPeriod" : "Tuesday,Thursday,Saturday",
  "ArchiveBackupKeepCount" : 1,
  "LogBackupRetentionPeriod" : "7",
  "LogBackupLocalRetentionNumber" : 60,
  "BackupLog" : "Enable",
  "EnableBackupLog" : "1",
  "SupportReleasedKeep" : 0,
  "SupportVolumeShadowCopy" : 1,
  "LocalLogRetentionSpace" : "30",
  "BackupRetentionPeriod" : 10,
  "DuplicationContent" : "",
  "BackupInterval" : "30"
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	IO.Exception	IO exception, retry later.	Le message d'erreur renvoyé en raison d'erreurs d'E/S.
400	InternalFailure	Internal failure, retry later.	Le message d'erreur renvoyé en raison de l'échec de la requête. Réessayez ultérieurement.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	Le message d'erreur renvoyé car la valeur du paramètre OwnerAccount n'est pas valide. Vérifiez la valeur.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	Le message d'erreur renvoyé car l'instance est introuvable, a été supprimée ou ne prend pas en charge l'opération.

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