计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
文档首页/ 云备份 CBR/ API参考/ API/ 存储库/ 创建包周期存储库

创建包周期存储库

更新时间:2025-02-13 GMT+08:00

功能介绍

创建包周期存储库

URI

POST /v3/{project_id}/vaults/order

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

vault

VaultOrder object

存储库

表4 VaultOrder

参数

是否必选

参数类型

描述

name

String

存储库名称

最小长度:1

最大长度:64

billing

BillingCreate object

创建参数信息

resources

Array of ResourceCreate objects

绑定的备份资源,未在创建时绑定资源填[]

description

String

描述

最小长度:0

最大长度:255

backup_policy_id

String

备份策略ID,不设置时为null,不自动备份。

tags

Array of Tag objects

标签列表 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。

enterprise_project_id

String

企业项目ID,默认为‘0’。

auto_bind

Boolean

是否支持自动挂载。

bind_rules

VaultBindRules object

自动挂载的规则

threshold

Integer

存储库阈值,百分比。

最小值:1

最大值:100

smn_notify

Boolean

当容量到达阈值,是否启用通知

parameters

VaultCreateParameters object

存储库订单联合参数

auto_expand

Boolean

是否开启存储库自动扩容能力(只支持按需存储库)。

locked

Boolean

用于标识当前存储库是否已锁定,锁定的存储库不支持解锁。

表5 BillingCreate

参数

是否必选

参数类型

描述

cloud_type

String

公有云:public ;混合云:hybrid

consistent_level

String

规格,崩溃一致性(crash_consistent)或应用一致性(app_consistent)

object_type

String

对象类型:云服务器(server),云硬盘(disk),文件系统(turbo),云桌面(workspace),VMware(vmware),关系型数据库(rds),文件(file)。

protect_type

String

保护类型:备份(backup)、复制(replication)。

size

Integer

容量,单位GB

charging_mode

String

创建模式,按需:post_paid,包周期:pre_paid,默认为post_paid

period_type

String

创建类型,charging_mode为pre_paid必填

  • year: 按年

  • month: 按月

period_num

Integer

创建类型的数量,charging_mode为pre_paid必填

is_auto_renew

Boolean

到期后是否自动续期,默认不续期

is_auto_pay

Boolean

是否自动付费,默认为不自动付费

console_url

String

跳转URL

is_multi_az

Boolean

存储库多az属性,默认为false

表6 ResourceCreate

参数

是否必选

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id

type

String

待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS::Workspace::DesktopV2

name

String

名称

表7 ResourceExtraInfo

参数

是否必选

参数类型

描述

exclude_volumes

Array of strings

需要排除备份的卷id。仅在多盘备份特性中有效,排除不需要备份的磁盘。当虚拟机新绑定磁盘时,也能继续排除之前设置不用备份的卷。

表8 Tag

参数

是否必选

参数类型

描述

key

String

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,数字,“-”,“_”组成。

value

String

值。

添加标签时value值必选,删除标签时value值可选。

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,数字,“-”,“_”,“.”组成。

表9 VaultBindRules

参数

是否必选

参数类型

描述

tags

Array of BindRulesTags objects

按tags过滤自动绑定的资源

最小长度:0

最大长度:5

表10 BindRulesTags

参数

是否必选

参数类型

描述

key

String

key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文,字母,数字,“-”,“_”组成。

value

String

value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文,字母,数字,“-”,“_”,“.”组成。

表11 VaultCreateParameters

参数

是否必选

参数类型

描述

combined_order

CombinedOrder object

组合订单。

表12 CombinedOrder

参数

是否必选

参数类型

描述

combined_order_id

String

组合订单 ID

combined_order_ecs_num

Integer

组合订单中 ECS 服务器数量,当前批量最大为 500。

最小值:1

最大值:1000

combined_order_num

Integer

组合订单数量。

最小值:1

最大值:1000

响应参数

状态码:200

表13 响应Body参数

参数

参数类型

描述

orders

Array of CbcOrderResult objects

订单详情

retCode

Integer

创建结果代码

0:成功

errText

String

创建结果信息

error_code

String

操作错误码

0:无错误

表14 CbcOrderResult

参数

参数类型

描述

cloudServiceId

String

云服务ID

orderId

String

订单ID

subscribeResult

Integer

订购结果,1:成功;0:失败

resourceId

String

包周期资源预生成资源id。

状态码:400

表15 响应Body参数

参数

参数类型

描述

error_code

String

请参见错误码

error_msg

String

错误信息

请求示例

  • 创建一个包周期云服务器备份存储库,存储库容量为80G,周期为一个月且绑定一个资源。

    POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/order
    
    {
      "vault" : {
        "name" : "vault_name",
        "billing" : {
          "consistent_level" : "app_consistent",
          "object_type" : "server",
          "protect_type" : "backup",
          "size" : 80,
          "charging_mode" : "pre_paid",
          "period_type" : "month",
          "period_num" : 1
        },
        "resources" : [ {
          "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c",
          "type" : "OS::Nova::Server"
        } ]
      }
    }
  • 创建一个包周期云服务器备份存储库,存储库容量阈值为80G,云服务器数量为5,周期为一个月同时绑定一个资源并添加标签。

    POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/order
    
    {
      "vault" : {
        "name" : "123",
        "description" : "description",
        "backup_policy_id" : "70e9c916-7109-472d-94e7-120900e4ba61",
        "tags" : [ {
          "key" : "key",
          "value" : "value"
        } ],
        "auto_bind" : false,
        "threshold" : 80,
        "smn_notify" : true,
        "parameters" : {
          "combined_order" : {
            "combined_order_id" : "CS2303030959MR1IT",
            "combined_order_ecs_num" : 5,
            "combined_order_num" : 5
          }
        },
        "bind_rules" : {
          "tags" : [ {
            "key" : "bind_rules_key",
            "value" : "bind_rules_value"
          } ]
        },
        "billing" : {
          "cloud_type" : "public",
          "is_auto_renew" : false,
          "is_auto_pay" : false,
          "console_url" : "https://www.com",
          "consistent_level" : "app_consistent",
          "object_type" : "server",
          "protect_type" : "backup",
          "size" : 80,
          "charging_mode" : "pre_paid",
          "period_type" : "month",
          "period_num" : 1
        },
        "resources" : [ {
          "id" : "8ef08ba1-81f7-4e41-ae49-d3e2fb0ba388",
          "type" : "OS::Nova::Server",
          "name" : "server_name",
          "extra_info" : {
            "exclude_volumes" : [ "1855eb9a-2b5e-4938-a9f0-aea08b6f9243" ]
          }
        } ]
      }
    }

响应示例

状态码:200

OK

{
  "orders" : [ {
    "orderId" : "CS2303030941NJJIW",
    "cloudServiceId" : "cbr",
    "subscribeResult" : 1,
    "resourceId" : "ef3bf6bb-1ffb-46c0-8b23-f935ded5024a"
  } ],
  "retCode" : 0,
  "errText" : "success",
  "error_code" : 0
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容