DescribeBackups - Tair (Redis® OSS-Compatible) - Alibaba Cloud Documentation Center

Mengambil informasi mengenai file backup untuk instans ApsaraDB for Tair yang kompatibel dengan Redis.

Deskripsi operasi

Operasi ini tidak berlaku untuk instans kluster cloud-native. Sebagai gantinya, gunakan operasi DescribeClusterBackupList.

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

kvstore:DescribeBackups

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID instans.	r-bp1zxszhcgatnx****
BackupId	integer	No	ID file backup.	11611111
BackupJobId	integer	No	ID pekerjaan cadangan yang dikembalikan oleh operasi `CreateBackup`. Jika `CreateBackup` mengembalikan beberapa ID pekerjaan cadangan, panggil operasi ini untuk setiap ID tersebut.	10001
PageSize	integer	No	Jumlah maksimum entri yang dikembalikan per halaman. Nilai yang valid: `30`, `50`, `100`, `200`, dan `300`.	30
PageNumber	integer	No	Nomor halaman yang dikembalikan. Nilainya harus lebih besar dari 0. Nilai default adalah 1.	1
StartTime	string	Yes	Waktu mulai untuk kueri. Tentukan waktu dalam UTC menggunakan format yyyy-MM-ddTHH:mmZ.	2019-03-11T10:00Z
EndTime	string	Yes	Waktu akhir untuk kueri. Waktu akhir harus lebih lambat daripada waktu mulai. Tentukan waktu dalam UTC menggunakan format yyyy-MM-ddTHH:mmZ.	2019-03-14T18:00Z
NeedAof	string	No	Menentukan apakah akan mengaktifkan Persistensi AOF. Nilai yang valid: 0: Dinonaktifkan. 1: Diaktifkan. Catatan Nilai default adalah 0.	1

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
RequestId	string	ID permintaan.	963C20F0-7CE1-4591-AAF3-6F3CD1CE****
PageNumber	integer	Nomor halaman.	1
PageSize	integer	Jumlah entri per halaman.	30
TotalCount	integer	Jumlah total set cadangan.	5
FullStorageSize	integer	Total ukuran cadangan penuh untuk instans, dalam byte. Cadangan penuh dihasilkan dari cadangan harian terjadwal, cadangan manual, atau analisis cache. Catatan Nilai ini merepresentasikan total ukuran semua cadangan penuh yang valid untuk instans, terlepas dari set cadangan yang dikembalikan dalam permintaan ini.	1000
LogStorageSize	integer	Total ukuran cadangan log untuk instans, dalam byte. Parameter ini hanya dikembalikan jika flashback diaktifkan. Catatan Nilai ini merepresentasikan total ukuran semua cadangan log yang valid untuk instans, terlepas dari set cadangan yang dikembalikan dalam permintaan ini.	5000
FreeSize	integer	Parameter ini tidak berlaku. Abaikan parameter ini.	100000
Backups	object	Detail tentang set cadangan.
Backup	array<object>	Array set cadangan.
	object	Detail set cadangan.
BackupStatus	string	Status backup. Nilai yang valid: Success: Backup berhasil. Failed: Backup gagal.	Success
BackupStartTime	string	Waktu mulai backup.	2019-03-14T05:28:50Z
BackupType	string	Jenis backup. Nilai yang valid: FullBackup: Cadangan penuh. IncrementalBackup: Cadangan inkremental.	FullBackup
BackupDownloadURL	string	URL unduh publik dari set cadangan.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
NodeInstanceId	string	ID node. Catatan Untuk instans Edisi Standar, parameter ini mengembalikan ID instans.	r-bp10noxlhcoim2****-db-1
BackupEndTime	string	Waktu selesai backup.	2019-03-14T05:31:13Z
BackupId	integer	ID set cadangan.	165*****50
BackupDBNames	string	Database yang dibackup. Nilai all menunjukkan bahwa semua database telah dibackup.	all
EngineVersion	string	Versi engine instans. Ini menentukan versi Redis yang kompatibel.	4.0
BackupIntranetDownloadURL	string	URL unduh internal dari set cadangan. Catatan Anda dapat menggunakan URL ini untuk mengunduh set cadangan dari Instance ECS yang berada dalam VPC yang sama dengan instans database.	https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********
BackupSize	integer	Ukuran set cadangan, dalam byte.	1024
BackupMode	string	Mode backup. Nilai yang valid: Automated: Backup otomatis. Manual: Backup manual.	Automated
BackupMethod	string	Metode backup. Nilai yang valid: Logical: Cadangan logis. Physical: Cadangan fisik.	Physical
BackupJobID	integer	ID pekerjaan cadangan.	24340
RecoverConfigMode	string	Menunjukkan apakah set cadangan mencakup informasi konfigurasi seperti akun (`account`), parameter kernel (`config`), dan daftar putih (`whitelist`). Catatan Parameter ini hanya tersedia untuk instans Edisi Cloud Native. Jika Anda mengubah pengaturan ini, misalnya membuat akun atau menambahkan alamat IP ke daftar putih, informasi yang diperbarui secara otomatis disertakan dalam set cadangan berikutnya.	{"whitelist":true,"config":true,"account":true}
ExpectExpireTime	string	Waktu kedaluwarsa set cadangan. Waktu dalam UTC dan menggunakan format yyyy-MM-ddTHH:mm:ssZ.	2025-06-01T21:51:22Z
AccessDeniedDetail	object	Parameter ini sudah tidak digunakan lagi.
AuthAction	string	Parameter ini sudah tidak digunakan lagi.	-
AuthPrincipalDisplayName	string	Parameter ini sudah tidak digunakan lagi.	-
AuthPrincipalOwnerId	string	Parameter ini sudah tidak digunakan lagi.	-
AuthPrincipalType	string	Parameter ini sudah tidak digunakan lagi.	-
EncodedDiagnosticMessage	string	Parameter ini sudah tidak digunakan lagi.	-
NoPermissionType	string	Parameter ini sudah tidak digunakan lagi.	-
PolicyType	string	Parameter ini sudah tidak digunakan lagi.	-

Contoh

Respons sukses

JSONformat

{
  "RequestId": "963C20F0-7CE1-4591-AAF3-6F3CD1CE****",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 5,
  "FullStorageSize": 1000,
  "LogStorageSize": 5000,
  "FreeSize": 100000,
  "Backups": {
    "Backup": [
      {
        "BackupStatus": "Success",
        "BackupStartTime": "2019-03-14T05:28:50Z",
        "BackupType": "FullBackup",
        "BackupDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "NodeInstanceId": "r-bp10noxlhcoim2****-db-1",
        "BackupEndTime": "2019-03-14T05:31:13Z",
        "BackupId": 0,
        "BackupDBNames": "all",
        "EngineVersion": "4.0",
        "BackupIntranetDownloadURL": "https://rdsbak-hk45-v2.oss-cn-hongkong.aliyuncs.com/********",
        "BackupSize": 1024,
        "BackupMode": "Automated",
        "BackupMethod": "Physical",
        "BackupJobID": 24340,
        "RecoverConfigMode": "{\"whitelist\":true,\"config\":true,\"account\":true}",
        "ExpectExpireTime": "2025-06-01T21:51:22Z"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "-",
    "AuthPrincipalDisplayName": "-",
    "AuthPrincipalOwnerId": "-",
    "AuthPrincipalType": "-",
    "EncodedDiagnosticMessage": "-",
    "NoPermissionType": "-",
    "PolicyType": "-"
  }
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidStartTime.Malformed	The Specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The Specified parameter EndTime is not valid.
400	InvalidEngineVersion.Malformed	The Specified EngieVersion is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.