计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

查询备份列表(v3.1)

更新时间:2024-12-27 GMT+08:00

功能介绍

获取备份列表。

接口约束

该接口仅支持查询GaussDB的手动全量备份及自动全量备份。

URI

GET https://{Endpoint}/v3.1/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

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

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

instance_id

String

参数解释:

实例ID,此参数是用户创建实例的唯一标识,用于查询某一实例的备份。

约束限制:

日志备份列表查询时实例ID必选。

取值范围:

严格匹配UUID规则,只能由英文字母、数字组成,且长度为32个字符。

默认取值

不涉及。

backup_id

String

参数解释:

备份ID,此参数是实例备份的唯一标识,用于查询某一备份的信息。

约束限制:

不涉及。

取值范围:

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

默认取值

不涉及。

backup_type

String

参数解释:

备份类型。

约束限制:

不涉及。

取值范围:

  • auto:实例级自动全量备份。
  • manual:实例级手动全量备份。

默认取值

不涉及。

offset

Integer

参数解释:

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制:

不涉及。

取值范围:

[0, 10^10-1]

默认取值

默认为0(偏移0条数据,表示从第一条数据开始查询)。

limit

Integer

参数解释:

查询记录数。

约束限制:

不涉及。

取值范围:

[0, 100]

默认取值

默认为100。

begin_time

String

参数解释:

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

约束限制:

可与end_time配合使用,end_time不使用时,查询结果为begin_time之后创建的备份列表,使用end_time时,查询结果为begin_time和end_time之间创建的备份列表。

取值范围:

不涉及。

默认取值

不涉及。

end_time

String

参数解释:

查询结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。示例:2022-05-09T16:01:10+0800。

约束限制:

可与begin_time配合使用,begin_time不使用时,查询结果为end_time之前创建的备份列表,使用begin_time时,查询结果为begin_time和end_time之间创建的备份列表。

取值范围:

不涉及。

默认取值

不涉及。

请求参数

无。

响应参数

表2 参数说明

参数

参数类型

描述

backups

Array of objects

参数解释:

备份信息。

详情请参见表3

total_count

Long

参数解释:

备份文件的总数。

取值范围

[0, 2^63 - 1],实际总数取决于备份列表个数。

表3 backups字段数据结构说明

参数

参数类型

描述

id

String

参数解释:

备份ID。备份的唯一标识。

取值范围

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

name

String

参数解释:

备份名称。

取值范围

不涉及。

description

String

参数解释:

备份文件描述信息。

取值范围

不超过256个字符,且不能包含回车和 ! < " = ' > &这些特殊字符。

begin_time

String

参数解释

备份开始时间,格式为"yyyy-mm-ddThh:mm:ssZ"。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。示例:2022-05-09T16:01:10+0800。

取值范围

不涉及。

end_time

String

参数解释

备份结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。示例2022-05-09T16:01:10+0800。

取值范围

不涉及。

status

String

参数解释

备份状态。

取值范围

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

size

Double

参数解释

备份大小(单位:MB)。

取值范围

由备份大小决定。

type

String

参数解释

备份类型。

取值范围

  • auto:实例级自动全量备份
  • manual:实例级手动全量备份

datastore

Object

参数解释

数据库信息。

详情请参见表4

instance_id

String

参数解释

实例ID。表明备份属于哪个实例。

取值范围:

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

表4 datastore字段数据结构说明

参数

参数类型

描述

type

String

参数解释

数据库引擎,不区分大小写,取值如下:

GaussDB

取值范围

不涉及。

version

String

参数解释

数据库版本。不填时,默认为当前最新版本。

数据库支持版本可根据查询数据库引擎的版本接口获取。

取值范围:

不涉及。

请求示例

  • 查询所有备份列表
    GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/backups
  • 根据指定条件查询实例列表
    GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3.1/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=88be33e4c5a64ceba42b42da89310111in14&backup_id=88be1234c5a64ceba42b42da89310111br14&backup_type=auto&begin_time=2022-05-09T16:15:50+0800&end_time=2022-05-09T16:20:45+0800&limit=1&offset=1

响应示例

查询备份列表成功。

{
    "backups": [
        {
            "id": "a696cd25e4fc453aa503650225cece8bbr14",
            "name": "GaussDB-hly-ha-20220509080110906",
            "status": "FAILED",
            "size": 0.0,
            "type": "auto",
            "datastore": {
                "type": "GaussDB",
                "version": "1.4"
            },
            "begin_time": "2022-05-09T16:01:10+0800",
            "end_time": "2022-05-09T16:04:31+0800",
            
            "instance_id": "164abc6d35114095bb849d007b19db3bin14"
        },
        {
            "id": "5651c62a7f12461c98020dd3abfe24ccbr14",
            "name": "GaussDB-hly-master-20220509022658257",
            "status": "FAILED",
            "size": 0.0,
            "type": "auto",
            "datastore": {
                "type": "GaussDB",
                "version": "1.4"
            },
            "begin_time": "2022-05-09T10:26:58+0800",
            "end_time": "2022-05-09T10:30:17+0800",
            
            "instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14"
        }
	],
    "total_count": 167
}

状态码

错误码

请参见错误码

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容