DescribeHanaInstances - Hybrid Backup Recovery - Alibaba Cloud Documentation Center

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

Parameter	Type	Required	Description	Example
VaultId	string	No	The ID of the backup vault.	v-000b0ov******6zs
ClusterId	string	No	The ID of the SAP HANA instance.	cl-0001zfc******50pr3
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
Tag	array	No	The tags of SAP HANA instance.
	object	No	The tags of SAP HANA instance.
Key	string	No	The tag key.	ace:rm:rgld
Value	string	No	The tag value.	rg-acfmwutpyat2kwy
ResourceGroupId	string	No	The ID of the resource group.	rg-aekz24ikcjyqjkq

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	4003DD68-3C3C-5071-B4FC-631A6C1BAC1C
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 returned on each page. Valid values: 1 to 99. Default value: 10.	10
TotalCount	integer	The total number of returned entries.	21
Hanas	array	The information about the SAP HANA instances.
	object	The details of SAN HANA instance.
Status	long	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
Host	string	The private or internal IP address of the host where the primary node of the SAP HANA instance resides.	47.100.XX.XX
VaultId	string	The ID of the backup vault.	v-0000s974******1hl
UseSsl	boolean	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
HanaName	string	The name of the SAP HANA instance.	HANA-DEV
InstanceNumber	integer	The instance number of the SAP HANA system.	00
ValidateCertificate	boolean	Indicates whether the SSL certificate of the SAP HANA instance is verified.	false
AlertSetting	string	The alert settings. Valid value: INHERITED, which indicates that the backup client sends alert notifications in the same way as the backup vault.	INHERITED
UserName	string	The username of the SYSTEMDB database.	admin
StatusMessage	string	The status information.	INSTALL_CLIENT_FAILED
ClusterId	string	The ID of the SAP HANA instance.	cl-0004cf6g6******0yd7y
Tags	array	The tags of the SAP HANA instance.
	object	The tags of SAP HANA instance.
Key	string	The tag key.	ace:rm:rgld
Value	string	The tag value.	rg-acfmwutpyat2kwy
ResourceGroupId	string	The ID of resource group.	rg-acfmvnf22m7itha

Examples

Sample success responses

JSONformat

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

Error codes

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