All Products
Search
Document Center

Hybrid Backup Recovery:DescribeHanaInstances

Last Updated:Nov 14, 2022

Queries one or more SAP HANA instances that meet the specified conditions.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-000b0ov******6zs
ClusterIdstringNo

The ID of the SAP HANA instance.

cl-0001zfc******50pr3
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
TagarrayNo

The tags of SAP HANA instance.

objectNo

The tags of SAP HANA instance.

KeystringNo

The tag key.

ace:rm:rgld
ValuestringNo

The tag value.

rg-acfmwutpyat2kwy
ResourceGroupIdstringNo

The ID of the resource group.

rg-aekz24ikcjyqjkq

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

4003DD68-3C3C-5071-B4FC-631A6C1BAC1C
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 returned on each page. Valid values: 1 to 99. Default value: 10.

10
TotalCountinteger

The total number of returned entries.

21
Hanasarray

The information about the SAP HANA instances.

object

The details of SAN HANA instance.

Statuslong

The status of the SAP HANA instance. Valid values:

  • INITIALIZING: The instance is being initialized.
  • INITIALIZED: The instance is registered.
  • INVALID_HANA_NODE: The instance is invalid.
  • INITIALIZE_FAILED: The client fails to be installed on the instance.
INITIALIZED
Hoststring

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

47.100.XX.XX
VaultIdstring

The ID of the backup vault.

v-0000s974******1hl
UseSslboolean

Indicates whether the SAP HANA instance is connected over Secure Sockets Layer (SSL). Valid values:

  • true: The SAP HANA instance is connected over SSL.
  • false: The SAP HANA instance is not connected over SSL.
true
HanaNamestring

The name of the SAP HANA instance.

HANA-DEV
InstanceNumberinteger

The instance number of the SAP HANA system.

00
ValidateCertificateboolean

Indicates whether the SSL certificate of the SAP HANA instance is verified.

false
AlertSettingstring

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

INHERITED
UserNamestring

The username of the SYSTEMDB database.

admin
StatusMessagestring

The status information.

INSTALL_CLIENT_FAILED
ClusterIdstring

The ID of the SAP HANA instance.

cl-0004cf6g6******0yd7y
Tagsarray

The tags of the SAP HANA instance.

object

The tags of SAP HANA instance.

Keystring

The tag key.

ace:rm:rgld
Valuestring

The tag value.

rg-acfmwutpyat2kwy
ResourceGroupIdstring

The ID of resource group.

rg-acfmvnf22m7itha

Example

Request example

http(s)://[Endpoint]/?Action=DescribeHanaInstances
&VaultId=v-000b0ov******6zs
&ClusterId=cl-0001zfc******50pr3
&PageNumber=1
&PageSize=10
&Tag=[{"Key":"ace:rm:rgld","Value":"rg-acfmwutpyat2kwy"}]
&ResourceGroupId=rg-aekz24ikcjyqjkq
&Common request parameters

Normal return example

JSONFormat

{
  "RequestId": "4003DD68-3C3C-5071-B4FC-631A6C1BAC1C",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 21,
  "Hanas": [
    {
      "Status": 0,
      "Host": "47.100.XX.XX",
      "VaultId": "v-0000s974******1hl",
      "UseSsl": true,
      "HanaName": "HANA-DEV",
      "InstanceNumber": 0,
      "ValidateCertificate": true,
      "AlertSetting": "INHERITED",
      "UserName": "admin",
      "StatusMessage": "INSTALL_CLIENT_FAILED",
      "ClusterId": "cl-0004cf6g6******0yd7y",
      "Tags": [
        {
          "Key": "ace:rm:rgld",
          "Value": "rg-acfmwutpyat2kwy"
        }
      ],
      "ResourceGroupId": "rg-acfmvnf22m7itha"
    }
  ]
}

Error codes

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