All Products
Search

This Product

    Data Management:ConfigureBackupPlan

    Document Center

    Data Management:ConfigureBackupPlan

    Last Updated:Jun 10, 2026

    Mengonfigurasi rencana cadangan Cadangan Basis Data (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:ConfigureBackupPlan

    update

    *BackupPlan

    acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}

    		 None None

    Parameter permintaan

    Parameter

    Type

    Required

    Description

    Example
    BackupPlanId

    string

    Yes

    ID rencana cadangan. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri ID rencana cadangan.

    dbstooi0*******
    SourceEndpointInstanceType

    string

    Yes

    Lokasi database. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini. Nilai valid:

    • RDS

    • ECS

    • Express: database yang terhubung melalui Jalur sewa, Gateway VPN, atau smart gerbang.

    • Agen: database yang terhubung melalui gateway cadangan.

    • DDS: Database Apsara for MongoDB.

    • Other: database yang terhubung langsung melalui IP:Port.

    RDS
    SourceEndpointRegion

    string

    No

    Wilayah database. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini.

    Catatan

    Parameter ini diperlukan ketika SourceEndpointInstanceType adalah RDS, ECS, DDS, Express, atau Agent.

    cn-hangzhou
    SourceEndpointInstanceID

    string

    No

    ID Instansiasi database. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini.

    Catatan

    Parameter ini diperlukan ketika SourceEndpoint.InstanceType adalah RDS, ECS, DDS, atau Express.

    rm-uf6wjk5*********
    SourceEndpointIP

    string

    No

    Titik akhir database. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini.

    Catatan

    Parameter ini diperlukan ketika SourceEndpointInstanceType adalah express, agent, atau other.

    rm-uf6wjk5*******.mysql.rds.aliyuncs.com
    SourceEndpointPort

    integer

    No

    Port database. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini.

    Catatan

    Parameter ini diperlukan ketika SourceEndpoint.InstanceType adalah express, agent, other, atau ECS.

    3306
    SourceEndpointDatabaseName

    string

    No

    Nama database. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini.

    Catatan

    Parameter ini diperlukan ketika tipe database adalah PostgreSQL atau MongoDB.

    testRDS
    SourceEndpointUserName

    string

    No

    Akun database.

    Catatan

    Parameter ini opsional ketika tipe database adalah Redis, atau ketika lokasi database adalah agent dan tipe database adalah SQL Server. Parameter ini diperlukan pada skenario lainnya.

    testRDS
    SourceEndpointPassword

    string

    No

    Kata sandi.

    Catatan

    Parameter ini opsional ketika tipe database adalah Redis, atau ketika lokasi database adalah agent dan tipe database adalah SQL Server. Parameter ini diperlukan pada skenario lainnya.

    testPassword
    BackupGatewayId

    integer

    No

    ID gateway cadangan. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini.

    Catatan

    Parameter ini diperlukan ketika SourceEndpointInstanceType adalah agent.

    23313123312
    OSSBucketName

    string

    No

    Nama Bucket OSS.

    Catatan

    Secara default, sistem akan secara otomatis menghasilkan nama baru.

    TestOssBucket
    BackupObjects

    string

    No

    Objek cadangan. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini.

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

    string

    No

    Periode cadangan penuh. Nilai valid:

    • Monday

    • Tuesday

    • Wednesday

    • Thursday

    • Friday

    • Saturday

    • Sunday.

    Monday
    BackupStartTime

    string

    No

    Pengatur waktu mulai cadangan penuh dalam format HH:mmZ (UTC). Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini.

    14:22
    EnableBackupLog

    boolean

    No

    Apakah akan mengaktifkan cadangan log inkremental. Nilai valid:

    • true: Mengaktifkan.

    • false: Menonaktifkan.

    true
    BackupLogIntervalSeconds

    integer

    No

    Interval inkremental dalam detik.

    Catatan

    Hanya cadangan fisik Port yang didukung.

    1000
    BackupRetentionPeriod

    integer

    No

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

    730
    DuplicationInfrequentAccessPeriod

    integer

    No

    Periode setelahnya data dikonversi ke penyimpanan Akses Jarang. Nilai default: 180 hari.

    180
    DuplicationArchivePeriod

    integer

    No

    Periode setelahnya data dikonversi ke penyimpanan dingin arsip. Nilai default: 365 hari.

    365
    BackupPlanName

    string

    Yes

    Nama rencana cadangan kustom. Anda dapat memanggil DescribeBackupPlanList untuk mengkueri nilai ini.

    dbstooi0*******
    SourceEndpointOracleSID

    string

    No

    Nama Oracle SID.

    Catatan

    Parameter ini diperlukan ketika tipe database adalah Oracle.

    test
    BackupStorageType

    string

    No

    Tipe penyimpanan bawaan. Nilai valid:

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

    • system: Data cadangan disimpan di 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

    Pembatasan bandwidth jaringan, dalam KB/s. Nilai maksimum adalah 10 GB.

    Catatan

    Parameter ini hanya valid untuk cadangan fisik MySQL.

    262144
    BackupStrategyType

    string

    No

    Strategi cadangan penuh. Nilai valid:

    • simple: cadangan berkala. Gunakan nilai ini bersama BackupPeriod dan BackupStartTime.

    • manual: cadangan manual.

    Catatan

    Nilai default: simple.

    simple
    CrossAliyunId

    string

    No

    UID untuk cadangan lintas akun Alibaba Cloud. Anda dapat memanggil DescribeRestoreTaskList untuk mengkueri nilai ini.

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    No

    Nama peran RAM untuk cadangan lintas akun Alibaba Cloud. Anda dapat memanggil DescribeRestoreTaskList untuk mengkueri nilai ini.

    test123
    AutoStartBackup

    boolean

    No

    Apakah akan mengaktifkan cadangan otomatis. Nilai valid:

    • true: Mengaktifkan.

    • false: Menonaktifkan.

    false
    ClientToken

    string

    No

    Token klien yang digunakan untuk memastikan idempotensi permintaan. Klien menghasilkan nilai ini, yang harus unik di antara permintaan yang berbeda. Token dapat memiliki panjang hingga 64 karakter ASCII.

    ETnLKlblzczshOTUbOCzxxxxxxx
    ResourceGroupId

    string

    No

    ID kelompok Sumber daya.

    rg-aekzecovzti****
    EnableSourceEndpointSsl

    string

    No

    true
    BackupStorageEncryptMethod

    string

    No

    encrypted
    SslCaPem

    string

    No

    -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----
    SourceEndpointOracleHome

    string

    No

    /home/test
    EnableMysqlPhysicalBackupBinlog

    string

    No

    true

    Elemen respons

    Element

    Type

    Description

    Example

    object

    The response parameters.

    HttpStatusCode

    integer

    The HTTP status code.

    200
    RequestId

    string

    The request ID.

    F1FB49D4-B504-47F1-9F43-D7EAB33F****
    ErrCode

    string

    The error code.

    Param.NotFound
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true
    ErrMessage

    string

    The error message.

    The specified parameter %s value is not valid.

    BackupPlanId

    string

    The backup plan ID.

    dbstooi01ex****

    Contoh

    Respons sukses

    JSONformat

    {
  "HttpStatusCode": 200,
  "RequestId": "F1FB49D4-B504-47F1-9F43-D7EAB33F****",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.     ",
  "BackupPlanId": "dbstooi01ex****"
}

    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.