Referensi API DescribeBackupPolicy untuk PolarDB - Data Management - Alibaba Cloud - Data Management

Mengkueri kebijakan cadangan Instans PolarDB Basis Data Relasional Cloud-Native.

Deskripsi operasi

Mesin yang didukung

PolarDB Basis Data Relasional Cloud-Native MySQL Edisi

Catatan

API ini saat ini hanya tersedia untuk pelanggan tertentu. Jika Anda memerlukan akses, ajukan melalui kelompok konsultasi pelanggan DBS (nomor kelompok DingTalk: 35585947).

Dokumentasi terkait

Kebijakan cadangan PolarDB Basis Data Relasional Cloud-Native MySQL Edisi.

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:DescribeBackupPolicy

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionCode	string	No	Wilayah tempat set cadangan berada.	cn-beijing
InstanceName	string	No	ID Instans PolarDB Basis Data Relasional Cloud-Native.	pc-2ze3nrr64c5****

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan.	54A63B3B-AA10-1CC3-A6BB-6CCE98D19628
Message	string	Paket yang dikembalikan.	instanceName can not be empty.
Data	object	Detail kebijakan cadangan.
PreferredBackupDate	string	Siklus cadangan untuk cadangan dasar. String 7 digit dikembalikan, di mana setiap digit dari kiri ke kanan sesuai dengan Senin hingga Minggu. 1 menunjukkan cadangan dilakukan, dan 0 menunjukkan tidak ada cadangan.	1010101
PreferredBackupWindowBegin	string	Pengatur waktu mulai jendela cadangan dasar.	23:00Z
PreferredBackupWindow	string	Jendela cadangan dasar.	23:00Z-24:00Z
BackupRetentionPeriod	integer	Periode retensi cadangan dasar. Jika kebijakan cadangan lanjutan diaktifkan, ini adalah periode retensi terpanjang dalam kebijakan cadangan level-1.	7
BackupRetentionPolicyOnClusterDeletion	string	Kebijakan retensi cadangan arsip untuk Instans yang dihapus. Nilai valid: NONE: Tidak mempertahankan LATEST: Mempertahankan yang terakhir ALL: Mempertahankan semua.	LATEST
HighFrequencyBakInterval	integer	Interval cadangan Frekuensi tinggi. Misalnya, 120 menunjukkan cadangan setiap dua jam. Unit: minutes.	120
BackupPriority	integer	Pengaturan cadangan Instans sekunder. Nilai valid: 1: Utamakan Instans sekunder 2: Paksa Instans utama Catatan Parameter ini hanya berlaku untuk Instans RDS SQL Server. Untuk mesin lain, Nilai kembali adalah 0.	0
EnableLogBackup	integer	Apakah cadangan log diaktifkan. Nilai valid: 1: Diaktifkan 0: Dinonaktifkan.	1
LogBackupRetention	integer	Periode retensi cadangan log.	7
LogBackupLocalRetentionNumber	string	Jumlah file log lokal yang dipertahankan.	10
EnableBackup	integer	Apakah cadangan diaktifkan.	1
LocalLogRetentionSpace	integer	Laju Penggunaan ruang log lokal maksimum.	30
HighSpaceUsageProtection	string	Apakah akan memaksa pembersihan log ketika Penggunaan ruang Instans melebihi 80% atau ruang tersisa kurang dari 5 GB: Disable: Tidak membersihkan Enable: Membersihkan.	Enable
Category	string	Apakah cadangan level detik diaktifkan. Nilai valid: Flash: Cadangan level detik diaktifkan Standard: Cadangan Jenis Penyimpanan Standar Catatan Parameter ini hanya berlaku untuk MySQL.	Standard
IncBackupInterval	integer	Interval cadangan inkremental Frekuensi tinggi.	-1
EnableIncBackup	integer	Apakah cadangan inkremental diaktifkan.	0
BackupMethod	string	Metode cadangan. Nilai valid: Physical: Cadangan fisik Snapshot: Cadangan snapshot.	Physical
AdvanceLogPolicies	array<object>	Detail Kebijakan cadangan log.
	object	Detail Kebijakan.
PolicyId	string	The backup policy ID.	dc13b153acc91141789122c23835****
SrcType	string	The source type of the backup policy. Valid values: db: database level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level1
SrcRegion	string	The source region of the backup policy.	cn-beijing
DestType	string	The destination type of the backup policy. Valid values: db: database level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level1
DestRegion	string	The destination region of the backup policy.	cn-shanghai
EnableLogBackup	integer	Reserved.	1
LogRetentionType	string	The retention type for log backups. Valid values: never: Log backups are retained permanently. delay: Log backups are retained for a specified number of days.	delay
LogRetentionValue	string	The retention period for log backups, in days.	3
FilterType	string	The filter type for the advanced policy. Valid values: crontab: recurring schedule event: event-driven schedule	crontab
FilterKey	string	The schedule type. Valid values: dayOfWeek: weekly schedule dayOfMonth: monthly schedule dayOfYear: yearly schedule backupInterval: fixed interval schedule Note: This parameter is returned only when `FilterType` is `crontab`.	dayOfWeek
FilterValue	string	The backup cycle.	1,2,3,4,5,6,7
AdvanceDataPolicies	array<object>	Detail Kebijakan Cadangan data.
	object	Detail Kebijakan.
PolicyId	string	The advanced policy ID.	71930ac2e9f15e41615e10627c******
FilterType	string	The filter type for the advanced policy. Valid values: crontab: recurring schedule event: event-driven schedule	crontab
FilterKey	string	The schedule type. Valid values: dayOfWeek: weekly schedule dayOfMonth: monthly schedule dayOfYear: yearly schedule backupInterval: fixed interval schedule Catatan This parameter is returned only when FilterType is set to crontab.	dayOfWeek
FilterValue	string	The backup cycle.	1,2,3,4,5,6,7
DumpAction	string	The dump action. Valid values: copy: Copies the backup. move: Moves the backup.	copy
RetentionType	string	The retention type for the backup set. Valid values: never: The backup set is retained permanently. delay: The backup set is retained for a specified number of days.	delay
RetentionValue	string	The retention period in days. This parameter is valid only when RetentionType is set to delay.	7
SrcType	string	The source type of the backup policy. Valid values: db: database level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	db
SrcRegion	string	The source region of the backup policy.	cn-beijing
DestType	string	The destination type of the backup policy. Valid values: db: database level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level1
DestRegion	string	The destination region of the backup policy.	cn-beijing
BakType	string	The backup type. Valid values: F: full backup L: log backup	F
AutoCreated	boolean	Indicates whether the backup policy is a system-generated policy. Valid values: true: The policy is system-generated. false: The policy is user-defined.	true
StorageClass	string	The data storage type.	STANDARD
AdvanceIncPolicies	array<object>	Kebijakan cadangan inkremental lanjutan.
	object
PolicyId	string	The advanced policy ID.	smp-l0bfdmlr4c***
FilterType	string	The filter type for the advanced policy. Valid values: crontab (recurring schedule) and event (event-driven schedule).	crontab
FilterKey	string	The schedule type, which is valid only when FilterType is set to crontab. Valid values: dayOfWeek (weekly schedule), dayOfMonth (monthly schedule), dayOfYear (yearly schedule), and backupInterval (fixed interval schedule).	dayOfMonth
FilterValue	string	The value of the filter.	1
DumpAction	string	The dump action. Valid values: copy and move.	Copy
RetentionType	string	The retention type. Valid values: never (retained permanently) and delay (retained for a specified number of days).	delay
RetentionValue	string	The retention period in days.	365
SrcType	string	The source type of the backup policy. Valid values: db (database), level1 (level-1 backup), level2 (level-2 backup), and level2Cross (level-2 cross-region backup).	db
SrcRegion	string	The source region of the backup policy.	cn-hangzhou
DestType	string	The destination type of the backup policy. Valid values: db (database), level1 (level-1 backup), level2 (level-2 backup), and level2Cross (level-2 cross-region backup).	db
DestRegion	string	The destination region of the backup policy.	cn-hangzhou
BakType	string	The backup type. Valid values: F (full backup) and L (log backup).	F
AutoCreated	boolean	Indicates whether the policy is system-generated.	true
PreferredNextBackupTime	string		2025-07-08T16:05Z
EnablePitrProtection	boolean
LogBackupLocalRetention	integer		7
ColdRetention	integer		30
ColdKeepPolicy	integer		1
ColdKeepCount	integer		1
ErrMessage	string	Paket kesalahan.	The specified parameter %s value is not valid.
Code	string	Kode status.	Success
Success	string	Apakah permintaan berhasil. Nilai valid: true: Permintaan berhasil. false: Permintaan gagal.	true
ErrCode	string	kode kesalahan.	Success

Contoh

Respons sukses

JSONformat

{
  "RequestId": "54A63B3B-AA10-1CC3-A6BB-6CCE98D19628",
  "Message": "instanceName can not be empty.",
  "Data": {
    "PreferredBackupDate": "1010101",
    "PreferredBackupWindowBegin": "23:00Z",
    "PreferredBackupWindow": "23:00Z-24:00Z",
    "BackupRetentionPeriod": 7,
    "BackupRetentionPolicyOnClusterDeletion": "LATEST",
    "HighFrequencyBakInterval": 120,
    "BackupPriority": 0,
    "EnableLogBackup": 1,
    "LogBackupRetention": 7,
    "LogBackupLocalRetentionNumber": "10",
    "EnableBackup": 1,
    "LocalLogRetentionSpace": 30,
    "HighSpaceUsageProtection": "Enable",
    "Category": "Standard",
    "IncBackupInterval": -1,
    "EnableIncBackup": 0,
    "BackupMethod": "Physical",
    "AdvanceLogPolicies": [
      {
        "PolicyId": "dc13b153acc91141789122c23835****",
        "SrcType": "level1",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-shanghai",
        "EnableLogBackup": 1,
        "LogRetentionType": "delay",
        "LogRetentionValue": "3",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7"
      }
    ],
    "AdvanceDataPolicies": [
      {
        "PolicyId": "71930ac2e9f15e41615e10627c******",
        "FilterType": "crontab",
        "FilterKey": "dayOfWeek",
        "FilterValue": "1,2,3,4,5,6,7",
        "DumpAction": "copy",
        "RetentionType": "delay",
        "RetentionValue": "7",
        "SrcType": "db",
        "SrcRegion": "cn-beijing",
        "DestType": "level1",
        "DestRegion": "cn-beijing",
        "BakType": "F",
        "AutoCreated": true,
        "StorageClass": "STANDARD"
      }
    ],
    "AdvanceIncPolicies": [
      {
        "PolicyId": "smp-l0bfdmlr4c***",
        "FilterType": "crontab",
        "FilterKey": "dayOfMonth",
        "FilterValue": "1",
        "DumpAction": "Copy",
        "RetentionType": "delay",
        "RetentionValue": "365",
        "SrcType": "db",
        "SrcRegion": "cn-hangzhou",
        "DestType": "db",
        "DestRegion": "cn-hangzhou",
        "BakType": "F",
        "AutoCreated": true
      }
    ],
    "PreferredNextBackupTime": "2025-07-08T16:05Z",
    "EnablePitrProtection": false,
    "LogBackupLocalRetention": 7,
    "ColdRetention": 30,
    "ColdKeepPolicy": 1,
    "ColdKeepCount": 1
  },
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "Code": "Success",
  "Success": "true",
  "ErrCode": "Success"
}

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.