使用DescribeBackupJob API擷取備份任務詳情-雲原生資料倉儲AnalyticDB-阿里雲

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:DescribeBackupJob

get

*DBInstance

acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 版執行個體的詳情，包括執行個體 ID。	gp-xxxxxxxxx
BackupJobId	integer	是	備份任務 ID。	123

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
BackupJobId	string	備份任務 ID。	123
BackupId	string	備份組 ID。說明您可以調用 DescribeDataBackups 查看目標執行個體下所有備份組的備份組 ID。	1111111111
BackupMode	string	備份模式。取值說明： Automated：系統自動備份 Manual：手動備份	Automated
BackupStatus	string	備份狀態。取值說明： schedule：初始化中 check：檢查中 backup：備份中 finish：已完成	backup
Process	string	備份任務進度百分比。	50%
StartTime	string	備份任務開始時間（UTC），格式為 YYYY-MM-DDThh:mm:ssZ。	2023-01-03T16:00:00Z

樣本

正常返回樣本

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "BackupJobId": "123",
  "BackupId": "1111111111",
  "BackupMode": "Automated",
  "BackupStatus": "backup",
  "Process": "50%",
  "StartTime": "2023-01-03T16:00:00Z"
}

錯誤碼

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

變更歷史

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