DescribeDataBackupSet - 查询备份集信息 - 云数据库 OceanBase

查询 OceanBase 备份集信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:DescribeDataBackupSet		全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
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>	备份集详情。
Data	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	integer	备份集 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>	备份对象列表。
BackupObjects	object	备份集详情。
ClusterName	string	集群名称。	test-****way
TenantName	string	租户名称。	ob2mr3oae0****
DatabaseTablesList	array<object>	备份集列表。
DatabaseTablesList	object	备份集列表。
Database	string	数据库名称。	sms_pre
Tables	array	表列表。
Tables	string	表列表。	{'Tables': []}
BackupResults	array<object>	备份结果。
BackupResults	object	备份结果详情。
ClusterName	string	集群名称。	container-opa-****-02
TenantName	string	租户名称。	ob2mr3oae0****
TableBackupResults	array<object>	表恢复结果。
TableBackupResults	object	表恢复结果。
Database	string	数据库名称。	order_ce****_online
Table	string	表名称。	tr_sale_order_****
Status	string	备份状态。	RUNNING
Message	string	错误描述。	Create tag success
DownloadTaskStatus	string	目标备份集所对应的备份任务状态。	not_exist
DownloadTaskId	long	目标备份集所对应的备份任务 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": 0,
      "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.	内部错误

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-02-02	OpenAPI 错误码发生变更	查看变更详情