DescribeHanaRestores - - Centre de documentation Alibaba Cloud

Consulte un ou plusieurs travaux de restauration SAP HANA répondant aux conditions spécifiées.

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.

hbr:DescribeHanaRestores

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
VaultId	string	Non	L'identifiant du coffre de sauvegarde.	v-000au6bq******mpu
ClusterId	string	Oui	L'identifiant de l'instance SAP HANA.	cl-000b******soejg
PageNumber	integer	Non	Le numéro de page. Les pages commencent à la page 1. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeurs valides : 1 à 99. Valeur par défaut : 10.	10
RestoreId	string	Non	L'identifiant du travail de restauration.	r-0007o3vqfukfe92hvf13
DatabaseName	string	Non	Le nom de la base de données.	SYSTEMDB
BackupId	integer	Non	L'identifiant de la sauvegarde.	1632754800158
RestoreStatus	string	Non	L'état du travail de restauration. Valeurs valides : RUNNING : Le travail est en cours d'exécution. COMPLETE : Le travail est terminé. PARTIAL_COMPLETE : Le travail est partiellement terminé. FAILED : Le travail a échoué. CANCELED : Le travail a été annulé. EXPIRED : Le travail a expiré.	COMPLETE
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-acfm4ebtpkzx7zy

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	7DEFC897-8F05-5C05-912C-C9A9510FBFF1
Success	boolean	Indique si la requête a réussi. Valeurs valides : true false	true
Code	string	Le code de réponse. Le code d'état 200 indique que la requête a réussi.	200
Message	string	Le message renvoyé. Si la requête a réussi, « successful » est renvoyé. Si la requête a échoué, un message d'erreur est renvoyé.	successful
PageNumber	integer	Le numéro de page. Les pages commencent à la page 1. Valeur par défaut : 1.	1
PageSize	integer	Le nombre d'entrées par page. Valeurs valides : 1 à 99. Valeur par défaut : 10.	10
TotalCount	integer	Le nombre total d'entrées renvoyées.	19
HanaRestore	object
HanaRestores	array<object>	Les informations sur les travaux de restauration.
	object	Le travail de restauration.
Status	string	The status of the restore job. Valid values: RUNNING: The job is running. COMPLETE: The job is completed. PARTIAL_COMPLETE: The job is partially completed. FAILED: The job failed. CANCELED: The job is canceled. EXPIRED: The job timed out.	COMPLETE
ReachedTime	integer	The point in time at which the database is restored.	1635315505
VaultId	string	The ID of the backup vault.	v-000g9acf******gta
CurrentPhase	integer	The current recovery phase. This value is obtained from SAP HANA.	2
ClearLog	boolean	Indicates whether all log entries are deleted from the log area after the log entries are restored. Valid values: true and false. If the return value is false, all log entries are deleted from the log area after the log entries are restored.	true
Message	string	The details of the recovery phase.	SQL Error 448 - recovery could not be completed:
CheckAccess	boolean	Indicates whether the differential backup and log backup are validated. Valid values: true: Cloud Backup checks whether the required differential backup and log backup are available before the restore job starts. If the differential backup or log backup is unavailable, Cloud Backup does not start the restore job. false: Cloud Backup does not check whether the required differential backup and log backup are available before the restore job starts.	true
Mode	string	The recovery mode. Valid values: RECOVERY_TO_MOST_RECENT: The database is restored to the recently available state to which the database has been backed up. RECOVERY_TO_POINT_IN_TIME: The database is restored to a specified point in time. RECOVERY_TO_SPECIFIC_BACKUP: The database is restored to a specified backup. RECOVERY_TO_LOG_POSITION: The database is restored to a specified log position.	RECOVERY_TO_SPECIFIC_BACKUP
SystemCopy	boolean	Indicates whether the database is restored to a different instance. Valid values: true: The database is restored to a different instance. false: The database is restored within the same instance.	true
CurrentProgress	integer	The current progress. This value is obtained from SAP HANA.	1
UseDelta	boolean	Indicates whether a differential backup or an incremental backup is used to restore the database. Valid values: true and false. If the return value is true, Cloud Backup uses a differential backup or an incremental backup to restore the database. If the return value is false, Cloud Backup uses a log backup to restore the database.	true
BackupID	integer	The backup ID.	1635315505
SourceClusterId	string	The ID of the source SAP HANA instance.	cl-0000g3mvy******5cj
VolumeId	integer	The ID of the volume that is restored. This parameter is returned only if the value of the Mode parameter is RECOVERY_TO_LOG_POSITION.	0
DatabaseName	string	The database name.	BWD
Phase	string	The recovery phase.	restart
ClusterId	string	The ID of the SAP HANA instance that is restored.	cl-000923yu******p00j4
DatabaseRestoreId	integer	The ID of the database recovery.	1644038961030
State	string	The recovery status. This value is obtained from SAP HANA.	successful
Source	string	The name of the source system. This parameter indicates the name of the source database that is restored. Format: `<Source database name>@SID`.	PRD@H4P
MaxPhase	integer	The maximum recovery phase. This value is obtained from SAP HANA.	4
EndTime	integer	The time when the restore job ends. This value is a UNIX timestamp. Unit: seconds.	1634356382
StartTime	integer	The time when the restore job starts. This value is a UNIX timestamp. Unit: seconds.	1636970413
BackupPrefix	string	The backup prefix.	INC_DATA_BACKUP
RestoreId	string	The ID of the restore job.	r-000c1en183ayn9sesgqh
LogPosition	integer	The log position to which the database is restored. This parameter is returned only if the value of the Mode parameter is RECOVERY_TO_LOG_POSITION.	0
RecoveryPointInTime	integer	The point in time to which the database is restored. This parameter is returned only if the value of the Mode parameter is RECOVERY_TO_POINT_IN_TIME. Cloud Backup restores the database to a state closest to the specified point in time.	1649851200
MaxProgress	integer	The maximum progress. This value is obtained from SAP HANA.	1
UseCatalog	boolean	Indicates whether a catalog backup is used to restore the database. This parameter is returned only if the value of the Mode parameter is RECOVERY_TO_SPECIFIC_BACKUP. If the return value is false, Cloud Backup finds the backup file based on the specified prefix and then restores the backup file.	false

Exemples

JSON format

{
  "RequestId": "7DEFC897-8F05-5C05-912C-C9A9510FBFF1",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 19,
  "HanaRestore": {
    "HanaRestores": [
      {
        "Status": "COMPLETE",
        "ReachedTime": 1635315505,
        "VaultId": "v-000g9acf******gta",
        "CurrentPhase": 2,
        "ClearLog": true,
        "Message": "SQL Error 448 - recovery could not be completed:",
        "CheckAccess": true,
        "Mode": "RECOVERY_TO_SPECIFIC_BACKUP",
        "SystemCopy": true,
        "CurrentProgress": 1,
        "UseDelta": true,
        "BackupID": 1635315505,
        "SourceClusterId": "cl-0000g3mvy******5cj",
        "VolumeId": 0,
        "DatabaseName": "BWD",
        "Phase": "restart",
        "ClusterId": "cl-000923yu******p00j4",
        "DatabaseRestoreId": 1644038961030,
        "State": "successful",
        "Source": "PRD@H4P",
        "MaxPhase": 4,
        "EndTime": 1634356382,
        "StartTime": 1636970413,
        "BackupPrefix": "INC_DATA_BACKUP",
        "RestoreId": "r-000c1en183ayn9sesgqh",
        "LogPosition": 0,
        "RecoveryPointInTime": 1649851200,
        "MaxProgress": 1,
        "UseCatalog": false
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.