调用CreateAutoSnapshotPolicy创建一条自动快照策略。

接口说明

创建的自动快照策略可以应用到任一云盘(ApplyAutoSnapshotPolicy),成功创建的自动快照策略可以后续修改策略内容(ModifyAutoSnapshotPolicyEx)。

调用该接口时,您需要注意:

  • 一个阿里云账户在一个地域最多能创建100条自动快照策略。
  • 如果云盘数据较多,单次创建自动快照的时长超过两个时间点间隔,则自动跳过下一时间点。示例:您设置了09:00、10:00、11:00和12:00为自动快照时间点。由于云盘数据较多,09:00开始创建快照,10:20完成创建快照,实际耗时80分钟。系统会跳过时间点10:00,等到11:00继续为您创建自动快照。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateAutoSnapshotPolicy

系统规定参数。取值:CreateAutoSnapshotPolicy

regionId String cn-hangzhou

自动快照策略所属的地域。您可以调用DescribeRegions查看最新的阿里云地域列表。

repeatWeekdays String ["1","2"]

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

当一星期内需要创建多次自动快照时,可以传入多个时间点:

  • 最多传入7个时间点。
  • 多个时间点用一个格式类似["1","2"..."7"]的JSON数组表示,时间点之间用半角逗号(,)隔开。
retentionDays Integer 30

自动快照的保留时间,单位为天。取值范围:

  • -1:永久保存。
  • 1~65535:指定保存天数。

默认值:-1。

timePoints String ["0", "1", … "23"]

自动快照的创建时间点,单位为小时。取值范围:0~23,代表00:00至23:00共24个时间点,如1表示01:00。

当一天内需要创建多次自动快照时,可以传入多个时间点,最多传入24个时间点。

autoSnapshotPolicyName String FinanceJoshua

自动快照策略的名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头,不能以http://和https://开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。

默认值:空。

返回数据

名称 类型 示例值 描述
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

AutoSnapshotPolicyId String sp-233e6yl**

自动快照策略ID。

示例

请求示例

https://ecs.aliyuncs.com/?Action=CreateAutoSnapshotPolicy
&regionId=cn-hangzhou
&repeatWeekdays=["1"]
&retentionDays=30
&timePoints=["0", "19"]
&autoSnapshotPolicyName=FinanceJoshua
&<公共请求参数>

正常返回示例

XML 格式

<CreateAutoSnapshotPolicyResponse>
      <RequestId>F3CD6886-D8D0-4FEE-B93E-1B73239673DE</RequestId>
      <AutoSnapshotPolicyId>sp-233e6yl**</AutoSnapshotPolicyId>
</CreateAutoSnapshotPolicyResponse>

JSON 格式

{
    "RequestId": "F3CD6886-D8D0-4FEE-B93E-1B73239673DE",
    "AutoSnapshotPolicyId": "sp-233e6yl**"
}

错误码

HttpCode 错误码 错误信息 描述
403 ParameterInvalid The specified RegionId parameter is invalid. 指定的地域 ID 无效,请您检查该地域是否正确。
403 ParameterInvalid The specified RepeatWeekDays parameter is invalid. 指定的日期无效,请您检查该日期是否正确。
403 ParameterInvalid The specified TimePoints parameter is invalid. 指定的时间点不合法,请您查看该时间点是否填写正确。
403 ParameterInvalid The specified RetentionDays parameter is invalid. 指定的保持天数不合法。
403 AutoSnapshotPolicy.QuotaExceed The maximum number of automatic snapshot policy has been reached. 自动快照策略数超出最大值。
400 DiskCategory.OperationNotSupported The type of the specified disk does not support creating a snapshot. 当前磁盘类型不支持此操作
403 InvalidAccountStatus.NotEnoughBalance Your account does not have enough balance. 账号余额不足,请您先充值再进行该操作。
403 InvalidAccountStatus.SnapshotServiceUnavailable Snapshot service has not been opened yet. 快照服务未开通,操作无法执行。

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