Use DeleteGateway API to Remove a Pay-As-You-Go Gateway - Cloud Storage Gateway - Alibaba Cloud - Cloud Storage Gateway

Operation description

Usage notes

Before 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 only when it is in one of the following states: Initialized, Activated, Running, Unknown, Failed, or Stopped.
If you deleted a gateway in the CSG console but it still appears in the Resource Management console, this may be caused by cached information or synchronization delays. Wait a moment for the system to update the status automatically. If the status does not update after a while, refresh the page or wait for the system to synchronize.

Warning Deleting a gateway interrupts business activities and data synchronization tasks. Proceed with caution.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hcs-sgw:DeleteGateway

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The gateway ID.	gw-0001xv7je3580031****
ReasonType	string	No	The reason for deleting the gateway. Valid values: REASON1: The gateway fee is too high. REASON2: The gateway is used for testing only and is no longer needed now. REASON3: The gateway feature or performance does not meet the business requirements. REASON4: The new features are highly anticipated.	REASON2
ReasonDetail	string	No	The detailed reason for deleting the gateway.	"网关测试需要，不再使用"

Response elements

Element	Type	Description	Example
	object
TaskId	string	The task ID.	t-0000iwdggbhaordh****
Message	string	The response message.	successful
RequestId	string	The request ID.	151BB31D-571D-4BB9-9A02-D4210E5B****
Code	string	The HTTP status code. A value of 200 indicates that the request was successful.	200
Success	boolean	Indicates whether the request was successful. true false	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	EmptyGatewayId	You must enter a valid ID for the gateway.	You must enter a valid ID for the gateway.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	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.	You cannot perform the operation when the gateway is in the current state.
400	GatewayInOperation	The gateway is processing requests . Try again later.	The gateway is busy. Try again later.
400	BadRequest	Invalid request. You must specify valid parameters in the request.	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.	There are file shares or block volumes still under the gateway, please delete them first and then delete the gateway.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.