DescribeBackups - - Centre de documentation Alibaba Cloud

Consulte les sauvegardes 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:DescribeBackups

get

*Instance

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. Remarque Si l'instance est une instance de cluster fragmenté, vous devez également spécifier le paramètre NodeId.	dds-bp1a7009eb24****
NodeId	string	Non	L'identifiant du nœud de fragmentation dans l'instance de cluster fragmenté. Remarque Ce paramètre est requis si vous spécifiez l'identifiant d'une instance de cluster fragmenté pour le paramètre DBInstanceId.	d-bp128a003436****
BackupId	string	Non	L'identifiant de la sauvegarde. Si vous spécifiez l'identifiant d'une instance de cluster fragmenté pour le paramètre DBInstanceId, le nombre d'identifiants de sauvegarde doit être identique au nombre de nœuds de fragmentation. Séparez les identifiants de sauvegarde par des virgules (,).	2072**,2072,2072**
PageNumber	integer	Non	Le numéro de page. La valeur doit être supérieure à 0 et ne pas dépasser la valeur maximale du type de données entier. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées à retourner sur chaque page. Valeurs valides : 30 (par défaut) 50 100	30
StartTime	string	Non	Le début de la plage horaire à interroger. Spécifiez l'heure au format yyyy-MM-ddTHH:mmZ. L'heure doit être en temps universel coordonné (UTC). Remarque Ce paramètre n'est pas valide si vous spécifiez le paramètre BackupId.	2022-01-13T13:00Z
EndTime	string	Non	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. L'heure doit être en UTC. Remarque Ce paramètre n'est pas valide si vous spécifiez le paramètre BackupId.	2022-01-14T13:00Z
SrcRegion	string	Non	La région où réside l'instance. Remarque Ce paramètre est requis pour restaurer une instance supprimée. Ce paramètre est requis pour la géo-redondance.	cn-beijing
DestRegion	string	Non	La région où réside la sauvegarde. Remarque Ce paramètre est requis pour la géo-redondance.	cn-hangzhou
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-xxxx
BackupJobId	string	Non	L'identifiant de la tâche de sauvegarde.	775051

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalCount	integer	Le nombre total de sauvegardes.	1
RequestId	string	L'identifiant de la requête.	275D43C3-F12F-5224-B375-************
PageSize	integer	Le nombre d'entrées retournées par page. Valeurs valides : 30 (par défaut) 50 100	30
PageNumber	integer	Le numéro de page.	1
Backups	object
Backup	array<object>	Les détails des fichiers de sauvegarde.
	object	Les détails des fichiers de sauvegarde.
BackupStatus	string	The backup status. Valid values: Success: The backup is successful. Failed: The backup failed.	Success
BackupType	string	The backup type. Valid values: FullBackup: full backup. IncrementalBackup: incremental backup.	FullBackup
BackupStartTime	string	The start time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2022-01-14T03:56:17Z
BackupIntranetDownloadURL	string	The internal download URL for the backup file. Remarque Use this URL to download the backup file from an ECS instance. The ECS instance must be in the same network as the MongoDB instance.	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559***/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=*******************&Signature=****************************&Region=cn-hangzhou
BackupSize	integer	The size of the backup file. Unit: bytes.	6168576
BackupDownloadURL	string	The external download URL for the backup file. If the file is not available for download, an empty string is returned.	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=********************&Signature=****************************&Region=cn-hangzhou
BackupMode	string	The backup mode. Valid values: Automated: automatic backup. Manual: manual backup.	Automated
BackupEndTime	string	The end time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2022-01-14T03:57:34Z
BackupId	string	The backup ID.	32102****
BackupDBNames	string	The name of the database that is backed up.	database
BackupMethod	string	The backup method. Valid values: Snapshot: snapshot backup. Physical: physical backup. Logical: logical backup.	Physical
BackupJobId	string	The ID of the backup set job.	1123xxxx
BackupName	string	The name of the backup set. This parameter is currently invalid.	12345678.tar.gz
BackupScale	string	The backup granularity. This parameter is currently invalid.	DBInstance
IsAvail	boolean	Indicates whether the backup set is available. Valid values: false: unavailable. true: available.	1
EngineVersion	string	The database engine version of the instance when the backup was created. Valid values: 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
BackupExpireTime	string	The expiration time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC. Important A value of "9999-01-01T00:00:00Z" indicates that the backup is permanently retained.	2025-08-30T09:49:11Z

Exemples

JSON format

{
  "TotalCount": 1,
  "RequestId": "275D43C3-F12F-5224-B375-************",
  "PageSize": 30,
  "PageNumber": 1,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2022-01-14T03:56:17Z",
        "BackupIntranetDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=***********************&Signature=******************************&Region=cn-hangzhou",
        "BackupSize": 6168576,
        "BackupDownloadURL": "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&OSSAccessKeyId=************************&Signature=******************************&Region=cn-hangzhou",
        "BackupMode": "Automated",
        "BackupEndTime": "2022-01-14T03:57:34Z",
        "BackupId": "32102****",
        "BackupDBNames": "database",
        "BackupMethod": "Physical",
        "BackupJobId": "1123xxxx",
        "BackupName": "12345678.tar.gz",
        "BackupScale": "DBInstance",
        "IsAvail": true,
        "EngineVersion": "4.2",
        "BackupExpireTime": "2025-08-30T09:49:11Z"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The Specified parameter StartTime or EndTime is not valid.
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.