文档

CreateBackupJob - 创建备份任务

更新时间:

创建一个手动备份任务。

调试

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

授权信息

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

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

请求参数

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

备份任务名称。

k8s-backup-infra-20220131150046-hbr
SourceTypestring

数据源类型,取值范围:

  • ECS_FILE:表示 ECS 文件备份任务。
  • UDM_ECS:表示 ECS 整机备份任务。
  • CONTAINER 表示容器备份任务。
CONTAINER
Retentionlong

备份保留天数。

15
InstanceIdstring

仅当 SourceType 取值为UDM_ECS时,需要配置该参数。表示 ECS 实例 ID。

i-bp1xxxxxxxxxxxxxxysm
Detailobject

整机备份详情,类型为 JSON 字符串。

  • doCopy:是否开启异地复制
  • destinationRegionId:异地复制目标地域
  • destinationRetention:异地复制备份点保留时间
  • diskIdList:备份的云盘 ID 列表,为空时备份全部云盘。
  • snapshotGroup:是否使用一致性快照组(仅实例所有云盘均为 ESSD 时有效)。
  • appConsistent:是否使用应用一致性(需要搭配参数 preScriptPath 和 postScriptPath 使用)。
  • preScriptPath:冻结脚本路径。
  • postScriptPath:解冻脚本路径。
  • enableWriters:仅当 AppConsistenttrue 时,需要配置该参数。是否设置应用一致性快照(默认为 true):
    • true:创建应用一致性快照
    • false:创建文件系统一致性快照
  • enableFsFreeze:仅当 AppConsistenttrue 时,需要配置该参数。是否在创建应用一致性快照前使用 Linux 的 FsFreeze 机制确保文件系统处于只读一致性。默认为 true。
  • timeoutSeconds:仅当 AppConsistenttrue 时,需要配置该参数。IO 冻结超时时间。默认为 30 秒。
{ "doCopy": false, "destinationRegionId": "", "destinationRetention": null, "diskIdList": [], "snapshotGroup": false, "appConsistent": false, "enableWriters": true, "preScriptPath": "", "postScriptPath": "", "enableFsFreeze": true, "timeoutInSeconds": 60 }
BackupTypestring

备份类型。

  • COMPLETE:全量备份。
  • INCREMENTAL:增量备份。
INCREMENTAL
VaultIdstring

备份仓库 ID。

v-000xxxxxxxxxxxxxxy1v
SpeedLimitstring

仅当 SourceType 取值为ECS_FILE时,需要配置该参数。表示备份流量控制。格式为{start}|{end}|{bandwidth}。多个流量控制配置使用|分隔,并且配置时间不允许有重叠。

  • start:起始小时。
  • end:结束小时。
  • bandwidth:限制速率,单位 KB/s。
0:24:NaN
Optionsstring

仅当 SourceType 取值为ECS_FILE时,需要配置该参数。表示是否使用 Windows 系统 VSS 定义备份路径。

  • 此功能仅支持 Windows 类型 ECS 实例。
  • 如果备份源中有数据更改,需要确保备份数据与源数据的一致时,才可配置为["UseVSS":true]
  • 选择使用 VSS 后,不支持多个文件目录同时备份。
{"UseVSS":false}
Includestring

仅当 SourceType 取值为ECS_FILE时,需要配置该参数。表示需要备份的路径,该路径下所有文件都备份。最多支持 255 个字符。

["/home/alice/*.pdf", "/home/bob/*.txt"]
Excludestring

仅当 SourceType 取值为ECS_FILE时,需要配置该参数。表示不需要进行备份的路径,该路径下所有文件都不备份。最多支持 255 个字符。

["/var", "/proc"]
ClusterIdstring

集群 ID。

cl-00068btz******oku
ContainerResourcesstring

集群资源,仅 SourceType 取值为 CONTAINER 时需要配置该参数。

[{\"resourceType\":\"PV\",\"backupMethod\":\"FILE\",\"resourceId\":\"674dac6d-74cd-47e9-a675-09e2f10d2c45\",\"resourceInfo\":\"{\\\"pv_name\\\":\\\"nas-650dac6d-74cd-47e9-a675-09e2f10d2c45\\\",\\\"pv_size\\\":\\\"8Gi\\\",\\\"storage_class\\\":\\\"alibabacloud-cnfs-nas\\\",\\\"pvc_name\\\":\\\"data-postgresql-default-0\\\",\\\"namespace\\\":\\\"database\\\"}\",\"host\":\"cn-huhehaote.192.168.13.133\",\"hostPrefix\":\"6f5e758e-8d35-4584-b9ce-8333adfc7547/volumes/kubernetes.io~csi/nas-670dac6d-74cd-47e9-a675-09e2f10d2c45/mount\",\"pvPath\":\"/\"}]
InitiatedByAckboolean

是否由容器服务调用。默认为 false。

false
ContainerClusterIdstring

集群 ID,仅 SourceType 取值为 CONTAINER 时需要配置该参数。

cc-000xxxxxxxxxxxxxxi00
CrossAccountTypestring

跨账号备份类型。支持:

  • SELF_ACCOUNT:本账号备份
  • CROSS_ACCOUNT:跨账号备份
SELF_ACCOUNT
CrossAccountUserIdlong

被当前账号管理的跨账号备份的原账号 ID。

158975xxxxxx4625
CrossAccountRoleNamestring

被当前账号管理的跨账号备份的原账号 RAM 中创建的角色名。

BackupRole

返回参数

名称类型描述示例值
object
Codestring

返回码,200 表示成功。

200
Messagestring

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

successful
RequestIdstring

请求 ID。

25F49E7B-7E39-542E-83AD-62E6E7F73786
Successboolean

请求是否成功。

  • true:成功。
  • false:失败。
true
JobIdstring

备份任务 ID。

job-000csy09q50a2jdcbwbo

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "25F49E7B-7E39-542E-83AD-62E6E7F73786",
  "Success": true,
  "JobId": "job-000csy09q50a2jdcbwbo"
}

错误码

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

变更历史

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