DeleteGateway - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Deletes a pay-as-you-go gateway from a cluster.

Usage notes

When you call this operation, take note of the following items:

You can delete only a pay-as-you-go gateway.
You can delete a gateway that is only in the Initialized, Activated, Running, Unknown, Failed, or Stopped state.

Warning

Calling this operation will interrupt business activities and data synchronization tasks. Exercise caution when performing this action.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DeleteGateway	The operation that you want to perform. Set the value to DeleteGateway.
GatewayId	String	Yes	gw-0001xv7je3580031y***	The ID of the gateway that you want to delete.
ReasonType	String	No	REASON2	The type of the reason why you want to delete the gateway.
ReasonDetail	String	No	""	The detailed reason why you want to delete the gateway.

Response parameters

Parameter	Type	Example	Description
TaskId	String	t-0000iwdggbhaordhk***	The ID of the task.
Message	String	successful	The description of the request result.
RequestId	String	151BB31D-571D-4BB9-9A02-D4210E5BF5DB	The ID of the request.
Code	String	200	The HTTP status code returned. A value of 200 indicates that the request was successful.
Success	Boolean	true	Indicates whether the request was successful.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeleteGateway
&GatewayId=gw-0001xv7je3580031y***
&<Common request parameters>

Sample success response

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteGatewayResponse>
		<TaskId>t-0000iwdggbhaordhk***</TaskId>
		<RequestId>151BB31D-571D-4BB9-9A02-D4210E5BF5DB</RequestId>
		<Message>successful</Message>
		<Code>200</Code>
		<Success>true</Success>
 </DeleteGatewayResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode	Error code	Error message	Description
400	EmptyGatewayId	You must enter a valid ID for the gateway.	The error message returned because no gateway ID is specified.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The error message returned because the specified gateway does not exist. Check whether the parameters are valid.
400	GatewayOperationNotAllowed	You cannot perform the operation when the gateway is in the current state.	The error message returned because the operation is not supported while the gateway is in the current state.
400	GatewayInOperation	The gateway is processing requests . Try again later.	The error message returned because another operation is in progress. Try again later.
400	BadRequest	Invalid request. You must specify valid parameters in the request.	The error message returned because the request is invalid. Check the request parameters and try again.

For a list of error codes, see Service error codes.