接口功能介绍
创建云硬盘备份存储库，该接口会涉及计费。
接口约束
无
URI
POST /v4/ebs-backup/repo/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 是 | String | 用于保证订单幂等性。要求单个云平台账户内唯一。使用同一个ClientToken值，其他请求参数相同时，则代表为同一个请求 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| repositoryName | 是 | String | 云硬盘备份存储库名称，长度为 2~32 个字符，只能由数字、字母、- 组成，不能以数字、- 开头，且不能以 - 结尾 | test-repo1 | |
| size | 否 | Integer | 云硬盘备份存储库容量，单位GB，取值100-1024000，默认100 | 100 | |
| cycleType | 是 | String | 本参数表示订购周期类型 ，取值范围： MONTH：按月 YEAR：按年 最长订购周期为3年 |
MONTH | |
| cycleCount | 是 | Integer | 订购时长，与cycleType配合，cycleType为Month时，单位为月，cycleType为YEAR时，单位为年 | 1 | |
| autoRenewStatus | 否 | Integer | 本参数表示是否自动续订 ，取值范围： 0：不续费 1：自动续费 默认不自动续费，如果选择自动续费： 按月购买：自动续订周期为3个月;按年购买：自动续订周期为1年 |
1 | |
| projectID | 否 | String | 企业项目ID，默认“0” | 0 |
响应参数
| 参数 | 是否必填 | 类型 | 描述 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | 是 | String | 错误信息的英文描述 | SUCCESS | |
| description | 是 | String | 错误信息的本地化描述（中文） | 成功 | |
| errorCode | 否 | String | 业务错误细分码，发生错误时返回 | 参考错误码 | |
| returnObj | 否 | Object | 成功时返回的数据，参见returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| masterOrderID | 是 | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
| masterOrderNO | 是 | String | 订单号，可根据订单号查询具体资源ID | 20221010142913884246 | |
| regionID | 是 | String | 资源所属资源池ID | 81f7728662dd11ec810800155d307d5b |
请求示例
请求头header
无
请求体body
{
"clientToken": "4cf2962d-e92c-4c00-9181-cfbb2218636c",
"regionID": "81f7728662dd11ec810800155d307d5b",
"repositoryName": "test-repo",
"size": 100,
"cycleType": "MONTH",
"cycleCount": 6,
"autoRenewStatus": 1
}
响应示例
{
"returnObj": {
"masterOrderNO": "20230116170722621567",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "2f7c845a957d11edbaba0242ac110010"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
错误码
| errorCode | 描述 |
|---|---|
| EbsBackup.RegionInfo.Empty | 查询资源池信息为空或资源池不存在，请确认资源池ID是否有效 |
| EbsBackup.RegionInfo.AccessFailed | 查询资源池失败，请重试。如果多次尝试失败，请提交工单 |
| EbsBackup.RegionInfo.DataDamaged | 查询资源池信息不符预期，请重试。如果多次尝试失败，请提交工单 |
| EbsBackup.Parameter.InvalidRepositoryName | 请求参数错误：{错误原因} |
| EbsBackup.Parameter.InvalidSize | 请求参数错误：{错误原因} |
| EbsBackup.Parameter.InvalidCycle | 请求参数错误：{错误原因} |
| EbsBackup.Parameter.InvalidCycleCount | 请求参数错误：{错误原因} |
| EbsBackup.Parameter.InvalidCycleType | 请求参数错误：{错误原因} |
| EbsBackup.Parameter.InvalidAutoRenewStatus | 请求参数错误：{错误原因} |
| EbsBackup.Parameter.InvalidRegionID | 请求参数错误：{错误原因} |
| EbsBackup.Parameter.InvalidClientToken | 请求参数错误：{错误原因} |
| EbsBackup.OrderCheck.InvalidProjectID | 企业项目不存在，请确认企业项目ID是否有效 |
| EbsBackup.OrderCheck.ProcFailed | 订单处理失败：{失败原因} |
