文档数据库服务 DDS-查询备份列表:响应消息

时间:2025-02-12 15:14:48

响应消息

  • 参数说明
    表2 参数说明

    名称

    参数类型

    是否必选

    描述

    backups

    Array of objects

    备份列表。详情请参见表3

    total_count

    Integer

    总记录数。

    表3 backups字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    id

    String

    备份ID。

    name

    String

    备份名称。

    instance_id

    String

    备份所属的实例ID,可以调用“查询实例列表”接口获取。如果未申请实例,可以调用“创建实例”接口创建。

    instance_name

    String

    备份所属的实例名称。

    datastore

    Object

    数据库版本信息。详情请参见表4

    type

    String

    备份类型。

    • 取值为“Auto”,表示自动全量备份。
    • 取值为“Manual”,表示手动全量备份。
    • 取值为“Incremental”,表示自动增量备份。

    begin_time

    String

    备份开始时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。

    end_time

    String

    备份结束时间,格式为“yyyy-mm-dd hh:mm:ss”。该时间为UTC时间。

    status

    String

    备份状态。取值:

    • BUILDING:备份中。
    • COMPLETED:备份完成。
    • FAILED:备份失败。
    • DISABLED:备份删除中。

    size

    Long

    备份大小,单位:KB。

    description

    String

    备份描述。

    表4 datastore字段数据结构说明

    名称

    参数类型

    是否必选

    描述

    type

    String

    数据库引擎。

    取值:DDS-Community。

    version

    String

    数据库版本。支持5.0、4.4、4.2、4.0、3.4版本,取值为“5.0”、“4.4”、“4.2”、“4.0”、“3.4”。

  • 响应示例
    {  "backups": [     {         "id": "43e4feaab48f11e89039fa163ebaa7e4br01",         "name": "backup-test",         "instance_id": "43e4feaab48f11e89039fa163ebaa7e4br01",         "instance_name": "cluster-test",        "datastore" : {                 "type" : "DDS-Community",                 "version" : "3.4"         },         "type": "auto",         "begin_time": "2018-08-06 12:41:14",         "end_time": "2018-08-06 12:43:14",        "status": "COMPLETED",         "size": 2803,        "description": "backup description"     }    ],    "total_count":1 }
support.huaweicloud.com/api-dds/dds_api_0029.html