All Products
Search
Document Center

Cloud Backup:DescribeHanaBackupPlans

Last Updated:Dec 19, 2024

Queries one or more SAP HANA backup plans that meet the specified conditions.

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:DescribeHanaBackupPlansget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
VaultIdstringNo

The ID of the backup vault.

v-000i4lg4kz******ahl
ClusterIdstringYes

The ID of the SAP HANA instance.

cl-000chxz******lz7bk
PageNumberintegerNo

The page number. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Valid values: 1 to 99. Default value: 10.

10
DatabaseNamestringNo

The database name.

SYSTEMDB
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmvywqfey5njq

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
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
PageNumberinteger

The page number. Pages start from page 1. Default value: 1.

1
PageSizeinteger

The number of entries per page. Valid values: 1 to 99. Default value: 10.

10
TotalCountlong

The total number of entries returned.

6
HanaBackupPlansarray<object>

The details of the backup plan.

HanaBackupPlanobject

The details of the backup plan.

VaultIdstring

The ID of the backup vault.

v-000csihw82pqkd7hcjws
BackupPrefixstring

The backup prefix.

COMPLETE_DATA_BACKUP
Schedulestring

The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D indicates that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.

  • startTime: the time at which the system starts to run a backup job. The time follows the UNIX time format. Unit: seconds.
  • interval: the interval at which the system runs a backup job. The interval follows the ISO 8601 standard. For example, PT1H indicates an interval of 1 hour. P1D indicates an interval of one day.
I|1602673264|P1D
DatabaseNamestring

The database name.

SYSTEMDB
BackupTypestring

The backup type. Valid values:

  • COMPLETE: full backup
  • INCREMENTAL: incremental backup
  • DIFFERENTIAL: differential backup
COMPLETE
Disabledboolean

Indicates whether the backup plan is disabled. Valid values:

  • true: The backup plan is disabled.
  • false: The backup plan is enabled.
false
PlanIdstring

The ID of the backup plan.

pl-0000tnyndg3ne5m4ubeu
ClusterIdstring

The ID of the SAP HANA instance.

cl-0002scknka*****
PlanNamestring

The name of the backup plan.

plan-20220118-141153

Examples

Sample success responses

JSONformat

{
  "RequestId": "F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 6,
  "HanaBackupPlans": {
    "HanaBackupPlan": [
      {
        "VaultId": "v-000csihw82pqkd7hcjws",
        "BackupPrefix": "COMPLETE_DATA_BACKUP",
        "Schedule": "I|1602673264|P1D",
        "DatabaseName": "SYSTEMDB",
        "BackupType": "COMPLETE",
        "Disabled": false,
        "PlanId": "pl-0000tnyndg3ne5m4ubeu",
        "ClusterId": "cl-0002scknka*****",
        "PlanName": "plan-20220118-141153"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-30The internal configuration of the API is changed, but the call is not affectedView Change Details