DeleteGateway - 删除网关

更新时间:
复制 MD 格式

从所属集群上删除一个按量付费的网关。

接口说明

接口说明

调用该接口时,您需要注意:

  • 仅支持删除按量付费的网关,即后付费网关。

  • 仅支持删除状态为已初始化(Initialized)、已激活(Activated)、运行中(Running)、未知状态(Unknown)、失败(Failed)、停止(Stopped)的网关。

  • 如果您已在云存储网关控制台删除实例,但资源管理控制台仍显示该实例,这可能是缓存信息或同步延迟引起的。请稍等片刻,系统将自动更新状态。若长时间未更新,您可尝试刷新页面或等待系统自动同步。

警告 删除网关会导致您的业务和数据同步中断,请谨慎操作。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:DeleteGateway

delete

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

GatewayId

string

是

网关 ID。

gw-0001xv7je3580031****

ReasonType

string

否

删除网关的原因,可能值如下:

  • REASON1:网关费用太高。

  • REASON2:网关测试需要,不再使用。

  • REASON3:网关特性或性能不满足业务需求。

  • REASON4:最希望网关新增功能。

REASON2

ReasonDetail

string

否

删除网关的详细原因。

Gateway testing completed, no longer needed

返回参数

名称

类型

描述

示例值

object

TaskId

string

任务 ID。

t-0000iwdggbhaordh****

Message

string

请求结果描述。

successful

RequestId

string

请求 ID。

151BB31D-571D-4BB9-9A02-D4210E5B****

Code

string

状态码。状态码为 200 表示请求成功。

200

Success

boolean

请求是否成功。可取值如下:

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

{
  "TaskId": "t-0000iwdggbhaordh****",
  "Message": "successful",
  "RequestId": "151BB31D-571D-4BB9-9A02-D4210E5B****",
  "Code": "200",
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 EmptyGatewayId You must enter a valid ID for the gateway. 网关ID不能为空。
400 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. 网关不存在,请确认输入参数是否正确。
400 GatewayOperationNotAllowed You cannot perform the operation when the gateway is in the current state. 网关当前状态不允许执行该操作。
400 GatewayInOperation The gateway is processing requests . Try again later. 网关正在进行操作中,请稍后再试。
400 BadRequest Invalid request. You must specify valid parameters in the request.  非法请求,请检查请求参数。
400 GatewayNotEmpty There are file shares or block volumes still under the gateway, please delete them first and then delete the gateway. 该网关仍存在共享或块卷,请先删除该网关下所有共享或块卷后再删除网关。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。