使用DescribeHanaBackupPlans查詢SAP HANA備份計劃-雲備份-阿里雲

擷取一個或者多個合格 SAP HANA 備份計劃。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:DescribeHanaBackupPlans

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
VaultId	string	否	備份倉庫 ID。	v-000i4lg4kz******ahl
ClusterId	string	是	SAP HANA 執行個體 ID。	cl-000chxz******lz7bk
PageNumber	integer	否	分頁頁碼。從 1 開始，預設值為 1。	1
PageSize	integer	否	分頁大小。最小值為 1，最大值為 99，預設值為 10。	10
DatabaseName	string	否	資料庫名稱。	SYSTEMDB
ResourceGroupId	string	否	資源群組 ID。	rg-acfmvywqfey5njq

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9
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	總記錄數。	6
HanaBackupPlans	object
HanaBackupPlan	array<object>	備份計劃詳情。
	object	備份計劃詳情。
VaultId	string	備份倉庫 ID。	v-000csihw82pqkd7hcjws
BackupPrefix	string	備份首碼。	COMPLETE_DATA_BACKUP
Schedule	string	備份策略。可選格式：`I\|{startTime}\|{interval}`。表示從{startTime}開始每隔{interval}的時間執行一次備份任務。不會補償已過去時間的備份任務。如果上一次備份任務沒有完成，不會觸發下一次備份任務。例如`I\|1631685600\|P1D`表示從 2021-09-15 14:00:00 開始每隔一天備份一次。 startTime：備份起始時間，UNIX 時間，單位為秒。 interval： ISO8601 時間間隔。例如：PT1H 表示間隔一小時。P1D 表示間隔一天。	I\|1602673264\|P1D
DatabaseName	string	資料庫的名稱。	SYSTEMDB
BackupType	string	備份類型。 COMPLETE：全量備份。 INCREMENTAL：增量備份。 DIFFERENTIAL：差量備份。	COMPLETE
Disabled	boolean	備份計劃是否屬於暫停狀態。 true：暫停 false：未暫停	false
PlanId	string	備份計劃 ID。	pl-0000tnyndg3ne5m4ubeu
ClusterId	string	SAP HANA 執行個體 ID。	cl-0002scknka*****
PlanName	string	備份計劃名稱。	plan-20220118-141153
BusinessStatus	string	業務狀態	ACTIVE

樣本

正常返回樣本

JSON格式

{
  "RequestId": "F029C1C7-26B6-5ADD-A73E-D85CCD7C73A9",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 6,
  "HanaBackupPlans": {
    "HanaBackupPlan": [
      {
        "VaultId": "v-000csihw82pqkd7hcjws",
        "BackupPrefix": "COMPLETE_DATA_BACKUP",
        "Schedule": "I|1602673264|P1D",
        "DatabaseName": "SYSTEMDB",
        "BackupType": "COMPLETE",
        "Disabled": false,
        "PlanId": "pl-0000tnyndg3ne5m4ubeu",
        "ClusterId": "cl-0002scknka*****",
        "PlanName": "plan-20220118-141153",
        "BusinessStatus": "ACTIVE"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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