文档首页/ 云数据库 RDS/ API参考/ API v3(推荐)/ 备份与恢复/ 查询自动转储策略(MySQL) - ShowTransferPolicy
更新时间:2025-12-02 GMT+08:00
分享

查询自动转储策略(MySQL) - ShowTransferPolicy

功能介绍

查询自动转储策略。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:getBackupPolicy

read

-

-

rds:instance:list

-

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/transfer/policy

  • 参数说明
    表1 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    参数解释

    租户在某一Region下的项目ID。

    获取方法请参见获取项目ID

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

    instance_id

    String

    参数解释

    实例ID。

    约束限制

    不涉及。

    取值范围

    不涉及。

    默认取值

    不涉及。

请求消息

无。

请求示例

查询自动转储策略。

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/e38d120bb5a640519fb2a1613140afd9in01/transfer/policy

响应消息

  • 正常响应要素说明
    表2 要素说明

    参数

    参数类型

    描述

    policies

    Array of objects

    参数解释

    转储策略列表。详情请参见表3

    表3 policies字段说明

    名称

    参数类型

    说明

    setting_id

    String

    参数解释

    策略ID。

    取值范围

    不涉及。

    instance_id

    String

    参数解释

    实例ID。

    取值范围

    不涉及。

    period

    String

    参数解释

    转储策略周期。

    取值范围

    格式为逗号隔开的数字,数字代表星期。

    例如:1,2,3,4则表示转储周期配置为星期一、星期二、星期三和星期四。选择周一,那么周一生成的备份文件将在周二自动转储到OBS目标存储桶。

    backup_type

    String

    参数解释

    转储备份类型。

    取值范围

    • Db:自动备份。
    • Log:增量备份。
    • Snapshot:手动备份。

    destination

    String

    参数解释

    目标存储。

    取值范围

    0~128个字符。

    prefix

    String

    参数解释

    转储目标前缀。

    取值范围

    0~128个字符,以分隔符“/”结尾。

  • 正常响应样例
    { 
        "policies":[ 
            { 
             "setting_id":"7c781e6a-d215-4482-bf15-cfe04cc7eb96", 
             "instance_id":"e4e2ee2f2c7943f1a9f9c817b993dc0ein01", 
             "period":"* * 1,2,3,4,5,6,7", 
             "backup_type":"Db", 
             "destination":"xxxbucket", 
             "prefix":"aaa/auto/" 
            } 
        ] 
    }
  • 异常响应

    请参见异常请求结果

状态码

错误码

请参见错误码

相关文档