调用ModifyAutoSnapshotPolicyEx修改一条自动快照策略。修改自动快照策略后,之前已应用该策略的云盘随即执行修改后的自动快照策略。已启用快照跨地域复制且在未配置加密参数场景下,加密快照默认使用目的端服务密钥进行加密拷贝。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:ModifyAutoSnapshotPolicyEx | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
regionId | string | 是 | 自动快照策略所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
autoSnapshotPolicyId | string | 是 | 目标自动快照策略 ID。您可以调用 DescribeAutoSnapshotPolicyEx 查看您可用的自动快照策略。 | sp-bp12m37ccmxvbmi5**** |
autoSnapshotPolicyName | string | 否 | 自动快照策略的名称。如果参数为空则代表不修改。 | SPTestName |
timePoints | string | 否 | 自动快照的创建时间点。使用 UTC +8 时间,单位为小时。取值范围为 0~23,代表 00:00 至 23:00 共 24 个时间点,如 1 表示 01:00。 当一天内需要创建多次自动快照时,可以传入多个时间点:
| ["0", "1"] |
repeatWeekdays | string | 否 | 自动快照的重复日期,单位为天,周期为星期。取值范围为 1~7,如 1 表示周一。 当一星期内需要创建多次自动快照时,可以传入多个时间点:
| ["1", "7"] |
retentionDays | integer | 否 | 自动快照的保留时间,单位为天。取值范围:
默认值为-1。 | 30 |
EnableCrossRegionCopy | boolean | 否 | 是否允许自动跨地域复制。
| false |
TargetCopyRegions | string | 否 | 跨地域复制快照的目标地域。目前支持设置一个目标地域。 | ["cn-hangzhou"] |
CopiedSnapshotsRetentionDays | integer | 否 | 跨地域复制快照的保留时间,单位为天。取值范围:
默认值为-1。 | 30 |
CopyEncryptionConfiguration | object | 否 | 快照跨地域复制加密参数对象 | |
Encrypted | boolean | 否 | 是否开启快照跨地域加密复制。取值范围:
默认值:false。 | false |
KMSKeyId | string | 否 | 快照跨地域加密复制使用的 KMS 密钥 ID。 | 0e478b7a-4262-4802-b8cb-00d3fb40826X |
Arn | array<object> | 否 | 该参数暂未开放使用。 | |
object | 否 | |||
RoleType | string | 否 | 该参数暂未开放使用。 | hide |
Rolearn | string | 否 | 该参数暂未开放使用。 | hide |
AssumeRoleFor | long | 否 | 该参数暂未开放使用。 | 1000000000 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter.EncryptedIllegal | The specified parameter Encrypted must be true when kmsKeyId is not empty. | 设置参数 KMSKeyId 后,您必须开启加密属性。 |
400 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | 加密云盘设置了 KMSKeyId 后,CMK必须处于启用状态。您可以调用密钥管理服务的 DescribeKey 接口查询指定CMK的相关信息。 |
400 | InvalidParameter.KmsNotEnabled | Failed to perform this operation because KMS is not activated. | 您需要开通KMS密钥管理服务。 |
400 | InvalidParameter.Encrypted.KmsNotEnable | Failed to perform this operation because KMS is not activated. | 您需要开通KMS密钥托管服务。 |
400 | InvalidParam.EncryptedMismatch | Creating encrypted disks with shared encrypted image requires replacing encryption keys. | 共享加密镜像创建云盘必须更换加密密钥. |
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 AutoSnapshotPolicyId is invalid. | 指定的自动快照规则 ID 不合法。 |
403 | ParameterInvalid | The specified RetentionDays parameter is invalid. | 指定的保持天数不合法。 |
403 | InvalidParameter.TargetCopyRegions | The specified TargetCopyRegions is invalid. | - |
403 | InvalidParameter.CopiedSnapshotsRetentionDays | The specified CopiedSnapshotsRetentionDays is invalid. | - |
403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag. | CMK 未授权 |
403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS 服务无权访问您的 KMS。 |
403 | Abs.InvalidAction.RegionNotSupport | This region does not support this action. | 地域不支持该操作. |
404 | ParameterInvalid | The specified automatic snapshot policy does not exist. | 指定的自动快照策略不存在,请您检查自动快照策略是否正确。 |
404 | ParameterInvalid | The specified automatic snapshot policy does not exist in the region. | 指定的自动快照策略不存在,请您检查自动快照策略是否正确。 |
404 | InvalidParameter.KMSKeyId.NotFound | The specified KMSKeyId does not exist. | 指定的参数 KMSKeyId 不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-03-21 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-02-29 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-02-28 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-02-28 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |