使用云盘快照,将云盘回滚到之前某一特定的历史状态。
接口说明
调用该接口时,您需要注意:
- 云盘的状态必须为使用中(In_Use)或空闲(Available)的状态。
- 云盘挂载的实例的状态必须为已停止(Stopped)。您可以调用 StopInstances 停止实例。
- 指定的参数 SnapshotId 必须是由 DiskId 创建的历史快照。
- 通过 DescribeInstances 查询 ECS 实例信息时,如果返回数据中包含
{"OperationLocks": {"LockReason" : "security"}}
,则禁止一切操作。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:ResetDisk | update | *Disk acs:ecs:{#regionId}:{#accountId}:disk/{#diskId} *Snapshot acs:ecs:{#regionId}:{#accountId}:snapshot/{#snapshotId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DiskId | string | 是 | 待回滚数据的云盘 ID。 | d-bp199lyny9b3**** |
SnapshotId | string | 是 | 需要恢复到某一云盘阶段的历史快照 ID。 | s-bp199lyny9b3**** |
DryRun | boolean | 否 | 是否预检本次请求。取值范围:
默认值:false。 | false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "F3CD6886-D8D0-4FEE-B93E-1B732396****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | DiskCategory.OperationNotSupported | The operation is not supported to the specified disk due to its disk category. | 由于磁盘种类限制,指定的磁盘不支持该操作。 |
400 | InvalidRegionId.MalFormed | The specified RegionId is not valid. | 指定的地域不存在,请检查该参数是否正确。 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | 通过“DryRun”校验,您的请求已通过验证。 |
403 | IncorrectDiskStatus | The current disk status does not support this operation. | 当前的磁盘不支持此操作,请您确认磁盘处于正常使用状态,是否欠费。 |
403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | 该资源目前的状态不支持此操作。 |
403 | InstanceLockedForSecurity | The instance is locked due to security. | 您的资源被安全锁定,拒绝操作。 |
403 | InvalidParameter.Mismatch | The specified snapshot is not created from the specified disk. | 未加密的磁盘无法通过加密的快照重置。 |
403 | InvalidParameter.Mismatch | Non-encrypted disk can not be reset by encrypted snapshot. | - |
403 | InvalidSnapshot.TooOld | The snapshotId is created before 2013-07-15, it cannot be restored since the first time the disk detached. | 创建于2013年7月15日之前的快照不支持此操作。 |
403 | InstanceExpiredOrInArrears | The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). | 实例已过期或者欠费,请您续费或者结清后再进行操作。 |
403 | OperationDenied | The specified snapshot dees not support ResetDisk. | 指定的快照不支持重置磁盘。 |
403 | InvalidSnapshotId.NotReady | The specified snapshot has not completed yet. | 指定的快照未完成。 |
403 | InvalidAccountStatus.NotEnoughBalance | Your account does not have enough balance. | 账号余额不足,请您先充值再进行该操作。 |
403 | InvalidAccountStatus.SnapshotServiceUnavailable | Snapshot service has not been opened yet. | 快照服务未开通,操作无法执行。 |
403 | Operation.Conflict | The operation may conflicts with others. | 该操作与其他操作冲突。 |
403 | UserNotInTheWhiteList | The user is not in disk white list. | 您不在磁盘白名单中,请加入白名单后重试。 |
403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag. | CMK 未授权 |
403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | 加密云盘设置了 KMSKeyId 后,CMK必须处于启用状态。您可以调用密钥管理服务的 DescribeKey 接口查询指定CMK的相关信息。 |
403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS 服务无权访问您的 KMS。 |
403 | IncorrectDiskStatus.HasUnfinishedSnapshot | The current disk has unfinished snapshot. | 当前磁盘有未完成快照。 |
404 | InvalidParameter.KMSKeyId.NotFound | The specified KMSKeyId does not exist. | 指定的参数 KMSKeyId 不存在。 |
404 | InvalidDiskId.NotFound | The specified disk does not exist. | 指定的磁盘不存在。请您检查磁盘 ID 是否正确。 |
404 | Disk.NotFound | The specified disk does not exist. | 指定的磁盘不存在,请您检查磁盘是否正确。 |
404 | InvalidSnapshotId.NotFound | The specified SnapshotId does not exist. | 指定的快照不存在,请您检查快照是否正确。 |
404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | 指定的实例ID未找到。 |
500 | InternalError | The request processing has failed due to some unknown error. | 内部错误,请重试。 |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | 内部错误,请重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-08-25 | OpenAPI 错误码发生变更 | 查看变更详情 |