云数据库 RDS-获取备份列表:响应消息

时间:2024-11-08 17:37:45

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    backups

    Array of objects

    参数解释

    备份列表。

    详情请参见表3

    total_count

    Integer

    参数解释

    总记录数。

    取值范围

    不涉及。

    表3 backups字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    参数解释

    备份ID。

    取值范围

    不涉及。

    name

    String

    参数解释

    备份名字。

    取值范围

    不涉及。

    type

    String

    参数解释

    备份类型。

    取值范围

    • auto:自动全量备份。
    • manual:手动全量备份。
    • fragment:差异全量备份。
    • incremental:自动增量备份。

    size

    Long

    参数解释

    备份大小,单位:KB

    取值范围

    不涉及。

    status

    String

    参数解释

    备份状态。

    取值范围

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

    begin_time

    String

    参数解释

    备份开始时间。

    • 全量备份类型下,指备份开始时间。
    • MySQL增量备份类型,指备份文件中上一轮增备任务的最后一个事务的提交时间。

    取值范围

    格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

    end_time

    String

    参数解释

    备份结束时间。

    • 全量备份类型下,指备份结束时间。
    • MySQL增量备份类型,指备份文件中最后一个事务的提交时间。

    取值范围

    格式为“yyyy-mm-ddThh:mm:ssZ”,其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。

    datastore

    Object

    参数解释

    数据库版本信息。

    详情请参见表4

    databases

    Array of objects

    参数解释

    用户自建库,仅Microsoft SQL Server的局部备份。

    详情请参见表5

    instance_id

    String

    参数解释

    备份所在实例ID。

    取值范围

    不涉及。

    associated_with_ddm

    Boolean

    参数解释:

    是否已被DDM实例关联。

    取值范围:

    • false:表示未被DDM实例关联。
    • true:表示被DDM实例关联。
    表4 datastore字段数据结构说明

    名称

    参数类型

    说明

    type

    String

    参数解释

    数据库引擎。

    取值范围

    不区分大小写。

    • MySQL
    • PostgreSQL
    • SQLServer

    version

    String

    参数解释

    数据库版本。

    取值范围

    不涉及。

    表5 databases字段数据结构说明

    名称

    参数类型

    说明

    name

    String

    参数解释

    用户自建数据库名。

    取值范围

    不涉及。

  • 正常响应样例

    RDS for MySQ L实例

    {
    	"backups": [{
    		"id": "43e4feaab48f11e89039fa163ebaa7e4br01",
    		"name": "xxxx.xxx",
    		"type": "auto",
    		"size": 2803,
    		"status": "COMPLETED",
    		"begin_time": "2018-08-06T12:41:14+0800",
    		"end_time": "2018-08-06T12:43:14+0800",
    		"datastore": {
    			"type": "MySQL",
    			"version": "5.7"
    		},
    		"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01",
    		"associated_with_ddm": false
    	}],
    	"total_count": 1
    }

    RDS for PostgreSQL实例:

    {
    	"backups": [{
    		"id": "43e4feaab48f11e89039fa163ebaa7e4br03",
    		"name": "xxxx.xxx",
    		"type": "incremental",
    		"size": 2803,
    		"status": "COMPLETED",
    		"begin_time": "2018-08-06T12:41:14+0800",
    		"end_time": "2018-08-06T12:43:14+0800",
    		"datastore": {
    			"type": "PostgreSQL",
    			"version": "1"
    		},
    		"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin03 ",
    		"associated_with_ddm": false
    	}],
    	"total_count": 1
    }

    RDS for SQL Server实例:

    {
    	"backups": [{
    		"id ": "43e4feaab48f11e89039fa163ebaa7e4br04",
    		"name": "xxxx.xxx",
    		"type": "manual",
    		"size": 2803,
    		"status": "COMPLETED",
    		"begin_time": "2018-08-06T12:41:14+0800",
    		"end_time": "2018-08-06T12:43:14+0800",
    		"datastore": {
    			"type": "SQLServer",
    			"version": "2014_WEB"
    		},
    		"databases": [{
    			"name": "user01"
    		}, {
    			"name": "user02"
    		}],
    		"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin04",
    		"associated_with_ddm": false
    	}],
    	"total_count": 1
    }
  • 异常响应

    请参见异常请求结果

support.huaweicloud.com/api-rds/rds_09_0005.html