DescribeDataBackupSet - 查詢備份組資訊 - ApsaraDB for OceanBase (Deprecated)

查詢 OceanBase 備份組資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

oceanbase:DescribeDataBackupSet

none

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	OceanBase 叢集 ID。	ob317v4uif****
Status	string	否	按照備份組狀態查詢。	DONE
BackupObjectType	string	否	按照備份物件類型查詢。	tenant
StartTime	string	否	開始時間，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 時間）。	2022-12-27T16:00:00Z
EndTime	string	否	備份組結束時間。	2023-01-06T15:59:59Z
PageNumber	integer	否	頁碼。	1
PageSize	integer	否	每頁數量。預設值：10。	10

返回參數

名稱	類型	描述	樣本值
	object	請求的返回結果。
TotalCount	integer	總記錄數。	2
RequestId	string	請求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	array<object>	備份組詳情。
	array<object>	備份組詳情。
EndTime	string	備份結束時間。	2023-04-13T03:38:10Z
Status	string	備份組狀態。	RUNNING
Type	string	備份類型。	manual
StartTime	string	備份開始時間。	2020-05-22T17:04:18
DataSize	integer	備份組資料大小。	31457280
Policy	string	備份策略。	automated
SetId	string	備份組 ID。	imm-test-set-cb**ee-b7d7-11ed-956f-**3e10bd70
Method	string	備份方法。	logical
Checkpoint	string	位點時間。	2023-05-15T07:11:08Z
DataVersion	integer	資料版本號碼。	1678847020352
BackupObjectType	string	備份物件類型。	cluster
BackupObjects	array<object>	備份對象列表。
	array<object>	備份組詳情。
ClusterName	string	叢集名稱。	test-****way
TenantName	string	租戶名稱。	ob2mr3oae0****
DatabaseTablesList	array<object>	備份組列表。
	object	備份組列表。
Database	string	資料庫名稱。	sms_pre
Tables	array	表列表。
	string	表列表。	{'Tables': []}
BackupResults	array<object>	備份結果。
	array<object>	備份結果詳情。
ClusterName	string	叢集名稱。	container-opa-****-02
TenantName	string	租戶名稱。	ob2mr3oae0****
TableBackupResults	array<object>	表恢複結果。
	object	表恢複結果。
Database	string	資料庫名稱。	order_ce****_online
Table	string	表名稱。	tr_sale_order_****
Status	string	備份狀態。	RUNNING
Message	string	錯誤描述。	Create tag success
DownloadTaskStatus	string	目標備份組所對應的備份任務狀態。	not_exist
DownloadTaskId	integer	目標備份組所對應的備份任務 ID。	100***012
Validity	string	有效性，可空。	VALID
Progress	string	備份進度。	52
StorageClass	string	備份組類型。 standard：一級備份。 archive：歸檔（二級）備份。	standard

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": [
    {
      "EndTime": "2023-04-13T03:38:10Z",
      "Status": "RUNNING",
      "Type": "manual",
      "StartTime": "2020-05-22T17:04:18",
      "DataSize": 31457280,
      "Policy": "automated",
      "SetId": "imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70",
      "Method": "logical",
      "Checkpoint": "2023-05-15T07:11:08Z",
      "DataVersion": 1678847020352,
      "BackupObjectType": "cluster",
      "BackupObjects": [
        {
          "ClusterName": "test-****way",
          "TenantName": "ob2mr3oae0****",
          "DatabaseTablesList": [
            {
              "Database": "sms_pre",
              "Tables": [
                "{'Tables': []}"
              ]
            }
          ]
        }
      ],
      "BackupResults": [
        {
          "ClusterName": "container-opa-****-02",
          "TenantName": "ob2mr3oae0****\n",
          "TableBackupResults": [
            {
              "Database": "order_ce****_online",
              "Table": "tr_sale_order_****",
              "Status": "RUNNING",
              "Message": "Create tag success"
            }
          ]
        }
      ],
      "DownloadTaskStatus": "not_exist",
      "DownloadTaskId": 0,
      "Validity": "VALID",
      "Progress": "52",
      "StorageClass": "standard"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	The request processing has failed due to some unknown error.	內部錯誤

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

變更歷史

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