All Products
Search
Document Center

Database Autonomy Service:DeleteStopGateway

Last Updated:Mar 03, 2024

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.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
GatewayIdstringYes

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

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code returned.

200
Messagestring

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
Datastring

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
RequestIdstring

The request ID.

FC6C0929-29E1-59FD-8DFE-70D9D41E****
Successstring

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 codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

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

Change history

Change timeSummary of changesOperation
No change history