ModifyBackupSetDownloadRules_数据灾备_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

使用本接口前请先确认备份数据是否存储在 DBS 的内置 OSS 上,您可通过调用 DescribeBackupPlanList 接口查看 BackupStorageType 取值情况。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
dbs:ModifyBackupSetDownloadRules
Update
全部资源
*

请求参数

字段名称字段详情
BackupPlanIdstring

备份计划 ID,可通过调用 DescribeBackupPlanList 接口查看。

示例值:dbstooi01xxxx参考取值来源:
    StopBackupPlan
    UpgradeBackupPlan
    RenewBackupPlan
    StartBackupPlan
    CreateBackupPlan
    ReleaseBackupPlan
    ModifyBackupPlanName
    EnableBackupLog
    ConfigureBackupPlan
    DescribeBackupPlanList
    DisableBackupLog
OpenAutoDownloadboolean

是否开启自动下载,默认 false。

示例值:false
BackupGatewayIdinteger<int64>

备份集下载备份网关 ID。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:23312323参考取值来源:
    DescribeBackupGatewayList
FullDataFormatstring

备份集下载全量数据格式:展开详情

示例值:CSV
IncrementDataFormatstring

备份集下载增量数据格式:展开详情

示例值:Native
BackupSetDownloadDirstring

备份集下载服务器目录。

示例值:test参考取值来源:
    DescribeBackupSetDownloadTaskList
BackupSetDownloadTargetTypestring

备份集下载目标类型 。展开详情

示例值:agent参考取值来源:
    DescribeBackupSetDownloadTaskList
BackupSetDownloadTargetTypeLocationstring

备份集下载目标目录类型,如果是开启自动下载,则必填,取值:展开详情

示例值:local
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。

示例值:ETnLKlblzczshOTUbOCzxxxxxxx

返回参数

字段名称字段详情
HttpStatusCodeinteger<int32>

HTTP 状态码。

示例值:200
RequestIdstring

请求 ID。

示例值:D6E068C3-25BC-455A-85FE-45F0B22ECB1F
ErrCodestring

错误码。

示例值:Param.NotFound
Successboolean

是否成功。

示例值:true
ErrMessagestring

错误信息。

示例值:The specified parameter %s value is not valid.
BackupPlanIdstring

备份计划 ID。

示例值:dbstooi01exxxx

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
403
Request.Forbidden
Have no Permissions诊断

变更历史

暂无变更历史

相关示例

ModifyBackupSetDownloadRules
2022-09-01