文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 备份恢复管理/ 查询备份扩展配置 - QueryingExtendedBackupPolicies
更新时间:2025-12-25 GMT+08:00
分享

查询备份扩展配置 - QueryingExtendedBackupPolicies

功能介绍

查询备份扩展配置信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/instances/{instance_id}/backups/config

表1 参数说明

名称

是否必选

参数类型

说明

project_id

String

参数解释:

租户在某一Region下的项目ID。

获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识。

约束限制:

不涉及。

取值范围:

只能由英文字母、数字组成,且长度为36个字符。

默认取值

不涉及。

请求参数

无。

响应参数

表2 参数说明

参数

参数类型

描述

rate_limit

Integer

参数解释:

备份流控。

取值范围:

不涉及。

prefetch_block

Integer

参数解释:

差量预取页面个数。

取值范围:

不涉及。

enable_standby_backup

Boolean

参数解释:

启用备机备份标识。

取值范围:

  • true:启用备机备份。
  • false:不启用备机备份。

close_compression

Boolean

参数解释:

是否关闭备份压缩。

取值范围:

  • true:关闭备份压缩。
  • false:开启备份压缩。

default_backup_method

String

参数解释:

默认备份方式。

取值范围:

  • PHYSICAL_BACKUP:物理备份。
  • EBACKUP:快照备份。

default_backup_media_type

String

参数解释:

默认备份存储介质。

取值范围:

  • OBS:对象存储。

backup_parallel_degree

Integer

参数解释:

并行备份任务数。将备份任务拆分成多个子任务同时备份,提高备份效率。

取值范围:

1,2,4,8。

backup_node_info

object

参数解释:

备份节点信息,指定节点或AZ下的节点进行备份。详情参见表3

表3 backup_node_info字段数据结构说明

参数

是否必选

参数类型

描述

az_list

String

参数解释:

选择指定AZ下的节点进行备份。

取值范围:

不涉及。

node_list

String

参数解释:

选择指定节点进行备份。

取值范围:

不涉及。

请求示例

GET https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/config

响应示例

备份流控76,差量预取页面个数65,启用备机备份,关闭备份压缩,备份方式是物理备份,存储介质是OBS。

{ 
  "rate_limit" : 76, 
  "prefetch_block" : 65, 
  "enable_standby_backup" : true, 
  "close_compression" : true
  "backup_parallel_degree": 4 ,
  "default_backup_method": "PHYSICAL_BACKUP",
  "default_backup_media_type": "OBS", 
   "backup_node_info" : { 
     "az_list" : [], 
     "node_list" : [ "node1", "node2" ] 
   }
}

状态码

错误码

请参见错误码

相关文档