DescribeBackups - Tair (Redis® OSS-Compatible) - Centre de documentation Alibaba Cloud

Consulte les informations sur les fichiers de sauvegarde d'une instance de base de données ApsaraDB for Tair (compatible avec Redis® OSS).

Description de l'opération

Cette opération n'est pas applicable aux instances à architecture en cluster cloud-native. Si nécessaire, utilisez l'opération DescribeClusterBackupList.

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.

kvstore:DescribeBackups

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance.	r-bp1zxszhcgatnx****
BackupId	integer	Non	L'identifiant du fichier de sauvegarde.	11611111
BackupJobId	integer	Non	L'identifiant de la tâche de sauvegarde. Cet identifiant est renvoyé par l'opération CreateBackup. Si CreateBackup renvoie plusieurs BackupJobIds, vous devez appeler cette opération pour interroger chacun d'eux séparément.	10001
PageSize	integer	Non	Le nombre maximal d'entrées par page. Valeurs valides : 30, 50, 100, 200 et 300. Valeurs valides : 30 : 30 entrées par page. 50 : 50 entrées par page. 100 : 100 entrées par page. 200 : 200 entrées par page. 300 : 300 entrées par page.	30
PageNumber	integer	Non	Le numéro de page. La valeur doit être supérieure à 0 et ne peut pas dépasser la valeur maximale du type de données Integer. Valeur par défaut : 1.	1
StartTime	string	Oui	L'heure de début de la requête. Spécifiez l'heure au format yyyy-MM-ddTHH:mmZ. L'heure doit être en UTC.	2019-03-11T10:00Z
EndTime	string	Oui	L'heure de fin de la requête. L'heure de fin doit être postérieure à l'heure de début. Spécifiez l'heure au format yyyy-MM-ddTHH:mmZ. L'heure doit être en UTC.	2019-03-14T18:00Z
NeedAof	string	Non	Indique si la persistance AOF doit être activée. Valeurs valides : 0 : Désactivée. 1 : Activée. Remarque Valeur par défaut : 0.	1

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	963C20F0-7CE1-4591-AAF3-6F3CD1CE****
PageNumber	integer	Le numéro de page.	1
PageSize	integer	Le nombre maximal d'entrées par page.	30
TotalCount	integer	Le nombre total de sauvegardes.	5
FullStorageSize	integer	La taille des fichiers de sauvegarde complète pour l'instance actuelle. Unité : octets. Les sauvegardes complètes incluent les sauvegardes planifiées quotidiennes, les sauvegardes manuelles et les sauvegardes générées lors de l'analyse du cache. Remarque Cette valeur est indépendante du nombre et de la taille des jeux de sauvegarde renvoyés dans la réponse actuelle. Elle représente la taille totale de toutes les sauvegardes complètes valides pour l'instance.	1000
LogStorageSize	integer	La taille des fichiers de sauvegarde des journaux de l'instance pour l'instance actuelle. Unité : octets. Cette valeur n'est valide que lorsque la fonctionnalité flashback est activée. Remarque Cette valeur est indépendante du nombre et de la taille des jeux de sauvegarde renvoyés dans la réponse actuelle. Elle représente la taille totale de toutes les sauvegardes de journaux d'instance valides pour l'instance.	5000
FreeSize	integer	Ce paramètre n'est pas en vigueur. Ignorez ce paramètre.	100000
Backups	object
Backup	array<object>	Les détails du jeu de sauvegarde.
	object	Les détails du jeu de sauvegarde.
BackupStatus	string	L'état de la sauvegarde. Valeurs valides : Success : La sauvegarde a réussi. Failed : La sauvegarde a échoué.	Success
BackupStartTime	string	L'heure de début de la sauvegarde. L'heure est au format YYYY-MM-DDTHH:mm:ssZ et affichée en UTC.	2019-03-14T05:28:50Z
BackupType	string	Le type de sauvegarde. Valeurs valides : FullBackup : Sauvegarde complète. IncrementalBackup : Sauvegarde incrémentielle.	FullBackup
BackupDownloadURL	string	L'URL publique pour télécharger le fichier de sauvegarde.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
NodeInstanceId	string	L'identifiant du nœud. Remarque Si l'instance utilise l'architecture standard, ce paramètre renvoie l'identifiant de l'instance.	r-bp10noxlhcoim2****-db-1
BackupEndTime	string	L'heure de fin de la sauvegarde. L'heure est au format YYYY-MM-DDTHH:mm:ssZ et affichée en UTC.	2019-03-14T05:31:13Z
BackupId	integer	L'identifiant du fichier de sauvegarde.	165*****50
BackupDBNames	string	Les bases de données qui sont sauvegardées. Valeur par défaut : all, ce qui indique que toutes les bases de données sont sauvegardées.	all
EngineVersion	string	La version du moteur de base de données, qui correspond à la version du moteur DPI compatible avec Redis sur l'instance.	4.0
BackupIntranetDownloadURL	string	L'URL interne pour télécharger le fichier de sauvegarde. Remarque Vous pouvez utiliser cette URL pour télécharger le fichier de sauvegarde à partir d'une instance ECS connectée à l'instance Tair. Les deux instances doivent résider dans le même VPC.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
BackupSize	integer	La taille du fichier de sauvegarde.	1024
BackupMode	string	Le mode de sauvegarde. Valeurs valides : Automated : Sauvegarde automatique. Manual : Sauvegarde manuelle.	Automated
BackupMethod	string	La méthode de sauvegarde. Valeurs valides : Logical : Sauvegarde logique. Physical : Sauvegarde physique.	Physical
BackupJobID	integer	L'identifiant de la tâche de sauvegarde.	24340
RecoverConfigMode	string	Indique si le jeu de sauvegarde contient des informations sur les comptes, les paramètres du noyau et les listes blanches. Remarque Ce paramètre s'applique uniquement aux instances cloud-native. Si vous modifiez les informations précédentes de l'instance, comme la création d'un compte ou l'ajout d'une liste blanche, les informations modifiées sont incluses dans les jeux de sauvegarde ultérieurs via la sauvegarde automatique.	{"whitelist":true,"config":true,"account":true}
ExpectExpireTime	string	L'heure d'expiration du jeu de sauvegarde. L'heure est au format yyyy-MM-ddTHH:mmZ et affichée en UTC.	2025-06-01T21:51:22Z
AccessDeniedDetail	object	Ce groupe de paramètres est obsolète. Ignorez-le.
AuthAction	string	Consultez la description précédente.	-
AuthPrincipalDisplayName	string	Consultez la description précédente.	-
AuthPrincipalOwnerId	string	Consultez la description précédente.	-
AuthPrincipalType	string	Consultez la description précédente.	-
EncodedDiagnosticMessage	string	Consultez la description précédente.	-
NoPermissionType	string	Consultez la description précédente.	-
PolicyType	string	Consultez la description précédente.	-

Exemples

JSON format

{
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 5,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupStartTime": "2019-03-14T05:28:50Z",
        "BackupType": "FullBackup",
        "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
        "BackupEndTime": "2019-03-14T05:31:13Z",
        "BackupId": 0,
        "BackupDBNames": "all",
        "EngineVersion": "4.0",
        "BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "BackupSize": 1024,
        "BackupMode": "Automated",
        "BackupMethod": "Physical",
        "BackupJobID": 24340,
        "RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}",
        "ExpectExpireTime": "2025-06-01T21:51:22Z"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidEngineVersion.Malformed	The Specified EngieVersion is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time.	L'heure de fin doit être postérieure à l'heure de début.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.

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

Notes de version

Consultez Notes de version pour la liste complète.