全部产品
Search

搜索本产品

    数据管理 DMS：ConfigureBackupPlan - 配置备份计划

    文档中心

    数据管理 DMS：ConfigureBackupPlan - 配置备份计划

    更新时间：Mar 19, 2026

    该接口用于配置一个DBS备份计划。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    dbs:ConfigureBackupPlan

    update

    *BackupPlan

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

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    BackupPlanId

    string

    是

    备份计划 ID，可通过调用 DescribeBackupPlanList 接口获取该参数的值。

    dbstooi0*******
    SourceEndpointInstanceType

    string

    是

    数据库所在位置，可通过调用 DescribeBackupPlanList 接口获取该参数的值。取值如下：

    • RDS

    • ECS

    • Express：通过专线/VPN 网关/智能网关接入的数据库

    • Agent：通过备份网关接入的数据库

    • DDS：云 MongoDB

    • Other：通过 IP:Port 直连的数据库

    RDS
    SourceEndpointRegion

    string

    否

    数据库地域，可通过调用 DescribeBackupPlanList 接口获取该参数的值。

    说明

    SourceEndpointInstanceType 为 RDS、ECS、DDS、Express、Agent 时，该参数必传。

    cn-hangzhou
    SourceEndpointInstanceID

    string

    否

    数据库实例 ID，可通过调用 DescribeBackupPlanList 接口获取该参数的值。

    说明

    SourceEndpoint.InstanceType 为 RDS、ECS、DDS、Express 时，该参数必传。

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

    string

    否

    数据库连接地址，可通过调用 DescribeBackupPlanList 接口获取该参数的值。

    说明

    SourceEndpointInstanceType 为 express、agent、other 时，该参数必传。

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

    integer

    否

    数据库端口，可通过调用 DescribeBackupPlanList 接口获取该参数的值。

    说明

    SourceEndpoint.InstanceType 为 express、agent、other、ECS 时，该参数必传。

    3306
    SourceEndpointDatabaseName

    string

    否

    数据库名称，可通过调用 DescribeBackupPlanList 接口获取该参数的值。

    说明

    数据库类型为 PostgreSQL、MongoDB 时，该参数必传。

    testRDS
    SourceEndpointUserName

    string

    否

    数据库账号。

    说明

    数据库类型为 Redis，或者数据库所在位置为 agent 且数据库类型为SQL Server时该参数非必须，其他场景均必传。

    testRDS
    SourceEndpointPassword

    string

    否

    密码。

    说明

    数据库类型为 Redis，或者数据库所在位置为 agent 且数据库类型为SQL Server时该参数非必须，其他场景均必传。

    testPassword
    BackupGatewayId

    integer

    否

    备份网关 ID，可通过调用 DescribeBackupPlanList 接口获取该参数的值。

    说明

    SourceEndpointInstanceType 为 agent 时，该参数必传。

    23313123312
    OSSBucketName

    string

    否

    OSS Bucket 名称。

    说明

    系统默认自动生成新的名称。

    TestOssBucket
    BackupObjects

    string

    否

    备份对象，可通过调用 DescribeBackupPlanList 接口获取该参数的值。

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

    string

    否

    全量备份周期，取值：

    • Monday：周一

    • Tuesday：周二

    • Wednesday：周三

    • Thursday：周四

    • Friday：周五

    • Saturday：周六

    • Sunday：周日

    Monday
    BackupStartTime

    string

    否

    全量备份开始时间，格式为HH:mmZ（UTC 时间）。可通过调用 DescribeBackupPlanList 接口获取该参数的值。

    14:22
    EnableBackupLog

    boolean

    否

    是否开启增量日志备份，取值：

    • true：开启

    • false：关闭

    true
    BackupLogIntervalSeconds

    integer

    否

    增量时间间隔，以秒（s）为单位。

    说明

    仅支持物理备份。

    1000
    BackupRetentionPeriod

    integer

    否

    备份数据保留时间，取值：0 ~ 1825，默认为 730 天。

    730
    DuplicationInfrequentAccessPeriod

    integer

    否

    转为低频访问存储时间，默认为 180 天。

    180
    DuplicationArchivePeriod

    integer

    否

    转为归档冷备存储时间，默认为 365 天。

    365
    BackupPlanName

    string

    是

    自定义备份计划名称，可通过调用 DescribeBackupPlanList 接口获取该参数的值。

    dbstooi0*******
    SourceEndpointOracleSID

    string

    否

    Oracle SID 名称。

    说明

    数据库类型为 Oracle 时，该参数必传。

    test
    BackupStorageType

    string

    否

    内置存储类型：

    • 空（默认）：备份数据存储在用户 OSS 上。

    • system ：备份数据存储在 DBS 的内置 OSS 上。

    无
    BackupSpeedLimit

    integer

    否

    磁盘 IO 限制 ， 单位为 KB/s。

    说明

    仅对 MySQL 物理备份生效。

    262144
    BackupRateLimit

    integer

    否

    网络带宽限制， 单位为 KB/s ，最大允许 10GB。

    说明

    仅对 MySQL 物理备份生效。

    262144
    BackupStrategyType

    string

    否

    全量备份周期，取值：

    • simple：周期备份，和 BackupPeriod、BackupStartTime 配合使用。

    • manual：手动备份。

    说明

    默认为 simple。

    simple
    CrossAliyunId

    string

    否

    跨阿里云账号备份的 UID，可通过调用 DescribeRestoreTaskList 接口获取该参数的值。

    2xxx7778xxxxxxxxxx
    CrossRoleName

    string

    否

    跨阿里云账号备份的 RAM 角色名称，可通过调用 DescribeRestoreTaskList 接口获取该参数的值。

    test123
    AutoStartBackup

    boolean

    否

    是否开启自动备份。

    • true：开启

    • false：不开启

    false
    ClientToken

    string

    否

    用于保证请求的幂等性，防止重复提交请求。由客户端生成该参数值，要保证在不同请求间唯一，最大值不超过 64 个 ASCII 字符，且该参数值中不能包含非 ASCII 字符。

    ETnLKlblzczshOTUbOCzxxxxxxx
    ResourceGroupId

    string

    否

    资源组 ID。

    rg-aekzecovzti****
    EnableSourceEndpointSsl

    string

    否

    true
    BackupStorageEncryptMethod

    string

    否

    encrypted
    SslCaPem

    string

    否

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

    string

    否

    /home/test
    EnableMysqlPhysicalBackupBinlog

    string

    否

    true

    返回参数

    名称

    类型

    描述

    示例值

    object

    详情信息如下。

    HttpStatusCode

    integer

    HTTP 状态码。

    200
    RequestId

    string

    请求 ID。

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

    string

    错误码。

    Param.NotFound
    Success

    boolean

    请求是否成功，返回值如下：

    • true：请求成功

    • false：请求失败

    true
    ErrMessage

    string

    错误信息。

    The specified parameter %s value is not valid.

    BackupPlanId

    string

    备份计划 ID。

    dbstooi01ex****

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    403 Request.Forbidden Have no Permissions 当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。