List SAP HANA Databases Using DescribeHanaDatabases - Cloud Backup - Alibaba Cloud - Cloud Backup

Queries SAP HANA database information.

Operation description

After you register an SAP HANA instance and install a Cloud Backup client, you can call this operation to query SAP HANA database information. To start or stop a database, call the StartHanaDatabaseAsync or StopHanaDatabaseAsync operation.

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

hbr:DescribeHanaDatabases

get

*All Resource

*

None

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 page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmw2azsegupmi

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The response code. Status code 200 indicates success.	200
Message	string	The returned message. "successful" is returned for successful requests. An error message is returned for failed requests.	successful
PageNumber	integer	The page number. Pages start from page 1. Default value: 1.	1
PageSize	integer	The number of entries per page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	integer	The total number of entries returned.	10
HanaDatabases	object
HanaDatabase	array<object>	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 database name.	SYSTEMDB
ServiceName	string	The service name.	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.