DescribeHanaRestores - Cloud Backup: Central de Documentação do Alibaba Cloud

Consulta um ou mais trabalhos de restauração do SAP HANA que atendem às condições especificadas.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hbr:DescribeHanaRestores

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VaultId	string	Não	O ID do cofre de backup.	v-000au6bq******mpu
ClusterId	string	Sim	O ID da instância do SAP HANA.	cl-000b******soejg
PageNumber	integer	Não	O número da página. As páginas começam na página 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valores válidos: 1 a 99. Valor padrão: 10.	10
RestoreId	string	Não	O ID do trabalho de restauração.	r-0007o3vqfukfe92hvf13
DatabaseName	string	Não	O nome do banco de dados.	SYSTEMDB
BackupId	integer	Não	O ID do backup.	1632754800158
RestoreStatus	string	Não	O status do trabalho de restauração. Valores válidos: RUNNING: O trabalho está em execução. COMPLETE: O trabalho foi concluído. PARTIAL_COMPLETE: O trabalho foi parcialmente concluído. FAILED: O trabalho falhou. CANCELED: O trabalho foi cancelado. EXPIRED: O trabalho expirou.	COMPLETE
ResourceGroupId	string	Não	O ID do grupo de recursos.	rg-acfm4ebtpkzx7zy

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	7DEFC897-8F05-5C05-912C-C9A9510FBFF1
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	true
Code	string	O código de resposta. O código de status 200 indica que a solicitação foi bem-sucedida.	200
Message	string	A mensagem retornada. Se a solicitação for bem-sucedida, "successful" será retornado. Se a solicitação falhar, uma mensagem de erro será retornada.	successful
PageNumber	integer	O número da página. As páginas começam na página 1. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página. Valores válidos: 1 a 99. Valor padrão: 10.	10
TotalCount	integer	O número total de entradas retornadas.	19
HanaRestore	object
HanaRestores	array<object>	As informações sobre os trabalhos de restauração.
	object	O trabalho de restauração.
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

Exemplos

Resposta de sucesso

JSON formato

{
  "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
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.