DescribeBackupPolicy - - Centre de documentation Alibaba Cloud

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

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

get

*dbinstance

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****
InstanceType	string	Non	Le type d'instance. replicate : instance de jeu de réplicas sharding : instance de cluster fragmenté	sharding
SrcRegion	string	Non	La région où se trouve l'instance.	cn-beijing

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
PreferredBackupPeriod	string	Le cycle de sauvegarde. Valeurs valides : Monday : lundi. Tuesday : mardi. Wednesday : mercredi. Thursday : jeudi. Friday : vendredi. Saturday : samedi. Sunday : dimanche.	Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
RequestId	string	L'identifiant de la requête.	5A9464CA-F7DC-5434-90B1-DF7F197C****
PreferredBackupTime	string	L'heure de sauvegarde au format HH:mmZ-HH:mmZ (heure UTC).	09:00Z-10:00Z
BackupRetentionPeriod	string	La période de rétention des sauvegardes en jours.	30
PreferredNextBackupTime	string	L'heure de la prochaine sauvegarde régulière au format yyyy-mm-ddthh:mmz (heure UTC).	2024-06-19T19:11Z
EnableBackupLog	integer	Indique si la sauvegarde des journaux est activée. Valeurs valides : 0 : désactivée (par défaut). 1 : activée.	1
LogBackupRetentionPeriod	integer	La période de rétention des sauvegardes de journaux en jours. Valeurs valides : 7 à 730.	7
SnapshotBackupType	string	Le type de sauvegarde d'instantané. Valeurs valides : Flash : sauvegarde à la seconde. Standard : sauvegarde régulière (par défaut).	Standard
BackupInterval	integer	La fréquence des sauvegardes à haute fréquence. Valeurs valides : -1 : la sauvegarde à haute fréquence est désactivée. 15 : toutes les 15 minutes. 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.	-1
HighFrequencyBackupRetention	string	La période de rétention des sauvegardes à haute fréquence en jours.	1
BackupRetentionPolicyOnClusterDeletion	integer	La stratégie de rétention des sauvegardes. 0 : tous les jeux de sauvegarde de l'instance sont immédiatement supprimés lors de la libération de l'instance. 1 : l'instance est automatiquement sauvegardée lors de sa libération, et le jeu de sauvegarde est conservé à long terme. 2 : l'instance est automatiquement sauvegardée lors de sa libération, et tous les jeux de sauvegarde du cluster sont conservés à long terme. Pour plus d'informations, consultez Rétention des sauvegardes à long terme.	0
SrcRegion	string	La région où se trouve l'instance source.	cn-hangzhou
DestRegion	string	La région où se trouve la sauvegarde à redondance géographique.	cn-shenzhen
CrossRetentionType	string	Le type de rétention de la sauvegarde à redondance géographique. delay : conservée pendant une certaine période never : n'expire jamais	delay
CrossRetentionValue	integer	La période de rétention de la sauvegarde à redondance géographique.	7
CrossBackupPeriod	string	La période de rétention de la sauvegarde à redondance géographique. Monday : lundi. Tuesday : mardi. Wednesday : mercredi. Thursday : jeudi. Friday : vendredi. Saturday : samedi. Sunday : dimanche. Remarque Requis pour la sauvegarde à redondance géographique	Monday
EnableCrossLogBackup	integer	Indique si la sauvegarde interrégionale des journaux est activée. Remarque Requis pour la sauvegarde à redondance géographique 1 : activée (doit être 1 pour les instances de cluster fragmenté) 0 : désactivée (doit être 0 pour les instances de jeu de réplicas)	1
CrossLogRetentionType	string	Le type de rétention de la sauvegarde des journaux à redondance géographique. delay : conservée pendant une certaine période never : n'expire jamais	delay
CrossLogRetentionValue	integer	La période de rétention de la sauvegarde des journaux à redondance géographique.	7
PreserveOneEachHour	boolean	Indique si la sauvegarde clairsemée dans l'heure est activée. true : lorsque la fréquence de sauvegarde est à la minute, tous les instantanés dans l'heure suivant l'heure actuelle sont conservés. Pour les instantanés datant de plus d'une heure mais de moins de 24 heures par rapport à l'heure actuelle, seul le premier instantané après chaque heure est conservé. false : la sauvegarde clairsemée dans l'heure est désactivée : tous les instantanés dans la période de rétention des sauvegardes à haute fréquence sont conservés.	false

Exemples

JSON format

{
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "RequestId": "5A9464CA-F7DC-5434-90B1-DF7F197C****",
  "PreferredBackupTime": "09:00Z-10:00Z",
  "BackupRetentionPeriod": "30",
  "PreferredNextBackupTime": "2024-06-19T19:11Z",
  "EnableBackupLog": 1,
  "LogBackupRetentionPeriod": 7,
  "SnapshotBackupType": "Standard",
  "BackupInterval": -1,
  "HighFrequencyBackupRetention": "1",
  "BackupRetentionPolicyOnClusterDeletion": 0,
  "SrcRegion": "cn-hangzhou",
  "DestRegion": "cn-shenzhen",
  "CrossRetentionType": "delay",
  "CrossRetentionValue": 7,
  "CrossBackupPeriod": "Monday",
  "EnableCrossLogBackup": 1,
  "CrossLogRetentionType": "delay",
  "CrossLogRetentionValue": 7,
  "PreserveOneEachHour": false
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.