订购存储库
更新时间 2026-04-02 15:40:59
最近更新时间: 2026-04-02 15:40:59
接口功能介绍
通过接口创建一个存储库
接口约束
1、单个用户单个资源池默认最大可以创建10个存储库,可以通过工单申请调整到20个 2、只支持包周期模式 3、单个资源池下的存储库名称不能重复 4、需要先开通云备份服务 5、存储库名称,只能由数字、字母、-组成,不能以数字和-开头、且不能以-结尾
URI
POST /v4/backup/create-storage-backup
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一 | storage-test | |
| regionID | 是 | String | 资源池ID | 41f64827f25f468595ffa3a5deb5d15d | |
| backupStorageName | 是 | String | 存储库名称,只能由数字、字母、-组成,不能以数字和-开头、且不能以-结尾 | storage-name | |
| backupStorageCapacity | 是 | Integer | 存储库容量,100-1024000,单位 GB | 100 | |
| cycleType | 是 | String | 包周期类型,year/month。 | month | |
| cycleCount | 是 | Integer | 包周期数。月[1-11],年[1-3] | 1 | |
| multiAz | 否 | Integer | 是否开启跨可用区部署,0:单AZ 1:多AZ,默认为0(目前仅支持部分资源池) | 0 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
| message | String | 成功或失败时的描述,一般为英文描述 | SUCCESS | |
| description | String | 成功或失败时的描述,一般为中文描述 | 成功 | |
| returnObj | Object | 成功时返回对象 | returnObj | |
| errorCode | String | 业务细分码,为product.module.code三段式码。 | backup.regionInfo.empty | |
| error | String | 业务细分码,为product.module.code三段式大驼峰码 | Backup.RegionInfo.Empty |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后,在若干错误情况下,可以使用masterOrderID进一步确认订单状态及资源状态 | 参考响应示例 | |
| masterResourceStatus | String | 主资源状态。只有主订单资源会返回 | 参考响应示例 | |
| masterOrderNo | String | 订单编号 | 参考响应示例 | |
| regionID | String | 资源所属资源池ID | 参考响应示例 | |
| resources | Array of Objects | 资源明细列表,参考表resources | resources |
表 resources
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| backupStorageID | String | 存储库ID | e1bc4a9b-8589-4dce-9917-9a9e4ff46e96 | |
| isMaster | Boolean | 是否是主资源项 | true | |
| backupStorageCapacity | Integer | 存储库容量,单位GB | 100 | |
| resourceType | String | 资源类型 | CT_CBR_VAULT | |
| backupStorageName | String | 存储库名称 | backupStorageName-azNEu | |
| createTime | Integer | 创建时间,epoch时戳,毫秒精度 | 1739425868000 | |
| updateTime | Integer | 更新时间,epoch时戳,毫秒精度 | 1739425877000 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"clientToken":"storage-test",
"regionID":"41f64827f25f468595ffa3a5deb5d15d",
"backupStorageName":"storage-name",
"backupStorageCapacity":300,
"cycleType":"month",
"cycleCount":6
}
响应示例
{
"httpstatus": 200,
"httpresult": {
"description": "订单处理中,可使用订单ID查询或使用原clientToken重试下单",
"returnObj": {
"masterOrderNO": "20250213135107252534",
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"masterOrderID": "84537626e9ce11efb59a7ec81208e587"
},
"errorCode": "backup.order.inProgress",
"error": "Backup.Order.InProgress",
"message": "order in progress",
"statusCode": 900
}
}
用重复的clientToken和相同参数继续执行,创建成功后会返回:
{
"httpstatus": 200,
"httpresult": {
"returnObj": {
"masterResourceStatus": "started",
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"masterOrderID": "84537626e9ce11efb59a7ec81208e587",
"resources": [
{
"isMaster": true,
"backupStorageName": "backupStorageName-azNEu",
"resourceType": "CT_CBR_VAULT",
"updateTime": 1739425877000,
"backupStorageID": "e1bc4a9b-8589-4dce-9917-9a9e4ff46e96",
"backupStorageCapacity": 100,
"createTime": 1739425868000
}
]
},
"message": "success",
"description": "成功",
"statusCode": 800
}
}
状态码
请参考 状态码
错误码
请参考 错误码