DescribeHanaBackupSetting - 查询符合条件的SAP HANA数据库备份参数

查询SAP HANA数据库的备份参数。

接口说明

若要查询数据库的备份保留时间,可以调用 DescribeHanaRetentionSetting。

调试

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

授权信息

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

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

请求参数

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

备份仓库 ID。

v-000css******za5uyqr
ClusterIdstring

SAP HANA 实例 ID。

cl-00068btz******oku
DatabaseNamestring

数据库名称。

SYSTEMDB

返回参数

名称类型描述示例值
object
Codestring

返回码,200 表示成功。

200
Messagestring

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

successful
RequestIdstring

请求 ID。

9D0DB5BC-5071-5ADF-BCD1-14EBB0C17C54
Successboolean

请求是否成功。

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

备份设置。

DatabaseNamestring

数据库名称。

SYSTEMDB
LogBackupUsingBackintboolean

是否日志备份到 Backint。

  • true:日志备份到 Backint。
  • false:不备份到 Backint。
true
CatalogBackupParameterFilestring

Catalog 备份配置文件。

/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param
CatalogBackupUsingBackintboolean

Catalog 备份使用 Backint。

  • true:使用 Backint。
  • false:不使用 Backint。
false
DataBackupParameterFilestring

数据备份配置文件。

/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param
LogBackupTimeoutlong

日志备份时间间隔,单位秒。

900
EnableAutoLogBackupboolean

是否开启自动日志备份。

  • true:开启自动日志备份。
  • false:不开启自动日志备份。
true
LogBackupParameterFilestring

日志备份配置文件。

/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "9D0DB5BC-5071-5ADF-BCD1-14EBB0C17C54",
  "Success": true,
  "HanaBackupSetting": {
    "DatabaseName": "SYSTEMDB",
    "LogBackupUsingBackint": true,
    "CatalogBackupParameterFile": "/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param",
    "CatalogBackupUsingBackint": false,
    "DataBackupParameterFile": "/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param",
    "LogBackupTimeout": 900,
    "EnableAutoLogBackup": true,
    "LogBackupParameterFile": "/usr/sap/SID/SYS/global/hdb/opt/hdbconfig/param"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史