DescribeHanaDatabases - 查询符合条件的SAP HANA数据库 - 云备份

查询SAP HANA数据库信息。

接口说明

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hbr:DescribeHanaDatabases

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
VaultId	string	否	备份库仓库 ID。	v-00063fq******8xjr
ClusterId	string	是	SAP HANA 实例 ID。	cl-000hpc******uv14x
PageNumber	integer	否	分页页码。从 1 开始，默认值为 1。	1
PageSize	integer	否	分页大小。最小值为 1，最大值为 99，默认值为 10。	10
ResourceGroupId	string	否	资源组 ID。	rg-acfmw2azsegupmi

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2
Success	boolean	请求是否成功。 true：成功。 false：失败。	true
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
PageNumber	integer	分页页码。从 1 开始，默认值为 1。	1
PageSize	integer	分页大小。最小值为 1，最大值为 99，默认值为 10。	10
TotalCount	integer	总记录数。	10
HanaDatabases	object
HanaDatabase	array<object>	SAP HANA 数据库列表。
	object	SAP HANA 数据库。
Host	string	主机名。	izbp1jbf3zy******antqmz
SqlPort	integer	端口。	30013
DatabaseName	string	数据库名称。	SYSTEMDB
ServiceName	string	服务名。	indexserver
ActiveStatus	string	启动状态。取值包括： YES：启动 NO：未启动	YES
Detail	string	详细信息。	master

示例

正常返回示例

JSON格式

{
  "RequestId": "DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 10,
  "HanaDatabases": {
    "HanaDatabase": [
      {
        "Host": "izbp1jbf3zy******antqmz",
        "SqlPort": 30013,
        "DatabaseName": "SYSTEMDB",
        "ServiceName": "indexserver",
        "ActiveStatus": "YES",
        "Detail": "master"
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。