All Products
Search

This Product

    Cloud Backup:CreateHanaBackupPlan

    Document Center

    Cloud Backup:CreateHanaBackupPlan

    Last Updated:Aug 28, 2026

    Creates a backup plan for an SAP HANA instance.

    Operation description

    • A backup plan defines the data source, backup policy, and other configurations. When you execute a backup plan, a backup job is generated to record the backup progress and result. If the backup job succeeds, a backup snapshot is generated. You can use the snapshot to create a restore job.

    • You can specify only one type of data source in a backup plan.

    • A backup plan supports only one interval as a backup cycle.

    • Each backup plan supports backing up data to only one backup vault.

    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:CreateHanaBackupPlan

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    VaultId

    string

    Yes

    The ID of the backup vault.

    v-0002pcwhdn******wmi
    ClusterId

    string

    Yes

    The ID of the SAP HANA instance.

    cl-00024vyjj9******v
    PlanName

    string

    Yes

    The name of the backup plan.

    plan-20220110-113108
    Schedule

    string

    Yes

    The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at the time specified by {startTime} and subsequent jobs at the interval specified by {interval}. No backup job runs before the specified start time, and each subsequent job starts only after the previous one completes. For example, I|1631685600|P1D specifies that the first backup job runs at 14:00:00 on September 15, 2021, with subsequent jobs running once a day.

    • startTime: the time when the first backup job starts. The time follows the UNIX time format. Unit: seconds.

    • interval: the interval between backup jobs, in ISO 8601 format. For example, PT1H specifies one hour and P1D specifies one day.

    I|1602673264|P1D
    BackupType

    string

    Yes

    The backup type. Valid values:

    • COMPLETE: full backup

    • INCREMENTAL: incremental backup

    • DIFFERENTIAL: differential backup

    COMPLETE
    DatabaseName

    string

    Yes

    The name of the database.

    SYSTEMDB
    BackupPrefix

    string

    No

    The backup prefix.

    DIFF_DATA_BACKUP
    ResourceGroupId

    string

    No

    The ID of the resource group.

    rg-acfmvnf22m7itha

    Response elements

    Element

    Type

    Description

    Example

    object

    Code

    string

    The HTTP status code. The value 200 indicates success.

    200
    Message

    string

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

    successful
    RequestId

    string

    The request ID.

    33AA3AAE-89E1-5D3A-A51D-0C0A80850F68
    PlanId

    string

    The ID of the backup plan.

    pl-000756jdlk2zmqig2nea
    Success

    boolean

    Indicates whether the request was successful.

    • true

    • false

    true

    Examples

    Success response

    JSON format

    {
  "Code": "200",
  "Message": "successful",
  "RequestId": "33AA3AAE-89E1-5D3A-A51D-0C0A80850F68",
  "PlanId": "pl-000756jdlk2zmqig2nea",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.