調用DescribeHanaDatabases API查詢SAP HANA資料庫資訊-雲備份-阿里雲

查詢SAP HANA資料庫資訊。

介面說明

註冊 SAP HANA 執行個體且安裝備份用戶端後，可以調用該介面查詢 SAP HANA 資料庫資訊；若要啟動或停止資料庫，可分別調用 StartHanaDatabaseAsync 和 StopHanaDatabaseAsync 介面。

調試

您可以在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"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。