接口介绍
通过接口创建一个存储库
接口约束
1、单个用户单个资源池默认最大可以创建10个存储库,可以通过工单申请调整到20个
2、只支持包周期模式
3、单个资源池下的存储库名称不能重复
4、需要先开通云备份服务
5、存储库名称,只能由数字、字母、-组成,不能以数字和-开头、且不能以-结尾
URI
POST /v4/backup/create-storage-backup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 否 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一。 | 参考请求示例 | |
regionID | 是 | String | 资源池ID, 例: 100054c0416811e9a6690242ac110002 | 参考请求示例 | |
backupStorageName | 是 | String | 存储库名称,只能由数字、字母、-组成,不能以数字和-开头、且不能以-结尾 | 参考请求示例 | |
backupStorageCapacity | 是 | Interger | 存储库容量,100-1024000,单位 GB | 参考请求示例 | |
cycleType | 是 | String | 包周期类型,year/month。 | 参考请求示例 | |
cycleCount | 是 | Integer | 包周期数。月[1-11],年[1-3] | 参考请求示例 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回状态码(800为成功,900为处理中/失败,详见errorCode) | 参考响应示例 | |
message | 是 | String | 失败时的错误描述,一般为英文描述 | 参考响应示例 | |
description | 是 | String | 失败时的错误描述,一般为中文描述 | 参考响应示例 | |
returnObj | 是 | Object | 参考表returnObj | 参考表returnObj | |
errorCode | 是 | String | 业务细分码,为product.module.code三段式码 | 参考状态码 |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
masterOrderID | 是 | String | 订单ID | 参考响应示例 | |
masterResourceStatus | 是 | String | 主资源状态。只有主订单资源会返回 | 参考响应示例 | |
masterOrderNo | 是 | String | 订单编号 | 参考响应示例 | |
regionID | 是 | String | 资源所属资源池ID | 参考响应示例 | |
resources | 是 | Array of Objects | 资源明细列表,参考表resources | 参考表resources |
表 resources
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
backupStorageID | 是 | String | 存储库ID | 参考响应示例 | |
isMaster | 是 | Boolean | 是否是主资源项 | 参考响应示例 | |
backupStorageCapacity | 是 | Integer | 存储库容量,单位GB | 参考响应示例 | |
resourceType | 是 | String | 资源类型 | 参考响应示例 | |
backupStorageName | 是 | String | 存储库名称 | 参考响应示例 | |
createTime | 是 | Integer | 创建时间,epoch时戳,毫秒精度 | 参考响应示例 | |
updateTime | 是 | Integer | 更新时间,epoch时戳,毫秒精度 | 参考响应示例 |
表 errorDetail
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
bssErrCode | 是 | String | bss错误明细码,包含于bss格式化JSON错误信息中 | 参考状态码 | |
bssErrMsg | 是 | String | bss错误信息,包含于bss格式化JSON错误信息中 | 参考状态码 | |
bssOrigErr | 是 | String | 无法明确解码bss错误信息时,原样透出的bss错误信息 | 参考状态码 | |
bssErrPrefixHint | 是 | String | bss格式化JSON错误信息的前置提示信息 | 参考状态码 |
请求示例
请求头header
无
请求体body
{
"clientToken": "storage-1",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"backupStorageName": "st001",
"backupStorageCapacity": 300,
"cycleType": "month",
"cycleCount": 6
}
响应示例
订单处理中:
{
{
"description": "订单处理中,可使用订单ID查询或使用原clientToken重试下单",
"returnObj": {
"masterOrderNO": "20221129142256886927",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "42d5cf746fae11ed98d30242ac11000b"
},
"errorCode": "ebs.order.inProgress",
"message": "order in progress",
"statusCode": 900
}
}
用重复的clientToken和相同参数继续执行,创建成功后会返回:
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"resources": [
{
"backupStorageID": "770fb5e7-7f84-423c-9dd4-2eaf7912d5bc",
"isMaster": true,
"backupStorageCapacity": 300,
"resourceType": "CBR",
"backupStorageName": "st001",
"createTime": 1660295761000,
"expireTime": 1660295799000,
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考状态码