DescribeBackups - - Centre de documentation Alibaba Cloud

Interroge les jeux de sauvegarde d'une instance ApsaraDB for MongoDB.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeBackups	Opération à effectuer. Définissez la valeur sur DescribeBackups.
RegionId	String	Non	cn-hangzhou	ID de région de l'instance. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
DBInstanceId	String	Oui	dds-bp1a7009eb24****	ID de l'instance. Remarque Si vous définissez ce paramètre sur l'ID d'une instance de cluster fragmenté, vous devez également spécifier le paramètre NodeId.
NodeId	String	Non	d-bp128a003436****	ID du nœud shard dans l'instance de cluster fragmenté. Remarque Ce paramètre est valide uniquement si DBInstanceId correspond à l'ID d'une instance de cluster fragmenté.
BackupId	String	Non	2072**,2072,2072**	ID du jeu de sauvegarde. Appelez l'opération CreateBackup pour obtenir la valeur de ce paramètre. Si vous définissez le paramètre DBInstanceId sur l'ID d'une instance de cluster fragmenté, le nombre d'ID de sauvegarde doit correspondre au nombre de shards. Séparez les ID par des virgules (,).
PageNumber	Integer	Non	1	Numéro de la page à renvoyer. La valeur doit être un entier supérieur à 0. Valeur par défaut : 1.
PageSize	Integer	Non	30	Nombre d'entrées à renvoyer par page. Valeurs valides : 30, 50 et 100. Valeur par défaut : 30.
StartTime	String	Non	2022-01-13T13:00Z	Début de la plage horaire à interroger. Spécifiez l'heure au format yyyy-MM-ddTHH:mmZ en UTC.
EndTime	String	Non	2022-01-14T13:00Z	Fin de la plage horaire à interroger. Spécifiez l'heure au format yyyy-MM-ddTHH:mmZ en UTC.

Paramètres de réponse

Paramètre	Type	Exemple	Description
TotalCount	Integer	1	Nombre total de jeux de sauvegarde renvoyés.
RequestId	String	275D43C3-F12F-5224-B375-0C6BF453BD56	ID de la requête.
PageSize	Integer	30	Nombre d'entrées renvoyées par page.
PageNumber	Integer	1	Numéro de la page renvoyée.
Backups	Array of Backup		Détails des jeux de sauvegarde.
Backup
BackupStatus	String	Success	État de la sauvegarde. Valeurs valides : Success : la tâche de sauvegarde a réussi. Failed : la tâche de sauvegarde a échoué.
BackupType	String	FullBackup	Méthode de sauvegarde. FullBackup : sauvegarde complète IncrementalBackup : sauvegarde incrémentielle
BackupStartTime	String	2022-01-14T03:56:17Z	Début de la plage horaire de sauvegarde. L'heure est au format yyyy-MM-ddTHH:mm:ssZ et affichée en UTC.
BackupIntranetDownloadURL	String	http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559***/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=LTAI4G2wxd32KLGARfi&Signature=lkFPjOY%2F8adB18vnOCbtmT7ii**&Region=cn-hangzhou	URL de téléchargement interne du jeu de sauvegarde. Remarque Utilisez cette URL pour télécharger le jeu de sauvegarde depuis une instance ECS située sur le même réseau que l'instance ApsaraDB for MongoDB.
BackupSize	Long	6168576	Taille du jeu de sauvegarde. Unité : octets.
BackupDownloadURL	String	http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559**/hins1936_data_2022052504_qp.xb?Expires=165361&OSSAccessKeyId=LTAI4G2wxd32KLGARf&Signature=lkFPjOY%2F8adB18vnOCbtmT7**&Region=cn-hangzhou	URL de téléchargement Internet du jeu de sauvegarde. Si l'URL de téléchargement n'est pas disponible, ce paramètre est une chaîne vide.
BackupMode	String	Automated	Mode de sauvegarde. Automated : sauvegarde automatique Manual : sauvegarde manuelle
BackupEndTime	String	2022-01-14T03:57:34Z	Fin de la plage horaire de sauvegarde. L'heure est au format yyyy-MM-ddTHH:mm:ssZ et affichée en UTC.
BackupId	Integer	32102****	ID du jeu de sauvegarde.
BackupDBNames	String	config,myNewDB	Nom de la base de données sauvegardée.
BackupMethod	String	Physical	Méthode de sauvegarde. Valeurs valides : Snapshot Physical Logical

Exemples

Exemple de requête

http(s)://mongodb.aliyuncs.com/?Action=DescribeBackups
&DBInstanceId=dds-bp1a7009eb24****
&<Common request parameters>

Exemple de réponse réussie

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeBackupsResponse>
    <TotalCount>1</TotalCount>
    <RequestId>275D43C3-F12F-5224-B375-0C6BF453BD56</RequestId>
    <PageSize>30</PageSize>
    <PageNumber>1</PageNumber>
    <Backups>
        <BackupStatus>Success</BackupStatus>
        <BackupType>FullBackup</BackupType>
        <BackupStartTime>2022-01-14T03:56:17Z</BackupStartTime>
        <BackupIntranetDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou-internal.aliyuncs.com/custins5559*****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&amp;Region=cn-hangzhou</BackupIntranetDownloadURL>
        <BackupSize>6168576</BackupSize>
        <BackupDownloadURL>http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARf****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7****&amp;Region=cn-hangzhou</BackupDownloadURL>
        <BackupMode>Automated</BackupMode>
        <BackupEndTime>2022-01-14T03:57:34Z</BackupEndTime>
        <BackupDBNames>database</BackupDBNames>
        <BackupMethod>Physical</BackupMethod>
    </Backups>
</DescribeBackupsResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "275D43C3-F12F-5224-B375-0C6BF453BD56",
  "PageSize" : 30,
  "PageNumber" : 1,
  "Backups" : {
    "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****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARfi****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7ii****&amp;Region=cn-hangzhou",
    "BackupSize" : 6168576,
    "BackupDownloadURL" : "http://rdsbak-hz-v3.oss-cn-hangzhou.aliyuncs.com/custins5559****/hins1936****_data_2022052504****_qp.xb?Expires=165361****&amp;OSSAccessKeyId=LTAI4G2wxd32KLGARf****&amp;Signature=lkFPjOY%2F8adB18vnOCbtmT7****&amp;Region=cn-hangzhou",
    "BackupMode" : "Automated",
    "BackupEndTime" : "2022-01-14T03:57:34Z",
    "BackupDBNames" : "database",
    "BackupMethod" : "Physical"
  }
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.