DescribeBackups - - Centre de documentation Alibaba Cloud

Remarque

Cette opération est disponible uniquement pour les clusters ApsaraDB for ClickHouse en version 21.8 ou ultérieure.

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 l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeBackups	Opération à effectuer. Définissez la valeur sur DescribeBackups.
DBClusterId	String	Yes	cc-bp1qx68m06981****	ID du cluster.
BackupId	String	No	117403****	ID de la tâche de sauvegarde.
StartTime	String	Yes	2021-11-21T16:00Z	Début de la plage horaire à interroger. Spécifiez l'heure au format ISO 8601 (aaaa-MM-jjTHH:mmZ). L'heure doit être exprimée en temps universel coordonné (UTC).
EndTime	String	Yes	2021-11-25T16:00Z	Fin de la plage horaire à interroger. Spécifiez l'heure au format ISO 8601 (aaaa-MM-jjTHH:mmZ). L'heure doit être exprimée en UTC.
PageSize	Integer	No	30	Nombre d'entrées à renvoyer par page. Valeurs possibles : 30 (par défaut) 50 100
PageNumber	Integer	No	1	Numéro de la page à renvoyer.

Paramètres de réponse

Parameter	Type	Example	Description
TotalCount	String	1	Nombre total d'entrées renvoyées.
PageSize	String	30	Nombre d'entrées renvoyées par page. Valeurs possibles : 30 (par défaut) 50 100
RequestId	String	F5178C10-1407-4987-9133-DE4DC9119F75	ID de la requête.
PageNumber	String	1	Numéro de la page renvoyée.
Items	Array of Backup		Jeux de sauvegarde renvoyés.
DBClusterId	String	cc-bp1qx68m06981****	ID du cluster.
BackupStatus	String	Success	État de la tâche de sauvegarde. Valeurs possibles : Success : La tâche de sauvegarde a abouti. Failure : La tâche de sauvegarde a échoué.
BackupType	String	IncrementalBackup	Type de sauvegarde. Valeurs possibles : FullBackup IncrementalBackup
BackupStartTime	String	2021-11-22T18:28:22Z	Heure de début de la tâche de sauvegarde. L'heure suit la norme ISO 8601 au format aaaa-MM-jjTHH:mmZ et est affichée en UTC.
BackupSize	Long	131072	Taille du jeu de sauvegarde. Unité : Mo.
BackupEndTime	String	2021-11-22T18:28:41Z	Heure de fin de la tâche de sauvegarde. L'heure suit la norme ISO 8601 au format aaaa-MM-jjTHH:mmZ et est affichée en UTC.
BackupSetInfo	String	{"shard_count": 4}	Nombre de nœuds dans le cluster. Si le cluster est de l'édition Single-replica, la valeur varie de 1 à 48. Si le cluster est de l'édition Double-replica, la valeur varie de 1 à 24.
BackupId	String	117403****	ID de la tâche de sauvegarde.
BackupMethod	String	Physical	Méthode de sauvegarde. Seule la valeur Physical est renvoyée, ce qui indique qu'une sauvegarde physique est effectuée.
ExpireDate	String	2022-07-22T18:28:41Z	Heure d'expiration du jeu de sauvegarde. L'heure suit la norme ISO 8601 au format aaaa-MM-jjTHH:mmZ et est affichée en UTC.

Exemples

Exemple de requêtes

http(s)://clickhouse.aliyuncs.com/?Action=DescribeBackups
&DBClusterId=cc-bp1qx68m06981****
&StartTime=2021-11-21T16:00Z
&EndTime=2021-11-22T16:00Z
&Common request parameters

Exemple de réponses réussies

Format XML

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

<DescribeBackupsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>30</PageSize>
    <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>
    <PageNumber>1</PageNumber>
    <Items>
        <DBClusterId>cc-bp1qx68m06981****</DBClusterId>
        <BackupStatus>Success</BackupStatus>
        <BackupType>IncrementalBackup</BackupType>
        <BackupStartTime>2021-11-22T18:28:22Z</BackupStartTime>
        <BackupSize>131072</BackupSize>
        <BackupEndTime>2021-11-22T18:28:41Z</BackupEndTime>
        <BackupSetInfo>{"shard_count": 4}</BackupSetInfo>
        <BackupId>117403****</BackupId>
        <BackupMethod>Physical</BackupMethod>
        <ExpireDate>2022-07-22T18:28:41Z</ExpireDate>
    </Items>
</DescribeBackupsResponse>

Format JSON

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

{
  "TotalCount" : "1",
  "PageSize" : "30",
  "RequestId" : "F5178C10-1407-4987-9133-DE4DC9119F75",
  "PageNumber" : "1",
  "Items" : [ {
    "DBClusterId" : "cc-bp1qx68m06981****",
    "BackupStatus" : "Success",
    "BackupType" : "IncrementalBackup",
    "BackupStartTime" : "2021-11-22T18:28:22Z",
    "BackupSize" : 131072,
    "BackupEndTime" : "2021-11-22T18:28:41Z",
    "BackupSetInfo" : "{\"shard_count\": 4}",
    "BackupId" : "117403****",
    "BackupMethod" : "Physical",
    "ExpireDate" : "2022-07-22T18:28:41Z"
  } ]
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	L'ID du cluster n'existe pas. Vérifiez si la valeur spécifiée pour le paramètre DBClusterId est valide.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur du service.