調用ListBackupData API查詢執行個體備份列表-即時數倉 Hologres-阿里雲

該介面用於查詢備份資料列表。一份備份是對執行個體截止快照時間的全量資料快照，可以通過新購執行個體完全恢複原來的資料。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hologram:ListBackupData

list

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

無

請求文法

GET /api/v1/backups HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
instanceId	string	否	執行個體 id。	hgprecn-cn-wwoxxxxx
backupType	string	否	備份類型。根據類型過濾特定的備份資料，為空白則返回所有備份資料。枚舉值： redundant_remote : 同城冗餘備份 remote : 遠程備份 redundant : 同城冗餘備份 full_remote : 單備份 local : 本地備份 full : 單備份	redundant

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 Id	4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46
BackupDataList	array<object>	備份列表。
	object
BackupType	string	備份類型。備份類型總體上分兩種：1）本地備份，快照與執行個體屬於相同 Region；2）遠程備份，快照與執行個體屬於不同 Region。 redundant: 本地備份，同城跨可用性區域多副本儲存。 redundant_remote: 遠程備份，同城跨可用性區域多副本儲存，redundant 類型在異地的拷貝。 full: 本地備份，單副本儲存。 full_remote: 遠程備份，單副本儲存，full 類型在異地的拷貝。 local: 不代表具體備份類型，只用於過濾本地備份資料。 remote: 不代表具體備份類型，只用於過濾遠程備份資料。	redundant
DataGran	string	備份粒度。枚舉值： instance : 執行個體級	instance
Id	integer	備份唯一 Id。	1780805690994479105
InstanceId	string	執行個體 id。	hgpostcn-cn-pe33jdxxxxx
StartTime	string	備份開始時間。北京時間，格式 YYYY-MM-DDTHH:mm:ss.SSSTZ。下同	2024-10-28T11:19:56.000+00:00
Status	string	備份狀態。枚舉值： processing : 處理中 completed : 已完成 failed : 失敗	completed
TriggerType	string	觸發類型。枚舉值： scheduled : 周期備份 manual : 手動備份	scheduled
DataDesc	string	備份資料描述。可更新。	demo
DataTime	string	資料快照時間。格式參考 StartTime。	2024-10-28T12:23:37.000+00:00
DataSize	integer	備份資料大小。單位：位元組。	76085723136
EndTime	string	備份結束時間。格式參考 StartTime。	2024-10-28T12:27:34.000+00:00
ColdDataSize	integer	冷存資料大小。單位：位元組	32413521
InstanceType	string	執行個體類型。枚舉值： Warehouse : 計算群組型 Standard : 標準型	Warehouse
InstanceRegion	string	執行個體所在地區。	cn-hangzhou
SnapshotRegion	string	備份資料所在地區。	cn-hangzhou
InstanceZoneId	string	執行個體所在可用性區域。	cn-hangzhou-j
SnapshotZoneId	string	備份資料所在可用性區域。其中，同城冗餘儲存儲存在多可用性區域，這裡是其中一個。	cn-hangzhou-j
InstanceName	string	執行個體名稱。	my-hologres-dw

樣本

正常返回樣本

JSON格式

{
  "RequestId": "4AA0C48F-B5BB-5FF9-A43B-6B91E0715D46",
  "BackupDataList": [
    {
      "BackupType": "redundant",
      "DataGran": "instance",
      "Id": 1780805690994479000,
      "InstanceId": "hgpostcn-cn-pe33jdxxxxx",
      "StartTime": "2024-10-28T11:19:56.000+00:00",
      "Status": "completed",
      "TriggerType": "scheduled",
      "DataDesc": "demo",
      "DataTime": "2024-10-28T12:23:37.000+00:00",
      "DataSize": 76085723136,
      "EndTime": "2024-10-28T12:27:34.000+00:00",
      "ColdDataSize": 32413521,
      "InstanceType": "Warehouse",
      "InstanceRegion": "cn-hangzhou",
      "SnapshotRegion": "cn-hangzhou",
      "InstanceZoneId": "cn-hangzhou-j",
      "SnapshotZoneId": "cn-hangzhou-j",
      "InstanceName": "my-hologres-dw"
    }
  ]
}

錯誤碼

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

變更歷史

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