文档

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

更新时间:

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

调试

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

授权信息

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

请求参数

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

备份仓库 ID。

v-000b0ov******6zs
ClusterIdstring

SAP HANA 实例 ID。

cl-0001zfc******50pr3
PageNumberinteger

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

1
PageSizeinteger

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

10
Tagobject []

SAP HANA 实例标签。

Keystring

标签键。

ace:rm:rgld
Valuestring

标签值。

rg-acfmwutpyat2kwy
ResourceGroupIdstring

资源组 ID。

rg-aekz24ikcjyqjkq

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

4003DD68-3C3C-5071-B4FC-631A6C1BAC1C
Successboolean

请求是否成功。

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

返回码。200 表示成功。

200
Messagestring

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

successful
PageNumberinteger

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

1
PageSizeinteger

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

10
TotalCountinteger

总记录数。

21
Hanasobject []

SAP HANA 实例列表。

Statuslong

SAP HANA 实例状态:

  • INITIALIZING:初始化中。
  • INITIALIZED:已注册。
  • INVALID_HANA_NODE:为无效的 HANA 节点。
  • INITIALIZE_FAILED:安装客户端失败。
INITIALIZED
Hoststring

SAP HANA 主节点的私有或内网 IP 地址。

47.100.XX.XX
VaultIdstring

备份仓库 ID。

v-0000s974******1hl
UseSslboolean

是否使用 SSL 安全连接方式连接数据库。

  • true:使用 SSL 安全连接方式连接数据库。
  • false:不使用 SSL 安全连接方式连接数据库。
true
HanaNamestring

SAP HANA 名称。

HANA-DEV
InstanceNumberinteger

安装 SAP HANA 时指定的实例编号。

00
ValidateCertificateboolean

打开验证 SSL 证书开关后,表示验证数据库服务端 SSL 证书。

false
AlertSettingstring

告警设置。取值为 INHERITED,表示使用与备份库一致的报警方式。

INHERITED
UserNamestring

SYSTEMDB 数据库的用户名。

admin
StatusMessagestring

状态信息。

INSTALL_CLIENT_FAILED
ClusterIdstring

SAP HANA 实例 ID。

cl-0004cf6g6******0yd7y
Tagsobject []

SAP HANA 实例标签。

Keystring

标签键。

ace:rm:rgld
Valuestring

标签值。

rg-acfmwutpyat2kwy
ResourceGroupIdstring

资源组 ID。

rg-acfmvnf22m7itha

示例

正常返回示例

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": "",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": ""
      }
    ]
  }
}

错误码

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

变更历史

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