CreateHanaInstance - Cloud Backup - Alibaba Cloud Documentation Center

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, Cloud Backup installs a Cloud Backup client on the Elastic Compute Service (ECS) instance that hosts the SAP HANA instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
hbr:CreateHanaInstance	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
VaultId	string	Yes	The ID of the backup vault.	v-0003v4a******gfv2
HanaName	string	No	The name of the SAP HANA instance.	HANA-DEV
Host	string	No	The private or internal IP address of the host where the primary node of the SAP HANA instance resides.	47.100.XX.XX
InstanceNumber	integer	No	The instance number of the SAP HANA system.	00
UserName	string	No	The username of the SYSTEMDB database.	admin
Password	string	No	The password that is used to connect with the SAP HANA database.	************
UseSsl	boolean	No	Specifies whether to connect with the SAP HANA database over Secure Sockets Layer (SSL).	true
ValidateCertificate	boolean	No	Specifies whether to verify the SSL certificate of the SAP HANA database.	false
AlertSetting	string	No	The alert settings. Valid value: INHERITED, which indicates that the Cloud Backup client sends alert notifications by using the same method configured for the backup vault.	INHERITED
EcsInstanceId	string	No	The IDs of the ECS instances that host the SAP HANA instance to be registered. Cloud Backup installs backup clients on the specified ECS instances.	[\"i-uf6ir9y******hvisj\"]
Sid	string	No	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
ResourceGroupId	string	No	The ID of the resource group.	rg-acfm4ebtpkzx7zy
CrossAccountType	string	No	The backup type. Valid values: SELF_ACCOUNT: Data is backed up within the same Alibaba Cloud account. CROSS_ACCOUNT: Data is backed up across Alibaba Cloud accounts.	CROSS_ACCOUNT
CrossAccountUserId	long	No	The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.	158975xxxxx4625
CrossAccountRoleName	string	No	The name of the Resource Access Management (RAM) role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.	hbrcrossrole

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The response code. The status code 200 indicates that the request was successful.	200
Message	string	The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.	successful
RequestId	string	The request ID.	EB526A5D-1FE2-51C1-B790-1732C1DBA969
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
ClusterId	string	The ID of the SAP HANA instance.	cl-000dp1sz******6hn

Examples

Sample success responses

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 Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-22	The request parameters of the API has changed	View Change Details