Tüm Ürünler
Search
Belge Merkezi

:UpdateBackupPlan

Son Güncelleme:Sep 30, 2026

Bir yedekleme planını günceller.

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

hbr:UpdateBackupPlan

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

PlanId

string

Yes

Yedekleme planının kimliği.

plan-20211***735

PlanName

string

No

Yedekleme planının adı.

planname

Schedule

string

No

Yedekleme ilkesi. I|{startTime}|{interval} biçimini kullanın. Bu, bir yedekleme işinin yinelenen aralıklarla çalıştığını belirtir. {startTime}, yedeklemenin başladığı zamandır. {interval}, işler arasındaki süredir. HBR, gecikmiş yedekleme işlerini çalıştırmaz. Önceki yedekleme işi tamamlanmadıysa bir sonraki iş başlamaz. Örneğin, I|1631685600|P1D, yedeklemenin 15 Eylül 2021 saat 14:00:00'te başlayarak günde bir kez çalıştığı anlamına gelir.

  • startTime: Yedeklemenin başlangıç zamanı. Bu, saniye cinsinden bir UNIX zaman damgasıdır.

  • interval: Zaman aralığı. ISO 8601 standardını kullanın. Örneğin, PT1H bir saatlik bir aralığı belirtir. P1D bir günlük bir aralığı belirtir.

I|1602673264|P1D

Retention

integer

No

Yedeklerin saklanacağı gün sayısı. Minimum değer 1'dir.

7

Prefix

string

No

Bu parametre yalnızca SourceType değeri OSS olarak ayarlandığında gereklidir. Bu parametre, yedeklenecek nesnelerin ön ekini belirtir. Bir ön ek belirledikten sonra yalnızca ön ekle eşleşen nesneler yedeklenir.

oss-prefix

VaultId

string

No

Yedekleme deposunun kimliği.

v-0006******q

Detail

object

No

ECS örneği yedeklemesinin ayrıntıları. Bu bir JSON dizesidir.

  • snapshotGroup: Anlık görüntü tutarlılığına sahip bir grubun kullanılıp kullanılmayacağını belirtir. Bu özellik yalnızca örneğin tüm diskleri Gelişmiş Katı Hal Sürücüleri (ESSD) olduğunda kullanılabilir.

  • appConsistent: Uygulama tutarlılığının etkinleştirilip etkinleştirilmeyeceğini belirtir. Ayrıca preScriptPath ve postScriptPath parametrelerini de yapılandırmanız gerekir.

  • preScriptPath: Ön dondurma betiğinin yolu.

  • postScriptPath: Çözme sonrası betiğinin yolu.

{\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60}

SourceType

string

No

Veri kaynağının türü. Geçerli değerler:

  • ECS_FILE: ECS dosyalarını yedekler.

  • OSS: Alibaba Cloud OSS'yi yedekler.

  • NAS: Alibaba Cloud NAS'ı yedekler.

  • OTS: Alibaba Cloud Tablestore'u yedekler.

  • UDM_ECS: Bir ECS örneğinin tamamını yedekler.

ECS_FILE

SpeedLimit

string

No

Bu parametre yalnızca SourceType değeri ECS_FILE olarak ayarlandığında gereklidir. Bu parametre, yedeklemeler için trafik şekillendirmeyi belirtir. Trafik şekillendirme, hizmetlerinizi etkilememek için yoğun iş saatlerinde yedekleme trafiğini kontrol etmenize yardımcı olur. Biçim {start}|{end}|{bandwidth} şeklindedir. Birden fazla trafik şekillendirme kuralı belirtebilirsiniz. Bunları dikey çubuklarla (|) ayırın. Kuralların zaman aralıkları çakışamaz.

  • start: Başlangıç saati.

  • end: Bitiş saati.

  • bandwidth: Maksimum hız. Birim: KB/s.

0:24:5120

Include

string

No

Bu parametre yalnızca SourceType değeri ECS_FILE olarak ayarlandığında gereklidir. Bu parametre, yedeklenecek dosyaların yollarını belirtir. Belirtilen yollardaki tüm dosyalar yedeklenir. Değer en fazla 255 karakter uzunluğunda olabilir.

["/home/alice/*.pdf", "/home/bob/*.txt"]

Exclude

string

No

Bu parametre yalnızca SourceType değeri ECS_FILE olarak ayarlandığında gereklidir. Bu parametre, yedeklemeye dahil edilmeyecek dosyaların yollarını belirtir. Belirtilen yollardaki hiçbir dosya yedeklenmez. Değer en fazla 255 karakter uzunluğunda olabilir.

["/var", "/proc"]

Options

string

No

Bu parametre yalnızca SourceType değeri ECS_FILE olarak ayarlandığında gereklidir. Bu parametre, yedekleme yolunu tanımlamak için Birim Gölge Kopya Hizmeti'nin (VSS) kullanılıp kullanılmayacağını belirtir.

  • Bu özellik yalnızca Windows ECS örnekleri için kullanılabilir.

  • Yedekleme kaynağında veri değişiklikleri meydana gelirse, veri tutarlılığını sağlamak için bu parametreyi ["UseVSS":true] olarak ayarlayın.

  • VSS'yi etkinleştirirseniz, aynı anda birden fazla dosya dizinini yedekleyemezsiniz.

{"UseVSS":false}

UpdatePaths

boolean

No

Path parametresi boşsa yedekleme yollarının güncellenip güncellenmeyeceğini belirtir.

  • true: Yedekleme yollarını bu çağrıda belirtilen yollara göre günceller.

  • false: Yedekleme yollarını güncellemez. Yedekleme planı oluşturulduğunda yapılandırılan yedekleme yolları kullanılır.

false

Path

array

No

Yedekleme yolları.

string

No

Yedekleme yolu. Değer en fazla 65.536 karakter uzunluğunda olabilir. Aşağıdaki kurallar geçerlidir:

  • Joker karakter (*) kullanmazsanız, en fazla 20 yol girebilirsiniz.

  • Joker karakter (*) kullanırsanız, yalnızca bir yol girebilirsiniz. /*/* gibi joker karakterler desteklenir.

  • Her yol mutlak bir yol olmalıdır.

  • VSS kullanırsanız, birden fazla yol, UNC yolu, joker karakter veya hariç tutulan dosya belirtemezsiniz.

  • UNC yolu kullanırsanız, VSS, joker karakter veya hariç tutulan dosya kullanamazsınız. Yedekleme kaynağı bir UNC yolu içeriyorsa, Windows Erişim Denetim Listeleri (ACL'ler) yedeklenmez.

["/home"]

Rule

array<object>

No

Yedekleme planının kuralları.

object

No

DestinationRetention

integer

No

Coğrafi yedekli yedeklemenin saklanacağı gün sayısı.

7

Schedule

string

No

Yedekleme ilkesi. I|{startTime}|{interval} biçimini kullanın. Bu, bir yedekleme işinin yinelenen aralıklarla çalıştığını belirtir. {startTime}, yedeklemenin başladığı zamandır. {interval}, işler arasındaki süredir. HBR, gecikmiş yedekleme işlerini çalıştırmaz. Önceki yedekleme işi tamamlanmadıysa bir sonraki iş başlamaz. Örneğin, I|1631685600|P1D, yedeklemenin 15 Eylül 2021 saat 14:00:00'te başlayarak günde bir kez çalıştığı anlamına gelir.

startTime: Yedeklemenin başlangıç zamanı. Bu, saniye cinsinden bir UNIX zaman damgasıdır. interval: Zaman aralığı. ISO 8601 standardını kullanın. Örneğin, PT1H bir saatlik bir aralığı belirtir. P1D bir günlük bir aralığı belirtir.

I|1631685600|P1D

Disabled

boolean

No

İlkenin devre dışı bırakılıp bırakılmayacağını belirtir.

false

Retention

integer

No

Yedeklerin saklanacağı gün sayısı. Minimum değer 1'dir.

7

DoCopy

boolean

No

Coğrafi yedekli çoğaltmanın etkinleştirilip etkinleştirilmeyeceğini belirtir.

false

DestinationRegionId

string

No

Coğrafi yedekli yedekleme için hedef bölgenin kimliği.

cn-shanghai

RuleName

string

No

İlkenin adı.

rule-test-name

BackupType

string

No

Yedekleme türü. Değeri COMPLETE olarak ayarlayın. Bu, tam yedeklemeyi gösterir.

COMPLETE

OtsDetail OtsDetail

No

Tablestore örneğinin ayrıntıları.

KeepLatestSnapshots

integer

No

En son yedekleme sürümünün kalıcı olarak saklanıp saklanmayacağını belirtir.

  • 0: Hayır

  • 1: Evet

1

ChangeListPath

string

No

Artımlı dosya eşitleme listesi için yapılandırma. (Bu parametre yalnızca dosya eşitlemesi için gereklidir.)

{"dataSourceId": "ds-123456789", "path": "/changelist"}

Edition

string

No

Sürüm. Geçerli değerler BASIC ve STANDARD'dır. Varsayılan değer STANDARD'dır.

STANDARD

Response elements

Element

Type

Description

Example

object

Code

string

Dönüş kodu. 200 değeri, isteğin başarılı olduğunu gösterir.

200

Message

string

Döndürülen mesaj. İstek başarılıysa successful döndürülür. İstek başarısız olursa, bir hata mesajı döndürülür.

successful

RequestId

string

İstek kimliği.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Success

boolean

İsteğin başarılı olup olmadığını gösterir.

  • true: İstek başarılıydı.

  • false: İstek başarısız oldu.

true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.