全部产品
Search

搜索本产品

    Data Management：ConfigureBackupPlan

    文档中心

    Data Management：ConfigureBackupPlan

    更新时间：Mar 19, 2026

    API ini digunakan untuk mengonfigurasi backup plan 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 backup plan. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

    dbstooi0*******
    SourceEndpointInstanceType

    string

    Yes

    Lokasi database. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini. Nilai yang valid:

    • RDS

    • ECS

    • Express: Database yang terhubung melalui leased line, VPN Gateway, atau Smart Gateway.

    • Agent: Database yang terhubung melalui backup gateway.

    • DDS: Cloud MongoDB.

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

    RDS
    SourceEndpointRegion

    string

    No

    Wilayah database. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

    Catatan

    Parameter ini wajib diisi ketika SourceEndpointInstanceType bernilai RDS, ECS, DDS, Express, atau Agent.

    cn-hangzhou
    SourceEndpointInstanceID

    string

    No

    ID instans database. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

    Catatan

    Parameter ini wajib diisi ketika SourceEndpoint.InstanceType bernilai RDS, ECS, DDS, atau Express.

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

    string

    No

    Titik akhir database. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

    Catatan

    Parameter ini wajib diisi ketika SourceEndpointInstanceType bernilai express, agent, atau other.

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

    integer

    No

    Port database. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

    Catatan

    Parameter ini wajib diisi ketika SourceEndpoint.InstanceType bernilai express, agent, other, atau ECS.

    3306
    SourceEndpointDatabaseName

    string

    No

    Nama database. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

    Catatan

    Parameter ini wajib diisi 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 wajib diisi dalam skenario lainnya.

    testRDS
    SourceEndpointPassword

    string

    No

    Password.

    Catatan

    Parameter ini opsional ketika tipe database adalah Redis, atau ketika lokasi database adalah agent dan tipe database adalah SQL Server. Parameter ini wajib diisi dalam skenario lainnya.

    testPassword
    BackupGatewayId

    integer

    No

    ID backup gateway. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

    Catatan

    Parameter ini wajib diisi ketika SourceEndpointInstanceType bernilai agent.

    23313123312
    OSSBucketName

    string

    No

    Nama Bucket OSS.

    Catatan

    Sistem secara otomatis menghasilkan nama baru secara default.

    TestOssBucket
    BackupObjects

    string

    No

    Objek backup. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

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

    string

    No

    Periode cadangan penuh. Nilai yang valid:

    • Monday: Senin

    • Tuesday: Selasa

    • Wednesday: Rabu

    • Thursday: Kamis

    • Friday: Jumat

    • Saturday: Sabtu

    • Sunday: Minggu

    Monday
    BackupStartTime

    string

    No

    Waktu mulai cadangan penuh dalam format HH:mmZ (UTC). Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

    14:22
    EnableBackupLog

    boolean

    No

    Aktifkan cadangan log inkremental. Nilai yang valid:

    • true: Aktifkan

    • false: Nonaktifkan

    true
    BackupLogIntervalSeconds

    integer

    No

    Interval inkremental dalam detik (s).

    Catatan

    Hanya backup fisik yang didukung.

    1000
    BackupRetentionPeriod

    integer

    No

    Periode retensi data backup. Nilai yang valid: 0 hingga 1825. Nilai default: 730 hari.

    730
    DuplicationInfrequentAccessPeriod

    integer

    No

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

    180
    DuplicationArchivePeriod

    integer

    No

    Periode setelah data dikonversi ke cold storage arsip. Nilai default: 365 hari.

    365
    BackupPlanName

    string

    Yes

    Nama kustom backup plan. Panggil API DescribeBackupPlanList untuk mendapatkan nilai parameter ini.

    dbstooi0*******
    SourceEndpointOracleSID

    string

    No

    Nama SID Oracle.

    Catatan

    Parameter ini wajib diisi ketika tipe database adalah Oracle.

    test
    BackupStorageType

    string

    No

    Tipe penyimpanan bawaan:

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

    • system: Data backup disimpan di OSS bawaan DBS.

    无
    BackupSpeedLimit

    integer

    No

    Batas I/O disk dalam KB/s.

    Catatan

    Parameter ini hanya berlaku untuk backup fisik MySQL.

    262144
    BackupRateLimit

    integer

    No

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

    Catatan

    Parameter ini hanya berlaku untuk backup fisik MySQL.

    262144
    BackupStrategyType

    string

    No

    Strategi cadangan penuh. Nilai yang valid:

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

    • manual: Backup manual.

    Catatan

    Nilai default: simple.

    simple
    CrossAliyunId

    string

    No

    UID untuk backup lintas akun Alibaba Cloud. Panggil API DescribeRestoreTaskList untuk mendapatkan nilai parameter ini.

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    No

    Nama role RAM untuk backup lintas akun Alibaba Cloud. Panggil API DescribeRestoreTaskList untuk mendapatkan nilai parameter ini.

    test123
    AutoStartBackup

    boolean

    No

    Aktifkan backup otomatis. Nilai yang valid:

    • true: Aktifkan

    • false: Nonaktifkan

    false
    ClientToken

    string

    No

    Memastikan idempotensi permintaan untuk mencegah pengiriman ganda. Klien menghasilkan nilai parameter ini. Pastikan nilainya unik di berbagai permintaan. Panjang maksimum adalah 64 karakter ASCII, dan nilainya tidak boleh mengandung karakter non-ASCII.

    ETnLKlblzczshOTUbOCzxxxxxxx
    ResourceGroupId

    string

    No

    ID kelompok sumber daya.

    rg-aekzecovzti****

    Elemen respons

    Element

    Type

    Description

    Example

    object

    Detailnya sebagai berikut.

    HttpStatusCode

    integer

    Kode status HTTP.

    200
    RequestId

    string

    ID permintaan.

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

    string

    Kode kesalahan.

    Param.NotFound
    Success

    boolean

    Menunjukkan apakah permintaan berhasil. Nilai yang valid:

    • true: Permintaan berhasil.

    • false: Permintaan gagal.

    true
    ErrMessage

    string

    Pesan kesalahan.

    The specified parameter %s value is not valid.

    BackupPlanId

    string

    ID backup plan.

    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.