DeleteStopGateway - Database Autonomy Service - Alibaba Cloud Documentation Center

Deletes the metadata of a stopped DBGateway.

Operation description

This operation is used to delete the metadata of a DBGateway that is released in a stress testing task created by calling the CreateCloudBenchTasks operation.
If you use an SDK to call API operations of Database Autonomy Service (DAS), you must set the region ID to cn-shanghai.

Note If the heartbeat is lost between a DBGateway and the access point for more than 20 seconds, the DBGateway is considered stopped.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is 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
hdm:DeleteStopGateway	delete	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID that can uniquely identify the DBGateway. You can obtain the DBGateway ID by calling the DescribeCloudbenchTask operation. The DBGateway ID is the value of the ClientGatewayId field in the response.	22938c83fcfbced4b4869b9695e3****

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code returned.	200
Message	string	The returned message. Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
Data	string	The result of the DeleteStopGateway operation. Valid values: 0: The metadata of the DBGateway is deleted. -1: A system error occurs. -2: The DBGateway does not exist. -3: The DBGateway is not stopped and the metadata cannot be deleted. -4: The metadata of the DBGateway fails to be deleted.	0
RequestId	string	The request ID.	FC6C0929-29E1-59FD-8DFE-70D9D41E****
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "Data": "0",
  "RequestId": "FC6C0929-29E1-59FD-8DFE-70D9D41E****",
  "Success": "true"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history