DescribeClusterBackups - - Centre de documentation Alibaba Cloud

Consulte les jeux de sauvegarde de cluster pour une instance de cluster fragmenté ApsaraDB for MongoDB utilisant des disques cloud.

Description de l'opération

Pour les instances de cluster fragmenté qui utilisent des disques cloud et qui ont été créées avant le 19 octobre 2023, vous devez d'abord appeler l'opération TransferClusterBackup pour convertir les sauvegardes de fragment en sauvegardes de cluster.

Les instances de cluster fragmenté qui utilisent des disques cloud et qui ont été créées après le 19 octobre 2023 utilisent les sauvegardes de cluster par défaut.

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

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.	dds-bp16cb162771****
BackupId	string	Non	L'identifiant de la sauvegarde de cluster.	5664****
PageNo	integer	Non	Le numéro de la page à renvoyer. La valeur doit être un entier positif. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées à renvoyer 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.	2019-03-13T12:11Z
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.	2019-03-14T13:10Z
IsOnlyGetClusterBackUp	boolean	Non	Indique si les informations sur les nœuds enfants dans la sauvegarde de cluster doivent être interrogées. Valeurs valides : true : renvoie uniquement les informations de base sur la sauvegarde de cluster, et non les informations de sauvegarde de tous les nœuds enfants. false (Par défaut) : renvoie les informations de sauvegarde de tous les nœuds enfants.	true
SrcRegion	string	Non	La région où réside l'instance. Remarque Ce paramètre est requis lorsque vous interrogez les jeux de sauvegarde d'une instance libérée. Ce paramètre est requis lorsque vous interrogez des sauvegardes géo-redondantes.	cn-hangzhou
DestRegion	string	Non	La région où réside la sauvegarde géo-redondante. Remarque Ce paramètre est requis lorsque vous interrogez des sauvegardes géo-redondantes.	cn-shanghai
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	Le schéma de la réponse.
RequestId	string	L'identifiant de la requête.	2F42BB4E-461F-5B55-A37C-53B1141C****
MaxResults	integer	Le nombre maximal d'entrées renvoyées dans cette requête.	10
PageNumber	integer	Le numéro de la page renvoyée.	1
PageSize	integer	Le nombre d'entrées renvoyées par page.	30
ClusterBackups	array<object>	Les détails des jeux de sauvegarde de cluster. Une sauvegarde de cluster contient les jeux de sauvegarde de tous les nœuds.
	array<object>	Les détails des jeux de sauvegarde de cluster. Une sauvegarde de cluster contient les jeux de sauvegarde de tous les nœuds.
IsAvail	integer	Indique si le jeu de sauvegarde de cluster est valide. Valeurs valides : 1 : le jeu de sauvegarde de cluster est valide. 0 : les jeux de sauvegarde des nœuds enfants sont incomplets ou ont échoué.	1
ClusterBackupId	string	L'identifiant de la sauvegarde de cluster.	cb-o8c2ugnxo26kx***
ClusterBackupStatus	string	L'état de la sauvegarde de cluster.	OK
ClusterBackupStartTime	string	L'heure de début de la sauvegarde de cluster.	2023-10-16T19:33:20Z
ClusterBackupSize	string	La taille du jeu de sauvegarde de cluster, en octets.	107374182400
ClusterBackupEndTime	string	L'heure de fin de la sauvegarde de cluster.	2023-10-16T19:33:20Z
ClusterBackupMode	string	Le mode de la sauvegarde de cluster.	Automated
ExtraInfo	object	Les informations supplémentaires. La valeur est une chaîne au format JSON.
RegistryFromHistory	string	Indicates whether the backup set was migrated from a historical backup. A value of 1 indicates that the backup was migrated.	1
Backups	array<object>	Les jeux de sauvegarde de chaque nœud enfant dans la sauvegarde de cluster.
	array<object>	Les jeux de sauvegarde de chaque nœud enfant dans la sauvegarde de cluster.
BackupId	string	The ID of the backup.	738025367
InstanceName	string	The name of the shard in the MongoDB cluster.	d-bp16cb162771****
BackupDownloadURL	string	The public URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.	http://oss.com/xxx
BackupIntranetDownloadURL	string	The internal URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.	http://oss.com/xxx
BackupStartTime	string	The time when the backup started. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2023-10-16T19:33:20Z
BackupEndTime	string	The time when the backup finished. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2023-10-16T19:33:20Z
BackupSize	string	The size of the backup file, in bytes.	77544597650
IsAvail	string	Indicates whether the backup set is available. Valid values: 0: unavailable. 1: available.	1
BackupStatus	string	The backup status. Valid values: Success: The backup is successful. Failed: The backup failed.	Success
BackupName	string	The name of the backup.	12345678.tar.gz
ExtraInfo	object	The information about the instance node that is associated with the backup.
NodeId	string	The ID of the node.	d-2ze75ab1fa5d****
StorageSize	string	The storage space of the node, in MB.	20480
InstanceClass	string	The specifications of the node.	mdb.shard.4x.large.d
NodeType	string	The type of the node.	db
Progress	string	La progression de la sauvegarde en pourcentage. Ce paramètre n'est renvoyé que pour les sauvegardes en cours.	50
AttachLogStatus	string	L'état de la sauvegarde des journaux attachés. Valeurs valides : Init : initialisation. No_Need : aucune sauvegarde des journaux attachés n'est disponible. Running : la sauvegarde des journaux attachés est en cours. Ready : la sauvegarde des journaux attachés est terminée. Failed : la sauvegarde des journaux attachés a échoué. Remarque Si la valeur du paramètre ClusterBackupStatus est OK, cela indique uniquement que la sauvegarde complète a réussi. Pour une instance de cluster pour laquelle la sauvegarde des journaux est activée, la sauvegarde des journaux attachés doit être terminée avant de pouvoir effectuer une restauration à un point dans le temps ou garantir la cohérence des données.	Ready
EngineVersion	string	La version du moteur de base de données de l'instance au moment de la création de la sauvegarde. Valeurs valides : 7.0 6.0 5.0 4.4 4.2 4.0 3.4	4.2
BackupExpireTime	string	L'heure d'expiration de la sauvegarde. L'heure est au format yyyy-MM-ddTHH:mm:ssZ et est affichée en UTC. Important Une valeur de "9999-01-01T00:00:00Z" indique que la sauvegarde est conservée de manière permanente.	2025-03-29T03:47:12Z

Exemples

JSON format

{
  "RequestId": "2F42BB4E-461F-5B55-A37C-53B1141C****",
  "MaxResults": 10,
  "PageNumber": 1,
  "PageSize": 30,
  "ClusterBackups": [
    {
      "IsAvail": 1,
      "ClusterBackupId": "cb-o8c2ugnxo26kx***",
      "ClusterBackupStatus": "OK",
      "ClusterBackupStartTime": "2023-10-16T19:33:20Z",
      "ClusterBackupSize": "107374182400",
      "ClusterBackupEndTime": "2023-10-16T19:33:20Z",
      "ClusterBackupMode": "Automated",
      "ExtraInfo": {
        "RegistryFromHistory": "1"
      },
      "Backups": [
        {
          "BackupId": "738025367",
          "InstanceName": "d-bp16cb162771****\n",
          "BackupDownloadURL": "http://oss.com/xxx",
          "BackupIntranetDownloadURL": "http://oss.com/xxx",
          "BackupStartTime": "2023-10-16T19:33:20Z",
          "BackupEndTime": "2023-10-16T19:33:20Z",
          "BackupSize": "77544597650",
          "IsAvail": "1",
          "BackupStatus": "Success",
          "BackupName": "12345678.tar.gz",
          "ExtraInfo": {
            "NodeId": "d-2ze75ab1fa5d****",
            "StorageSize": "20480",
            "InstanceClass": "mdb.shard.4x.large.d",
            "NodeType": "db"
          }
        }
      ],
      "Progress": "50",
      "AttachLogStatus": "Ready",
      "EngineVersion": "4.2",
      "BackupExpireTime": "2025-03-29T03:47:12Z"
    }
  ]
}

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.