調用DescribeBackupTasks查詢執行個體進行中的備份任務-ApsaraDB for MongoDB-阿里雲

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeBackupTasks

none

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。	dds-2zeb2d64cb46xxxx
BackupJobId	string	否	備份任務 ID。說明如果您調用 CreateBackup 執行了手動備份，您可以將返回的備份 ID 傳入，用以查詢備份的進度。	170034

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
RequestId	string	請求 ID。	D648B367-15B6-1B42-BD4B-47507C9CC****
BackupJobs	array<object>	備份任務詳情。
	object	備份任務詳情。
BackupjobId	string	備份任務 ID。	170034
BackupSetStatus	string	備份任務狀態。 Scheduled：計劃中備份任務，包括未開始的常規備份任務。 Checking：備份前執行個體檢查。 Backuping：備份中。 Finished：備份完成。	Scheduled
BackupStartTime	string	備份開始時間。	2024-01-16T11:04:56Z
Progress	string	備份進度，單位為%。僅正在啟動並執行備份才會顯示進度。	18%
JobMode	string	備份模式，傳回值： Automated：系統自動備份。 Manual：手動備份。	Manual

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D648B367-15B6-1B42-BD4B-47507C9CC****",
  "BackupJobs": [
    {
      "BackupjobId": "170034\n",
      "BackupSetStatus": "Scheduled",
      "BackupStartTime": "2024-01-16T11:04:56Z",
      "Progress": "18%",
      "JobMode": "Manual"
    }
  ]
}

錯誤碼

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

變更歷史

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