以合规模式锁定快照,以防止快照被意外或者恶意删除。快照锁定期间,任何用户都无法将其删除。
接口说明
您还可以使用该接口重新配置已锁定快照,可配置项取决于锁定模式和锁定状态:
如果快照以合规模式锁定,且处于冷静期,支持延长或缩短冷静期、延长或缩短锁定时长。
如果快照以合规模式锁定,且冷静期已过,仅支持延长锁定时长。
在冷静期内重新配置已锁定快照,系统将视为重新锁定操作,所有锁定参数将全部重置,而非单项调整。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:LockSnapshot |
update |
*Snapshot
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| SnapshotId |
string |
是 |
快照 ID。 |
s-9dp2qojdpdfmgfmf**** |
| LockMode |
string |
是 |
锁定模式。取值范围:
|
compliance |
| LockDuration |
integer |
是 |
锁定时长。锁定时长结束后快照锁定会自动过期。 单位:天。 取值范围:1~36500。 |
1 |
| CoolOffPeriod |
integer |
是 |
冷静期。合规模式下可以设置冷静期或者跳过冷静期直接锁定快照。 冷静期内,具备相应 RAM 权限的用户可以解锁快照、延长或缩短冷静期、延长或缩短锁定时长,冷静期内快照不允许删除。 冷静期结束后,仅支持延长锁定时长。 单位:小时。 取值范围:0~72。取值为 0 表示跳过冷静期直接锁定快照。 如果快照已进入合规模式锁定期,延长锁定时长该参数需要填 0。 |
3 |
| DryRun |
boolean |
否 |
是否只预检此次请求。取值范围:
|
false |
| ClientToken |
string |
否 |
保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。 |
5EC38E7D-389F-1925-ABE2-D7925A8F**** |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3**** |
| LockedSnapshotInfo |
object |
锁定快照信息。 |
|
| SnapshotId |
string |
快照 ID。 |
s-9dp2qojdpdfmgfmf**** |
| LockMode |
string |
锁定模式。可能值:
|
compliance |
| LockStatus |
string |
锁定状态。可能值:
|
compliance-cooloff |
| LockCreationTime |
string |
锁定时间。按照 ISO 8601 标准表示,并使用 UTC + 0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2025-10-15T10:00:00Z |
| CoolOffPeriod |
integer |
合规模式冷静期。单位:小时。 |
3 |
| CoolOffPeriodExpiredTime |
string |
合规模式冷静期结束时间。按照 ISO 8601 标准表示,并使用 UTC + 0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2025-10-15T13:00:00Z |
| LockDuration |
integer |
锁定时长。锁定时长结束后快照锁定会自动过期。单位:天。 |
1 |
| LockDurationStartTime |
string |
锁定时长开始时间。按照 ISO 8601 标准表示,并使用 UTC + 0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 如果锁定处于 progressing 状态的快照,锁定时长将在快照进入 accomplished 状态后才开始计算。 |
2025-10-15T10:00:00Z |
| LockExpiredTime |
string |
锁定过期时间。按照 ISO 8601 标准表示,并使用 UTC + 0 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 |
2025-10-16T10:00:00Z |
示例
正常返回示例
JSON格式
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
"LockedSnapshotInfo": {
"SnapshotId": "s-9dp2qojdpdfmgfmf****",
"LockMode": "compliance",
"LockStatus": "compliance-cooloff",
"LockCreationTime": "2025-10-15T10:00:00Z",
"CoolOffPeriod": 3,
"CoolOffPeriodExpiredTime": "2025-10-15T13:00:00Z",
"LockDuration": 1,
"LockDurationStartTime": "2025-10-15T10:00:00Z",
"LockExpiredTime": "2025-10-16T10:00:00Z"
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidLockMode.Malformed | The specified parameter LockMode is invalid. Please check the valid range for this parameter. | 指定的参数 LockMode 无效,请检查该参数的取值范围。 |
| 400 | InvalidLockDuration.ExceedRetentionDays | The specified parameter LockDuration is invalid. The LockDuration should be less than the snapshot RetentionDays. | 指定的参数 LockDuration 无效,锁定时长应小于快照保留时间。 |
| 400 | InvalidCoolOffPeriod.ExceedLockDuration | The specified parameter CoolOffPeriod is invalid. The CoolOffPeriod should be less than the LockDuration. | 指定的参数 CoolOffPeriod 无效,冷静期应小于锁定时长。 |
| 403 | InvalidOperation.SnapshotNotAvailable | The unavailable snapshot does not support locking. | 不可用的快照不支持锁定。 |
| 403 | InvalidOperation.ResourceManagedByCloudProduct | The current operation is not supported because the resource is managed by a cloud product [%s]. Please contact the relevant cloud product to confirm the reason. | 此次操作不支持因为资源被云产品托管。请联系对应的云产品确认原因。 |
| 403 | InvalidOperation.LockSharedSnapshotUnsupported | The shared snapshot does not support locking. | 来源为共享的快照不支持锁定。 |
| 403 | InvalidOperation.CoolOffPeriodExpired | The snapshot is locked in compliance mode, and the cool-off period has expired. The current operation is not supported. | 快照以合规模式锁定且冷静期已结束,不支持当前操作。 |
| 404 | InvalidSnapshotId.NotFound | The specified snapshot is not found | 指定的快照不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。