All Products
Search
Document Center

Hybrid Backup Recovery:UpdateHanaInstance

Last Updated:Nov 14, 2022

Updates an 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-0003v4ah******9xp
ClusterIdstringNo

The ID of the SAP HANA instance.

cl-000axjt******c6j8
HanaNamestringNo

The name of the SAP HANA instance.

SAP-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
InstanceNumberintegerYes

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.

**********
UseSslbooleanYes

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

  • true: The SAP HANA database is connected over SSL.
  • false: The SAP HANA database is not connected over SSL.
true
ValidateCertificatebooleanYes

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

  • true: The SSL certificate of the SAP HANA instance is verified.
  • false: The SSL certificate of the SAP HANA instance is not verified.
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
ResourceGroupIdstringNo

The ID of the resource group.

rg-aekzvx7d3c4kpny

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code. The status code 200 indicates that the call was 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.

A6AB6D5A-9D21-5529-9335-A894FB045ED6
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=UpdateHanaInstance
&VaultId=v-0003v4ah******9xp
&ClusterId=cl-000axjt******c6j8
&HanaName=SAP-HANA-DEV
&Host=47.100.XX.XX
&InstanceNumber=0
&UserName=admin
&Password=**********
&UseSsl=true
&ValidateCertificate=false
&AlertSetting=INHERITED
&ResourceGroupId=rg-aekzvx7d3c4kpny
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "A6AB6D5A-9D21-5529-9335-A894FB045ED6",
  "Success": true
}

Error codes

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