Deletes a pay-as-you-go gateway from its cluster.
Operation description
Usage notes
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.
- If you have deleted a gateway using the CSG console, but it still appears in the Resource Management console, this may be due to cached information or synchronization delays. Wait a moment for the system to automatically update the status. If it does not update after an extended period, try refreshing the page or allow the system to synchronize automatically.
Warning Deleting a gateway will interrupt business activities and data synchronization tasks. Exercise caution when performing this action.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| hcs-sgw:DeleteGateway | delete | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| GatewayId | string | Yes | The gateway ID. | gw-0001xv7je3580031y*** |
| ReasonType | string | No | The type of the reason why you want to delete the gateway. Valid values:
| REASON2 |
| ReasonDetail | string | No | The detailed reason why you want to delete the gateway. | "" |
Response parameters
Examples
Sample success responses
JSONformat
{
"TaskId": "t-0000iwdggbhaordhk***",
"Message": "successful",
"RequestId": "151BB31D-571D-4BB9-9A02-D4210E5BF5DB",
"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. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|
No change history