文档

CreateAutoSnapshotPolicy - 创建一条自动快照策略

更新时间:

调用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代码示例。

授权信息

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

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

请求参数

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

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

cn-hangzhou
autoSnapshotPolicyNamestring

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

默认值:空

TestName
timePointsstring

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

  • 传入的参数需要保持 JSON 数组格式。例如,["1"]表示 01:00 创建自动快照。
  • 当一天内需要创建多次自动快照时,可以传入多个时间点,时间点之间用半角逗号(,)隔开,最多传入 24 个时间点。例如,["1","3","5"]表示 01:00、03:00、05:00 时创建自动快照。
["0", "1", … "23"]
repeatWeekdaysstring

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

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

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

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

默认值:-1。

30
EnableCrossRegionCopyboolean

是否允许自动跨地域复制。

  • true:允许。
  • false:不允许。
false
TargetCopyRegionsstring

跨地域复制快照的目标地域。目前支持设置一个目标地域。

["cn-hangzhou"]
StorageLocationArnstring
说明 该参数暂未开放使用。
null
CopiedSnapshotsRetentionDaysinteger

跨地域复制快照的保留时间,单位为天。取值范围:

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

默认值:-1。

30
Tagarray<object>

自动快照策略标签列表。

object
Keystring

自动快照策略的标签键。N 的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持 128 个字符,不能以 aliyun 或 acs:开头,不能包含 http://或 https://。

TestKey
Valuestring

自动快照策略的标签值。N 的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持 128 个字符,不能以 acs:开头,不能包含 http://或 https://。

TestValue
ResourceGroupIdstring

资源组 ID。

rg-aek2kkmhmhs****
CopyEncryptionConfigurationobject

快照异地备份加密参数对象

Encryptedboolean

是否开启快照异地加密备份。取值范围:

  • true:是。
  • false:否。

默认值:false。

false
KMSKeyIdstring

快照异地加密备份使用的 KMS 密钥 ID

0e478b7a-4262-4802-b8cb-00d3fb40826X
Arnarray<object>

该参数暂未开放使用。

object
RoleTypestring

该参数暂未开放使用。

hide
Rolearnstring

该参数暂未开放使用。

hide
AssumeRoleForlong

该参数暂未开放使用。

1000000000

返回参数

名称类型描述示例值
object
AutoSnapshotPolicyIdstring

自动快照策略 ID。

sp-bp12m37ccmxvbmi5****
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

示例

正常返回示例

JSON格式

{
  "AutoSnapshotPolicyId": "sp-bp12m37ccmxvbmi5****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

错误码

HTTP status code错误码错误信息描述
400DiskCategory.OperationNotSupportedThe type of the specified disk does not support creating a snapshot.当前磁盘类型不支持此操作。
400InvalidSnapshotPolicyName.MalformedThe specified autoSnapshotPolicyName is wrongly formed.-
400Duplicate.TagKeyThe Tag.N.Key contain duplicate key.标签中存在重复的键,请保持键的唯一性。
400InvalidTagKey.MalformedThe specified Tag.n.Key is not valid.指定的标签键参数有误。
400InvalidTagValue.MalformedThe specified Tag.n.Value is not valid.指定的标签值参数有误。
400InvalidParameter.EncryptedIllegalThe specified parameter Encrypted must be true when kmsKeyId is not empty.设置参数 KMSKeyId 后,您必须开启加密属性。
400InvalidParameter.KMSKeyId.CMKNotEnabledThe CMK needs to be enabled.加密云盘设置了 KMSKeyId 后,CMK必须处于启用状态。您可以调用密钥管理服务的 DescribeKey 接口查询指定CMK的相关信息。
400InvalidParameter.KmsNotEnabledFailed to perform this operation because KMS is not activated.您需要开通KMS密钥管理服务。
400InvalidParameter.Encrypted.KmsNotEnableFailed to perform this operation because KMS is not activated.您需要开通KMS密钥托管服务。
400InvalidParam.EncryptedMismatchCreating encrypted disks with shared encrypted image requires replacing encryption keys.共享加密镜像创建云盘必须更换加密密钥.
403ParameterInvalidThe specified RegionId parameter is invalid.指定的地域 ID 无效,请您检查该地域是否正确。
403ParameterInvalidThe specified RepeatWeekDays parameter is invalid.指定的日期无效,请您检查该日期是否正确。
403ParameterInvalidThe specified TimePoints parameter is invalid.指定的时间点不合法,请您查看该时间点是否填写正确。
403ParameterInvalidThe specified RetentionDays parameter is invalid.指定的保持天数不合法。
403AutoSnapshotPolicy.QuotaExceedThe maximum number of automatic snapshot policy has been reached.自动快照策略数超出最大值。
403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.账号余额不足,请您先充值再进行该操作。
403InvalidAccountStatus.SnapshotServiceUnavailableSnapshot service has not been opened yet.快照服务未开通,操作无法执行。
403InvalidParameter.TargetCopyRegionsThe specified TargetCopyRegions is invalid.-
403InvalidParameter.CopiedSnapshotsRetentionDaysThe specified CopiedSnapshotsRetentionDays is invalid.-
403InvalidParameter.KMSKeyId.CMKUnauthorizedThe CMK needs to be added ECS tag.CMK 未授权
403InvalidParameter.KMSKeyId.KMSUnauthorizedECS service have no right to access your KMS.ECS 服务无权访问您的 KMS。
403InvalidOperation.KMSKeyIdNotFoundThe specified KMSKeyId not found, %s.无法找到关联的KMS加密密钥,请确认该KMS加密密钥有效性。
403Abs.InvalidAction.RegionNotSupportThis region does not support this action.地域不支持该操作.

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

变更历史

变更时间变更内容概要操作
2024-03-21OpenAPI 错误码发生变更查看变更详情
2024-02-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情