Skip to Content
分布式NewSQL数据库 TiDB列出按实例备份tidb的备份列表 - ListTiDBClusterBackup

列出按实例备份tidb的备份列表 - ListTiDBClusterBackup

简介

列出按实例备份tidb的备份列表

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称,当前 API 为 ListTiDBClusterBackupYes
PublicKeystring用户公钥,可从 控制台 获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名,参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
Idstring实例idYes
Limitint返回数据长度,默认为30,最大30No
Offsetint列表起始位置偏移量,默认为0No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码,为 0 则为成功返回,非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息,当 RetCode 非 0 时提供详细的描述信息No
DataBackupData备份信息Yes
TotalCountint备份总数No

数据模型

BackupData

字段名类型描述信息必填
BackupIdstring备份 IDYes
BackupStartTimeint备份起始时间Yes
BackupEndTimeint备份结束时间Yes
BackupSizeint备份文件大小,单位:MBYes
Statestring备份状态Yes
BackupTypestring备份方式Yes

示例

请求示例

https://api.tnqacloud.com/?Action=ListTiDBClusterBackup &Region=cn-zj &Id=MlaMfzgZ &Limit=7 &Offset=7

响应示例

{ "Action": "ListTiDBClusterBackupResponse", "BackupData": {}, "RetCode": 0, "TotalCount": 8 }