调用DeleteGateway接口从所属集群上删除一个按量付费的网关。
调用该接口时,您需要注意:
- 仅支持删除按量付费的网关,即后付费网关。
- 仅支持删除状态为已初始化(Initialized)、已激活(Activated)、运行中(Running)、长时间没有心跳(Unknown)、失败(Failed)、停止(Stopped)的网关。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DeleteGateway |
系统规定参数。取值:DeleteGateway。 |
GatewayId | String | 是 | gw-0001xv7je3580031y*** |
网关ID。 |
ReasonType | String | 否 | REASON2 |
删除网关的原因。 |
ReasonDetail | String | 否 | "" |
删除网关的详细原因。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
TaskId | String | t-0000iwdggbhaordhk*** |
任务ID。 |
Message | String | successful |
请求结果描述。 |
RequestId | String | 151BB31D-571D-4BB9-9A02-D4210E5BF5DB |
请求ID。 |
Code | String | 200 |
状态码。状态码为200表示请求成功。 |
Success | Boolean | true |
请求是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DeleteGateway
&GatewayId=gw-0001xv7je3580031y***
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<TaskId>t-0000iwdggbhaordhk***</TaskId>
<RequestId>151BB31D-571D-4BB9-9A02-D4210E5BF5DB</RequestId>
<Message>successful</Message>
<Code>200</Code>
<Success>true</Success>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TaskId" : "t-0000iwdggbhaordhk***",
"RequestId" : "151BB31D-571D-4BB9-9A02-D4210E5BF5DB",
"Message" : "successful",
"Code" : 200,
"Success" : true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 非法请求,请检查请求参数。 |
访问错误中心查看更多错误码。