Query Master-Slave Redis - DescribeURedisGroup

Overview

Query Master-Slave Redis

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeURedisGroup`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	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
Zone	string	Availability Zone. See Availability Zone List	No
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 specified, the description is obtained, otherwise it is a list operation, Offset/Limit must be specified	No
Offset	int	The starting offset for pagination display, the default value is 0.	No
Limit	int	Number of items displayed per page, default value is 20	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 nodes in the group	No
DataSet	array[URedisGroupSet]	Group List See URedisGroupSet	No

Data Model

URedisGroupSet

Field Name	Type	Description Information	Required
Zone	string	The availability zone where the instance is located, or the availability zone where the master redis is located, see Availability Zone List	No
RewriteTime	int	Return operation and maintenance time 0 //0 o'clock 1 //1 o'clock and so on	Yes
Role	string	Instance Type	Yes
VPCId	string	vpcid	No
SubnetId	string	subnetid	No
GroupId	string	Group ID	No
Name	string	Group Name	No
Type	string	Space Type: single (no hot backup), double (hot backup)	No
Protocol	string	Protocol	No
MemorySize	int	Capacity Unit GB	No
GroupName	string	Group Name	No
ConfigId	string	Configuration ID of the node	No
VirtualIP	string	Virtual IP address of the node	No
Port	int	Service port assigned to the node	No
Size	int	Capacity Unit GB	No
UsedSize	int	Usage Unit MB	No
AutoBackup	string	Do you need automatic backup, enable, disable	No
BackupTime	int	Group automatic backup start time, measured in hours, range [0-23]	No
HighAvailability	string	Enable high availability, enable, disable	No
Version	string	Redis Version Information	No
ExpireTime	int	Expiration Time (UNIX Timestamp)	No
ChargeType	string	Billing Type: Yearly, Monthly, Dynamic. Default is Dynamic.	No
State	string	Status Marker Creating // Initializing CreateFail // Creation Failed Deleting // Deleting DeleteFail // Deletion Failed Running // Running Resizing // Resizing ResizeFail // Resize Failed Configing // Configuring ConfigFail // Configuration Failed	No
CreateTime	int	Creation Time (UNIX Timestamp)	No
ModifyTime	int	Modification Time (UNIX Timestamp)	No
Tag	string	Business Group Name	No
SlaveZone	string	Cross-IDC URedis, the availability zone where the slave redis is located, see Availability Zone List	No
IsHighPerformance	boolean	Is it a high-performance Redis, true means yes; false means no	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeURedisGroup
&Region=cn-bj2
&Zone=SZQDzLQZ

Response Example

{
  "Action": "DescribeURedisGroupResponse",
  "DataSet": [
    {
      "AutoBackup": "disable",
      "BackupTime": 3,
      "ChargeType": "Month",
      "ConfigId": "03fXXXXca9-b64d-4XXd-abc7-c6b9XXXXX801",
      "CreateTime": 1529912330,
      "ExpireTime": 1530374400,
      "GroupId": "uredis-gXXXXXbz",
      "GroupName": "zbredia_XXXXX_modify",
      "HighAvailability": "enable",
      "MemorySize": 4,
      "ModifyTime": 1529912337,
      "Name": "zbreXXia_XXXXX_modify",
      "Port": 6379,
      "Protocol": "redis",
      "Size": 4,
      "SlaveZone": "",
      "State": "Running",
      "SubnetId": "subnet-iXXXXhz",
      "Tag": "Default",
      "Type": "double",
      "UsedSize": 61,
      "VPCId": "uvnet-oXXXX4j",
      "Version": "3.0",
      "VirtualIP": "XX.X9.XX.1XX",
      "Zone": "cn-bj2-04"
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}

DescribeUMemSpace ModifyURedisGroupName