Query master-slave Redis backup - DescribeURedisBackup

Overview

Query master-slave Redis backup

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeURedisBackup`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
GroupId	string	Group ID, if RegionType is not provided, GroupId is a required field	No
Offset	int	The starting offset for pagination display, the default value is 0.	No
Limit	int	Number of items displayed per page, the default value is 10	No
SlaveZone	string	Cross-IDC URedis, the availability zone where the slave is located (must be in the same Region as the Zone, and cannot be the same)	No
RegionType	string	Used to distinguish between cross-availability backup and normal backup. The default is normal. Cross-availability is divided into (source, target).	No
BackupId	string	if Backup Id not NULL, only return this backup info	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
TotalCount	int	Total number of backups under the username	No
DataSet	array[URedisBackupSet]	Backup List See URedisBackupSet	No

Data Model

URedisBackupSet

Field Name	Type	Description Information	Required
Zone	string	Availability Zone, see Availability Zone List	No
BackupId	string	Backup ID	No
GroupId	string	Corresponding Instance ID	No
GroupName	string	Group Name	No
BackupName	string	Name of the Backup	No
BackupTime	int	Backup Time (UNIX Timestamp)	No
BackupSize	int	Backup file size, in bytes	No
BackupType	string	Backup Type: Manual Manual Auto Automatic	No
State	string	Status of the backup: Backuping In progress Success Backup successful Error Backup failed Expired Backup expired	No
SrcRegionName	string	Cross Region Backup Src Region	No
DstRegionName	string	Cross Region Backup 1st Region	No
MemorySize	int	Source Redis Memory Size	No
RedisVersion	string	Source Redis Version	No

Example

Request Example


https://api.ucloud-global.com/?Action=DescribeURedisBackup
&Region=cn-bj2
&SlaveZone=IRVyPYOd
&RegionType=JaAnSlXu
&BackupId=UwszgeYW
&BackupId=UUBzedWb

Response Example


{
  "Action": "DescribeURedisBackupResponse",
  "DataSet": [
    {
      "BackupId": "a75XXXa9-d9e1-4d38-9XX1-aecad464XXX5",
      "BackupName": "sgbf_XXXXXX",
      "BackupSize": 18,
      "BackupTime": 1529912363,
      "BackupType": "Manual",
      "GroupId": "uredis-grXXXz",
      "GroupName": "zbredia_XXXXX",
      "State": "Success",
      "Zone": "cn-bj2-04"
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}