調用SearchHistoricalSnapshots查詢歷史備份快照-雲備份-阿里雲

擷取一個或者多個合格歷史備份快照。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:SearchHistoricalSnapshots

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
SourceType	string	否	資料來源類型。取值範圍： ECS_FILE：表示 ECS 檔案的備份快照。 OSS：表示阿里雲 OSS 的備份快照。 NAS：表示阿里雲 NAS 的備份快照。	ECS_FILE
Query	array	是	查詢條件。Query 樣本如下： `[ { "field": "VaultId", "value": "v-0003rf9m***qx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2*e9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vk***gkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": "1626769913", "operation": "GREATER_THAN_OR_EQUAL" } ]` 支援的 field 如下： VaultId：必選參數，表示倉庫 ID。 InstanceId：僅當 SourceType=ECS_FILE 時，必選參數，表示 ECS 執行個體 ID。 Bucket ：僅當 SourceType=OSS 時，必選參數，表示 OSS bucket 名稱。 FileSystemId：僅當 SourceType=NAS 時，必選參數，表示 NAS 檔案系統 ID。 CreateTime ：僅當 SourceType=NAS 時，必選參數，表示 NAS 檔案系統建立時間。 CompleteTime：快照完成時間。 PlanId：備份計劃 ID。支援的 operation 如下： MATCH_TERM：精確匹配。 GREATER_THAN：大於。 GREATER_THAN_OR_EQUAL：大於等於。 LESS_THAN：小於。 LESS_THAN_OR_EQUAL：小於等於。 BETWEEN：區間，value 為 JSON 數組 `[下界,上界]`。 IN：在集合中，value 為數組。 NOT_IN：不在集合中，value 為數組。	[ { "field": "VaultId", "value": "v-0003rf9m17pap3ltpqx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2wuzdie9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vkqhpesqgkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": 1626769913, "operation": "GREATER_THAN_OR_EQUAL" } ]
	any	否	查詢條件。Query 樣本如下： `[ { "field": "VaultId", "value": "v-0003rf9m***qx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2*e9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vk***gkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": "1626769913", "operation": "GREATER_THAN_OR_EQUAL" } ]` 支援的 field 如下： VaultId：必選參數，表示倉庫 ID。 InstanceId：僅當 SourceType=ECS_FILE 時，必選參數，表示 ECS 執行個體 ID。 Bucket ：僅當 SourceType=OSS 時，必選參數，表示 OSS bucket 名稱。 FileSystemId：僅當 SourceType=NAS 時，必選參數，表示 NAS 檔案系統 ID。 CreateTime ：僅當 SourceType=NAS 時，必選參數，表示 NAS 檔案系統建立時間。 CompleteTime：快照完成時間。 PlanId：備份計劃 ID。支援的 operation 如下： MATCH_TERM：精確匹配。 GREATER_THAN：大於。 GREATER_THAN_OR_EQUAL：大於等於。 LESS_THAN：小於。 LESS_THAN_OR_EQUAL：小於等於。 BETWEEN：區間，value 為 JSON 數組 `[下界,上界]`。 IN：在集合中，value 為數組。 NOT_IN：不在集合中，value 為數組。	[ { "field": "VaultId", "value": "v-0003rf9m17pap3ltpqx5", "operation": "MATCH_TERM" }, { "field": "InstanceId", "value": "i-bp1i20zq2wuzdie9368m", "operation": "MATCH_TERM" }, { "field": "PlanId", "value": "plan-0005vkqhpesqgkd1iu4f", "operation": "MATCH_TERM" }, { "field": "CompleteTime", "value": 1626769913, "operation": "GREATER_THAN_OR_EQUAL" } ]
Limit	integer	否	本次查詢需要返回的最大數量。如果只為了擷取行數，無需具體資料，可以設定`limit=0`，即不返回任意一行資料。	10
NextToken	string	否	擷取下一頁快照所需的 Token。	caeba0bbb2be03f84eb48b699f0a****
SortBy	string	否	排序欄位。	CreatedTime
Order	string	否	排序方式，預設值為 ASC。 ASC：升序 DESC：降序	ASC
Edition	string	否	版本類型，支援 BASIC 和 STANDARD，預設值為 STANDARD。	BASIC

返回參數

名稱	類型	描述	樣本值
	object
NextToken	string	擷取下一頁快照所需的 Token。	BE
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	請求是否成功。 true：成功。 false：失敗。	true
Limit	integer	當前頁顯示歷史快照數量。	10
Code	string	返回碼，200 表示成功。	200
Message	string	返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。	successful
TotalCount	integer	合格快照總數。	20
Snapshots	object
Snapshot	array<object>	歷史快照列表。
	array<object>
Status	string	備份快照任務的狀態。取值範圍： COMPLETE：成功 PARTIAL_COMPLETE：部分成功 FAILED：失敗	COMPLETE
SnapshotHash	string	快照 HASH 值。	f2fe...
VaultId	string	儲存備份庫快照的倉庫 ID。	v-0003rf9m17pap3ltpqx5
ActualItems	integer	快照實際專案數。說明目前僅檔案備份可用。	6
BackupType	string	備份類型。取值為 COMPLETE，表示全量備份。	COMPLETE
CreateTime	integer	僅當 SourceType 取值為 NAS 時，該參數有效。表示檔案系統建立時間。UNIX 時間，單位為秒。	1607436917
ActualBytes	integer	去重後快照實際資料量。單位為位元組。	600
SourceType	string	資料來源類型。取值範圍： ECS_FILE：ECS 檔案的備份快照。 OSS：阿里雲 OSS 的備份快照。 NAS：阿里雲 NAS 的備份快照。	ECS_FILE
Prefix	string	僅當 SourceType 取值為 OSS 時，該參數有效。表示備份首碼。	example/
ClientId	string	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示備份用戶端識別碼。	c-*********************
BytesTotal	integer	資料來源總量。單位為位元組。	1000
ItemsDone	integer	備份專案數。說明目前僅檔案備份可用。	8
CompleteTime	integer	備份快照完成時間。UNIX 時間，單位為秒。	1554347313
Retention	integer	備份快照保留天數。	7
CreatedTime	integer	備份快照的建立時間。UNIX 時間，單位為秒。	1554347313
Bucket	string	僅當 SourceType 取值為 OSS 時，該參數有效。表示 OSS bucket 名稱。	hbr-backup-oss
ParentSnapshotHash	string	父備份的快照 HASH 值。	f2fe..
InstanceId	string	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示 ECS 執行個體 ID。	i-*********************
FileSystemId	string	僅當 SourceType 取值為 NAS 時，該參數有效。表示檔案系統 ID。	005494
ErrorFile	string	記錄備份失敗資訊的檔案，包含備份部分完成的資訊。	Item Error Message C:\Program Files (x86)\Symantec\Symantec Endpoint Protection\14.3.558.0000.105\Bin\service.dat Open: open \\?\C:\Program Files (x86)\Symantec\Symantec Endpoint Protection\14.3.558.0000.105\Bin\service.dat: The process cannot access the file because it is being used by another process. C:\ProgramData\McAfee\Agent\data\InstallerFiles\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini Open: open \\?\C:\ProgramData\McAfee\Agent\data\InstallerFiles\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini: Access is denied.
StartTime	integer	快照開始時間。UNIX 時間，單位為秒。	1554347313
UpdatedTime	integer	備份快照的更新時間。UNIX 時間，單位為秒。	1554347313
SnapshotId	string	備份快照 ID。	s-*********************
JobId	string	備份任務 ID。	v-*********************
Path	string	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示備份的檔案路徑。	["/home"]
ItemsTotal	integer	資料來源專案總數。說明目前僅檔案備份可用。	10
BytesDone	integer	增量備份的資料量。單位為位元組。	800
Paths	object
Path	array	備份檔案路徑列表。	"/home"
	string	僅當 SourceType 取值為 NAS 時，該參數有效。表示備份的檔案路徑。	"/home"
InstanceName	string	Table Store執行個體名稱。	instancename
TableName	string	Table Store執行個體的資料表名稱。	table2
RangeStart	integer	備份任務開始執行時間。UNIX 時間，單位為毫秒。	1642492553038
RangeEnd	integer	備份任務結束執行時間。UNIX 時間，單位為毫秒。	1642521709966
ExpireTime	integer	快照到期時間，UNIX 時間，單位為秒。	1640334062
SourceSnapshotHash	string	轉歸檔前快照 HASH 值。	qwer***
SourceParentSnapshotHash	string	轉歸檔前父快照 HASH 值。	qwer***
StorageClass	string	儲存類型。取值： Standard：標準。 Archive：歸檔。 ColdArchive：冷歸檔。	STANDARD
ArchiveTime	integer	轉歸檔時間。	1640334062
UseCommonNas	boolean	是否使用本地 NAS。	false
Include	string	備份任務包含的備份路徑。	[\"/test/example_cn-huhehaote_3.txt\", \"/test/example_cn-huhehaote_9.txt\", \"/test/example_cn-huhehaote_5.txt\", \"/test/example_cn-huhehaote_1.txt\", \"/test/example_cn-huhehaote_7.txt\"]
Exclude	string	備份任務不包含的備份路徑。	[\"/test/example_cn-hangzhou_7.txt\", \"/test/example_cn-hangzhou_1.txt\", \"/test/example_cn-hangzhou_3.txt\", \"/test/example_cn-hangzhou_9.txt\", \"/test/example_cn-hangzhou_6.txt\"]
ProtectedDataSize	integer	保護的源端資料量，單位 Byte。當 SourceType=ECS_FILE 時，表示已保護的雲端硬碟容量。	42949672960

樣本

正常返回樣本

JSON格式

{
  "NextToken": "BE",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Limit": 10,
  "Code": "200",
  "Message": "successful",
  "TotalCount": 20,
  "Snapshots": {
    "Snapshot": [
      {
        "Status": "COMPLETE",
        "SnapshotHash": "f2fe...",
        "VaultId": "v-0003rf9m17pap3ltpqx5",
        "ActualItems": 6,
        "BackupType": "COMPLETE",
        "CreateTime": 1607436917,
        "ActualBytes": 600,
        "SourceType": "ECS_FILE",
        "Prefix": "example/",
        "ClientId": "c-*********************",
        "BytesTotal": 1000,
        "ItemsDone": 8,
        "CompleteTime": 1554347313,
        "Retention": 7,
        "CreatedTime": 1554347313,
        "Bucket": "hbr-backup-oss",
        "ParentSnapshotHash": "f2fe..",
        "InstanceId": "i-*********************",
        "FileSystemId": "005494",
        "ErrorFile": "Item\tError Message C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat\tOpen: open \\\\?\\C:\\Program Files (x86)\\Symantec\\Symantec Endpoint Protection\\14.3.558.0000.105\\Bin\\service.dat: The process cannot access the file because it is being used by another process. C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini\tOpen: open \\\\?\\C:\\ProgramData\\McAfee\\Agent\\data\\InstallerFiles\\172e8a3b04b7ab0fd0215f4fb7707e3744b37d83b6743b3eacb94447c74dc9af_contrib.ini: Access is denied.",
        "StartTime": 1554347313,
        "UpdatedTime": 1554347313,
        "SnapshotId": "s-*********************",
        "JobId": "v-*********************",
        "Path": "[\"/home\"]",
        "ItemsTotal": 10,
        "BytesDone": 800,
        "Paths": {
          "Path": [
            "\"/home\""
          ]
        },
        "InstanceName": "instancename",
        "TableName": "table2",
        "RangeStart": 1642492553038,
        "RangeEnd": 1642521709966,
        "ExpireTime": 1640334062,
        "SourceSnapshotHash": "qwer***",
        "SourceParentSnapshotHash": "qwer***",
        "StorageClass": "STANDARD",
        "ArchiveTime": 1640334062,
        "UseCommonNas": false,
        "Include": "[\\\"/test/example_cn-huhehaote_3.txt\\\", \\\"/test/example_cn-huhehaote_9.txt\\\", \\\"/test/example_cn-huhehaote_5.txt\\\", \\\"/test/example_cn-huhehaote_1.txt\\\", \\\"/test/example_cn-huhehaote_7.txt\\\"]",
        "Exclude": "[\\\"/test/example_cn-hangzhou_7.txt\\\", \\\"/test/example_cn-hangzhou_1.txt\\\", \\\"/test/example_cn-hangzhou_3.txt\\\", \\\"/test/example_cn-hangzhou_9.txt\\\", \\\"/test/example_cn-hangzhou_6.txt\\\"]",
        "ProtectedDataSize": 42949672960
      }
    ]
  }
}

錯誤碼

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

變更歷史

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