All Products
Search

This Product

    Cloud Backup:CreateHanaInstance

    Document Center

    Cloud Backup:CreateHanaInstance

    Last Updated:Aug 28, 2026

    Registers an SAP HANA instance.

    Operation description

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

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hbr:CreateHanaInstance

    create

    *All Resource

    *

    		 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 used to connect to the SAP HANA database.

    ************
    UseSsl

    boolean

    No

    Whether to connect to the SAP HANA database over Secure Sockets Layer (SSL).

    true
    ValidateCertificate

    boolean

    No

    Whether to verify the SSL certificate of the SAP HANA database.

    false
    AlertSetting

    string

    No

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

    INHERITED
    EcsInstanceId

    string

    No

    The IDs of the ECS instances that host the SAP HANA instance. Cloud Backup installs backup clients on these 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

    integer

    No

    The ID of the source Alibaba Cloud account that authorizes the current account for cross-account backup.

    158975xxxxx4625
    CrossAccountRoleName

    string

    No

    The name of the Resource Access Management (RAM) role created within the source Alibaba Cloud account and assigned to the current account for cross-account backup.

    hbrcrossrole

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The response code. Status code 200 indicates success.

    200
    Message

    string

    The returned message. Returns "successful" for successful requests, or an error message for failed requests.

    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

    Success response

    JSON format

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "EB526A5D-1FE2-51C1-B790-1732C1DBA969",
  "Success": true,
  "ClusterId": "cl-000dp1sz******6hn"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.