DescribeBackupPlans查詢備份計劃-雲備份-阿里雲

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

hbr:DescribeBackupPlans

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
PageNumber	integer	否	分頁頁碼，從 1 開始，預設值為 1。	1
PageSize	integer	否	分頁大小，最小值為 1，最大值為 99，預設值為 10。	10
SourceType	string	否	資料來源類型，取值範圍： ECS_FILE：備份 ECS 檔案 OSS：備份阿里雲 OSS NAS：備份阿里雲 NAS OTS：備份阿里雲Table Store UDM_ECS：備份阿里雲 ECS 整機 SYNC：資料同步	ECS_FILE
Filters	array<object>	否	查詢過濾器。
	object	否
Key	string	否	查詢過濾器中的索引值。取值可包括： regionId：地區 ID planId：計劃 ID sourceType：備份源類型 vaultId：倉庫 ID instanceName：執行個體名稱 instanceId：執行個體 ID planName：計劃名稱	vaultId
Values	array	否	查詢過濾器中的待匹配的值。	["v-*********************"]
	string	否	查詢過濾器中的待匹配的值。	v-*********************
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
BackupPlans	object
BackupPlan	array<object>	查詢到的合格備份計劃列表。
	array<object>
VaultId	string	備份倉庫 ID。	v-*********************
BackupType	string	備份類型。取值為 COMPLETE，表示全量備份。	COMPLETE
CreateTime	integer	僅當 SourceType 取值為 NAS 時，該參數有效。表示檔案系統建立時間。UNIX 時間，單位為秒。	1554347313
DataSourceId	string	資料來源 ID。	ds-000ht6o9*****w61
SourceType	string	資料來源類型，取值範圍： ECS_FILE：備份 ECS 檔案 OSS：備份阿里雲 OSS NAS：備份阿里雲 NAS OTS：備份阿里雲Table Store UDM_ECS：備份阿里雲 ECS 整機 SYNC：資料同步	ECS_FILE
Disabled	boolean	備份計劃是否屬於暫停狀態。 true：暫停 false：未暫停	false
Prefix	string	僅當 SourceType 取值為 OSS 時，該參數有效。表示備份首碼。	oss-prefix
Options	string	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示是否使用 Windows 系統 VSS 定義備份路徑。	{"UseVSS":false}
ClientId	string	用戶端識別碼。	c-000ge4w*****1qb
Exclude	string	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示不需要進行備份的路徑，該路徑下所有檔案都不備份。	["/var", "/proc"]
Retention	integer	備份保留天數。	7
CreatedTime	integer	備份計劃的建立時間。UNIX 時間，單位為秒。	1554347313
ClusterId	string	用戶端組 ID。	cl-000ht6o9******h
Bucket	string	僅當 SourceType 取值為 OSS 時，該參數有效。表示 OSS bucket 名稱。	hbr-backup-oss
Detail	string	整機備份詳情。	{\"doCopy\":true,\"doBackup\":false,\"instanceName\":\"instance example\",\"appConsistent\":false,\"destinationRegionId\":\"cn-shanghai\",\"enableFsFreeze\":true,\"osNameEn\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"osName\":\"Windows Server 2019 Data Center Edition 64bit Chinese Edition\",\"diskIdList\":[],\"backupVaultId\":\"\",\"snapshotGroup\":true,\"destinationRetention\":35,\"platform\":\"Windows Server 2012\",\"timeoutInSeconds\":60,\"backupRetention\":1,\"osType\":\"windows\",\"preScriptPath\":\"\",\"postScriptPath\":\"\",\"enableWriters\":true,\"ecsDeleted\":false}
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
SpeedLimit	string	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示備份流量控制。格式為`{start}\|{end}\|{bandwidth}`。多個流量控制配置使用`\|`分隔，並且配置時間不允許有重疊。 start：起始小時。 end：結束小時。 bandwidth：限制速率，單位為 KB。	0:24:5120
InstanceId	string	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示 ECS 執行個體 ID。	i-*********************
PlanId	string	備份計劃 ID。	plan-*********************
BackupSourceGroupId	string	備份資料來源組 ID。	System-Database
FileSystemId	string	僅當 SourceType 取值為 NAS 時，該參數有效。表示檔案系統 ID。	00594
OtsDetail	object	Table Store詳細資料。
TableNames	object
TableName	array	Table Store資訊。
	string	Table Store的資料表名。	test2_HBR_RESTORED
InstanceName	string	Table Store的執行個體名稱。	instancename
UpdatedTime	integer	備份計劃更新時間。UNIX 時間，單位為秒。	1554347313
PlanName	string	備份計劃名稱。	planname
Include	string	僅當 SourceType 取值為ECS_FILE時，該參數有效。表示需要備份的路徑，該路徑下所有檔案都備份。	["/home/alice/.pdf", "/home/bob/.txt"]
Rules	object
Rule	array<object>	備份策略列表，僅雲端硬碟備份有效。
	object
DestinationRetention	integer	異地備份保留天數。	90
Schedule	string	備份策略。可選格式：`I\|{startTime}\|{interval}`。表示從`{startTime}`開始每隔`{interval`}的時間執行一次備份任務。不會執行已過去時間的備份任務。如果上一次備份任務沒有完成，不會觸發下一次備份任務。例如`I\|1631685600\|P1D`表示從 2021-09-15 14:00:00 開始每隔一天備份一次。 `startTime`：備份起始時間，UNIX 時間，單位為秒。 `interval`： ISO8601 時間間隔。例如：PT1H 表示間隔一小時。P1D 表示間隔一天。	I\|1631685600\|P1D
Retention	integer	備份保留天數。	90
Disabled	boolean	策略是否禁用。	true
DoCopy	boolean	備份快照資料到備份倉庫。	false
DestinationRegionId	string	異地備份地區 ID。	cn-shanghai
RuleId	string	策略 ID。	rule-0008i52rf0ulpni6kn6m
RuleName	string	策略名稱稱。	Disk Golden Rule
BackupType	string	備份類型。取值為 COMPLETE，表示全量備份。	COMPLETE
Resources	object
Resource	array<object>	備份資源清單，僅雲端硬碟備份有效。
	object
SourceType	string	資料來源類型。取值範圍包括UDM_DISK。	UDM_DISK
ResourceId	string	資料來源 ID。	d-j6cgioir6m******lu4
Extra	string	資料來源其他資訊。	{\"doBackup\":false,\"diskName\":\"data_disk\",\"size\":100,\"type\":\"data\",\"category\":\"cloud_essd\",\"imageId\":\"\",\"device\":\"/dev/xvdb\",\"encrypted\":false}
Paths	object
Path	array	備份路徑列表。僅當 SourceType 取值為ECS_FILE時，該參數有效。
	string	備份路徑。	["/home"]
TrialInfo	object	免費試用屬性。
TrialStartTime	integer	免費試用開始時間。	1579413159
TrialVaultReleaseTime	integer	免費試用倉庫釋放時間。	1594965600
TrialExpireTime	integer	免費試用到期時間。	1584597600
KeepAfterTrialExpiration	boolean	免費試用結束後是否轉為隨用隨付。	true
InstanceGroupId	string	執行個體分組 ID。	i-**
CrossAccountType	string	跨帳號備份類型。支援： SELF_ACCOUNT CROSS_ACCOUNT	CROSS_ACCOUNT
CrossAccountUserId	integer	被當前帳號管理的跨帳號備份的原帳號 ID。	1841642xxxxx9795
CrossAccountRoleName	string	被當前帳號管理的跨帳號備份的原帳號 RAM 中建立的角色名稱。	BackupRole
KeepLatestSnapshots	integer	是否開啟保留至少一個備份版本。 0 - 不保留 1 - 保留	0
DestSourceType	string	目的端資料來源類型。（僅同步需要）	OSS
DestDataSourceId	string	目的端資料來源 ID。（僅同步需要）	ds-*********************
DestDataSourceDetail	string	目的端資料來源詳情。（僅同步需要）	{\"prefix\":\"/\"}
ChangeListPath	string	增量檔案同步列表的配置。（僅同步需要）	{"dataSourceId": "ds-123456789", "path": "/changelist"}
LatestExecuteJobId	string	計劃最近一次執行的作業 Id	job-12345678
LatestFinishJobId	string	上一個結束的備份任務 ID。	job-00**************9khz
CreatedByTag	boolean	是否通過標籤自動建立。	false
HitTags	object
HitTag	array<object>	命中的標籤規則。
	object	命中的標籤規則。
Key	string	標籤鍵。	type
Value	string	標籤值。	0
Operator	string	標籤匹配規則，支援 EQUAL：匹配標籤鍵和標籤值。 NOT：匹配標籤鍵，不匹配標籤值。	EQUAL
BusinessStatus	string	業務狀態	ACTIVE

樣本

正常返回樣本

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 8,
  "BackupPlans": {
    "BackupPlan": [
      {
        "VaultId": "v-*********************",
        "BackupType": "COMPLETE",
        "CreateTime": 1554347313,
        "DataSourceId": "ds-000ht6o9*****w61",
        "SourceType": "ECS_FILE",
        "Disabled": false,
        "Prefix": "oss-prefix",
        "Options": "{\"UseVSS\":false}",
        "ClientId": "c-000ge4w*****1qb",
        "Exclude": "[\"/var\", \"/proc\"]\t",
        "Retention": 7,
        "CreatedTime": 1554347313,
        "ClusterId": "cl-000ht6o9******h",
        "Bucket": "hbr-backup-oss",
        "Detail": "{\\\"doCopy\\\":true,\\\"doBackup\\\":false,\\\"instanceName\\\":\\\"instance example\\\",\\\"appConsistent\\\":false,\\\"destinationRegionId\\\":\\\"cn-shanghai\\\",\\\"enableFsFreeze\\\":true,\\\"osNameEn\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"osName\\\":\\\"Windows Server  2019 Data Center Edition 64bit Chinese Edition\\\",\\\"diskIdList\\\":[],\\\"backupVaultId\\\":\\\"\\\",\\\"snapshotGroup\\\":true,\\\"destinationRetention\\\":35,\\\"platform\\\":\\\"Windows Server 2012\\\",\\\"timeoutInSeconds\\\":60,\\\"backupRetention\\\":1,\\\"osType\\\":\\\"windows\\\",\\\"preScriptPath\\\":\\\"\\\",\\\"postScriptPath\\\":\\\"\\\",\\\"enableWriters\\\":true,\\\"ecsDeleted\\\":false}",
        "Schedule": "I|1602673264|P1D",
        "SpeedLimit": "0:24:5120",
        "InstanceId": "i-*********************",
        "PlanId": "plan-*********************",
        "BackupSourceGroupId": "System-Database",
        "FileSystemId": "00594",
        "OtsDetail": {
          "TableNames": {
            "TableName": [
              "test2_HBR_RESTORED"
            ]
          }
        },
        "InstanceName": "instancename",
        "UpdatedTime": 1554347313,
        "PlanName": "planname",
        "Include": "[\"/home/alice/*.pdf\", \"/home/bob/*.txt\"]",
        "Rules": {
          "Rule": [
            {
              "DestinationRetention": 90,
              "Schedule": "I|1631685600|P1D",
              "Retention": 90,
              "Disabled": true,
              "DoCopy": false,
              "DestinationRegionId": "cn-shanghai",
              "RuleId": "rule-0008i52rf0ulpni6kn6m",
              "RuleName": "Disk Golden Rule",
              "BackupType": "COMPLETE"
            }
          ]
        },
        "Resources": {
          "Resource": [
            {
              "SourceType": "UDM_DISK",
              "ResourceId": "d-j6cgioir6m******lu4",
              "Extra": "{\\\"doBackup\\\":false,\\\"diskName\\\":\\\"data_disk\\\",\\\"size\\\":100,\\\"type\\\":\\\"data\\\",\\\"category\\\":\\\"cloud_essd\\\",\\\"imageId\\\":\\\"\\\",\\\"device\\\":\\\"/dev/xvdb\\\",\\\"encrypted\\\":false}"
            }
          ]
        },
        "Paths": {
          "Path": [
            "[\"/home\"]"
          ]
        },
        "TrialInfo": {
          "TrialStartTime": 1579413159,
          "TrialVaultReleaseTime": 1594965600,
          "TrialExpireTime": 1584597600,
          "KeepAfterTrialExpiration": true
        },
        "InstanceGroupId": "i-**",
        "CrossAccountType": "CROSS_ACCOUNT",
        "CrossAccountUserId": 0,
        "CrossAccountRoleName": "BackupRole",
        "KeepLatestSnapshots": 0,
        "DestSourceType": "OSS",
        "DestDataSourceId": "ds-*********************",
        "DestDataSourceDetail": "{\\\"prefix\\\":\\\"/\\\"}",
        "ChangeListPath": "{\"dataSourceId\": \"ds-123456789\", \"path\": \"/changelist\"}",
        "LatestExecuteJobId": "job-12345678",
        "LatestFinishJobId": "job-00**************9khz",
        "CreatedByTag": false,
        "HitTags": {
          "HitTag": [
            {
              "Key": "type",
              "Value": "0",
              "Operator": "EQUAL"
            }
          ]
        },
        "BusinessStatus": "ACTIVE"
      }
    ]
  }
}

錯誤碼

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

變更歷史

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