全部产品
Search

搜索本产品

    Data Management：CreateAndStartBackupPlan

    文档中心

    Data Management：CreateAndStartBackupPlan

    更新时间：Jan 13, 2026

    Membuat, mengonfigurasi, dan memulai backup plan.

    Deskripsi operasi

    Sebelum memanggil operasi ini, pastikan Anda memahami metode penagihan dan harga Database Backup (DBS).

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

    create

    *全部资源

    *

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    BackupPlanId

    string

    No

    ID dari backup plan.

    dbstooi0*******
    Region

    string

    No

    Wilayah tempat DBS tersedia. Untuk melihat wilayah yang tersedia, panggil operasi DescribeRegions.

    cn-hangzhou
    InstanceClass

    string

    Yes

    Spesifikasi backup plan. Nilai yang valid:

    • micro

    • small

    • medium

    • large

    • xlarge

    Catatan

    Spesifikasi yang lebih tinggi memberikan performa backup dan pemulihan yang lebih baik. Untuk informasi selengkapnya, lihat Specifications.

    micro
    DatabaseType

    string

    Yes

    Jenis database. Nilai yang valid:

    • MySQL

    • MSSQL

    • Oracle

    • MariaDB

    • PostgreSQL

    • DRDS

    • MongoDB

    • Redis

    MySQL
    BackupMethod

    string

    Yes

    Metode backup. Nilai yang valid:

    • logical: logical backup

    • physical: physical backup

    logical
    Period

    string

    No

    Siklus penagihan instans langganan. Nilai yang valid:

    • Year

    • Month

    Year
    UsedTime

    integer

    No

    Durasi langganan. Nilai yang valid:

    • Jika Period diatur ke Year, nilai UsedTime dapat berkisar antara 1 hingga 5.

    • Jika Period diatur ke Month, nilai UsedTime dapat berkisar antara 1 hingga 11.

    1
    PayType

    string

    No

    Metode pembayaran. Nilai yang valid:

    prepay: subscription

    postpay
    DatabaseRegion

    string

    No

    Wilayah tempat database berada.

    cn-hangzhou
    StorageRegion

    string

    No

    Wilayah penyimpanan.

    cn-hangzhou
    InstanceType

    string

    No

    Jenis instansiasi basis data. Nilai yang valid:

    • RDS

    • PolarDB

    • DDS: Alibaba Cloud MongoDB

    • Kvstore: Alibaba Cloud Redis

    • Other: Database yang terhubung melalui alamat IP dan port.

    • dg: Database yang dikelola sendiri tanpa alamat IP publik atau port, terhubung melalui Database Gateway (DG).

    RDS
    StorageType

    string

    No

    Parameter ini belum tersedia.

    无
    FromApp

    string

    No

    Sumber permintaan. Nilai default adalah OpenApi. Anda tidak perlu mengatur parameter ini.

    OpenApi
    SourceEndpointInstanceType

    string

    Yes

    Lokasi database. Nilai yang valid:

    • RDS

    • ECS

    • Express: Database yang terhubung melalui jalur sewa, VPN Gateway, atau Smart Access Gateway.

    • Agent: Database yang terhubung melalui gateway cadangan.

    • DDS: Alibaba Cloud MongoDB

    • Other: Database yang terhubung langsung melalui alamat IP dan port.

    • dg: Database yang dikelola sendiri tanpa alamat IP publik atau port, terhubung melalui Database Gateway (DG).

    RDS
    SourceEndpointRegion

    string

    No

    Wilayah tempat database berada.

    Catatan

    Parameter ini wajib jika SourceEndpoint.InstanceType diatur ke RDS, ECS, DDS, Express, atau Agent.

    cn-hangzhou
    SourceEndpointInstanceID

    string

    No

    ID instansiasi basis data.

    Catatan

    Parameter ini wajib jika SourceEndpoint.InstanceType diatur ke RDS, ECS, DDS, atau Express.

    rm-uf6wjk5xxxxxxxxxx
    SourceEndpointIP

    string

    No

    Titik akhir database.

    Catatan

    Parameter ini wajib jika SourceEndpoint.InstanceType diatur ke express, agent, atau other.

    rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com
    SourceEndpointPort

    integer

    No

    Port database.

    Catatan

    Parameter ini wajib jika SourceEndpoint.InstanceType diatur ke express, agent, other, atau ECS.

    3306
    SourceEndpointDatabaseName

    string

    No

    Nama database.

    Catatan

    Parameter ini wajib jika jenis database adalah PostgreSQL atau MongoDB.

    testRDS
    SourceEndpointUserName

    string

    No

    Akun database.

    Catatan

    Parameter ini opsional jika jenis database adalah Redis, atau jika lokasi database adalah agent dan jenis database adalah MSSQL. Dalam semua kasus lainnya, parameter ini wajib.

    testRDS
    SourceEndpointPassword

    string

    No

    Password untuk akun database.

    Catatan

    Parameter ini opsional jika jenis database adalah Redis, atau jika lokasi database adalah agent dan jenis database adalah MSSQL. Dalam semua kasus lainnya, parameter ini wajib.

    testPassword
    BackupGatewayId

    integer

    No

    ID gateway cadangan.

    Catatan

    • Parameter ini wajib jika SourceEndpoint.InstanceType diatur ke agent.

    • Untuk informasi selengkapnya tentang cara membuat gateway cadangan, lihat Add a backup gateway.

    • Anda dapat memanggil operasi DescribeBackupGatewayList untuk melihat daftar gateway cadangan yang ada.

    23313123312
    OSSBucketName

    string

    No

    Nama bucket Object Storage Service (OSS).Default: Sistem secara otomatis menghasilkan nama baru.

    TestOssBucket
    BackupObjects

    string

    No

    Objek yang dicadangkan.

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

    string

    No

    Siklus cadangan penuh. Nilai yang valid:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Catatan

    Anda dapat memilih beberapa nilai. Pisahkan dengan koma (,).

    Monday
    BackupStartTime

    string

    No

    Waktu mulai untuk cadangan penuh. Waktu dalam format HH:mm dan dalam UTC.

    14:22
    EnableBackupLog

    boolean

    No

    Menentukan apakah akan mengaktifkan cadangan log inkremental. Nilai yang valid:

    • true

    • false

    true
    BackupLogIntervalSeconds

    integer

    No

    Interval untuk cadangan inkremental, dalam detik.

    Catatan

    Parameter ini hanya wajib untuk physical backups.

    1000
    BackupRetentionPeriod

    integer

    No

    Periode retensi data cadangan, dalam hari. Nilai yang valid: 0 hingga 1825. Nilai default: 730.

    730
    DuplicationInfrequentAccessPeriod

    integer

    No

    Waktu setelah data cadangan dikonversi ke penyimpanan Infrequent Access (IA), dalam hari. Nilai default: 180.

    180
    DuplicationArchivePeriod

    integer

    No

    Waktu setelah data cadangan dikonversi ke penyimpanan arsip, dalam hari. Nilai default: 365.

    365
    BackupPlanName

    string

    Yes

    Nama kustom dari backup plan.

    dbstooi0*******
    SourceEndpointOracleSID

    string

    No

    Oracle system ID (SID). Parameter ini wajib jika jenis database adalah Oracle.

    test
    BackupStorageType

    string

    No

    Jenis penyimpanan bawaan:

    • Kosong (default): Data cadangan disimpan di bucket OSS Anda.

    • system: Data cadangan disimpan di bucket OSS bawaan DBS.

    无
    BackupSpeedLimit

    integer

    No

    Batas I/O disk, dalam KB/s.

    Catatan

    Parameter ini hanya berlaku untuk physical backup MySQL.

    262144
    BackupRateLimit

    integer

    No

    Batas throttling bandwidth jaringan, dalam KB/s. Nilai maksimum yang diizinkan adalah 10 GB.

    Catatan

    Parameter ini hanya berlaku untuk physical backup MySQL.

    262144
    BackupStrategyType

    string

    No

    Strategi cadangan penuh. Nilai yang valid:

    • simple: periodic backup. Gunakan nilai ini bersama BackupPeriod dan BackupStartTime.

    • manual: manual backup.

    Catatan

    Nilai default adalah simple.

    simple
    CrossAliyunId

    string

    No

    UID Akun Alibaba Cloud untuk backup cross-account.

    1648821913******
    CrossRoleName

    string

    No

    Nama Peran RAM untuk backup cross-account.

    test123
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan. Ini mencegah permintaan duplikat.

    ASDASDASDSADASFCZXVZ
    ResourceGroupId

    string

    No

    ID kelompok sumber daya.

    rg-aekzecovzti****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Parameter respons.

    HttpStatusCode

    integer

    Kode status HTTP.

    200
    RequestId

    string

    ID permintaan.

    4F1888AC-1138-4995-B9FE-D2734F61C058
    CreateBackupSet

    boolean

    Menunjukkan apakah set cadangan diaktifkan. Nilai kembali adalah salah satu dari berikut:

    • true: Diaktifkan

    • false: Dinonaktifkan

    true
    ErrCode

    string

    Kode kesalahan.

    Param.NotFound
    Success

    boolean

    Menunjukkan apakah permintaan berhasil.

    true
    ErrMessage

    string

    Pesan kesalahan.

    The specified parameter %s value is not valid.
    BackupPlanId

    string

    ID dari backup plan.

    dbs1hvb0wwwe****
    OrderId

    string

    ID pesanan.

    2056157***

    Contoh

    Respons sukses

    JSONformat

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

    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.