查询主备redis备份 - DescribeURedisBackup

简介

查询主备redis备份

定义

公共参数

参数名	类型	描述信息	必填
Action	string	对应的 API 指令名称，当前 API 为 `DescribeURedisBackup`	Yes
PublicKey	string	用户公钥，可从控制台获取	Yes
Signature	string	根据公钥及 API 指令生成的用户签名，参见签名算法	Yes

请求参数

参数名	类型	描述信息	必填
Region	string	地域。参见地域和可用区列表	Yes
ProjectId	string	项目ID。不填写为默认项目，子帐号必须填写。请参考GetProjectList接口	No
Offset	int	分页显示的起始偏移, 默认值为0	No
Limit	int	分页显示的条目数, 默认值为10	No
GroupId	string	组的ID	No

响应字段

字段名	类型	描述信息	必填
RetCode	int	返回状态码，为 0 则为成功返回，非 0 为失败	Yes
Action	string	操作指令名称	Yes
Message	string	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息	No
TotalCount	int	用户名下总的备份个数	No
DataSet	array[URedisBackupSet]	备份列表参见 URedisBackupSet	No

数据模型

URedisBackupSet

字段名	类型	描述信息	必填
BackupId	string	备份ID	No
Zone	string	可用区，参见可用区列表	No
GroupId	string	对应的实例ID	No
GroupName	string	组名称	No
BackupName	string	备份的名称	No
BackupTime	int	备份时间 (UNIX时间戳)	No
BackupSize	int	备份文件大小, 以字节为单位	No
BackupType	string	备份类型: Manual 手动 Auto 自动	No
State	string	备份的状态: Backuping 备份中 Success 备份成功 Error 备份失败 Expired 备份过期	No

示例

请求示例


https://api.an-link.com/?Action=DescribeURedisBackup
&Region=cn-east-01
&Offset=0
&Limit=20

响应示例


{
  "Action": "DescribeURedisBackupResponse",
  "DataSet": [
    {
      "BackupId": "24149c99-4df6-4b5a-99b4-8ab1ca2d7aaa",
      "BackupName": "backup-test",
      "BackupSize": 1024,
      "BackupTime": 1403249482,
      "BackupType": 1,
      "GroupId": "uredis-2cwmyb",
      "GroupName": "uredis-one",
      "State": "Success"
    },
    {
      "BackupId": "24149c99-4df6-4b5a-99b4-8ab1ca2d7aab",
      "BackupName": "backup-test2",
      "BackupSize": 1024,
      "BackupTime": 1403249482,
      "BackupType": 1,
      "GroupId": "uredis-0vcq2a",
      "GroupName": "uredis-two",
      "State": "Error"
    }
  ],
  "RetCode": 0,
  "TotalCount": 2
}