接口功能介绍
退订云主机备份存储库
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1. 使用限制,本接口只支持在拉萨3、上海7、广州6、郴州2、长沙3、北京5、内蒙6、南京3、重庆2、合肥2、成都4、晋中、昆明2、乌鲁木齐27、福州25、衡阳3、长沙37、张家界2、华北2、央企北京1、华东1、上海32、上海33、上海36资源池进行公测
2. 退订仅支持购买七天内的存储库,且存储库内不可含有备份
URI
POST /v4/ecs/backup-repo/delete
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
repositoryID | 是 | String | 云主机备份存储库ID,您可以查看产品定义-存储库来了解存储库 获取: 查 查询存储库列表 创 创建存储库 |
829e9ef0-7805-492d-988f-de4b4e705339 | |
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,则代表为同一个请求。保留时间为24小时 | 4cf2962d-e92c-4c00-9181-cfbb2218636c |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
masterOrderNO | String | 订单号 | 20221010142913884246 | |
regionID | String | 资源池ID | bb9fdb42056f11eda1610242ac110002 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:在华东1资源池退订一个云主机备份存储库
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"clientToken": "delete3001",
"repositoryID": "829e9ef0-7805-492d-988f-de4b4e705339"
}
响应示例
{
"returnObj": {
"regionID": "bb9fdb42056f11eda1610242ac110002",
"masterOrderID": "107e901c449611ed8b6a0242ac110002",
"masterOrderNO": "20221009163836430197"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码