Tüm Ürünler
Search
Belge Merkezi

:CreateAndStartBackupPlan

Son Güncelleme:Sep 30, 2026

Bir yedekleme planı oluşturur, yapılandırır ve başlatır.

Operation description

Bu işlemi çağırmadan önce, Veritabanı Yedekleme (DBS) hizmetinin faturalandırma yöntemlerini ve fiyatlandırmasını anladığınızdan emin olun.

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

dbs:CreateAndStartBackupPlan

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

BackupPlanId

string

No

Yedekleme planının kimliği.

dbstooi0*******

Region

string

No

DBS'nin kullanılabildiği bölge. Kullanılabilir bölgeleri görüntülemek için DescribeRegions işlemini çağırın.

cn-hangzhou

InstanceClass

string

Yes

Yedekleme planının teknik özellikleri. Geçerli değerler:

  • micro

  • small

  • medium

  • large

  • xlarge

Not

Daha yüksek teknik özellikler daha iyi yedekleme ve kurtarma performansı sağlar. Daha fazla bilgi için Teknik özellikler sayfasına bakın.

micro

DatabaseType

string

Yes

Veritabanı türü. Geçerli değerler:

  • MySQL

  • MSSQL

  • Oracle

  • MariaDB

  • PostgreSQL

  • DRDS

  • MongoDB

  • Redis

MySQL

BackupMethod

string

Yes

Yedekleme yöntemi. Geçerli değerler:

  • logical: mantıksal yedekleme

  • physical: fiziksel yedekleme

logical

Period

string

No

Abonelik örneğinin faturalandırma döngüsü. Geçerli değerler:

  • Year

  • Month

Year

UsedTime

integer

No

Abonelik süresi. Geçerli değerler:

  • Period değeri Year olarak ayarlanmışsa, UsedTime değeri 1 ile 5 arasında olabilir.

  • Period değeri Month olarak ayarlanmışsa, UsedTime değeri 1 ile 11 arasında olabilir.

1

PayType

string

No

Ödeme yöntemi. Geçerli değer:

prepay: abonelik

prepay

DatabaseRegion

string

No

Veritabanının bulunduğu bölge.

cn-hangzhou

StorageRegion

string

No

Depolama bölgesi.

cn-hangzhou

InstanceType

string

No

Veritabanı örnek türü. Geçerli değerler:

  • RDS

  • PolarDB

  • DDS: Alibaba Cloud MongoDB

  • Kvstore: Alibaba Cloud Redis

  • Other: Bir IP adresi ve bağlantı noktası üzerinden bağlanan veritabanı.

  • dg: Genel IP adresi veya bağlantı noktası olmayan, Veritabanı Ağ Geçidi (DG) üzerinden bağlanan kendi yönettiğiniz veritabanı.

RDS

StorageType

string

No

Bu parametre henüz kullanıma sunulmamıştır.

无

FromApp

string

No

İsteğin kaynağı. Varsayılan değer OpenApi'dir. Bu parametreyi ayarlamanıza gerek yoktur.

OpenApi

SourceEndpointInstanceType

string

Yes

Veritabanının konumu. Geçerli değerler:

  • RDS

  • ECS

  • Express: Kiralık hat, VPN Ağ Geçidi veya Akıllı Erişim Ağ Geçidi üzerinden bağlanan bir veritabanı.

  • Agent: Yedekleme ağ geçidi üzerinden bağlanan bir veritabanı.

  • DDS: Alibaba Cloud MongoDB

  • Other: Doğrudan bir IP adresi ve bağlantı noktası üzerinden bağlanan bir veritabanı.

  • dg: Genel IP adresi veya bağlantı noktası olmayan, Veritabanı Ağ Geçidi (DG) üzerinden bağlanan kendi yönettiğiniz veritabanı.

RDS

SourceEndpointRegion

string

No

Veritabanının bulunduğu bölge.

Not

SourceEndpoint.InstanceType değeri RDS, ECS, DDS, Express veya Agent olarak ayarlanmışsa bu parametre gereklidir.

cn-hangzhou

SourceEndpointInstanceID

string

No

Veritabanı örneğinin kimliği.

Not

SourceEndpoint.InstanceType değeri RDS, ECS, DDS veya Express olarak ayarlanmışsa bu parametre gereklidir.

rm-uf6wjk5xxxxxxxxxx

SourceEndpointIP

string

No

Veritabanı uç noktası.

Not

SourceEndpoint.InstanceType değeri express, agent veya other olarak ayarlanmışsa bu parametre gereklidir.

rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com

SourceEndpointPort

integer

No

Veritabanı bağlantı noktası.

Not

SourceEndpoint.InstanceType değeri express, agent, other veya ECS olarak ayarlanmışsa bu parametre gereklidir.

3306

SourceEndpointDatabaseName

string

No

Veritabanı adı.

Not

Veritabanı türü PostgreSQL veya MongoDB ise bu parametre gereklidir.

testRDS

SourceEndpointUserName

string

No

Veritabanı hesabı.

Not

Veritabanı türü Redis ise veya veritabanı konumu agent ve veritabanı türü MSSQL ise bu parametre isteğe bağlıdır. Diğer tüm durumlarda bu parametre gereklidir.

testRDS

SourceEndpointPassword

string

No

Veritabanı hesabının parolası.

Not

Veritabanı türü Redis ise veya veritabanı konumu agent ve veritabanı türü MSSQL ise bu parametre isteğe bağlıdır. Diğer tüm durumlarda bu parametre gereklidir.

testPassword

BackupGatewayId

integer

No

Yedekleme ağ geçidinin kimliği.

Not
  • SourceEndpoint.InstanceType değeri agent olarak ayarlanmışsa bu parametre gereklidir.

  • Yedekleme ağ geçidinin nasıl oluşturulacağı hakkında daha fazla bilgi için Yedekleme ağ geçidi ekleme sayfasına bakın.

  • Mevcut yedekleme ağ geçitlerinin listesini görüntülemek için DescribeBackupGatewayList işlemini çağırabilirsiniz.

23313123312

OSSBucketName

string

No

Object Storage Service (OSS) bucket'ının adı. Varsayılan değer: Sistem otomatik olarak yeni bir ad oluşturur.

TestOssBucket

BackupObjects

string

No

Yedekleme nesneleri.

[ { "DBName":"待备份库名", "SchemaName":"待备份 Schema 名", "TableIncludes":[{ "TableName":"待备份表表名" }], "TableExcludes":[{ "TableName":"待备份库名不需要备份表的表名" }] } ]

BackupPeriod

string

No

Tam yedekleme döngüsü. Geçerli değerler:

  • Monday

  • Tuesday

  • Wednesday

  • Thursday

  • Friday

  • Saturday

  • Sunday

Not

Birden fazla değer seçebilirsiniz. Değerleri virgül (,) ile ayırın.

Monday

BackupStartTime

string

No

Tam yedeklemenin başlangıç zamanı. Zaman HH:mm biçimindedir ve UTC dilimindedir.

14:22

EnableBackupLog

boolean

No

Artımlı günlük yedeklemesinin etkinleştirilip etkinleştirilmeyeceğini belirtir. Geçerli değerler:

  • true

  • false

true

BackupLogIntervalSeconds

integer

No

Artımlı yedeklemeler için saniye cinsinden aralık.

Not

Bu parametre yalnızca fiziksel yedeklemeler için gereklidir.

1000

BackupRetentionPeriod

integer

No

Yedekleme verilerinin gün cinsinden saklama süresi. Geçerli değerler: 0 ile 1825 arası. Varsayılan değer: 730.

730

DuplicationInfrequentAccessPeriod

integer

No

Yedekleme verilerinin Seyrek Erişim (IA) depolamasına dönüştürülmesi için geçmesi gereken gün cinsinden süre. Varsayılan değer: 180.

180

DuplicationArchivePeriod

integer

No

Yedekleme verilerinin arşiv depolamasına dönüştürülmesi için geçmesi gereken gün cinsinden süre. Varsayılan değer: 365.

365

BackupPlanName

string

Yes

Yedekleme planının özel adı.

dbstooi0*******

SourceEndpointOracleSID

string

No

Oracle sistem kimliği (SID). Veritabanı türü Oracle ise bu parametre gereklidir.

test

BackupStorageType

string

No

Yerleşik depolama türü:

  • Boş (varsayılan): Yedekleme verileri OSS bucket'ınızda depolanır.

  • system: Yedekleme verileri DBS'nin yerleşik OSS bucket'ında depolanır.

无

BackupSpeedLimit

integer

No

KB/s cinsinden disk G/Ç limiti.

Not

Bu parametre yalnızca MySQL fiziksel yedeklemeleri için geçerlidir.

262144

BackupRateLimit

integer

No

KB/s cinsinden ağ bant genişliği kısıtlama limiti. İzin verilen maksimum değer 10 GB'tır.

Not

Bu parametre yalnızca MySQL fiziksel yedeklemeleri için geçerlidir.

262144

BackupStrategyType

string

No

Tam yedekleme stratejisi. Geçerli değerler:

  • simple: dönemsel yedekleme. Bu değeri BackupPeriod ve BackupStartTime ile birlikte kullanın.

  • manual: manuel yedekleme.

Not

Varsayılan değer simple'dır.

simple

CrossAliyunId

string

No

Hesaplar arası yedekleme için Alibaba Cloud hesabının UID'si.

1648821913******

CrossRoleName

string

No

Hesaplar arası yedekleme için RAM rolünün adı.

test123

ClientToken

string

No

İsteğin idempotent olmasını sağlamak için kullanılan bir istemci belirteci. Bu, yinelenen istekleri önler.

ASDASDASDSADASFCZXVZ

ResourceGroupId

string

No

Kaynak grubunun kimliği.

rg-aekzecovzti****

Response elements

Element

Type

Description

Example

object

Yanıt parametreleri.

HttpStatusCode

integer

HTTP durum kodu.

200

RequestId

string

İstek kimliği.

4F1888AC-1138-4995-B9FE-D2734F61C058

CreateBackupSet

boolean

Yedekleme kümesinin etkinleştirilip etkinleştirilmediğini gösterir. Dönüş değeri aşağıdakilerden biridir:

  • true: Etkin

  • false: Devre dışı

true

ErrCode

string

Hata kodu.

Param.NotFound

Success

boolean

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

true

ErrMessage

string

Hata mesajı.

The specified parameter %s value is not valid.

BackupPlanId

string

Yedekleme planının kimliği.

dbs1hvb0wwwe****

OrderId

string

Siparişin kimliği.

2056157***

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "4F1888AC-1138-4995-B9FE-D2734F61C058",
  "CreateBackupSet": true,
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.",
  "BackupPlanId": "dbs1hvb0wwwe****",
  "OrderId": "2056157***"
}

Error codes

HTTP status code

Error code

Error message

Description

403 Request.Forbidden Have no Permissions

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.