Referensi API DescribeBackupDataList untuk PolarDB MySQL - Data Management - Alibaba Cloud - Data Management

Mengkueri data cadangan untuk kluster PolarDB Basis Data Relasional Cloud-Native for MySQL.

Deskripsi operasi

Applicable engines

PolarDB for MySQL

Catatan

This API operation is available only to specific customers. To use this operation, join the DBS Customer Service DingTalk group (ID: 35585947) to request access.

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

dbs:DescribeBackupDataList

list

DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceName	string	No	ID kluster PolarDB.	pc-2ze3nrr64c5******
RegionCode	string	No	Wilayah tempat set cadangan berada.	cn-hangzhou
SceneType	string	No	Skenario cadangan. Parameter ini hanya mendukung LEVEL_1, yang menunjukkan cadangan level-1 di wilayah tempat instans berada.	LEVEL_1
StartTime	string	No	Awal rentang waktu untuk dikueri. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC.	2024-04-17T17:00:16Z
EndTime	string	No	Akhir rentang waktu untuk dikueri. Waktu akhir harus lebih lambat dari waktu mulai. Tentukan waktu dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu harus dalam UTC.	2024-04-17T17:00:32Z
BackupStatus	string	No	Status set cadangan. Nilai valid: OK: Cadangan berhasil. ERROR: Cadangan gagal.	OK
BackupId	string	No	ID set cadangan.	213064****
BackupMethod	string	No	Metode cadangan. Nilai valid: Physical: cadangan fisik Logical: cadangan logis Snapshot: cadangan snapshot.	Snapshot
BackupMode	string	No	Mode cadangan. Nilai valid: Automated: cadangan otomatis Manual: cadangan manual.	Automated
BackupType	string	No	Tipe cadangan. Nilai valid: FullBackup: cadangan penuh IncrementBackup: cadangan inkremental.	FullBackup
BackupScale	string	No	Cakupan cadangan. Nilai valid: DBInstance: cadangan instans DBTable: cadangan database dan tabel.	DBInstance
PageSize	integer	No	Jumlah entri yang akan ditampilkan di setiap halaman. Nilai default-nya adalah 20.	20
PageNumber	integer	No	Nomor halaman. Nilai harus berupa bilangan bulat yang lebih besar dari 0 dan tidak melebihi nilai maksimum tipe data integer. Nilai default-nya adalah 1.	1
InstanceIsDeleted	boolean	No	Apakah instans telah dihapus. Nilai valid: true: Instans telah dihapus. false: Instans tidak dihapus. Ini adalah nilai default.	false
InstanceRegion	string	No	Wilayah asli instans.	cn-hangzhou
DataSourceId	string	No	Parameter ini dicadangkan dan tidak perlu ditentukan.	test****

Elemen respons

Element	Type	Description	Example
	object	The details of the returned parameters.
Data	object	The returned data.
Content	array<object>	The details of the task.
	array<object>	The details of the task.
BackupId	string	The ID of the backup set.	213088****
BackupName	string	The name of the backup set.	logic_backup
BackupMode	string	The backup mode. Valid values: Automated: automatic backup Manual: manual backup	Automated
BackupType	string	The backup type. Valid values: FullBackup: full backup IncrementBackup: incremental backup	FullBackup
BackupScale	string	The backup scope. Valid values: DBInstance: instance backup DBTable: database and table backup	DBInstance
BackupMethod	string	The backup method. Valid values: Physical: physical backup Logical: logical backup Snapshot: snapshot backup	Snapshot
BackupSize	integer	The size of the backup set in bytes.	25669140480
BackupStatus	string	The status of the backup set. Valid values: OK: The backup is successful. ERROR: The backup failed.	OK
BackupStartTime	string	The start time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-17T17:00:16Z
BackupEndTime	string	The end time of the backup. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-17T17:00:32Z
ConsistentTime	integer	The point in time of the consistent snapshot. The value is a UNIX timestamp. Unit: seconds.	1713373221
BackupLocation	string	The storage path of the backup.	logic
InstanceName	string	The ID of the instance.	pc-2ze3nrr64c5******
Engine	string	The database engine type.	polardb_mysql
EngineVersion	string	The database engine version.	5.7
SupportDeletion	integer	Indicates whether the backup set can be deleted. Valid values: 0: The backup set can be deleted. 1: The backup set cannot be deleted.	0
Encryption	string	The encryption information.	psk2
IsAvail	integer	Indicates whether the backup set is available. Valid values: 1: The backup set is available. 0: The backup set is unavailable.	1
Checksum	string	The checksum.	84a4c16431f969712e6895992719****
BackupDownloadURL	string	The public download URL of the backup set. Catatan This parameter is returned only when BackupMethod is set to Physical (physical backup) or Logical (logical backup).	http://oss.com/****
BackupIntranetDownloadURL	string	The internal download URL of the backup set. Catatan This parameter is returned only when BackupMethod is set to Physical (physical backup) or Logical (logical backup).	http://oss.com/****
ExpectExpireType	string	The expected expiration type of the backup set. Valid values: NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	The expected expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-19T05:00:49Z
PolarSnapshot	object	The information about the level-2 dump of the PolarDB cluster. Catatan The PolarSnapshot-related information is returned only after the level-2 dump feature is enabled for the PolarDB cluster in the same region and the level-1 backup is successfully dumped.
DumpId	integer	The ID of the dump.	abc****
DumpSize	integer	The size of the dump backup in bytes.	25669140589
expectExpireType	string	The expected expiration type of the backup set. Valid values: NEVER EXPIRED DELAY	DELAY
ExpectExpireTime	string	The expected expiration time of the backup set. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2024-04-19T05:00:49Z
PageSize	integer	The page size.	20
PageNumber	integer	The page number.	1
TotalPages	integer	The total number of pages.	1
TotalElements	integer	The total number of backup sets.	1
Extra	string	Extra information.	dbtest
RequestId	string	The ID of the request.	95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28
ErrCode	string	The error code.	Request.Forbidden
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrMessage	string	The error message.	The specified parameter %s value is not valid.
Code	string	The status code.	Success
Message	string	The returned message.	The specified parameter %s value is not valid.

Contoh

Respons sukses

JSONformat

{
  "Data": {
    "Content": [
      {
        "BackupId": "213088****",
        "BackupName": "logic_backup",
        "BackupMode": "Automated",
        "BackupType": "FullBackup",
        "BackupScale": "DBInstance",
        "BackupMethod": "Snapshot",
        "BackupSize": 25669140480,
        "BackupStatus": "OK",
        "BackupStartTime": "2024-04-17T17:00:16Z",
        "BackupEndTime": "2024-04-17T17:00:32Z",
        "ConsistentTime": 1713373221,
        "BackupLocation": "logic",
        "InstanceName": "pc-2ze3nrr64c5******",
        "Engine": "polardb_mysql",
        "EngineVersion": "5.7",
        "SupportDeletion": 0,
        "Encryption": "psk2",
        "IsAvail": 1,
        "Checksum": "84a4c16431f969712e6895992719****",
        "BackupDownloadURL": "http://oss.com/****",
        "BackupIntranetDownloadURL": "http://oss.com/****",
        "ExpectExpireType": "DELAY",
        "ExpectExpireTime": "2024-04-19T05:00:49Z",
        "PolarSnapshot": {
          "DumpId": 0,
          "DumpSize": 25669140589,
          "expectExpireType": "DELAY",
          "ExpectExpireTime": "2024-04-19T05:00:49Z"
        }
      }
    ],
    "PageSize": 20,
    "PageNumber": 1,
    "TotalPages": 1,
    "TotalElements": 1,
    "Extra": "dbtest"
  },
  "RequestId": "95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28",
  "ErrCode": "Request.Forbidden\t",
  "Success": "true",
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "Code": "Success",
  "Message": "The specified parameter %s value is not valid."
}

Kode kesalahan

HTTP status code	Error code	Error message	Description
403	Request.Forbidden	Have no Permissions

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.

Data Management:DescribeBackupDataList