All Products
Search
Document Center

DescribeHanaDatabases

Last Updated: Aug 09, 2022

Queries the information about SAP HANA databases.

Operation Description

After you register an SAP HANA instance and install a backup client on the instance, you can call this operation to query the information about SAP HANA databases. You can call the StartHanaDatabaseAsync operation to start a database and call the StopHanaDatabaseAsync operation to stop a database.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-00063fq******8xjr
ClusterIdstringYes

The ID of the SAP HANA instance.

cl-000hpc******uv14x
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.

10
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmw2azsegupmi

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2
Successboolean

Indicates whether the call is successful. Valid values:

  • true: The call is successful.
  • false: The call fails.
true
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
PageNumberinteger

The page number of the returned page. Pages start from page 1. Default value: 1.

1
PageSizeinteger

The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.

10
TotalCountLong

The total number of returned entries.

10
HanaDatabasesarray

The information about SAP HANA databases.

object

The information about SAP HANA databases.

Hoststring

The hostname.

izbp1jbf3zy******antqmz
SqlPortinteger

The port number.

30013
DatabaseNamestring

The name of the database.

SYSTEMDB
ServiceNamestring

The name of the service.

indexserver
ActiveStatusstring

Indicates whether the database is started. Valid values:

  • YES: The database is started.
  • NO: The database is not started.
YES
Detailstring

The detailed information.

master

Example

Request example

http(s)://[Endpoint]/?Action=DescribeHanaDatabases
&VaultId=v-00063fq******8xjr
&ClusterId=cl-000hpc******uv14x
&PageNumber=1
&PageSize=10
&ResourceGroupId=rg-acfmw2azsegupmi
&Common request parameters

Normal return example

JSONFormat

{
  "RequestId": "DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10,
  "HanaDatabases": [
    {
      "Host": "izbp1jbf3zy******antqmz",
      "SqlPort": 30013,
      "DatabaseName": "SYSTEMDB",
      "ServiceName": "indexserver",
      "ActiveStatus": "YES",
      "Detail": "master"
    }
  ]
}

Error codes

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