CreateAutoSnapshotPolicy - 创建自动快照策略

更新时间:
复制 MD 格式

在指定地域下创建一条自动快照策略。自动快照策略可以周期性地为数据库文件系统创建快照备份数据。

接口说明

数据库文件系统快照基于云盘快照,由云盘进行快照扣费。请确保在使用该接口前,已充分了解云盘快照的收费方式和价格。

调试

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

调试

授权信息

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

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

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dbfs:CreateAutoSnapshotPolicy

create

*AutoSnapShotPolicy

acs:dbfs:{#regionId}:{#accountId}:autosnapshotpolicy/*

无 无

请求参数

名称

类型

必填

描述

示例值

PolicyName

string

是

策略名称。

policyTest

RetentionDays

integer

是

保留天数。

30

RepeatWeekdays

array

是

自动快照的重复日期列表,单位为天,周期为星期。取值范围:1~7,例如 1 表示周一。格式说明:

  • 传入的参数需要保持 JSON 数组格式。例如,["1"]表示每周一重复创建自动快照。

  • 当一星期内需要创建多次自动快照时,可以传入多个时间点,时间点之间用半角逗号(,)隔开,最多传入 7 个时间点。例如,["1","3","5"]表示每周一、周三、周五重复创建自动快照。

string

是

自动快照的重复日期,周期为星期。

"1"

TimePoints

array

是

自动快照的创建时间点列表。使用 UTC +8 时间,单位为小时。取值范围:0~23,代表 00:00 至 23:00 共 24 个时间点,例如 01 表示 01:00。格式说明:

  • 传入的参数需要保持 JSON 数组格式。例如,["1"]表示 01:00 创建自动快照。

  • 当一天内需要创建多次自动快照时,可以传入多个时间点,时间点之间用半角逗号(,)隔开,最多传入 24 个时间点。例如,["01","03","15"]表示 01:00、03:00、15:00 时创建自动快照。

string

是

自动快照的创建时间点。

"01"

RegionId

string

是

所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

PolicyId

string

自动快照策略 ID

sp-z5siir3iq3m**********

AccessDeniedDetail

object

PolicyType

string

PolicyType

AuthPrincipalOwnerId

string

AuthPrincipalOwnerId

EncodedDiagnosticMessage

string

EncodedDiagnosticMessage

AuthPrincipalType

string

AuthPrincipalType

AuthPrincipalDisplayName

string

AuthPrincipalDisplayName

NoPermissionType

string

NoPermissionType

AuthAction

string

AuthAction

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PolicyId": "sp-z5siir3iq3m**********",
  "AccessDeniedDetail": {
    "PolicyType": "",
    "AuthPrincipalOwnerId": "",
    "EncodedDiagnosticMessage": "",
    "AuthPrincipalType": "",
    "AuthPrincipalDisplayName": "",
    "NoPermissionType": "",
    "AuthAction": ""
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 ParameterInvalid.RetentionDays The RetentionDays parameter is invalid. 保留时间参数无效。
400 ParameterInvalid.RepeatWeekDays The RepeatWeekdays parameter is invalid. 重复日期无效。
400 ParameterInvalid.TimePoints The TimePoints parameter is invalid. 重复时间无效。
400 InvalidRegion.DBFS The region is not supported. 不支持的区域。
400 ParameterInvalid.PolicyName The PolicyName parameter is invalid. 自动快照策略名称无效。

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

变更历史

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