接口功能介绍
创建云主机备份存储库。
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
计费模式:确认云主机备份存储库的计费模式,详细查看计费模式
注意事项:
代金券:只支持预付费用户抵扣包周期资源的金额,且不可超过包周期资源的金额
接口约束
1.仅支持创建包年包月的存储库
2.使用限制,本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
3.云主机备份存储库容量为100GB-10240GB
4.仅支持升级云主机备份存储库容量
5.不支持批量创建存储库
URI
POST /v4/ecs/backup-repo/create
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
projectID | 否 | String | 企业项目ID,企业项目管理服务提供统一的云资源按企业项目管理,以及企业项目内的资源管理,成员管理。您可以通过查看创建企业项目了解如何创建企业项目 注:默认值为"0" |
0 | |
repositoryName | 是 | String | 云主机备份存储库名称,满足以下规则:长度为2-63字符,头尾不支持输入空格 | repo-test | |
cycleCount | 是 | Integer | 订购时长,该参数需要与cycleType一同使用 注:最长订购周期为60个月(5年) |
6 | |
cycleType | 是 | String | 订购周期类型,取值范围: MONTH:按月 YEAR:按年 最长订购周期为5年 |
MONTH | |
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c | |
size | 否 | Integer | 云主机备份存储库容量,单位GB,取值范围:[100-1024000],默认值100 | 100 | |
autoRenewStatus | 否 | Integer | 是否自动续订,取值范围: 0(不续费), 1(自动续费), 注:按月购买,自动续订周期为1个月;按年购买,自动续订周期为1年 |
1 | |
payVoucherPrice | 否 | Float | 代金券,满足以下规则:两位小数,不足两位自动补0,超过两位小数无效;不可为负数; 注:字段为0时表示不使用代金券,默认不使用代金券。 |
20.55 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败)。 | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误描述,一般为英文描述 | SUCCESS | |
description | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回参数 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 主订单ID。调用方在拿到masterOrderID之后,可以使用materOrderID进一步确认订单状态及资源状态 | 2dcbb4eca35011ed979b0242ac110002 | |
masterOrderNO | String | 订单号 | 20230205172651675969 | |
regionID | String | 资源池ID | bb9fdb42056f11eda1610242ac110002 | |
masterResourceID | String | 订单主资源ID | 8adb4810aa8842efa1f2693537ae181c |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:在华东1资源池订购一个月容量为100GB的云主机备份存储库
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"projectID": "0",
"repositoryName": "cbr-test-001",
"size": 100,
"clientToken": "sqlkjsdajdsal",
"cycleCount": 1,
"cycleType": "MONTH"
}
响应示例
{
"returnObj": {
"masterResourceID": "8adb4810aa8842efa1f2693537ae181c",
"masterOrderNO": "20230205172651675969",
"regionID": "bb9fdb42056f11eda1610242ac110002",
"masterOrderID": "2dcbb4eca35011ed979b0242ac110002"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码