All Products
Search

This Product

    Data Management:CreateAndStartBackupPlan

    Document Center

    Data Management:CreateAndStartBackupPlan

    Last Updated:Jun 10, 2026

    Membuat, mengonfigurasi, dan memulai rencana cadangan.

    Deskripsi operasi

    Before you call this operation, ensure that you understand the billing methods and pricing of 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 rencana cadangan.

    dbstooi0*******
    Region

    string

    No

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

    cn-hangzhou
    InstanceClass

    string

    Yes

    Spesifikasi format rencana cadangan. Nilai valid:

    • micro

    • small (kecil)

    • medium (Menengah)

    • large (Tingkat Tinggi)

    • xlarge

    Catatan

    Spesifikasi yang lebih tinggi memberikan performa cadangan dan pemulihan yang lebih baik. Untuk informasi lebih lanjut, lihat Spesifikasi.

    micro
    DatabaseType

    string

    Yes

    Tipe database. Nilai valid:

    • MySQL

    • MSSQL

    • Oracle

    • MariaDB

    • PostgreSQL

    • DRDS

    • MongoDB

    • Redis.

    MySQL
    BackupMethod

    string

    Yes

    Metode cadangan. Nilai valid:

    • logical: cadangan logis

    • physical: cadangan fisik.

    logical
    Period

    string

    No

    Siklus penagihan Instansi langganan. Nilai valid:

    • Year

    • Month.

    Year
    UsedTime

    integer

    No

    Durasi langganan. Nilai valid:

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

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

    1
    PayType

    string

    No

    Metode pembayaran. Nilai valid:

    prepay: langganan.

    prepay
    DatabaseRegion

    string

    No

    Wilayah tempat database berada.

    cn-hangzhou
    StorageRegion

    string

    No

    Wilayah penyimpanan.

    cn-hangzhou
    InstanceType

    string

    No

    Tipe Instansiasi basis data. Nilai valid:

    • RDS

    • PolarDB (PolarDB Basis Data Relasional Cloud-Native)

    • 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 Gerbang Basis Data (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 valid:

    • RDS

    • ECS

    • Express: Database yang terhubung melalui Jalur sewa, Gateway VPN, 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 Gerbang Basis Data (DG).

    RDS
    SourceEndpointRegion

    string

    No

    Wilayah tempat database berada.

    Catatan

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

    cn-hangzhou
    SourceEndpointInstanceID

    string

    No

    ID Instansiasi basis data database.

    Catatan

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

    rm-uf6wjk5xxxxxxxxxx
    SourceEndpointIP

    string

    No

    Titik akhir database.

    Catatan

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

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

    integer

    No

    Port database.

    Catatan

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

    3306
    SourceEndpointDatabaseName

    string

    No

    Nama database.

    Catatan

    Parameter ini diperlukan jika tipe database adalah PostgreSQL atau MongoDB.

    testRDS
    SourceEndpointUserName

    string

    No

    Akun database.

    Catatan

    Parameter ini opsional jika tipe database adalah Redis, atau jika lokasi database adalah agent dan tipe database adalah MSSQL. Dalam semua kasus lain, parameter ini diperlukan.

    testRDS
    SourceEndpointPassword

    string

    No

    Kata sandi untuk akun database.

    Catatan

    Parameter ini opsional jika tipe database adalah Redis, atau jika lokasi database adalah agent dan tipe database adalah MSSQL. Dalam semua kasus lain, parameter ini diperlukan.

    testPassword
    BackupGatewayId

    integer

    No

    ID gateway cadangan.

    Catatan

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

    • Untuk informasi lebih lanjut tentang cara membuat gateway cadangan, lihat Menambahkan gateway cadangan.

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

    23313123312
    OSSBucketName

    string

    No

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

    TestOssBucket
    BackupObjects

    string

    No

    Objek cadangan.

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

    string

    No

    Siklus cadangan penuh. Nilai valid:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday

    Catatan

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

    Monday
    BackupStartTime

    string

    No

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

    14:22
    EnableBackupLog

    boolean

    No

    Apakah akan mengaktifkan cadangan log inkremental. Nilai valid:

    • true

    • false.

    true
    BackupLogIntervalSeconds

    integer

    No

    Interval untuk cadangan inkremental, dalam detik.

    Catatan

    Parameter ini hanya diperlukan untuk cadangan fisik.

    1000
    BackupRetentionPeriod

    integer

    No

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

    730
    DuplicationInfrequentAccessPeriod

    integer

    No

    Pengatur waktu setelah data cadangan dikonversi ke penyimpanan Akses Jarang (IA), dalam hari. Nilai default: 180.

    180
    DuplicationArchivePeriod

    integer

    No

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

    365
    BackupPlanName

    string

    Yes

    Nama kustom Rencana cadangan.

    dbstooi0*******
    SourceEndpointOracleSID

    string

    No

    ID sistem Oracle (SID). Parameter ini diperlukan jika tipe database adalah Oracle.

    test
    BackupStorageType

    string

    No

    Tipe 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 valid untuk cadangan fisik MySQL.

    262144
    BackupRateLimit

    integer

    No

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

    Catatan

    Parameter ini hanya valid untuk cadangan fisik MySQL.

    262144
    BackupStrategyType

    string

    No

    Strategi cadangan penuh. Nilai valid:

    • simple: cadangan berkala (periode berkala). Gunakan nilai ini dengan BackupPeriod dan BackupStartTime.

    • manual: cadangan manual.

    Catatan

    Nilai default adalah simple.

    simple
    CrossAliyunId

    string

    No

    UID akun Alibaba Cloud untuk cadangan lintas akun.

    1648821913******
    CrossRoleName

    string

    No

    Nama Peran RAM untuk cadangan lintas akun.

    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

    The response parameters.

    HttpStatusCode

    integer

    The HTTP status code.

    200
    RequestId

    string

    The request ID.

    4F1888AC-1138-4995-B9FE-D2734F61C058
    CreateBackupSet

    boolean

    Indicates whether the backup set is enabled. The return value is one of the following:

    • true: Enabled

    • false: Disabled

    true
    ErrCode

    string

    The error code.

    Param.NotFound
    Success

    boolean

    Indicates whether the request was successful.

    true
    ErrMessage

    string

    The error message.

    The specified parameter %s value is not valid.
    BackupPlanId

    string

    The ID of the backup plan.

    dbs1hvb0wwwe****
    OrderId

    string

    The ID of the order.

    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.