云服务器备份 CSBS云服务器备份 CSBS

计算
弹性云服务器 ECS
裸金属服务器 BMS
云手机 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器 HECS
VR云渲游平台 CVR
特惠算力专区
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属企业存储服务
云存储网关 CSG
专属分布式存储服务 DSS
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘小站 IES
智能边缘平台 IEF
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
园区智能体 CampusGo
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
视频分析服务 VAS
语音交互服务 SIS
知识图谱 KG
人证核身服务 IVS
IoT物联网
设备接入 IoTDA
设备管理 IoTDM(联通用户专用)
全球SIM联接 GSL
IoT开发者服务
IoT数据分析
车联网服务 IoV
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
开发与运维
软件开发平台 DevCloud
项目管理 ProjectMan
代码托管 CodeHub
流水线 CloudPipeline
代码检查 CodeCheck
编译构建 CloudBuild
部署 CloudDeploy
云测 CloudTest
发布 CloudRelease
移动应用测试 MobileAPPTest
CloudIDE
Classroom
开源镜像站 Mirrors
应用魔方 AppCube
云性能测试服务 CPTS
应用管理与运维平台 ServiceStage
云应用引擎 CAE
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
资源管理服务 RMS
应用身份管理服务 OneAccess
区块链
区块链服务 BCS
可信跨链服务 TCS
智能协作
IdeaHub
开发者工具
SDK开发指南
API签名指南
DevStar
HCloud CLI
Terraform
Ansible
API问题定位指导
云生态
云市场
合作伙伴中心
华为云培训中心
其他
管理控制台
消息中心
产品价格详情
系统权限
我的凭证
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
应用编排服务 AOS
多云容器平台 MCP
基因容器 GCS
容器洞察引擎 CIE
云原生服务中心 OSC
容器批量计算 BCE
容器交付流水线 ContainerOps
应用服务网格 ASM
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB (for openGauss)
云数据库 GaussDB(for MySQL)
云数据库 GaussDB NoSQL
数据管理服务 DAS
数据库和应用迁移 UGO
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据湖治理中心 DGC
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
API网关 APIG
分布式缓存服务 DCS
分布式消息服务RocketMQ版
企业应用
域名注册服务 Domains
云解析服务 DNS
云速建站 CloudSite
网站备案
华为云WeLink
会议
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMAExchange
API全生命周期管理 ROMA API
安全与合规
安全技术与应用
DDoS防护 ADS
Web应用防火墙 WAF
云防火墙 CFW
应用信任中心 ATC
企业主机安全 HSS
容器安全服务 CGS
云堡垒机 CBH
数据库安全服务 DBSS
数据加密服务 DEW
数据安全中心 DSC
云证书管理服务 CCM
SSL证书管理 SCM
漏洞扫描服务 VSS
态势感知 SA
威胁检测服务 MTD
管理检测与响应 MDR
安全治理云图 Compass
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
专属云
专属计算集群 DCC
解决方案
高性能计算 HPC
SAP
游戏云
混合云灾备
华为工业云平台 IMC
价格
成本优化最佳实践
专属云商业逻辑
用户服务
帐号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
更新时间:2021-03-18 GMT+08:00
分享

创建备份策略

功能介绍

创建备份策略对服务器进行周期性备份,还可以为备份策略附加一个复制策略,对该策略产生的备份进行复制。

URI

  • URI

    POST https://{endpoint}/v1/{project_id}/policies

  • 参数说明
    表1 参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    String

    项目ID。

    获取方法请参见获取项目ID

请求

  • 要素说明
    表2 要素说明

    参数

    是否必选

    参数类型

    描述

    policy

    policy_create

    创建参数。

    详情请参见表3

  • policy_create 字段数据结构说明
    表3 policy_create 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    description

    String

    备份策略描述,长度限制:0- 255,除了“<”、“>”不能输入,其它字符均可。

    name

    String

    备份策略名称,长度限制:1- 255,只能由中文、字母、数字、“_”、“-”组成。

    parameters

    policy_param

    备份参数。

    详情请参见表4

    provider_id

    String

    备份提供商ID,当前取值固定值:fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。

    resources

    List<resource>

    备份对象列表,列表可以为空。

    详情请参见表5

    scheduled_operations

    List<scheduled_operation_create>

    调度周期。

    详情请参见表6

  • policy_param 字段数据结构说明
    表4 policy_param 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    common

    common_param

    备份策略通用参数,此处默认为空。

    详情请参见common_param 字段数据结构说明

  • common_param 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    app_consistency

    Integer

    是否对备份策略中的备份对象做应用一致性备份;0代表不做应用一致性备份;1代表做应用一致性备份且应用一致性备份失败后,不继续做崩溃一致性备份;2代表做应用一致性备份且应用一致性备份失败后,继续做崩溃一致性备份。未输入app_consistency参数时,不做应用一致性备份。应用一致性备份特性参照创建资源备份接口描述。

  • resource 字段数据结构说明
    表5 resource 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    id

    String

    待备份对象ID

    type

    String

    备份对象的实体对象类型。

    当前支持的取值包含两个:OS::Nova::Server,该值代表备份对象为云服务器,OS::Ironic::BareMetalServer,该值代表备份对象为裸金属服务器。

    name

    String

    备份对象名称

    extra_info

    Dict

    备份对象的附加信息

  • extra_info参数说明

    参数

    是否必选

    参数类型

    描述

    exclude_volumes

    List<volume_id>

    磁盘的ID列表,如果备份对象为云服务器或者裸金属服务器,代表备份时不对该服务器下指定的磁盘进行备份。

  • scheduled_operation_create 字段数据结构说明
    表6 scheduled_operation_create 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    description

    String

    调度周期描述,长度限制:0- 255,除了“<”、“>”不能输入,其它字符均可。

    enabled

    Boolean

    是否启用该调度周期, 启用时策略会自动调度;不启用时策略不会自动调度,可以通过调用执行备份策略接口手动执行策略。

    name

    String

    调度周期名称,长度限制:1- 255,只能由中文、字母、数字、“_”、“-”组成。

    operation_type

    String

    操作类型,如备份,复制

    Enum:[ backup,replication]

    operation_definition

    operation_definition

    调度周期参数。

    详情请参见表7

    trigger

    trigger

    调度策略

  • operation_definition 字段数据结构说明
    表7 operation_definition 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    max_backups

    Integer

    单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。

    retention_duration_days

    Integer

    备份保留时长,单位天。取值为-1或0-99999。-1代表不按时间清理。

    permanent

    Boolean

    是否永久保留。“false”:不永久保留,“true”:永久保留

    plan_id

    String

    备份策略ID。

    provider_id

    String

    备份提供商ID,当前取值固定值:fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。

    destination_region

    String

    复制的目标区域ID,仅在跨区域复制时才会使用并且必须指定。

    destination_project_id

    String

    复制的目标项目ID,仅在跨区域复制时才会使用并且必须指定。

    获取方法请参见获取项目ID

    enable_acceleration

    Boolean

    跨区域复制时,是否启用加速从而缩减复制的时间,如果不指定,默认不启用加速

    day_backups

    Integer

    保留日备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone 也必选。

    week_backups

    Integer

    保留周备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone 也必选。

    month_backups

    Integer

    保留月备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone 也必选。

    year_backups

    Integer

    保留年备个数,该备份不受保留最大备份数限制。若选择该参数,则timezone 也必选。

    timezone

    String

    用户所在时区,格式形如UTC+08:00,若没有选择年备,月备,周备,日备中任一参数,则不能选择该参数。

    • permanent配置为true,无论max_backups和retention_duration_days配置为何值,都是表示永久保留。
    • permanent配置为false或者不配置,以max_backups和retention_duration_days配置为准。
    • permanent,max_backups和retention_duration_days都不配置,则表示永久保留。
  • trigger 字段数据结构说明
    表8 trigger 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    properties

    trigger_properties

    调度器属性。

    详情请参见表9

  • trigger_properties 字段数据结构说明
    表9 trigger_properties 字段数据结构说明

    参数

    是否必选

    参数类型

    描述

    pattern

    String

    调度器的调度策略,长度限制为10240个字符,参照iCalendar RFC 2445规范,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE四个参数,其中FREQ仅支持WEEKLY和DAILY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且时间点间隔不能小于一小时,一个备份策略可以同时设置多个备份时间点,一天最多可以设置24个时间点。

  • 请求样例
    POST https://{endpoint}/v1/{project_id}/policies
    {
      "policy" : {
        "name" : "my-plan",
        "description" : "My plan",
        "provider_id" : "fc4d5750-22e7-4798-8a46-f48f62c4c1da",
        "parameters" : {
          "common" : {
              "app_consistency": 1
          }
        },
        "scheduled_operations" : [ {
          "name" : "my-backup-policy",
          "description" : "My backup policy",
          "enabled" : true,
          "operation_definition" : {
            "max_backups" : 20
          },
          "trigger" : {
            "properties" : {
              "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
            }
          },
          "operation_type" : "backup"
        },{
          "name" : "my-replication-policy",
          "description" : "My replication policy",
          "enabled" : true,
          "operation_definition" : {
            "max_backups" : 20,
            "destination_region": "cn-south-1",
            "destination_project_id": "827099a5c63945d3b5a473ce9a1eaf88"
          },
          "trigger" : {
            "properties" : {
              "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
            }
          },
          "operation_type" : "replication"
        }],
        "resources" : [ {
          "id" : "45baf976-c20a-4894-a7c3-c94b7376bf55",
          "type" : "OS::Nova::Server",
          "name" : "resource1",
        }, {
          "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
          "type" : "OS::Nova::Server",
          "name" : "resource2"
        } ]
      }
    }

响应

  • 要素说明
    表10 要素说明

    参数

    参数类型

    描述

    policy

    policy_resp

    详情请参见表11

  • policy_resp 字段数据结构说明
    表11 policy_resp 字段数据结构说明

    参数

    参数类型

    描述

    created_at

    String

    创建时间,如:"2017-04-18T01:21:52.701973"

    description

    String

    备份策略描述,长度限制:0- 255,除了“<”、“>”不能输入,其它字符均可。

    id

    String

    备份策略ID

    name

    String

    备份策略名称,长度限制:1- 255,只能由中文、字母、数字、“_”、“-”组成。

    parameters

    policy_param

    备份策略参数。

    详情请参见表12

    project_id

    String

    项目ID

    获取方法请参见获取项目ID

    provider_id

    String

    备份提供商ID,当前取值固定值:fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。

    resources

    List<resource>

    备份对象列表。

    详情请参见表13

    scheduled_operations

    List<scheduled_operation_resp>

    调度周期列表。

    详情请参见表14

    status

    String

    备份策略状态,

    “disabled”:不可用

    “enabled”:可用

  • policy_param 字段数据结构说明
    表12 policy_param 字段数据结构说明

    参数

    参数类型

    描述

    common

    common_param

    备份策略通用参数。

    详情请参见common_param 字段数据结构说明

  • common_param 字段数据结构说明

    参数

    参数类型

    描述

    app_consistency

    Integer

    是否对备份策略中的备份对象做应用一致性备份;0代表不做应用一致性备份;1代表做应用一致性备份且应用一致性备份失败后,不继续做崩溃一致性备份;2代表做应用一致性备份且应用一致性备份失败后,继续做崩溃一致性备份。未输入app_consistency参数时,不做应用一致性备份。应用一致性备份特性参照创建资源备份接口描述。

  • resource 字段数据结构说明
    表13 resource 字段数据结构说明

    参数

    参数类型

    描述

    id

    String

    待备份对象ID

    type

    String

    备份对象的实体对象类型。

    虚拟机:OS::Nova::Server

    type

    String

    备份对象的实体对象类型。

    当前支持的取值包含两个:OS::Nova::Server,该值代表备份的对象为云服务器,OS::Ironic::BareMetalServer,该值代表备份的对象为裸金属服务器。

    name

    String

    备份对象名称

    extra_info

    Dict

    备份对象的附加信息

  • extra_info参数说明

    参数

    参数类型

    描述

    exclude_volumes

    List<volume_id>

    磁盘的ID列表,如果备份对象为云服务器或者裸金属服务器,代表备份时不对该服务器下指定的磁盘进行备份。

  • scheduled_operation_resp 字段数据结构说明
    表14 scheduled_operation_resp 字段数据结构说明

    参数

    参数类型

    描述

    description

    String

    调度周期描述,长度限制:0- 255,除了“<”、“>”不能输入,其它字符均可。

    enabled

    Boolean

    是否启用该调度周期,默认为true, 不启用时策略不会自动调度,可以手工调度

    name

    String

    调度周期名称,长度限制:1- 255,只能由中文、字母、数字、“_”、“-”组成。

    operation_type

    String

    操作类型,备份,复制

    Enum:[ backup,replication]

    operation_definition

    operation_definition

    调度周期参数。

    详情请参见表15

    trigger

    trigger_resp

    调度策略

    id

    String

    调度周期ID

    trigger_id

    String

    调度器ID

  • operation_definition 字段数据结构说明
    表15 operation_definition 字段数据结构说明

    参数

    参数类型

    描述

    max_backups

    String

    单个备份对象自动备份的最大备份数。取值为-1或0-99999。-1代表不按备份数清理。

    retention_duration_days

    String

    备份保留时长,单位天。取值为-1或0-99999。-1代表不按时间清理。

    permanent

    String

    是否永久保留。

    plan_id

    String

    备份策略ID。

    provider_id

    String

    备份提供商ID,当前取值固定值:fc4d5750-22e7-4798-8a46-f48f62c4c1da。用于区分备份对象是服务器或磁盘。

    destination_region

    String

    复制的目标区域,仅在跨区域复制时才会使用并且必须指定。

    destination_project_id

    String

    复制的目标项目ID,仅在跨区域复制时才会使用并且必须指定。

    enable_acceleration

    String

    跨区域复制时,是否启用加速从而缩减复制的时间,如果不指定,默认不启用加速。

    • permanent配置为true,无论max_backups和retention_duration_days配置为何值,都是表示永久保留。
    • permanent配置为false或者不配置,以max_backups和retention_duration_days配置为准。
    • permanent,max_backups和retention_duration_days都不配置,则表示永久保留。
  • trigger_resp 字段数据结构说明
    表16 trigger_resp 字段数据结构说明

    参数

    参数类型

    描述

    properties

    trigger_properties_resp

    调度器属性。

    详情请参见trigger_properties_resp 字段数据结构说明

    id

    String

    调度器ID。

    name

    String

    调度器名称。

    type

    String

    调度类型,"time":时间类型

  • trigger_properties_resp 字段数据结构说明
    表17 trigger_properties_resp 字段数据结构说明

    参数

    参数类型

    描述

    pattern

    String

    调度器的调度策略,长度限制为10240个字符,参照iCalendar RFC 2445规范,但仅支持FREQ、BYDAY、BYHOUR、BYMINUTE四个参数,其中FREQ仅支持WEEKLY和DAILY,BYDAY支持一周七天(MO、TU、WE、TH、FR、SA、SU),BYHOUR支持0-23小时,BYMINUTE支持0-59分钟,并且时间点间隔不能小于一小时,一个备份策略可以同时设置多个备份时间点,一天最多可以设置24个时间点。

    start_time

    String

    调度器开始时间,如:"2017-04-18T01:21:52"

    format

    String

    调度器类型

  • 响应样例
    {
      "policy" : {
        "created_at" : "2017-03-07T09:27:40.928000",
        "description" : "My plan",
        "id" : "f766c171-9336-479a-8b30-b83cabf6381e",
        "name" : "my-plan",
        "parameters" : {
          "common" : {
              "app_consistency": 1
          }
        },
        "project_id" : "tenant",
        "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec",
        "resources" : [ {
          "id" : "45baf976-c20a-4894-a7c3-c94b7376bf55",
          "name" : "resource1",
          "type" : "OS::Nova::Server",
          "extra_info" : {
            "exclude_volumes": ["8a8ccde2-0b9a-4450-a5f3-150816635f46"]
        }
        }, {
          "id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
          "name" : "resource2",
          "type" : "OS::Nova::Server"
        } ],
        "scheduled_operations" : [ {
          "description" : "My backup policy",
          "enabled" : true,
          "id" : "9303a23d-e433-48e7-b88a-5ee6442e434e",
          "name" : "my-backup-policy",
          "operation_definition" : {
            "max_backups" : "20",
            "plan_id" : "f766c171-9336-479a-8b30-b83cabf6381e",
            "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec"
          },
          "operation_type" : "backup",
          "trigger" : {
            "id" : "8178846b-766d-4fe6-941f-b38c76b6f3b9",
            "name" : "default",
            "properties" : {
              "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
              "start_time" : "2017-03-07 09:27:41",
              "format" : "ical"
            },
            "type" : "time"
          },
          "trigger_id" : "8178846b-766d-4fe6-941f-b38c76b6f3b9"
        },{
          "description" : "My replication policy",
          "enabled" : true,
          "id" : "9303a23d-e433-48e7-b88a-5ee6442e434f",
          "name" : "my-replication-policy",
          "operation_definition" : {
            "max_backups" : "20",
            "plan_id" : "f766c171-9336-479a-8b30-b83cabf6381e",
            "provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec",
            "destination_region": "cn-south-1",
            "destination_project_id": "827099a5c63945d3b5a473ce9a1eaf88"
          },
          "operation_type" : "replication",
          "trigger" : {
            "id" : "8178846b-766d-4fe6-941f-b38c76b6f3b8",
            "name" : "default",
            "properties" : {
              "pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
              "start_time" : "2017-03-07 09:27:41"
            },
            "type" : "time"
          },
          "trigger_id" : "8178846b-766d-4fe6-941f-b38c76b6f3b8"
        } ],
        "status" : "suspended"
      }
    }

状态码

  • 正常

    状态码

    说明

    200

    OK

  • 异常

    状态码

    说明

    400

    请求参数不合法

    401

    鉴权失败

    403

    没有操作权限

    404

    请求对象不存在

    500

    服务内部错误

    503

    服务不可用

错误码

请参考错误码

分享:

    相关文档

    相关产品

关闭导读