文档

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

更新时间:

查询SAP HANA数据库信息。

接口说明

注册 SAP HANA 实例且安装备份客户端后,可以调用该接口查询 SAP HANA 数据库信息;若要启动或停止数据库,可分别调用 StartHanaDatabaseAsync 和 StopHanaDatabaseAsync 接口。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

备份库仓库 ID。

v-00063fq******8xjr
ClusterIdstring

SAP HANA 实例 ID。

cl-000hpc******uv14x
PageNumberinteger

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

1
PageSizeinteger

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

10
ResourceGroupIdstring

资源组 ID。

rg-acfmw2azsegupmi

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

DAAB6A29-34EB-5F56-962F-D5BDBFE8A5C2
Successboolean

请求是否成功。

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

返回码,200 表示成功。

200
Messagestring

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

successful
PageNumberinteger

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

1
PageSizeinteger

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

10
TotalCountlong

总记录数。

10
HanaDatabasesobject []

SAP HANA 数据库列表。

Hoststring

主机名。

izbp1jbf3zy******antqmz
SqlPortinteger

端口。

30013
DatabaseNamestring

数据库名称。

SYSTEMDB
ServiceNamestring

服务名。

indexserver
ActiveStatusstring

启动状态。取值包括:

  • YES:启动
  • NO:未启动
YES
Detailstring

详细信息。

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)