DescribeBackups - PolarDB

Mengambil informasi cadangan untuk kluster PolarDB.

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

polardb:DescribeBackups

get

*Backup

acs:polardb:{#regionId}:{#accountId}:DBCluster/{#DBClusterId}

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	ID kluster.	pc-****************
BackupId	string	No	ID cadangan.	11111111
BackupStatus	string	No	Status cadangan. Nilai yang valid: Success: Cadangan berhasil. Failed: Cadangan gagal.	Success
BackupMode	string	No	Mode cadangan. Nilai yang valid: Automated: cadangan otomatis Manual: cadangan manual	Automated
StartTime	string	Yes	Awal rentang waktu untuk ditanyakan. Tentukan waktu dalam format `YYYY-MM-DDThh:mmZ`. Waktu harus dalam UTC.	2020-11-14T00:00Z
EndTime	string	Yes	Akhir rentang waktu untuk ditanyakan. Waktu akhir harus lebih lambat dari waktu mulai. Tentukan waktu dalam format `YYYY-MM-DDThh:mmZ`. Waktu harus dalam UTC.	2020-11-16T00:00Z
BackupRegion	string	No	Wilayah tujuan cadangan cross-region. Catatan Parameter ini hanya didukung oleh PolarDB for MySQL.	cn-hangzhou
PageSize	integer	No	Jumlah entri yang dikembalikan per halaman. Nilai yang valid: 30 50 100 Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilainya harus berupa bilangan bulat yang lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1.	1

Elemen respons

Element	Type	Description	Example
	object
TotalRecordCount	string	Jumlah total entri.	1
PageRecordCount	string	Jumlah entri yang dikembalikan pada halaman saat ini.	1
RequestId	string	ID permintaan.	24A1990B-4F6E-482B-B8CB-75C612******
PageNumber	string	Nomor halaman.	1
Items	object
Backup	array<object>	Detail set cadangan.
	object
BackupSetSize	string	Ukuran file cadangan. Satuan: byte. Catatan Karena snapshot berbagi blok data, storage space yang dilepas setelah Anda menghapus cadangan snapshot jauh lebih kecil daripada ukuran file cadangan tersebut. Untuk informasi selengkapnya, lihat Backup FAQ.	4639948800
ConsistentTime	string	Titik waktu snapshot konsisten. Nilai ini merupakan Stempel waktu UNIX. Satuan: detik.	1605425407
BackupStatus	string	Status cadangan. Nilai yang valid: Success: Cadangan berhasil. Failed: Cadangan gagal.	Success
BackupType	string	Tipe cadangan. Hanya cadangan penuh yang didukung. Nilainya tetap sebagai FullBackup.	FullBackup
BackupStartTime	string	Waktu mulai cadangan. Waktu dalam UTC.	2020-11-15T07:30:05Z
ExpectExpireTime	string	Waktu kedaluwarsa yang diharapkan untuk set cadangan. Parameter ini hanya didukung untuk instans yang telah mengaktifkan fitur cadangan jarang.	2022-10-24T08:13:23Z
ExpectExpireType	string	Tipe kedaluwarsa yang diharapkan untuk set cadangan. Parameter ini hanya didukung untuk instans yang telah mengaktifkan fitur cadangan jarang. Valid values: NEVER : NEVER EXPIRED : EXPIRED DELAY : DELAY	EXPIRED
IsAvail	string	Menunjukkan apakah set cadangan tersedia. Nilai yang valid: 0: tidak tersedia 1: tersedia	0
BackupEndTime	string	Waktu selesai cadangan. Waktu dalam UTC.	2020-11-15T07:30:20Z
BackupId	string	ID cadangan.	61*******
DBClusterId	string	ID kluster.	pc-****************
BackupsLevel	string	Tingkat set cadangan. Nilai yang valid: Level-1: cadangan level-1 Level-2: cadangan level-2	Level-1
BackupMode	string	Mode cadangan. Nilai yang valid: Automated: cadangan otomatis Manual: cadangan manual	Automated
BackupMethod	string	Metode cadangan data. Hanya cadangan snapshot yang didukung. Nilainya tetap sebagai Snapshot.	Snapshot
TotalLevel2BackupSize	string	Total ukuran cadangan level-2 di wilayah yang ditentukan. Satuan: byte. Catatan Parameter ini hanya didukung untuk kluster yang menggunakan kelas penyimpanan PSL4 atau PSL5. Parameter ini hanya didukung untuk kluster yang telah mengaktifkan fitur cadangan level-2. Jika parameter ini tidak dikembalikan, ukuran cadangan level-2 adalah 0.	4639948800

Contoh

Respons sukses

JSONformat

{
  "TotalRecordCount": "1",
  "PageRecordCount": "1",
  "RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
  "PageNumber": "1",
  "Items": {
    "Backup": [
      {
        "BackupSetSize": "4639948800",
        "ConsistentTime": "1605425407",
        "BackupStatus": "Success",
        "BackupType": "FullBackup",
        "BackupStartTime": "2020-11-15T07:30:05Z",
        "ExpectExpireTime": "2022-10-24T08:13:23Z",
        "ExpectExpireType": "EXPIRED\u0000\u0000",
        "IsAvail": "0",
        "BackupEndTime": "2020-11-15T07:30:20Z",
        "BackupId": "61*******",
        "DBClusterId": "pc-****************",
        "BackupsLevel": "Level-1",
        "BackupMode": "Automated",
        "BackupMethod": "Snapshot"
      }
    ]
  },
  "TotalLevel2BackupSize": "4639948800"
}

Kode kesalahan

HTTP status code	Error code	Error message
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
400	InvalidBackupStatus.Malformed	The specified parameter BackupStatus is not valid.
400	InvalidBackupMode.Malformed	The specified parameter BackupMode is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.