You need to enable JavaScript to run this app.
文档中心
云服务器

云服务器

复制全文
下载 pdf
自动快照策略
CreateAutoSnapshotPolicy - 创建自动快照策略
复制全文
下载 pdf
CreateAutoSnapshotPolicy - 创建自动快照策略
调用CreateAutoSnapshotPolicy接口创建自动快照策略。​
注意事项​
  • 每个云盘最多可以创建1024个自动快照;当自动快照数量达到上限后,系统会自动删除创建时间最早的自动快照。​
  • 单个账户下,每一个地域最多支持创建32个自动快照策略。​
  • 您设置的自动快照策略时间和实际创建快照时间可能存在一定差异,请以实际创建的时间为准。​
  • 如果某次创建快照的时长超过两个自动快照执行的时间间隔,系统会自动跳过第二个时间点,不创建快照。例如:您设置了1:00、2:00、3:00为自动快照时间点,而1:00创建的快照时间较长,持续到2:30才完成,那么2:00这个时间点将不创建快照,下个创建快照的时间点为3:00。​
  • 云盘不能同时创建自动快照和手动快照。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:CreateAutoSnapshotPolicy​
要执行的操作,取值:CreateAutoSnapshotPolicy。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
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参数。​
​
RetentionDays integer 必选 示例值:30​
自动快照的保留时间,单位为天,取值说明如下:​
  • -1:永久保存。​
  • 1~65536:指定保存天数。​
​
RepeatDays integer 可选 示例值:10​
按天重复创建快照,即间隔一定天数创建快照,取值范围为[1, 30] 。​
说明​
  • 按天为周期重复创建快照时,创建自动快照策略的当天视为第一天,并且已过去的时间点不会创建快照,若当天的所有快照创建时间点都已过,当天仍然算第一天。​
  • 创建自动快照策略时,必须设置RepeatWeekdays.N和RepeatDays参数中的一个,不支持同时设置RepeatWeekdays.N和RepeatDays参数。​
​
Tags.N.Key string[] 可选 示例值:Tags.1.Key=tag​
标签的标签键。​
  • Tags.N.Key:N表示标签键的序号。取值范围:1~20。​
  • 多个标签键之间用&分隔。​
​
Tags.N.Value string[] 可选 示例值:Tags.1.Value=test​
标签的标签值。​
  • Tags.N.Value:N表示标签值的序号。取值范围:1~20。​
  • 多个标签值之间用&分隔。​
​
ProjectName string 可选 示例值:default​
自动快照策略所属项目。​
注意​
  • 自动快照策略不会继承云盘的项目,即自动快照策略与云盘或快照均可以所属不同的项目。​
  • 如果您在创建自动快照策略时未设置ProjectName,则自动快照策略默认会加入default项目。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
AutoSnapshotPolicyId string 示例值:asp-anj249wubz9kakc8****​
自动快照策略ID。​
​
​
​
请求示例​
​
POST /?Action=CreateAutoSnapshotPolicy&Version=2020-04-01&TimePoints.1=TimePoints.1%3D0%26TimePoints.2%3D1 HTTP/1.1​
Host: open.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20251124T082339Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251124/cn-beijing/storage_ebs/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
"AutoSnapshotPolicyName": "testName",​
"RetentionDays": 30​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202511241623421421290842099C****",​
"Action": "CreateAutoSnapshotPolicy",​
"Version": "2020-04-01",​
"Service": "storage_ebs",​
"Region": "cn-beijing"​
},​
"Result": {​
"AutoSnapshotPolicyId": "asp-anj249wubz9kakc8****"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidRequest​
The operation is not permitted due to the request is invalid.​
无效的请求。​
400​
InvalidParameters​
The request has invalid parameters.​
请求存在无效参数。​
400​
InvalidSnapshotPolicyNameLen​
The length of the automatic snapshot policy name is invalid.​
自动快照策略名称长度不合法。​
400​
InvalidSnapshotPolicyNameFormat​
The format of the automatic snapshot policy name is invalid.​
自动快照策略名称格式不合法。​
400​
ErrInvalidTimePoints​
The specified time point is invalid.​
指定的时间点不合法。​
400​
InvalidRepeatDays​
The specified period days is invalid.​
指定的重复周期不合法。​
400​
ErrInvalidRepeatWeekDays​
The specified repeat weekdays is invalid.​
指定的重复周期不合法。​
400​
ErrorAccountIsOverdue​
Account is in arrears, and some snapshot features are unavailable.​
账号已欠费,快照部分功能不可用。​
403​
AutoSnapshotPolicyQuotaExceed​
The number of automatic snapshot policies exceeds quota, please submit ticket to request an increase in quota.​
自动快照策略数量超过配额限制,请申请提高配额。​
500​
InternalError​
An internal error has occurred.​
内部错误,请重试。如果多次尝试失败,请提交工单。​
​
​
最近更新时间:2026.01.08 11:19:58
这个页面对您有帮助吗?
有用
有用
无用
无用