Ringkasan DescribeHanaRestores API untuk Job Pemulihan SAP HANA - Cloud Backup - Alibaba Cloud - Cloud Backup

Mengkueri satu atau beberapa pekerjaan pemulihan SAP HANA yang memenuhi kondisi yang ditentukan.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

hbr:DescribeHanaRestores

get

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
VaultId	string	No	ID dari brankas cadangan (backup vault).	v-000au6bq******mpu
ClusterId	string	Yes	ID dari instance SAP HANA.	cl-000b******soejg
PageNumber	integer	No	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.	1
PageSize	integer	No	Jumlah entri per halaman. Nilai yang valid: 1 hingga 99. Nilai default: 10.`	10
RestoreId	string	No	ID dari pekerjaan pemulihan.	r-0007o3vqfukfe92hvf13
DatabaseName	string	No	Nama database.	SYSTEMDB
BackupId	integer	No	ID cadangan.	1632754800158
RestoreStatus	string	No	Status dari pekerjaan pemulihan. Nilai yang valid: RUNNING: Pekerjaan sedang berjalan. COMPLETE: Pekerjaan telah selesai. PARTIAL_COMPLETE: Pekerjaan selesai sebagian. FAILED: Pekerjaan gagal. CANCELED: Pekerjaan dibatalkan. EXPIRED: Pekerjaan kehabisan waktu.	COMPLETE
ResourceGroupId	string	No	ID dari grup sumber daya (resource group).	rg-acfm4ebtpkzx7zy

Elemen respons

Element	Type	Description	Example
	object
RequestId	string	ID permintaan.	7DEFC897-8F05-5C05-912C-C9A9510FBFF1
Success	boolean	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true false	true
Code	string	Kode respons. Kode status 200 menunjukkan bahwa permintaan berhasil.	200
Message	string	Pesan yang dikembalikan. Jika permintaan berhasil, "successful" akan dikembalikan. Jika permintaan gagal, pesan kesalahan akan dikembalikan.	successful
PageNumber	integer	Nomor halaman. Halaman dimulai dari halaman 1. Nilai default: 1.	1
PageSize	integer	Jumlah entri per halaman. Nilai yang valid: 1 hingga 99. Nilai default: 10.	10
TotalCount	integer	Jumlah total entri yang dikembalikan.	19
HanaRestore	object
HanaRestores	array<object>	Informasi tentang pekerjaan pemulihan.
	object	Pekerjaan pemulihan.
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

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.