DescribeHanaDatabases - Hybrid Backup Recovery - Alibaba Cloud Documentation Center

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

Parameter	Type	Required	Description	Example
VaultId	string	No	The ID of the backup vault.	v-00063fq******8xjr
ClusterId	string	Yes	The ID of the SAP HANA instance.	cl-000hpc******uv14x
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.	10
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmw2azsegupmi

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
Code	string	The HTTP status code. The status code 200 indicates that the call is successful.	200
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
PageNumber	integer	The page number of the returned page. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries to return on each page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	long	The total number of returned entries.	10
HanaDatabases	array	The information about SAP HANA databases.
	object	The information about SAP HANA databases.
Host	string	The hostname.	izbp1jbf3zy******antqmz
SqlPort	integer	The port number.	30013
DatabaseName	string	The name of the database.	SYSTEMDB
ServiceName	string	The name of the service.	indexserver
ActiveStatus	string	Indicates whether the database is started. Valid values: YES: The database is started. NO: The database is not started.	YES
Detail	string	The detailed information.	master

Examples

Sample success responses

JSONformat

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

Error codes

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