调用DeleteSnapshot删除一个备份快照。

接口说明

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DeleteSnapshot

系统规定参数。取值:DeleteSnapshot

SnapshotId String s-*********************

备份快照ID。

VaultId String v-*********************

备份仓库ID。

ClientId String c-*********************

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

SourceType String ECS_FILE

备份源类型。取值范围:

  • ECS_FILE:表示ECS文件的备份快照。
  • OSS:表示阿里云OSS的备份快照。
  • NAS:表示阿里云NAS的备份快照。
InstanceId String i-*********************

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

Force Boolean false

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

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

返回数据

名称 类型 示例值 描述
Code String 200

返回码,200表示成功。

Message String successful

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

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

Success Boolean true

请求是否成功。

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

示例

请求示例

http(s)://[Endpoint]/?Action=DeleteSnapshot
&SnapshotId=s-*********************
&<公共请求参数>

正常返回示例

XML格式

<DeleteSnapshotResponse>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <Code>200</Code>
  <Success>true</Success>
</DeleteSnapshotResponse>

JSON格式

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

错误码

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