DescribeBackupPolicy - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengkueri pengaturan cadangan instans ApsaraDB RDS.

Deskripsi operasi

Mesin yang didukung

ApsaraDB RDS for MySQL
ApsaraDB RDS for PostgreSQL
ApsaraDB RDS for SQL Server
ApsaraDB RDS for MariaDB.

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

rds:DescribeBackupPolicy

get

*DBInstance

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

rds:ResourceTag
rds:ResourceTag
rds:ResourceTag
rds:ResourceTag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	ID instans. Anda dapat memanggil DescribeDBInstances untuk mendapatkan ID instans.	rm-uf6wjk5****
BackupPolicyMode	string	No	Jenis cadangan. Nilai valid: DataBackupPolicy: cadangan data LogBackupPolicy: cadangan log.	DataBackupPolicy
CompressType	string	No	Metode kompresi cadangan. Nilai valid: 0: tanpa kompresi 1: kompresi zlib 2: kompresi zlib paralel 4: kompresi QuickLZ dengan fitur pemulihan database dan tabel diaktifkan 8: kompresi QuickLZ tetapi fitur pemulihan database dan tabel tidak didukung.	1
ReleasedKeepPolicy	string	No	Kebijakan retensi data untuk cadangan terarsip dari instans MySQL yang dihapus. Nilai valid: None: Tidak ada cadangan terarsip yang dipertahankan. Lastest: Hanya cadangan terarsip terakhir yang dipertahankan. All: Semua cadangan terarsip dipertahankan.	Lastest

Elemen respons

Element	Type	Description	Example
	object	Parameter respons.
ArchiveBackupKeepCount	string	Jumlah cadangan terarsip yang dipertahankan untuk instans MySQL.	1
ArchiveBackupKeepPolicy	string	Siklus retensi cadangan terarsip untuk instans MySQL.	ByMonth
ArchiveBackupRetentionPeriod	string	Jumlah hari cadangan terarsip dipertahankan untuk instans MySQL.	365
BackupInterval	string	Interval cadangan. Unit: minutes. Untuk instans MySQL, parameter ini menentukan frekuensi cadangan snapshot (bukan siklus cadangan snapshot). Untuk instans SQL Server, parameter ini menentukan frekuensi cadangan log.	30
BackupLog	string	Apakah cadangan log diaktifkan. Nilai valid: Enable: diaktifkan Disabled: dinonaktifkan Untuk instans SQL Server: Enable hanya dikembalikan ketika frekuensi cadangan log instans adalah setiap 5 menit. Ketika frekuensi cadangan log instans adalah setiap 30 menit atau konsisten dengan siklus cadangan data, parameter ini mengembalikan Disabled. Gunakan nilai BackupInterval sebagai referensi.	Enable
BackupMethod	string	Metode cadangan dari instans SQL Server dengan cloud disk. Nilai valid: Physical: cadangan fisik Snapshot: cadangan snapshot.	Physical
BackupPriority	integer	Pengaturan cadangan untuk instans sekunder dari instans SQL Server Enterprise Edisi Kluster. Nilai valid: 1: Instans sekunder diutamakan. 2: Instans utama dipaksa. Catatan Parameter ini hanya dikembalikan ketika SupportModifyBackupPriority adalah True.	2
BackupRetentionPeriod	integer	Jumlah hari cadangan data dipertahankan.	7
Category	string	Apakah cadangan dalam hitungan detik diaktifkan untuk instans MySQL atau PostgreSQL. Nilai valid: Flash: diaktifkan Standard: dinonaktifkan Catatan Parameter ini hanya berlaku ketika parameter BackupPolicyMode diatur ke DataBackupPolicy.	Standard
CompressType	string	Metode kompresi cadangan. Nilai valid: 0: tanpa kompresi 1: kompresi zlib 2: kompresi zlib paralel 4: kompresi QuickLZ dengan fitur pemulihan database dan tabel diaktifkan 8: kompresi QuickLZ tetapi fitur pemulihan database dan tabel tidak didukung.	1
EnableBackupLog	string	Apakah cadangan log diaktifkan. Nilai valid: 1: diaktifkan 0: dinonaktifkan Untuk instans SQL Server: 1 hanya dikembalikan ketika frekuensi cadangan log instans adalah setiap 5 menit. Ketika frekuensi cadangan log instans adalah setiap 30 menit atau konsisten dengan siklus cadangan data, parameter ini mengembalikan 0. Gunakan nilai BackupInterval sebagai referensi.	1
EnableIncrementDataBackup	boolean	Apakah cadangan inkremental diaktifkan untuk instans SQL Server. Nilai valid: True: diaktifkan False: dinonaktifkan.	True
IncBackupInterval	integer
EnablePitrProtection	boolean	Apakah pemulihan titik waktu tertentu (PITR) diaktifkan untuk instans MySQL. PITR adalah versi peningkatan dari cadangan log. Nilai valid: True: diaktifkan False: dinonaktifkan Catatan Untuk informasi lebih lanjut, lihat Mengonfigurasi kebijakan pemulihan titik waktu tertentu.	True
HighSpaceUsageProtection	string	Apakah log biner dihapus secara paksa ketika penggunaan penyimpanan instans MySQL melebihi 80% atau penyimpanan tersisa kurang dari 5 GB. Nilai valid: Disable: Log biner tidak dihapus. Enable: Log biner dihapus.	Enable
LocalLogRetentionHours	integer	Jumlah jam cadangan log biner dipertahankan secara lokal untuk instans MySQL.	0
LocalLogRetentionSpace	string	Penggunaan penyimpanan maksimum log biner yang disimpan secara lokal untuk instans MySQL.	30
LogBackupFrequency	string	Frekuensi cadangan log instans SQL Server. Nilai valid: LogInterval: setiap 30 menit. Secara default, frekuensi cadangan log sama dengan siklus cadangan data yang ditentukan oleh PreferredBackupPeriod.	LogInterval
LogBackupLocalRetentionNumber	integer	Jumlah log biner lokal yang dipertahankan untuk instans MySQL.	60
LogBackupRetentionPeriod	integer	Jumlah hari cadangan log dipertahankan.	7
PitrRetentionPeriod	integer	Jumlah hari pemulihan titik waktu tertentu didukung untuk instans MySQL.	7
PreferredBackupPeriod	string	Siklus cadangan data. Beberapa nilai dipisahkan oleh koma (,). Nilai valid: Monday: Senin Tuesday: Selasa Wednesday: Rabu Thursday: Kamis Friday: Jumat Saturday: Sabtu Sunday: Minggu.	Monday,Wednesday,Friday,Sunday
PreferredBackupTime	string	Waktu cadangan data. Format: HH:mmZ-HH:mmZ (UTC).	15:00Z-16:00Z
PreferredNextBackupTime	string	Waktu cadangan berikutnya. Format: yyyy-MM-ddTHH:mmZ (UTC).	2018-01-19T15:15Z
ReleasedKeepPolicy	string	Kebijakan retensi data untuk cadangan terarsip dari instans MySQL yang dihapus. Nilai valid: None: Tidak ada cadangan terarsip yang dipertahankan. Lastest: Hanya cadangan terarsip terakhir yang dipertahankan. All: Semua cadangan terarsip dipertahankan.	None
RequestId	string	ID permintaan.	B87E2AB3-B7C9-4394-9160-7F639F732031
SupportModifyBackupPriority	boolean	Apakah opsi cadangan instans sekunder dapat dimodifikasi untuk instans SQL Server. Nilai valid: True: Opsi dapat dimodifikasi. False: Opsi tidak dapat dimodifikasi.	False
SupportReleasedKeep	integer	Parameter yang dicadangkan.	0
SupportVolumeShadowCopy	integer	Apakah cadangan snapshot didukung untuk instans SQL Server. Nilai valid: 1: didukung 0: tidak didukung.	1
SupportsHighFrequencyBackup	integer	Apakah fitur cadangan log 5 menit didukung untuk instans SQL Server. Nilai valid: 0: tidak didukung 1: didukung.	0
AdvancedDataPolicies	object
AdvancedDataPolicy	array<object>
	object
StrategyId	string
ActionType	string
OnlyPreserveOneEachHour	boolean
RetentionValue	integer
BakType	string
FilterKey	string
FilterValue	string
DestType	string
FilterType	string
SrcRegion	string
OnlyPreserveOneEachDay	boolean
SrcType	string
DestRegion	string
RetentionType	string
AdvancedLogPolicies	object
AdvancedLogPolicy	array<object>
	object
StrategyId	string
ActionType	string
LogRetentionType	string
DestType	string
EnableLogBackup	integer
SrcType	string
SrcRegion	string
LogRetentionValue	integer
DestRegion	string
FilterKey	string
FilterValue	string
AdvancedBackupPolicyEnabled	boolean

Contoh

Respons sukses

JSONformat

{
  "ArchiveBackupKeepCount": "1",
  "ArchiveBackupKeepPolicy": "ByMonth",
  "ArchiveBackupRetentionPeriod": "365",
  "BackupInterval": "30",
  "BackupLog": "Enable",
  "BackupMethod": "Physical",
  "BackupPriority": 2,
  "BackupRetentionPeriod": 7,
  "Category": "Standard",
  "CompressType": "1",
  "EnableBackupLog": "1",
  "EnableIncrementDataBackup": true,
  "IncBackupInterval": 0,
  "EnablePitrProtection": true,
  "HighSpaceUsageProtection": "Enable",
  "LocalLogRetentionHours": 0,
  "LocalLogRetentionSpace": "30",
  "LogBackupFrequency": "LogInterval",
  "LogBackupLocalRetentionNumber": 60,
  "LogBackupRetentionPeriod": 7,
  "PitrRetentionPeriod": 7,
  "PreferredBackupPeriod": "Monday,Wednesday,Friday,Sunday",
  "PreferredBackupTime": "15:00Z-16:00Z",
  "PreferredNextBackupTime": "2018-01-19T15:15Z",
  "ReleasedKeepPolicy": "None",
  "RequestId": "B87E2AB3-B7C9-4394-9160-7F639F732031",
  "SupportModifyBackupPriority": true,
  "SupportReleasedKeep": 0,
  "SupportVolumeShadowCopy": 1,
  "SupportsHighFrequencyBackup": 0,
  "AdvancedDataPolicies": {
    "AdvancedDataPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "OnlyPreserveOneEachHour": false,
        "RetentionValue": 0,
        "BakType": "",
        "FilterKey": "",
        "FilterValue": "",
        "DestType": "",
        "FilterType": "",
        "SrcRegion": "",
        "OnlyPreserveOneEachDay": false,
        "SrcType": "",
        "DestRegion": "",
        "RetentionType": ""
      }
    ]
  },
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "StrategyId": "",
        "ActionType": "",
        "LogRetentionType": "",
        "DestType": "",
        "EnableLogBackup": 0,
        "SrcType": "",
        "SrcRegion": "",
        "LogRetentionValue": 0,
        "DestRegion": "",
        "FilterKey": "",
        "FilterValue": ""
      }
    ]
  },
  "AdvancedBackupPolicyEnabled": false
}

Kode kesalahan

HTTP status code	Error code	Error message
400	IO.Exception	IO exception, retry later.
400	InternalFailure	Internal failure, retry later.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	InvalidEngine.Malformed	Specified engine is not valid.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.