You need to enable JavaScript to run this app.
导航
云服务器
  • 文档首页
    • /
  • 云服务器

CreateAutoSnapshotPolicy

最近更新时间：2024.04.25 17:11:26

首次发布时间：2022.06.02 15:47:48

我的收藏

调用CreateAutoSnapshotPolicy接口创建自动快照策略。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

注意事项

  • 目前快照功能处于免费阶段，每个云盘最多可以创建64个自动快照；当自动快照数量达到上限后，系统会自动删除创建时间最早的自动快照。
  • 单个账户下，每一个地域最多支持创建32个自动快照策略。
  • 您设置的自动快照策略时间和实际创建快照时间可能存在一定差异，请以实际创建的时间为准。
  • 如果某次创建快照的时长超过两个自动快照执行的时间间隔，系统会自动跳过第二个时间点，不创建快照。例如：您设置了1:00、2:00、3:00为自动快照时间点，而1:00创建的快照时间较长，持续到2:30才完成，那么2:00这个时间点将不创建快照，下个创建快照的时间点为3:00。
  • 云盘不能同时创建自动快照和手动快照。

请求参数

名称类型是否必选示例值描述
ActionString是CreateAutoSnapshotPolicy要执行的操作，取值：CreateAutoSnapshotPolicy。

AutoSnapshotPolicyName

String

是

testName

自动快照策略名称，命名规范如下：

  • 首字符仅支持中文、字母或下划线（_）。
  • 可包含中文、字母、数字、下划线（_）、中划线（-）或英文句号（.）。
  • 长度限制在1~128个字符。

TimePoints.N

String

是

TimePoints.1=0&TimePoints.2=1

自动快照的创建时间点，取值说明如下：

  • 使用UTC +8时间，单位为小时。
  • 取值范围：0~23，代表00:00至23:00共24个时间点，例如1表示01:00。
  • 当一天内需要创建多次自动快照时，可以传入多个时间点，最多传入24个时间点。

RepeatWeekdays.N

String

否

RepeatWeekdays.1=1&RepeatWeekdays.2=7

按周重复创建快照，即在周一至周日之间选择一个或多个日期创建快照。说明如下：

  • 取值范围为1~7，例如1表示周一。
  • 当一星期内需要创建多次自动快照时，可以传入多个时间点，最多传入7个时间点。

说明

创建自动快照策略时，必须设置RepeatWeekdays.N和RepeatDays参数中的一个，不支持同时设置RepeatWeekdays.N和RepeatDays参数。

RepeatDays

Integer

否

2

按天重复创建快照，即间隔一定天数创建快照，取值范围为[1, 30] 。

说明

  • 按天为周期重复创建快照时，创建自动快照策略的当天视为第一天，并且已过去的时间点不会创建快照，若当天的所有快照创建时间点都已过，当天仍然算第一天。
  • 创建自动快照策略时，必须设置RepeatWeekdays.N和RepeatDays参数中的一个，不支持同时设置RepeatWeekdays.N和RepeatDays参数。

RetentionDays

Integer

是

30

自动快照的保留时间，单位为天，取值说明如下：

  • -1：永久保存。
  • 1~65536：指定保存天数。

ProjectName

String

否

default

自动快照策略所要加入的Project（项目）名称。

注意

  • 自动快照策略不会继承云盘的项目，即自动快照策略与云盘或快照均可以所属不同的项目。
  • 如果您在创建自动快照策略时未设置ProjectName，则自动快照策略默认会加入default项目。

Tags.N.Key

String

否

Tags.1.Key=tag

需要创建的标签键。

  • Tags.N.Key：N表示标签键的序号。取值范围：1～20。

  • 多个标签键之间用&分隔。

命名规则如下：

  • 不能以任何大小写形式的volc:或sys:开头，volc:或sys:开头为系统预留标签键，禁止创建。

  • 只能包含语言字符、数字、空格和特殊符号_.:/=+-@。

  • 长度限制在1～128个字符之间。

Tags.N.Value

String

否

Tags.1.Value=test

标签的标签值。

  • Tags.N.Value：N表示标签值的序号。取值范围：1～20。

  • 多个标签值之间用&分隔。

命名规则如下：

  • 只能包含语言字符、数字、空格和特殊符号_.:/=+-@。

  • 允许为空，长度限制在0～256个字符之间。

返回数据

名称类型示例值描述
AutoSnapshotPolicyIdStringasp-anj249wubz9kakc8****创建的自动快照策略ID。

请求示例

GET /?Action=CreateAutoSnapshotPolicy&AutoSnapshotPolicyName=testName&Version=2020-04-01&TimePoints.1=0&TimePoints.2=1&RepeatWeekdays.1=1&RepeatWeekdays.2=7&RetentionDays=30 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: storage_ebs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022050518195101021004303704C2****",
        "Action": "CreateAutoSnapshotPolicy",
        "Version": "2020-04-01",
        "Service": "storage_ebs",
        "Region": "cn-beijing"
    },
    "Result": {
        "AutoSnapshotPolicyId": "asp-anj249wubz9kakc8****"
    }
}

错误码

HttpCode错误码错误信息
500InternalError内部错误，请提工单解决
400InvalidSnapshotPolicyNameFormat自动快照策略名称格式不合法
400InvalidProjectName指定的项目名不合法。