全部产品
Search
文档中心

云备份:DeleteBackupPlan - 删除备份计划

更新时间:Dec 26, 2024

删除一个备份计划。

接口说明

  • 删除备份计划,会级联删除备份任务。
  • 删除备份计划,不会删除已创建的快照文件。

调试

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

授权信息

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

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

请求参数

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

备份计划 ID。

plan-*********************
VaultIdstring

备份库仓库 ID,当 SourceType 不为 UDM_ECS 时,备份仓库 ID 必填。

v-*********************
SourceTypestring

数据源类型,取值范围:

  • ECS_FILE:表示备份 ECS 文件
  • OSS:表示备份阿里云 OSS
  • NAS:表示备份阿里云 NAS
  • UDM_ECS:表示备份 ECS 整机
  • OTS:表示备份阿里云 Tablestore
ECS_FILE
RequireNoRunningJobsboolean

是否要求无正在运行的作业

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
}

错误码

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

变更历史

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