Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Vaults/ Creating a Yearly/Monthly Vault

Creating a Yearly/Monthly Vault

Function

Creating a Yearly/Monthly Vault

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v3/{project_id}/vaults/order

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

vault

Yes

VaultOrder object

Vaults

Table 4 VaultOrder

Parameter

Mandatory

Type

Description

name

No

String

Vault name

Minimum length: 1 character

Maximum length: 64 characters

Minimum: 1

Maximum: 64

billing

Yes

BillingCreate object

Parameter information for creation

resources

Yes

Array of ResourceCreate objects

Associated resources. Set this parameter to [] if no resources are associated when creating a vault.

Array Length: 0 - 256

description

No

String

Description

Minimum length: 0 characters

Maximum length: 255 characters

Minimum: 0

Maximum: 255

backup_policy_id

No

String

Backup policy ID. If the value of this parameter is null, automatic backup is not performed.

tags

No

Array of Tag objects

Tag list. This list cannot be an empty list.The list can contain up to 10 keys.Keys in this list must be unique.

Array Length: 1 - 10

enterprise_project_id

No

String

Enterprise project ID

auto_bind

No

Boolean

Whether automatic association is supported

bind_rules

No

VaultBindRules object

Rules for automatic association

threshold

No

Integer

Vault's capacity threshold, in percentage

Minimum value: 1

Maximum value: 100

smn_notify

No

Boolean

Whether to enable notifications when the vault's used capacity reaches the threshold

parameters

No

VaultCreateParameters object

Vault order combined parameters

auto_expand

No

Boolean

Whether to enable auto capacity expansion (supported for pay-per-use vaults only)

Table 5 BillingCreate

Parameter

Mandatory

Type

Description

cloud_type

No

String

Cloud type, which can be public or hybrid

consistent_level

Yes

String

Vault specification, which can be crash_consistent (crash consistent backup) or app_consistent (application consistency backup)

object_type

Yes

String

Object type, which can be server, disk, turbo, workspace, vmware, rds, or file

protect_type

Yes

String

Protection type, which can be backup or replication

size

Yes

Integer

Capacity, in GB

Minimum: 10

Maximum: 10485760

charging_mode

No

String

Billing mode, which can be post_paid (pay-per-use) or pre_paid (yearly/monthly). The default value is post_paid.

Default: post_paid

period_type

No

String

Package type. This parameter is mandatory if charging_mode is set to pre_paid. Possible values are year (yearly) or month (monthly).

Enumeration values:

  • year

  • month

period_num

No

Integer

Required duration for the package. This parameter is mandatory if charging_mode is set to pre_paid.

is_auto_renew

No

Boolean

Whether to automatically renew the subscription after expiration. By default, it is not renewed.

Default: false

is_auto_pay

No

Boolean

Whether the fee is automatically deducted from the customer's account balance after an order is submitted. The non-automatic payment mode is used by default.

Default: false

console_url

No

String

Redirection URL

Minimum: 1

Maximum: 255

is_multi_az

No

Boolean

Multi-AZ attribute of a vault. The default value is false.

Default: false

Table 6 ResourceCreate

Parameter

Mandatory

Type

Description

extra_info

No

ResourceExtraInfo object

Extra information of the resource

id

Yes

String

ID of the resource to be backed up

type

Yes

String

Type of the resource to be backed up, which can be OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, or OS::Workspace::DesktopV2

name

No

String

Backup name

Minimum: 0

Maximum: 255

Table 7 ResourceExtraInfo

Parameter

Mandatory

Type

Description

exclude_volumes

No

Array of strings

IDs of the disks that will not be backed up. This parameter is used when servers are added to a vault, which include all server disks. But some disks do not need to be backed up. Or in case that a server was previously added and some disks on this server do not need to be backed up.

Table 8 Tag

Parameter

Mandatory

Type

Description

key

Yes

String

Key

It can contain a maximum of 36 characters.

It cannot be an empty string.

Spaces before and after a key will be discarded.

It cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

It can contain only letters, digits, hyphens (-), and underscores (_).

value

Yes

String

Value

It is mandatory when a tag is added and optional when a tag is deleted.

It can contain a maximum of 43 characters.

It can be an empty string.

Spaces before and after a value will be discarded.

It cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

It can contain only letters, digits, hyphens (-), underscores (_), and periods (.).

Table 9 VaultBindRules

Parameter

Mandatory

Type

Description

tags

No

Array of BindRulesTags objects

Filters automatically associated resources by tag.

Minimum length: 0 characters

Maximum length: 5 characters

Array Length: 0 - 5

Table 10 BindRulesTags

Parameter

Mandatory

Type

Description

key

Yes

String

The key cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

The key can contain only letters, digits, hyphens (-), and underscores (_).

value

Yes

String

The value cannot contain non-printable ASCII characters (0–31) and the following characters: =*<>,|/

The value can contain only letters, digits, periods (.), hyphens (-), and underscores (_).

Table 11 VaultCreateParameters

Parameter

Mandatory

Type

Description

combined_order

No

CombinedOrder object

Combined order

Table 12 CombinedOrder

Parameter

Mandatory

Type

Description

combined_order_id

No

String

Combined order ID

combined_order_ecs_num

No

Integer

Number of ECSs in the combined order. Maximum ECSs allowed in the current batch: 500

Minimum value: 1

Maximum value: 1000

Minimum: 1

Maximum: 1000

combined_order_num

No

Integer

Number of combined orders

Minimum value: 1

Maximum value: 1000

Minimum: 1

Maximum: 1000

Response Parameters

Status code: 200

Table 13 Response body parameters

Parameter

Type

Description

orders

Array of CbcOrderResult objects

Order details

retCode

Integer

Result code 0: success

errText

String

Creation results

error_code

String

Error code 0: no error

Table 14 CbcOrderResult

Parameter

Type

Description

cloudServiceId

String

Cloud service ID

orderId

String

Order ID

subscribeResult

Integer

Subscription result. 1: succeeded; 0: Failed

resourceId

String

ID of a pre-generated yearly/monthly resource

Status code: 400

Table 15 Response body parameters

Parameter

Type

Description

error_code

String

For details, see Error Codes.

error_msg

String

Error message

Example Requests

  • Creating an 80-GB yearly/monthly server backup vault, setting the duration to 1 month, and associating a resource with the vault

    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"
        } ]
      }
    }
  • Creating an 80-GB yearly/monthly server backup vault using the combined purchase (allowing up to 5 servers in an order), setting the duration to 1 month, associating a resource, and adding tags

    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" ]
          }
        } ]
      }
    }

Example Responses

Status code: 200

OK

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

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback