DescribeHanaInstances - 查询符合条件的SAP HANA实例 - 云备份

查询一个或多个符合条件的SAP HANA实例。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hbr:DescribeHanaInstances

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
VaultId	string	否	备份仓库 ID。	v-000b0ov******6zs
ClusterId	string	否	SAP HANA 实例 ID。	cl-0001zfc******50pr3
PageNumber	integer	否	分页页码。从 1 开始，默认值为 1。	1
PageSize	integer	否	分页大小。最小值为 1，最大值为 99，默认值为 10。	10
Tag	array<object>	否	SAP HANA 实例标签。
	object	否	SAP HANA 实例标签。
Key	string	否	标签键。	ace:rm:rgld
Value	string	否	标签值。	rg-acfmwutpyat2kwy
ResourceGroupId	string	否	资源组 ID。	rg-aekz24ikcjyqjkq

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	4003DD68-3C3C-5071-B4FC-631A6C1BAC1C
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	总记录数。	21
Hanas	object
Hana	array<object>	SAP HANA 实例列表。
	array<object>	SAP HANA 实例。
Status	integer	SAP HANA 实例状态： INITIALIZING：初始化中。 INITIALIZED：已注册。 INVALID_HANA_NODE：为无效的 HANA 节点。 INITIALIZE_FAILED：安装客户端失败。	INITIALIZED
Host	string	SAP HANA 主节点的私有或内网 IP 地址。	47.100.XX.XX
VaultId	string	备份仓库 ID。	v-0000s974******1hl
UseSsl	boolean	是否使用 SSL 安全连接方式连接数据库。 true：使用 SSL 安全连接方式连接数据库。 false：不使用 SSL 安全连接方式连接数据库。	true
HanaName	string	SAP HANA 名称。	HANA-DEV
InstanceNumber	integer	安装 SAP HANA 时指定的实例编号。	00
ValidateCertificate	boolean	打开验证 SSL 证书开关后，表示验证数据库服务端 SSL 证书。	false
AlertSetting	string	告警设置。取值为 INHERITED，表示使用与备份库一致的报警方式。	INHERITED
UserName	string	SYSTEMDB 数据库的用户名。	admin
StatusMessage	string	状态信息。	INSTALL_CLIENT_FAILED
ClusterId	string	SAP HANA 实例 ID。	cl-0004cf6g6******0yd7y
Tags	object
Tag	array<object>	SAP HANA 实例标签。
	object	SAP HANA 实例标签。
Key	string	标签键。	ace:rm:rgld
Value	string	标签值。	rg-acfmwutpyat2kwy
ResourceGroupId	string	资源组 ID。	rg-acfmvnf22m7itha
CrossAccountType	string	跨账号备份类型。支持： SELF_ACCOUNT：本账号备份 CROSS_ACCOUNT：跨账号备份	CROSS_ACCOUNT
CrossAccountUserId	integer	被当前账号管理的跨账号备份的原账号 ID。	158975xxxxx4625
CrossAccountRoleName	string	被当前账号管理的跨账号备份的原账号 RAM 中创建的角色名。	hbrcrossrole

示例

正常返回示例

JSON格式

{
  "RequestId": "4003DD68-3C3C-5071-B4FC-631A6C1BAC1C",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 21,
  "Hanas": {
    "Hana": [
      {
        "Status": 0,
        "Host": "47.100.XX.XX",
        "VaultId": "v-0000s974******1hl",
        "UseSsl": true,
        "HanaName": "HANA-DEV",
        "InstanceNumber": 0,
        "ValidateCertificate": false,
        "AlertSetting": "INHERITED",
        "UserName": "admin",
        "StatusMessage": "INSTALL_CLIENT_FAILED",
        "ClusterId": "cl-0004cf6g6******0yd7y",
        "Tags": {
          "Tag": [
            {
              "Key": "ace:rm:rgld",
              "Value": "rg-acfmwutpyat2kwy"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmvnf22m7itha",
        "CrossAccountType": "CROSS_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "hbrcrossrole"
      }
    ]
  }
}

错误码

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

变更历史

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