全部产品
Search

搜索本产品

    数据库备份 DBS：ModifyBackupSetDownloadRules - 设置备份集下载规则

    文档中心

    数据库备份 DBS：ModifyBackupSetDownloadRules - 设置备份集下载规则

    更新时间：Nov 14, 2024

    该接口用于开启、修改、关闭自动下载功能。

    接口说明

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

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    dbs:ModifyBackupSetDownloadRulesupdate
    • 全部资源
      *
      无
    		无

    请求参数

    名称类型必填描述示例值
    BackupPlanIdstring是

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

    		dbstooi01xxxx
    OpenAutoDownloadboolean否

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

    		false
    BackupGatewayIdlong否

    备份集下载备份网关 ID。

    		23312323
    FullDataFormatstring否

    备份集下载全量数据格式：

    • Native
    • SQL
    • CSV
    • JSON
    说明 默认 CSV。
    		CSV
    IncrementDataFormatstring否

    备份集下载增量数据格式：

    • Native
    • SQL
    • CSV
    • JSON
    说明 默认 Native。
    		Native
    BackupSetDownloadDirstring否

    备份集下载服务器目录。

    		test
    BackupSetDownloadTargetTypestring否

    备份集下载目标类型 。

    说明 默认 agent：已安装备份网关，目前仅此项。
    		agent
    BackupSetDownloadTargetTypeLocationstring否

    备份集下载目标目录类型，如果是开启自动下载，则必填，取值：

    • local
    • nas
    • ftp
    • minio
    说明 默认为 local。
    		local
    ClientTokenstring否

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

    		ETnLKlblzczshOTUbOCzxxxxxxx

    返回参数

    名称类型描述示例值
    object
    HttpStatusCodeinteger

    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

    示例

    正常返回示例

    JSON格式

    {
  "HttpStatusCode": 200,
  "RequestId": "D6E068C3-25BC-455A-85FE-45F0B22ECB1F",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid.  ",
  "BackupPlanId": "dbstooi01exxxx"
}

    错误码

    HTTP status code错误码错误信息描述
    403Request.ForbiddenHave no Permissions当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史