文档

DescribeDataBackupSet - 查询备份集信息

更新时间:

查询 OceanBase 备份集信息。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
Statusstring

按照备份集状态查询。

DONE
BackupObjectTypestring

按照备份对象类型查询。

tenant
StartTimestring

开始时间,

格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2022-12-27T16:00:00Z
EndTimestring

备份集结束时间。

2023-01-06T15:59:59Z
PageNumberinteger

页码。

1
PageSizeinteger

每页数量。
默认值:10。

10

返回参数

名称类型描述示例值
object

请求的返回结果。

TotalCountinteger

总记录数。

2
RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject []

备份集详情。

EndTimestring

备份结束时间。

2023-04-13T03:38:10Z
Statusstring

备份集状态。

RUNNING
Typestring

备份类型。

manual
StartTimestring

备份开始时间。

2020-05-22T17:04:18
DataSizeinteger

备份集数据大小。

31457280
Policystring

备份策略。

automated
SetIdinteger

备份集 ID。

imm-test-set-cb****ee-b7d7-11ed-956f-****3e10bd70
Methodstring

备份方法。

logical
Checkpointstring

位点时间。

2023-05-15T07:11:08Z
DataVersioninteger

数据版本号。

1678847020352
BackupObjectTypestring

备份对象类型。

cluster
BackupObjectsobject []

备份对象列表。

ClusterNamestring

集群名称。

test-****way
TenantNamestring

租户名称。

ob2mr3oae0****
DatabaseTablesListobject []

备份集列表。

Databasestring

数据库名称。

sms_pre
Tablesarray

表列表。

string

表列表。

{'Tables': []}
BackupResultsobject []

备份结果。

ClusterNamestring

集群名称。

container-opa-****-02
TenantNamestring

租户名称。

ob2mr3oae0****
TableBackupResultsobject []

表恢复结果。

Databasestring

数据库名称。

order_ce****_online
Tablestring

表名称。

tr_sale_order_****
Statusstring

备份状态。

RUNNING
Messagestring

错误描述。

Create tag success
DownloadTaskStatusstring

目标备份集所对应的备份任务状态。

not_exist
DownloadTaskIdlong

目标备份集所对应的备份任务 ID。

100***012
Validitystring

有效性,可空。

VALID
Progressstring

备份进度。

52
StorageClassstring

备份集类型。

  • 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错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.内部错误

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

变更历史

变更时间变更内容概要操作
2024-02-02OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
  • 本页导读 (0)