All Products
Search
Document Center

Hybrid Backup Recovery:StopHanaDatabaseAsync

Last Updated:Nov 14, 2022

Stops an SAP HANA database.

Operation Description

To start the database again, call the StartHanaDatabaseAsync operation.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-0006wkn******gzkn
ClusterIdstringNo

The ID of the SAP HANA instance.

cl-000dw******45ijer
DatabaseNamestringYes

The name of the database.

BWP

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
RequestIdstring

The ID of the request.

CD8B903B-DE8F-5969-9414-B2C634D504D9
TaskIdstring

The ID of the asynchronous job. You can call the DescribeTask operation to query the execution result of the asynchronous job.

t-0007o3vqfukgd3y5bxxr
Successboolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
true

Example

Request example

http(s)://[Endpoint]/?Action=StopHanaDatabaseAsync
&VaultId=v-0006wkn******gzkn
&ClusterId=cl-000dw******45ijer
&DatabaseName=BWP
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "CD8B903B-DE8F-5969-9414-B2C634D504D9",
  "TaskId": "t-0007o3vqfukgd3y5bxxr",
  "Success": true
}

Error codes

For a list of error codes, visit the API error center.