使用DescribeBackupJobs2 API查詢備份任務-雲備份-阿里雲

查詢一個或者多個合格備份任務。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:DescribeBackupJobs2

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	分頁頁碼，從 1 開始，預設值為 1。	1
PageSize	integer	否	分頁大小，最小值為 1，最大值為 99，預設值為 10。	10
SourceType	string	否	資料來源類型，取值範圍： ECS_FILE：備份 ECS 檔案 OSS：備份阿里雲 OSS NAS：備份阿里雲 NAS OTS：備份阿里雲 OTS UDM_ECS：備份 ECS 整機 UDM_ECS_DISK：ECS 整機備份-雲端硬碟備份子任務 COMMON_NAS：通用 NAS 資料來源，包括歸檔 NAS 資料來源和本地 NAS 資料來源。您需要通過 Filters 的 Values 區分資料來源類型。 File：本地檔案備份 SYNC：資料同步	ECS_FILE
SortDirection	string	否	排序方向。取值範圍： ASCEND：升序 DESCEND（預設）：降序	DESCEND
Filters	array<object>	否	查詢過濾器中的索引值。
	object	否	查詢過濾器。
Key	string	否	查詢過濾器中的索引值。取值包括： RegionId：地區 ID PlanId：備份計劃 ID JobId：備份任務 ID VaultId：倉庫 ID InstanceId：ECS 執行個體 ID Bucket：OSS bucket 名稱 FileSystemId：檔案系統 ID Status：任務狀態 CreatedTime：任務開始時間 CompleteTime：任務結束時間 InstanceName：Table Store執行個體名稱 BackupType：備份任務（僅當 SourceType 取值為 COMMON_NAS 時，需要配置該參數） ParentId：查詢子任務類型時，需要指定父類型任務的 ID。如：SourceType 取值為 UDM_ECS_DISK 時，需要指定 UDM_ECS 類型的任務 ID。	VaultId
Values	array	否	查詢過濾器的變數值。
	string	否	查詢過濾器的變數值。 -COMPLETE：本地 NAS 備份 0：ARCHIVE：歸檔資料來源 NAS 1：ARCHIVE_BY_SEARCH：歸檔資料來源 NAS	COMPLETE
Operator	string	否	匹配方式。預設為 IN。即過濾器中 Key 和 Value 支援的匹配操作（Operator）方式，取值包括： EQUAL：等於 NOT_EQUAL：不等於 GREATER_THAN：大於 GREATER_THAN_OR_EQUAL：大於等於 LESS_THAN：小於 LESS_THAN_OR_EQUAL：小於等於 BETWEEN：區間，value 為 JSON 數組`[下屆,上屆]`。 IN：在集合中，value 為數組。說明當使用 CompleteTime 作為 Key 查詢時，暫時不支援 IN 操作。	IN
Edition	string	否	版本類型，支援 BASIC 和 STANDARD，預設值為 STANDARD。	STANDARD

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
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	查詢到的合格備份任務總數。	8
BackupJobs	object
BackupJob	array<object>	合格備份工作清單。
	array<object>	備份任務詳情。
Status	string	備份任務狀態。取值範圍： COMPLETE：成功 PARTIAL_COMPLETE：部分成功 FAILED：失敗	COMPLETE
ErrorMessage	string	備份任務的錯誤資訊。	PARTIAL_COMPLETE
ActualItems	integer	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示備份任務實際專案數。	6
VaultId	string	備份倉庫 ID。	v-0006******q
ActualBytes	integer	去除重複後備份任務實際資料量。單位為位元組。	600
CreateTime	integer	僅當 SourceType 取值為 NAS 時，該參數有效。表示檔案系統建立時間。UNIX 時間，單位為秒。	1607436917
BackupType	string	備份類型。取值為 COMPLETE，表示全量備份。	COMPLETE
Prefix	string	僅當 SourceType 取值為 OSS 時，該參數有效。表示備份對象首碼。	example/
SourceType	string	資料來源類型，取值範圍： ECS_FILE：備份 ECS 檔案 OSS：備份阿里雲 OSS NAS：備份阿里雲 NAS	ECS_FILE
Options	string	僅當 SourceType 取值為ECS_FILE時，需要配置該參數。表示是否使用 Windows 系統 VSS 定義備份路徑。此功能僅支援 Windows 類型 ECS 執行個體。如果備份源中有資料更改，需要確保備份資料與來源資料的一致時，才可配置為`["UseVSS":true]`。選擇使用 VSS 後，不支援多個檔案目錄同時備份。	{"UseVSS":false}
ClientId	string	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示備份用戶端識別碼。	c-*********************
ItemsDone	integer	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示備份專案數。	8
BytesTotal	integer	資料來源總資料量。單位為位元組。	1000
Exclude	string	僅當 SourceType 取值為ECS_FILE時，需要配置該參數。表示不需要進行備份的路徑，該路徑下所有檔案都不備份。最多支援 255 個字元。	["/var", "/proc"]
JobName	string	備份任務名稱。	jobname
CompleteTime	integer	備份任務完成時間。UNIX 時間，單位為秒。	1554347313
CreatedTime	integer	備份任務建立時間。UNIX 時間，單位為秒。	1554347313
Bucket	string	僅當 SourceType 取值為 OSS 時，該參數有效。表示備份 OSS bucket 名稱。	hbr-backup-oss
Progress	integer	備份進度。值為 100%*100。	10000
SpeedLimit	string	僅當 SourceType 取值為ECS_FILE時，需要配置該參數。表示備份流量控制。格式為`{start}\|{end}\|{bandwidth}`。多個流量控制配置使用`\|`分隔，並且配置時間不允許有重疊。 start：起始小時 end：結束小時 bandwidth：限制速率，單位 KB/s。	0:24:5120
InstanceId	string	僅當 SourceType 取值為 NAS 時，該參數有效。表示 ECS 執行個體 ID。	i-*********************
PlanId	string	備份計劃 ID。	plan-20********35
FileSystemId	string	僅當 SourceType 取值為 NAS 時，該參數有效。表示檔案系統 ID。	005494
StartTime	integer	備份任務開始時間。UNIX 時間，單位為秒。	1554347313
UpdatedTime	integer	備份任務更新時間。UNIX 時間，單位為秒。	1554347313
JobId	string	備份任務 ID。	job-000g********w7
ItemsTotal	integer	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示資料來源專案總數。	10
Include	string	備份任務包含的備份路徑。	["/home/alice/.pdf", "/home/bob/.txt"]
BytesDone	integer	增量備份的資料量。單位為位元組。	800
Paths	object
Path	array	表示備份路徑。
	string	表示備份路徑。	"/home"
Detail	object	ECS 整機備份任務詳情。
DoCopy	boolean	是否進行異地複寫。	true
DestinationNativeSnapshotId	string	異地複寫快照 ID。	s-******************
DestinationNativeSnapshotProgress	integer	異地複寫進度。	85
DestinationNativeSnapshotStatus	string	異地複寫狀態。	COMPLETE
DestinationRetention	integer	異地複寫備份保留時間。	30
DestinationSnapshotId	string	異地複寫備份 ID。	s-******************
DestinationNativeSnapshotErrorMessage	string	異地複寫失敗資訊。	ECS.CreatingSnapshot
NativeSnapshotId	string	快照 ID。	s-******************
DiskNativeSnapshotIdList	object
DiskNativeSnapshotId	array	快照與雲端硬碟對應關係。
	string	快照 ID。	s-******************
InstanceInfos	object	ECS 執行個體資訊，包含 ECS 執行個體名稱、執行個體規格等。	{ "i-xxxxxxxx": { "hostName": "test", "instanceName": "test", "instanceType": "ecs.c7.xlarge", "osType": "linux", "diskIds": [ "d-xxxxxxxx01", "d-xxxxxxxx02" ], "osNameEn": "Rocky Linux 8.8 64 bit", "osName": "Rocky Linux 8.8 64位", "platform": "Rocky Linux" } }
InstanceName	string	Table Store執行個體名稱。	instancename
OtsDetail	object	Table Store執行個體詳情。
TableNames	object
TableName	array	Table Store執行個體的資料表名稱列表。
	string	Table Store執行個體的資料表名稱。	["table1", "table2", "table3"]
Speed	integer	實際的平均備份速度。單位為 KB/s。	500
TableName	string	Table Store執行個體的資料表名稱。	table1
CrossAccountType	string	跨帳號備份類型。支援： SELF_ACCOUNT：本帳號備份 CROSS_ACCOUNT：跨帳號備份	SELF_ACCOUNT
CrossAccountUserId	integer	被當前帳號管理的跨帳號備份的原帳號 ID。	158975xxxxx4625
CrossAccountRoleName	string	被當前帳號管理的跨帳號備份的原帳號 RAM 中建立的角色名稱。	BackupRole
Report	object	任務報表
TotalFiles	string	所有的檔案清單。（資料同步不返回該欄位）	/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv
SuccessFiles	string	成功的檔案清單。	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip
FailedFiles	string	失敗的檔案清單。	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip
SkippedFiles	string	跳過的檔案清單。	/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip
ReportTaskStatus	string	報告產生狀態。	COMPLETE
Identifier	string	僅 SourceType=CONTAINER 時返回，表示容器備份任務備份的叢集標識。當叢集類型為阿里雲Container Service Kubernetes 叢集時，該值為 Kubernetes 叢集 ID。	c83**************************b76
DestSourceType	string	目的端資料來源類型。（僅同步需要）	OSS
DestDataSourceId	string	目的端資料來源 ID。（僅同步需要）	ds-000cov4ufudxklj24zdk
DestDataSourceDetail	string	目的端資料來源詳情。（僅同步需要）	{\"prefix\":\"/\"}
ChangeListPath	string	增量檔案同步列表的配置。（僅同步需要）	{"dataSourceId": "ds-123456789", "path": "/changelist"}
FilesTotal	integer	表示需處理檔案的總數。	10
FilesDone	integer	表示檔案已處理完成數。	9
ActualFiles	integer	表示實際處理的檔案數。	8
TriggerMode	string

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "BackupJobs": {
    "BackupJob": [
      {
        "Status": "COMPLETE",
        "ErrorMessage": "PARTIAL_COMPLETE",
        "ActualItems": 6,
        "VaultId": "v-0006******q",
        "ActualBytes": 600,
        "CreateTime": 1607436917,
        "BackupType": "COMPLETE",
        "Prefix": "example/",
        "SourceType": "ECS_FILE",
        "Options": "{\"UseVSS\":false}",
        "ClientId": "c-*********************",
        "ItemsDone": 8,
        "BytesTotal": 1000,
        "Exclude": "[\"/var\", \"/proc\"]",
        "JobName": "jobname",
        "CompleteTime": 1554347313,
        "CreatedTime": 1554347313,
        "Bucket": "hbr-backup-oss",
        "Progress": 10000,
        "SpeedLimit": "0:24:5120",
        "InstanceId": "i-*********************",
        "PlanId": "plan-20********35",
        "FileSystemId": "005494",
        "StartTime": 1554347313,
        "UpdatedTime": 1554347313,
        "JobId": "job-000g********w7",
        "ItemsTotal": 10,
        "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
        "BytesDone": 800,
        "Paths": {
          "Path": [
            "\"/home\""
          ]
        },
        "Detail": {
          "DoCopy": true,
          "DestinationNativeSnapshotId": "s-******************",
          "DestinationNativeSnapshotProgress": 85,
          "DestinationNativeSnapshotStatus": "COMPLETE",
          "DestinationRetention": 30,
          "DestinationSnapshotId": "s-******************",
          "DestinationNativeSnapshotErrorMessage": "ECS.CreatingSnapshot",
          "NativeSnapshotId": "s-******************",
          "DiskNativeSnapshotIdList": {
            "DiskNativeSnapshotId": [
              "s-******************"
            ]
          },
          "InstanceInfos": {
            "i-xxxxxxxx": {
              "hostName": "test",
              "instanceName": "test",
              "instanceType": "ecs.c7.xlarge",
              "osType": "linux",
              "diskIds": [
                "d-xxxxxxxx01",
                "d-xxxxxxxx02"
              ],
              "osNameEn": "Rocky Linux 8.8 64 bit",
              "osName": "Rocky Linux 8.8 64位",
              "platform": "Rocky Linux"
            }
          }
        },
        "InstanceName": "instancename",
        "OtsDetail": {
          "TableNames": {
            "TableName": [
              "[\"table1\", \"table2\", \"table3\"]"
            ]
          }
        },
        "Speed": 500,
        "TableName": "table1",
        "CrossAccountType": "SELF_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "BackupRole",
        "Report": {
          "TotalFiles": "/temp/report/158975xxxxxx4625/job-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_total.csv",
          "SuccessFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_success.zip",
          "FailedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_failed.zip",
          "SkippedFiles": "/temp/report/158975xxxxxx4625/r-0001hfxxxxxymsspjjtl/job-0001hfxxxxxymsspjjtl_skipped.zip",
          "ReportTaskStatus": "COMPLETE"
        },
        "Identifier": "c83**************************b76",
        "DestSourceType": "OSS",
        "DestDataSourceId": "ds-000cov4ufudxklj24zdk",
        "DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
        "ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
        "FilesTotal": 10,
        "FilesDone": 9,
        "ActualFiles": 8,
        "TriggerMode": ""
      }
    ]
  }
}

錯誤碼

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

變更歷史

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