All Products
Search
Document Center

Hybrid Backup Recovery:CreateHanaInstance

Last Updated:Nov 14, 2022

Registers an SAP HANA instance.

Operation Description

To register an SAP HANA instance, you must configure the connection parameters of the SAP HANA instance. After the SAP HANA instance is registered, HBR installs an HBR client on the ECS instance that hosts the SAP HANA instance.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-0003v4a******gfv2
HanaNamestringNo

The name of the SAP HANA instance.

HANA-DEV
HoststringNo

The private or internal IP address of the host where the primary node of the SAP HANA instance resides.

47.100.XX.XX
InstanceNumberintegerNo

The instance number of the SAP HANA system.

00
UserNamestringNo

The username of the SYSTEMDB database.

admin
PasswordstringNo

The password that is used to connect with the SAP HANA database.

************
UseSslbooleanNo

Specifies whether to connect with the SAP HANA database over Secure Sockets Layer (SSL).

true
ValidateCertificatebooleanNo

Specifies whether to verify the SSL certificate of the SAP HANA database.

false
AlertSettingstringNo

The alert settings. Valid value: INHERITED, which indicates that the backup client sends alert notifications in the same way as the backup vault.

INHERITED
EcsInstanceIdstringNo

The IDs of ECS instances that host the SAP HANA instance to be registered. HBR installs backup clients on the specified ECS instances.

[\"i-uf6ir9y******hvisj\"]
SidstringNo

The security identifier (SID) of the SAP HANA database.

For more information, see How to find sid user and instance number of HANA db?

HXE
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfm4ebtpkzx7zy

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.

EB526A5D-1FE2-51C1-B790-1732C1DBA969
Successboolean

Indicates whether the call is successful. Valid values:

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

The ID of the SAP HANA instance.

cl-000dp1sz******6hn

Example

Request example

http(s)://[Endpoint]/?Action=CreateHanaInstance
&VaultId=v-0003v4a******gfv2
&HanaName=HANA-DEV
&Host=47.100.XX.XX
&InstanceNumber=0
&UserName=admin
&Password=************
&UseSsl=true
&ValidateCertificate=false
&AlertSetting=INHERITED
&EcsInstanceId=[\"i-uf6ir9y******hvisj\"]
&Sid=HXE
&ResourceGroupId=rg-acfm4ebtpkzx7zy
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "EB526A5D-1FE2-51C1-B790-1732C1DBA969",
  "Success": true,
  "ClusterId": "cl-000dp1sz******6hn"
}

Error codes

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