DescribeBackupPolicy - - Alibaba Cloud Dokümantasyon Merkezi

Bir ApsaraDB RDS örneğinin yedekleme ayarlarını sorgular.

Operation description

Desteklenen motorlar

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

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

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	Örnek kimliği. Örnek kimliğini almak için DescribeDBInstances çağrısı yapabilirsiniz.	rm-uf6wjk5****
BackupPolicyMode	string	No	Yedekleme türü. Geçerli değerler: DataBackupPolicy: veri yedekleme LogBackupPolicy: günlük yedekleme.	DataBackupPolicy
CompressType	string	No	Yedekleme sıkıştırma yöntemi. Geçerli değerler: 0: sıkıştırılmamış 1: zlib sıkıştırması 2: paralel zlib sıkıştırması 4: tekil veritabanları ve tablolar için hızlı geri yükleme etkinleştirilmiş QuickLZ sıkıştırması 8: QuickLZ sıkıştırması ancak tekil veritabanları ve tablolar için hızlı geri yükleme henüz desteklenmiyor.	1
ReleasedKeepPolicy	string	No	Silinen MySQL örnekleri için arşivlenmiş yedek verisi saklama politikası. Geçerli değerler: None: Arşivlenmiş yedekler saklanmaz. Lastest: Yalnızca son arşivlenmiş yedek saklanır. All: Tüm arşivlenmiş yedekler saklanır.	Lastest

Response elements

Element	Type	Description	Example
	object	Yanıt parametreleri.
ArchiveBackupKeepCount	string	MySQL örneği için saklanan arşivlenmiş yedek sayısı.	1
ArchiveBackupKeepPolicy	string	MySQL örneği için arşivlenmiş yedeklerin saklama döngüsü.	ByMonth
ArchiveBackupRetentionPeriod	string	MySQL örneği için arşivlenmiş yedeklerin saklandığı gün sayısı.	365
BackupInterval	string	Yedekleme aralığı. Birim: dakika. MySQL örnekleri için bu parametre anlık görüntü yedekleme sıklığını (anlık görüntü yedekleme döngüsünü değil) belirtir. SQL Server örnekleri için bu parametre günlük yedekleme sıklığını belirtir.	30
BackupLog	string	Günlük yedeklemenin etkin olup olmadığını gösterir. Geçerli değerler: Enable: etkin Disabled: devre dışı SQL Server örnekleri için: Enable değeri yalnızca örnek günlük yedekleme sıklığı her 5 dakikada bir olduğunda döndürülür. Örnek günlük yedekleme sıklığı her 30 dakikada bir veya veri yedekleme döngüsüyle aynı olduğunda, bu parametre Disabled değerini döndürür. Referans olarak BackupInterval değerini kullanın.	Enable
BackupMethod	string	Bulut disklerine sahip SQL Server örnekleri için yedekleme yöntemi. Geçerli değerler: Physical: fiziksel yedekleme Snapshot: anlık görüntü yedekleme.	Physical
BackupPriority	integer	SQL Server Enterprise Cluster Edition örneğinin ikincil örneği için yedekleme önceliği ayarı. Geçerli değerler: 1: İkincil örnek tercih edilir. 2: Birincil örnek zorlanır. Not Bu parametre yalnızca SupportModifyBackupPriority değeri True olduğunda döndürülür.	2
BackupRetentionPeriod	integer	Veri yedeklerinin saklandığı gün sayısı.	7
Category	string	MySQL veya PostgreSQL örneği için saniyeler içinde yedeklemenin etkin olup olmadığını gösterir. Geçerli değerler: Flash: etkin Standard: devre dışı Not Bu parametre yalnızca BackupPolicyMode parametresi DataBackupPolicy olarak ayarlandığında geçerli olur.	Standard
CompressType	string	Yedekleme sıkıştırma yöntemi. Geçerli değerler: 0: sıkıştırılmamış 1: zlib sıkıştırması 2: paralel zlib sıkıştırması 4: tekil veritabanları ve tablolar için hızlı geri yükleme etkinleştirilmiş QuickLZ sıkıştırması 8: QuickLZ sıkıştırması ancak tekil veritabanları ve tablolar için hızlı geri yükleme henüz desteklenmiyor.	1
EnableBackupLog	string	Günlük yedeklemenin etkin olup olmadığını gösterir. Geçerli değerler: 1: etkin 0: devre dışı SQL Server örnekleri için: 1 değeri yalnızca örnek günlük yedekleme sıklığı her 5 dakikada bir olduğunda döndürülür. Örnek günlük yedekleme sıklığı her 30 dakikada bir veya veri yedekleme döngüsüyle aynı olduğunda, bu parametre 0 değerini döndürür. Referans olarak BackupInterval değerini kullanın.	1
EnableIncrementDataBackup	boolean	SQL Server örneği için artımlı yedeklemenin etkin olup olmadığını gösterir. Geçerli değerler: True: etkin False: devre dışı.	True
IncBackupInterval	integer
EnablePitrProtection	boolean	MySQL örneği için belirli bir noktaya kurtarma (PITR) özelliğinin etkin olup olmadığını gösterir. PITR, günlük yedeklemenin yükseltilmiş bir sürümüdür. Geçerli değerler: True: etkin False: devre dışı Not Daha fazla bilgi için Belirli bir noktaya kurtarma politikası yapılandırma konusuna bakın.	True
HighSpaceUsageProtection	string	MySQL örneğinin depolama kullanımı %80'i aştığında veya kalan depolama alanı 5 GB'tan az olduğunda ikili günlüklerin zorla silinip silinmeyeceğini gösterir. Geçerli değerler: Disable: İkili günlükler zorla silinmez. Enable: İkili günlükler zorla silinir.	Enable
LocalLogRetentionHours	integer	MySQL örneği için ikili günlük yedeklerinin yerel olarak saklandığı saat sayısı.	0
LocalLogRetentionSpace	string	MySQL örneği için yerel olarak depolanan ikili günlüklerin maksimum depolama kullanımı.	30
LogBackupFrequency	string	SQL Server örneği için günlük yedekleme sıklığı. Geçerli değerler: LogInterval: her 30 dakikada bir. Varsayılan olarak, günlük yedekleme sıklığı PreferredBackupPeriod tarafından belirtilen veri yedekleme döngüsüyle aynıdır.	LogInterval
LogBackupLocalRetentionNumber	integer	MySQL örneği için saklanan yerel ikili günlük sayısı.	60
LogBackupRetentionPeriod	integer	Günlük yedeklerinin saklandığı gün sayısı.	7
PitrRetentionPeriod	integer	MySQL örneği için belirli bir noktaya kurtarma işleminin desteklendiği gün sayısı.	7
PreferredBackupPeriod	string	Veri yedekleme döngüsü. Birden fazla değer virgülle (,) ayrılır. Geçerli değerler: Monday: Pazartesi Tuesday: Salı Wednesday: Çarşamba Thursday: Perşembe Friday: Cuma Saturday: Cumartesi Sunday: Pazar.	Monday,Wednesday,Friday,Sunday
PreferredBackupTime	string	Veri yedekleme zamanı. Biçim: HH:mmZ-HH:mmZ (UTC).	15:00Z-16:00Z
PreferredNextBackupTime	string	Sonraki yedekleme zamanı. Biçim: yyyy-MM-ddTHH:mmZ (UTC).	2018-01-19T15:15Z
ReleasedKeepPolicy	string	Silinen MySQL örnekleri için arşivlenmiş yedek verisi saklama politikası. Geçerli değerler: None: Arşivlenmiş yedekler saklanmaz. Lastest: Yalnızca son arşivlenmiş yedek saklanır. All: Tüm arşivlenmiş yedekler saklanır.	None
RequestId	string	İstek kimliği.	B87E2AB3-B7C9-4394-9160-7F639F732031
SupportModifyBackupPriority	boolean	SQL Server örneği için ikincil örnek yedekleme seçeneğinin değiştirilip değiştirilemeyeceğini gösterir. Geçerli değerler: True: Seçenek değiştirilebilir. False: Seçenek değiştirilemez.	False
SupportReleasedKeep	integer	Ayrılmış bir parametre.	0
SupportVolumeShadowCopy	integer	SQL Server örneği için anlık görüntü yedeklemenin desteklenip desteklenmediğini gösterir. Geçerli değerler: 1: desteklenir 0: desteklenmez.	1
SupportsHighFrequencyBackup	integer	SQL Server örneği için 5 dakikalık günlük yedekleme özelliğinin desteklenip desteklenmediğini gösterir. Geçerli değerler: 0: desteklenmez 1: desteklenir.	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

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code	Error code	Error message	Description
400	IO.Exception	IO exception, retry later.	Ağ sorunları nedeniyle veri aktarımı başarısız oldu. Daha sonra tekrar deneyin.
400	InternalFailure	Internal failure, retry later.	İsteğin işlenmesi, bilinmeyen bir hata nedeniyle başarısız oldu.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.	OwnerAccount parametresi hatalı olduğu için işlem başarısız oldu. Parametre değerini kontrol edin.
400	InvalidEngine.Malformed	Specified engine is not valid.	Mevcut Engine parametresi geçersiz. Engine parametresini yeniden ayarlayın.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	Paketteki örnekler üzerinde ayrı ayrı işlem yapılamaz.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Fiyatlandırma planı sonucu bulunamadı.
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.	Gerçek ad doğrulamasını tamamlamadınız ve satın alma işlemi yapma uygunluğuna sahip değilsiniz. Gerçek ad doğrulamasını tamamlamak için Giderler ve Maliyetler'de oturum açın.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Hesap bakiyeniz 0'dan azdır. Satın alma işlemi yapmadan önce hesabınıza bakiye yükleyin.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Ticari hizmet çağrısı başarısız oldu.
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.	Alibaba Cloud, mevcut bölgeyi optimize etmeyi ve ayarlamayı planlamaktadır. Bu bölgedeki bulut hizmetleri operasyonlarını sonlandıracaktır. İş sürekliliğinizi ve sorunsuz bir veri geçişini sağlamak için şu anda yeni satın alma siparişleri veremezsiniz. Anlayışınız ve desteğiniz için teşekkür ederiz.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	Satın aldığınız modül geçersiz. Modülü yeniden satın alın.
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.	Belirtilen bölge kullanımdan kaldırılmıştır.
400	Price.CommoditySys	Commodity system call exception.	Ticari sistem çağrılırken bir istisna oluştu.
400	Pay.InsufficientBalance	Insufficient available balance.	Mevcut hesap bakiyesi 100'den az. Satın alma işlemi yapmadan önce hesabınıza bakiye yükleyin.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	Seçilen abonelik süresi geçersiz. Farklı bir abonelik süresi seçin.
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.	Seçtiğiniz hizmet için ödenmemiş bir sipariş mevcut. Yeni bir sipariş vermeden önce mevcut siparişi ödeyin veya iptal edin.
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.	Bilgileriniz eksik. Devam etmeden önce bilgilerinizi tamamlayın.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Hesabınızda bir istisna durumu bulunmaktadır. Ayrıntılar için müşteri hizmetleriyle iletişime geçin.
400	Api.NotSupport	Specified api is not supported.	Mevcut işlem desteklenmez.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	Siparişi engelleyen bir etiket mevcut. Bu sorunu çözmek için distribütörünüzle iletişime geçin.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	Belirtilen örnek mevcut değil. Örneğin var olup olmadığını ve silinmemiş olduğunu kontrol edin.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	Mevcut örnek türü bu depolama türünü desteklememektedir.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	İşlem başarısız oldu. Parametre geçersiz.
400	KmsApiError	User secret key invalid.	Kullanıcı anahtarı geçersiz.
400	System.SaleValidateFailed	Sales expression validation system error.	İstek geçerli bir abonelik süresi içermiyor. Period veya UsedTime parametresini kontrol edin.
400	Abs.InvalidAccount.NotFound	account is not found.	Hesap mevcut değil.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL komutu yürütülemedi veya zaman aşımına uğradı.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	Mevcut örnek DPI motoru sürümü soğuk veri arşivlemeyi desteklemez.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	Mevcut çekirdek sürümü soğuk veri arşivlemeyi desteklemez.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	Mevcut örnek türü bu işlemi desteklemez.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	Bağlantı adresi adı yineleniyor. Farklı bir bağlantı dizesi belirtin.
400	RequiredParam.NotFound	Required input param is not found.	Gerekli bir parametre eksik.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parametre geçersiz. Parametreleri kontrol edin.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Soğuk veri arşivleme, bölgeler arası yedeklemeyi veya yüksek frekanslı anlık görüntü yedeklemesini desteklemez. Yedekleme politikasını kontrol edin.
400	InvalideStatus.Format	The instance status does not support this operation.	Örnek durumu bu işlemi desteklemiyor.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Örnek serbest bırakıldıktan sonraki arşivlenmiş yedek veri saklama politikası geçersiz.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	Örneğin veritabanı motoru türü bu işlemi desteklemez.
400	Pay.NoCreditCard	No credit cards.	Hesap bir kredi kartına bağlı değil.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	Bu işlem, VPC ağ türündeki örnekler için desteklenmez.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Veritabanı örneği görüntüsü zaten mevcut.
400	UnsupportedClassCode	The specified DB instance class stops selling.	Örnek türü artık satın alıma sunulmamaktadır.
400	InvalidBackupSet	The specified database does not exist in the backup set.	Belirtilen veritabanı yedekleme kümesinde mevcut değil.
400	OrdTCommodityQueryError	Failed to query for product.	Ürün sorgulanamadı.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	Örnek serbest bırakılmıştır. Sipariş vermeden önce örneği doğrulayın.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	Belirtilen bölge kullanımdan kaldırılmıştır.
500	ExternalFailure	The request processing has failed due to external service failure.	İstek başarısız oldu. Daha sonra tekrar deneyin.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	İstek başarısız oldu. Daha sonra tekrar deneyin veya teknik destek ile iletişime geçin.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	İstek, RDS API hizmetindeki bir hata nedeniyle başarısız oldu.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	İşlem başarısız oldu. Mevcut örnek durumu bu işlemi desteklemiyor. Daha sonra tekrar deneyin.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	Örneğin ödenmemiş bir siparişi var. Siparişi ödeyin ve tekrar deneyin.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	Ölçek küçültme için hedef kapasite, mevcut depolama kullanımından az olamaz.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	SSD bulut diskleri bu işlemi desteklemez. ESSD'ye yükseltin.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	Kullanıcı izinleri bu işlemi desteklemez.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	Belirtilen VSwitchId geçersiz bir formatta veya boş.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	Mevcut alt motor sürümü bu işlemi desteklemiyor.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	Kullanılabilir stok bölgesi bulunmuyor.
403	NotInFlowController	Sorry,no permission.	Bu işlem, kurumsal olmayan bulut kullanıcıları için kullanılamaz. Gerekli izinlere sahip değilsiniz.
403	InvalidKmsKey	Kms key is disabled.	KMS anahtarı devre dışı.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	İşlem başarısız oldu. Belirtilen teknik özellik kodu, belirtilen uç nokta sayısını desteklememektedir. Parça sayısını ve mevcut uç nokta sayısını kontrol edin.
404	InvalidDBInstance.NotFound	Specified instance does not exist or not support.	Belirtilen örnek mevcut değil veya bu işlemi desteklemiyor.
404	InvalidDBInstanceName.NotFound	Invalid DBInstanceId NotFound.	Belirtilen örnek kimliği mevcut değil. Örnek kimliğini doğrulayın ve tekrar deneyin.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	Mevcut örneğin Key Management Service'e erişim yetkisi bulunmuyor.
404	Request.NotFound	The requested resource is not available.	İstenen kaynak kullanılamıyor.
404	HostInfo.NotFound	The specified host info is not found.	Belirtilen ana makine bilgileri mevcut değil.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.