DeleteStopGateway - Database Autonomy Service - Alibaba Cloud Documentation Center

Deletes the metadata of a stopped database gateway.

Operation description

Call this API to delete metadata for inactive database gateway instances that were created during stress testing created by the CreateCloudBenchTasks operation.

When you use an SDK to call the DAS service, you must specify the region as cn-shanghai.

Note

A database gateway is considered "stopped" if it has not sent a heartbeat to the DAS service for more than 20 seconds.

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 support 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

hdm:DeleteStopGateway

delete

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The unique ID of the database gateway. Note: You can get this ID from the `ClientGatewayId` field in the response of the DescribeCloudbenchTask API.	22938c83fcfbced4b4869b9695e3****

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The returned status code.	200
Message	string	The returned message. Note When the request is successful, this parameter returns Successful. When the request fails, this parameter returns exception information such as error codes.	Successful
Data	string	The status code indicating the result of the deletion: 0: Success. The metadata was deleted. -1: A system error occurred. -2: The specified database gateway does not exist. -3: The database gateway is still active (not stopped) and its metadata cannot be deleted. -4: Failed to delete the metadata.	0
RequestId	string	The request ID.	FC6C0929-29E1-59FD-8DFE-70D9D41E****
Success	string	Indicates whether the request was successful: true: The operation is successful. false: The operation failed.	true

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.