接口介绍
支持续订存储库
接口约束
1、续订时长范围1-11个月,1-3年
URI
POST /v4/backup/renew-storage-backup
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 否 | String | 客户端存根,用于保证订单幂等性。 要求单个云平台账户内唯一。 |
参考请求示例 | |
backupStorageID | 是 | String | 存储库ID | 参考请求示例 | |
regionID | 是 | String | 资源池ID | 参考请求示例 | |
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。调用方在拿到masterOrderID之后, 在若干错误情况下,可以使用masterOrderID进一步确认订单状态及资源状态。 |
参考响应示例 | |
masterOrderNO | 是 | String | 订单号 | 参考响应示例 |
请求示例
请求头header
无
请求体body
{
"clientToken": "storage-4",
"backupStorageID": "770fb5e7-7f84-423c-9dd4-2eaf7912d5bc",
"regionID": "41f64827f25f468595ffa3a5deb5d15d",
"cycleType": "month",
"cycleCount": 2
}
响应示例
订单处理中:
{
{
"description": "订单处理中,可使用订单ID查询或使用原clientToken重试下单",
"returnObj": {
"masterOrderNO": "20220812171600203284",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2"
},
"errorCode": "ebs.order.inProgress",
"message": "order in progress",
"statusCode": 900
}
}
用重复的clientToken和相同参数继续执行,创建成功后会返回:
{
"returnObj": {
"masterOrderID": "beacf51a20dd4889bfc99877d89e03e2",
"masterOrderNO": "20220812171600203284"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
状态码 | 描述 |
---|---|
800 | 表示请求成功。 |
错误码
请参考状态码