文档首页/ 云数据库 GaussDB/ API参考/ API(推荐)/ 备份恢复管理/ 查询备份扩展配置 - QueryingExtendedBackupPolicies
更新时间:2026-07-14 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,此参数是用户创建实例的唯一标识。请参考查询数据库实例列表 - QueryingDBInstances接口获取实例ID。

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

X-Language

String

参数解释:

指定接口返回信息的语言类型。

约束限制:

不涉及。

取值范围:

  • zh-cn:中文
  • en-us:英文

默认取值

en-us

响应参数

表3 参数说明

参数

参数类型

描述

rate_limit

Integer

参数解释:

备份流控,单位MB/s。

取值范围:

不涉及。

file_split_size

Integer

参数解释:

分片大小,单位GB。

取值范围:

不涉及。

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。

请求示例

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

响应示例

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

{ 
  "rate_limit" : 76, 
  "file_split_size": 1,
  "prefetch_block" : 65, 
  "enable_standby_backup" : true, 
  "close_compression" : true,
  "backup_parallel_degree": 4 ,
  "default_backup_method": "PHYSICAL_BACKUP",
  "default_backup_media_type": "OBS" 
}

状态码

错误码

请参见错误码

相关文档