ListSnapshots - Cloud Backup

查詢備份點清單。

介面說明

本介面基於受保護的資源（ProtectedResourceId）查詢備份點清單。使用限制：

受保護的資源必須存在，且 SourceType 必須與受保護資源的資料來源類型一致。
MaxResults 取值必須大於 1，預設值為 10。
Skip 必須為非負整數，且為 MaxResults 的整數倍；Skip 大於 0 時不能同時傳入 NextToken。
CompleteTimeStart 和 CompleteTimeEnd 為 UNIX 時間戳記，單位為秒，篩選範圍為[CompleteTimeStart, CompleteTimeEnd)。
不指定排序欄位時，預設按備份完成時間（CompleteTime）降序排列。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
NextToken	string	否	分頁遊標。首次查詢無需傳入，翻頁時傳入上一頁返回的 NextToken。NextToken 為空說明沒有下一頁。不能與 Skip 同時使用。	eyJJbmRleCI6NjUwMX0=
MaxResults	integer	否	分頁查詢時設定的最大返回數量。預設值：10。取值必須大於 1。	10
Skip	integer	否	跳過的數量。必須為非負整數，且為 MaxResults 的整數倍。不能與 NextToken 同時使用。	0
SourceType	string	是	資料來源類型。必須與已保護的資源（ProtectedResourceId）的資料來源類型一致。目前支援的資料來源類型如列舉值所示。枚舉值： NAS : 阿里雲 NAS 備份。 COMMON_FILE_SYSTEM : CPFS 備份。 ECS_FILE : ECS 檔案備份。 COMMON_NAS : 本地 NAS 備份。 File : 本地檔案備份。 OSS : OSS 備份。	ECS_FILE
ProtectedResourceId	string	是	已保護的資源 ID。已保護的資源必須存在，且其資料來源類型必須與 SourceType 參數一致。	pr-123***7890
VaultId	string	否	儲存庫 ID。可選過濾條件，傳入時僅返回該備份庫中的備份點。	v-00030j3c******sn
CompleteTimeStart	integer	否	起始完成時間。UNIX 時間戳記，單位為秒。僅返回備份完成時間大於等於該時間的備份點。	1776059082
CompleteTimeEnd	integer	否	截止完成時間。UNIX 時間戳記，單位為秒。僅返回備份完成時間小於該時間的備份點。	1776059382
PlanId	string	否	計劃 ID。可選過濾條件，傳入時僅返回該備份計劃下的備份點。	po-0000****123

返回參數

名稱	類型	描述	樣本值
	object	回應。
RequestId	string	請求 ID。	17189276-**--**-0FF51B5A41A0
Code	string	返回碼。200 表示成功。	200
Message	string	返回資訊描述，成功一般返回 successful，錯誤時會返回相應錯誤資訊。	successful
Success	boolean	請求是否成功。 true：成功 false：失敗	true
Snapshots	array<object>	備份點清單。
	object	備份點資訊。
Status	string	備份點狀態。枚舉值： COMPLETE : 備份完成。 ARCHIVING : 後台歸檔中。 PARTIAL_COMPLETE : 備份部分完成。	COMPLETE
SnapshotHash	string	備份點雜湊值。	f2ac5fd243**********************bc4451777be019
VaultId	string	儲存備份資料的備份庫 ID。	v-00030j*******sn
ActualItems	integer	實際節點數。	6
BackupType	string	備份類型。取值為 COMPLETE，表示全量備份。	COMPLETE
CreateTime	integer	備份點建立時間（秒）。	1607436917
ActualBytes	integer	實際寫入資料量（位元組）。	600
SourceType	string	資料來源類型。取值範圍： ECS_FILE：ECS 檔案備份 File：本地檔案備份 OSS：OSS 備份 NAS：阿里雲 NAS 備份 COMMON_NAS：本地 NAS 備份 CONTAINER：容器備份 OTS_TABLE：表格儲存備份 COMMON_FILE_SYSTEM：CPFS 備份	ECS_FILE
ClientId	string	當 SourceType 取值為ECS_FILE或 File 時，表示備份用戶端 ID。其他時候代表備份資料來源的 ID。	c-*********************
BytesTotal	integer	需備份總資料量（位元組）。	1000
ItemsDone	integer	完成備份的節點數。	8
CompleteTime	integer	備份完成時間。UNIX 時間戳記，單位為秒。	1642496679
Retention	integer	備份保留天數。	7
CreatedTime	integer	備份建立時間。	1642496679
InstanceId	string	備份資料來源執行個體 ID。	i-*********************
ErrorFile	string	記錄備份失敗資訊的檔案，包含備份部分完成的資訊。	temp/report/123456789/job-xxxxxxxxx_failed.zip
SnapshotId	string	備份點 ID。	s-00047mxg17p26*****b
JobId	string	備份工作 ID。	job-00030j3chkt******2
Path	string	備份路徑。	/home
ItemsTotal	integer	需備份總節點數。	10
BytesDone	integer	完成備份的資料量（位元組）。	800
Paths	array	備份路徑清單。
	string	備份路徑。	/home
InstanceName	string	表格儲存執行個體名稱。	instancename
TableName	string	表格儲存執行個體的資料表名稱。	table2
RangeStart	integer	表格儲存備份工作開始執行時間。UNIX 時間，單位為毫秒。	1642492553038
RangeEnd	integer	表格儲存備份工作結束執行時間。UNIX 時間，單位為毫秒。	1642521709966
ExpireTime	integer	備份過期時間。	1771901707
StorageClass	string	儲存類型。枚舉值： ARCHIVE : 歸檔儲存。 STANDARD : 標準儲存。	STANDARD
ArchiveTime	integer	轉歸檔時間。	1640334062
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
PlanId	string	備份計劃 ID。	po-123***7890
TotalCount	integer	總記錄數。	3
MaxResults	integer	最大返回結果數。	10
NextToken	string	下一頁開始的 Token，NextToken 為空說明沒有下一頁。	aWQj********MCMy

樣本

正常返回樣本

JSON格式

{
  "RequestId": "17189276-****-****-****-0FF51B5A41A0",
  "Code": "200",
  "Message": "successful",
  "Success": true,
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "f2ac5fd243**********************bc4451777be019",
      "VaultId": "v-00030j*******sn",
      "ActualItems": 6,
      "BackupType": "COMPLETE",
      "CreateTime": 1607436917,
      "ActualBytes": 600,
      "SourceType": "ECS_FILE",
      "ClientId": "c-*********************",
      "BytesTotal": 1000,
      "ItemsDone": 8,
      "CompleteTime": 1642496679,
      "Retention": 7,
      "CreatedTime": 1642496679,
      "InstanceId": "i-*********************",
      "ErrorFile": "temp/report/123456789/job-xxxxxxxxx_failed.zip",
      "SnapshotId": "s-00047mxg17p26*****b",
      "JobId": "job-00030j3chkt******2",
      "Path": "/home",
      "ItemsTotal": 10,
      "BytesDone": 800,
      "Paths": [
        "/home"
      ],
      "InstanceName": "instancename",
      "TableName": "table2",
      "RangeStart": 1642492553038,
      "RangeEnd": 1642521709966,
      "ExpireTime": 1771901707,
      "StorageClass": "STANDARD",
      "ArchiveTime": 1640334062,
      "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,
      "PlanId": "po-123***7890"
    }
  ],
  "TotalCount": 3,
  "MaxResults": 10,
  "NextToken": "aWQj********MCMy"
}

錯誤碼

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

變更歷史

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