文档

DeleteSnapshot - 删除备份快照

更新时间:

删除一个备份快照。

接口说明

删除数据源的最近一次备份快照时,需要指定参数Force=true,否则会报错。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

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

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

请求参数

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

删除的凭证内容。

02WJDOE7
VaultIdstring

备份仓库 ID。

v-*********************
ClientIdstring

客户端 ID。删除 ECS 文件备份快照时,与 InstanceId 二者必选其一。

c-*********************
SnapshotIdstring

备份快照 ID。

s-*********************
SourceTypestring

备份源类型。取值范围:

  • ECS_FILE:表示 ECS 文件的备份快照。
  • OSS:表示阿里云 OSS 的备份快照。
  • NAS:表示阿里云 NAS 的备份快照。
ECS_FILE
InstanceIdstring

ECS 实例 ID。删除 ECS 文件备份快照时,与 ClientId 二者必选其一。

i-*********************
Forceboolean

是否强制删除最近一次备份快照。

  • true 表示强制删除最近一次备份快照。
  • false(默认值)表示不强制删除。
false

返回参数

名称类型描述示例值
object
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Successboolean

请求是否成功。

  • true 表示成功。
  • false 表示失败。
true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史