接口功能介绍
删除指定的某个网关资源以及该网关下已过期的缓存盘资源
接口约束
1、删除网关的前提是已创建网关资源
2、删除已创建的网关会将该网关及其挂载的已过期的缓存盘一并删除
3、该网关下存在缓存盘处于中间状态(部署中、删除中)时,无法进行网关删除
4、该网关下存在至少一个未过期的缓存盘,无法进行网关删除
URI
POST /v4/nfs/delete-nfs-gateway
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 参考请求示例 | |
gatewayID | 是 | String | 网关的ID | 参考请求示例 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为处理中/失败) | 800 | |
message | String | 状态描述 | SUCCESS | |
description | String | 状态描述,一般为中文 | 成功 | |
returnObj | Object | 响应对象 | 参考表returnObj | |
error | String | 业务细分码(仅失败时具有此参数),为product.module.code三段式码大驼峰形式 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderNO | String | 订单号 | 参考响应示例 | |
regionID | String | 资源池ID | 参考响应示例 | |
masterOrderID | String | 订单ID,调用方在拿到masterOrderID之后,在若干错误情况下,可以使用 materOrderID 进一步确认订单状态及资源状态 | 参考响应示例 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"gatewayID":"fc4df18e-c4d0-11ee-ae9f-18022d1723b2",
"regionID": "81f7728662dd11ec810800155d307d5b",
}
响应示例
{
"returnObj":{
"masterOrderNO":"20240206171653517198",
"regionID":"81f7728662dd11ec810800155d307d5b",
"masterOrderID":"e15f25a5ec3b4dbc88fbbe6e43870c56"
},
"details":"",
"message":"success",
"description":"成功",
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码