DescribeBackups - - Centre de documentation Alibaba Cloud

Consulte les informations de sauvegarde d'un cluster PolarDB.

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.

polardb:DescribeBackups

get

*Backup

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBClusterId	string	Oui	L'identifiant du cluster.	pc-****************
BackupId	string	Non	L'identifiant de la sauvegarde.	11111111
BackupStatus	string	Non	L'état de la sauvegarde. Valeurs valides : Success : la sauvegarde est terminée. Failed : la sauvegarde a échoué.	Success
BackupMode	string	Non	Le mode de sauvegarde. Valeurs valides : Automated : sauvegarde automatique. Manual : sauvegarde manuelle.	Automated
StartTime	string	Oui	Le début de la plage horaire à interroger. Spécifiez l'heure au format `YYYY-MM-DDThh:mmZ` (UTC).	2020-11-14T00:00Z
EndTime	string	Oui	La fin de la plage horaire à interroger. L'heure de fin doit être postérieure à l'heure de début. Spécifiez l'heure au format `YYYY-MM-DDThh:mmZ` (UTC).	2020-11-16T00:00Z
BackupRegion	string	Non	La région de destination pour les sauvegardes interrégionales. Remarque Actuellement, seul PolarDB for MySQL prend en charge ce paramètre.	cn-hangzhou
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 30 50 100 Valeur par défaut : 30.	30
PageNumber	integer	Non	Le numéro de page. Définissez la valeur sur un entier supérieur à 0 et n'excédant pas la valeur maximale du type de données Integer. Valeur par défaut : 1.	1

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalRecordCount	string	Le nombre total d'enregistrements.	1
PageRecordCount	string	Le nombre d'enregistrements sur la page actuelle.	1
RequestId	string	L'identifiant de la requête.	24A1990B-4F6E-482B-B8CB-75C612******
PageNumber	string	Le numéro de page.	1
Items	object
Backup	array<object>	Les détails du jeu de sauvegarde.
	object
BackupSetSize	string	The size of the backup file. Unit: bytes. Remarque Because data blocks are shared between snapshots, the space released after you delete a snapshot backup is much smaller than the size of the backup file. For more information, see Backup FAQ.	4639948800
ConsistentTime	string	The point in time of the consistent snapshot. The value is a UNIX timestamp. Unit: seconds.	1605425407
BackupStatus	string	The backup status. Valid values: Success: The backup is complete. Failed: The backup failed.	Success
BackupType	string	The backup type. Only full backups are supported. The value is fixed as FullBackup.	FullBackup
BackupStartTime	string	The start time of this backup (UTC).	2020-11-15T07:30:05Z
ExpectExpireTime	string	The expected expire time of the backup set. This parameter is supported only for instances with sparse backup enabled.	2022-10-24T08:13:23Z
ExpectExpireType	string	The expected expire type of the backup set. This parameter is supported only for instances with sparse backup enabled. Valeurs valides : NEVER : NEVER EXPIRED : EXPIRED DELAY : DELAY	EXPIRED
IsAvail	string	Indicates whether the backup set is available. Valid values: 0: unavailable. 1: available.	0
BackupEndTime	string	The end time of this backup (UTC).	2020-11-15T07:30:20Z
BackupId	string	The backup ID.	61*******
DBClusterId	string	The cluster ID.	pc-****************
BackupsLevel	string	The backup set level. Valid values: Level-1: level-1 backup. Level-2: level-2 backup.	Level-1
BackupMode	string	The backup mode. Valid values: Automated: automatic backup. Manual: manual backup.	Automated
BackupMethod	string	The data backup method. Only snapshot backups are supported. The value is fixed as Snapshot.	Snapshot
TableRestoreMetaStatus	string
Comment	string
TotalLevel2BackupSize	string	La taille totale des sauvegardes de niveau 2 dans la région spécifiée. Unité : octets. Remarque Seuls les types de stockage PSL4 et PSL5 sont pris en charge. Seuls les clusters pour lesquels la fonctionnalité de sauvegarde de niveau 2 est activée sont pris en charge. Si ce paramètre n'est pas renvoyé, la taille de la sauvegarde de niveau 2 est de 0.	4639948800

Exemples

JSON format

{
  "TotalRecordCount": "1",
  "PageRecordCount": "1",
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "BackupSetSize": "4639948800",
        "ConsistentTime": "1605425407",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2020-11-15T07:30:05Z",
        "ExpectExpireTime": "2022-10-24T08:13:23Z",
        "ExpectExpireType": "EXPIRED\u0000\u0000",
        "IsAvail": "0",
        "BackupEndTime": "2020-11-15T07:30:20Z",
        "BackupId": "61*******",
        "DBClusterId": "pc-****************",
        "BackupsLevel": "Level-1",
        "BackupMode": "Automated",
        "BackupMethod": "Snapshot",
        "TableRestoreMetaStatus": "",
        "Comment": ""
      }
    ]
  },
  "TotalLevel2BackupSize": "4639948800"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidBackupStatus.Malformed	The specified parameter BackupStatus is not valid.	The specified BackupStatus parameter is invalid.
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.	The specified BackupMode parameter is invalid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.	The specified StartTime parameter is invalid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.	The specified EndTime parameter is invalid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

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

Notes de version

Consultez Notes de version pour la liste complète.