DescribeHanaBackupPlans - 查询符合条件的SAP HANA备份计划

获取一个或者多个符合条件的SAP HANA备份计划。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hbr:DescribeHanaBackupPlansget
*全部资源
*

请求参数

名称类型必填描述示例值
VaultIdstring

备份仓库 ID。

v-000i4lg4kz******ahl
ClusterIdstring

SAP HANA 实例 ID。

cl-000chxz******lz7bk
PageNumberinteger

分页页码。从 1 开始,默认值为 1。

1
PageSizeinteger

分页大小。最小值为 1,最大值为 99,默认值为 10。

10
DatabaseNamestring

数据库名称。

SYSTEMDB
ResourceGroupIdstring

资源组 ID。

rg-acfmvywqfey5njq

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

请求是否成功。

  • true:成功
  • false:失败
true
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
PageNumberinteger

分页页码。从 1 开始,默认值为 1。

1
PageSizeinteger

分页大小。最小值为 1,最大值为 99,默认值为 10。

10
TotalCountlong

总记录数。

6
HanaBackupPlansarray<object>

备份计划详情。

HanaBackupPlanobject

备份计划详情。

VaultIdstring

备份仓库 ID。

v-000csihw82pqkd7hcjws
BackupPrefixstring

备份前缀。

COMPLETE_DATA_BACKUP
Schedulestring

备份策略。可选格式:I|{startTime}|{interval}。表示从{startTime}开始每隔{interval}的时间执行一次备份任务。不会补偿已过去时间的备份任务。如果上一次备份任务没有完成,不会触发下一次备份任务。例如I|1631685600|P1D表示从 2021-09-15 14:00:00 开始每隔一天备份一次。

  • startTime:备份起始时间,UNIX 时间,单位为秒。
  • interval: ISO8601 时间间隔。例如:PT1H 表示间隔一小时。P1D 表示间隔一天。
I|1602673264|P1D
DatabaseNamestring

数据库的名称。

SYSTEMDB
BackupTypestring

备份类型。

  • COMPLETE:全量备份。
  • INCREMENTAL:增量备份。
  • DIFFERENTIAL:差量备份。
COMPLETE
Disabledboolean

备份计划是否属于暂停状态。

  • true:暂停
  • false:未暂停
false
PlanIdstring

备份计划 ID。

pl-0000tnyndg3ne5m4ubeu
ClusterIdstring

SAP HANA 实例 ID。

cl-0002scknka*****
PlanNamestring

备份计划名称。

plan-20220118-141153

示例

正常返回示例

JSON格式

{
  "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"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-05-30API 内部配置变更,不影响调用查看变更详情