文档

DescribeBackupPolicy - 查询自动备份策略

更新时间:

查询Redis实例的备份策略,包括备份周期、备份时间等。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeBackupPolicyRead
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

r-bp1zxszhcgatnx****

返回参数

名称类型描述示例值
object
BackupRetentionPeriodstring

备份保留天数。

7
RequestIdstring

请求 ID。

90B82DB7-FB28-4CC2-ADBF-1F8659F3****
PreferredBackupPeriodstring

备份周期,返回值:

  • Monday:周一。
  • Tuesday:周二。
  • Wednesday:周三。
  • Thursday:周四。
  • Friday:周五。
  • Saturday:周六。
  • Sunday:周日。
Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
PreferredNextBackupTimestring

下次备份时间,格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

2019-03-14T05:28Z
PreferredBackupTimestring

备份时间,格式为HH:mmZ-HH:mmZ(UTC 时间)。

05:00Z-06:00Z
EnableBackupLoginteger

是否开启了增量备份,返回值:

  • 1:已开启。
  • 0:未开启。
1
AccessDeniedDetailobject

本组参数已弃用,请忽略。

AuthActionstring

说明如上。

_
AuthPrincipalDisplayNamestring

说明如上。

_
AuthPrincipalOwnerIdstring

说明如上。

_
AuthPrincipalTypestring

说明如上。

_
EncodedDiagnosticMessagestring

说明如上。

_
NoPermissionTypestring

说明如上。

_
PolicyTypestring

说明如上。

_
DbsInstancestring

实例是否启用备份服务化,取值:

  • 1:开启
  • 0:未开启
0

示例

正常返回示例

JSON格式

{
  "BackupRetentionPeriod": "7",
  "RequestId": "90B82DB7-FB28-4CC2-ADBF-1F8659F3****",
  "PreferredBackupPeriod": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday",
  "PreferredNextBackupTime": "2019-03-14T05:28Z",
  "PreferredBackupTime": "05:00Z-06:00Z",
  "EnableBackupLog": 1,
  "AccessDeniedDetail": {
    "AuthAction": "_",
    "AuthPrincipalDisplayName": "_",
    "AuthPrincipalOwnerId": "_",
    "AuthPrincipalType": "_",
    "EncodedDiagnosticMessage": "_",
    "NoPermissionType": "_",
    "PolicyType": "_"
  },
  "DbsInstance": "0"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-13OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-11-06OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-31OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-07-25OpenAPI 描述信息更新、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
出参OpenAPI 返回结构发生变更