All Products
Search

This Product

    Cloud Backup:CreateHanaInstance

    Document Center

    Cloud Backup:CreateHanaInstance

    Last Updated:Dec 17, 2024

    Registers an SAP HANA instance.

    Operation description

    To register an SAP HANA instance, you must configure the SAP HANA connection information. After the SAP HANA instance is registered, Cloud Backup installs a backup client on the node of the SAP HANA instance.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    hbr:CreateHanaInstancecreate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    VaultIdstringYes

    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 Cloud Backup client sends alert notifications by using the same method configured for the backup vault.

    		INHERITED
    EcsInstanceIdstringNo

    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\"]
    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
    CrossAccountTypestringNo

    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
    CrossAccountUserIdlongNo

    The ID of the source Alibaba Cloud account that authorizes the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.

    		158975xxxxx4625
    CrossAccountRoleNamestringNo

    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

    ParameterTypeDescriptionExample
    object
    Codestring

    The response code. The status code 200 indicates that the request was successful.

    		200
    Messagestring

    The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.

    		successful
    RequestIdstring

    The request ID.

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

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true
    ClusterIdstring

    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 timeSummary of changesOperation
    2024-05-22The request parameters of the API has changedView Change Details