Pull UDRedis Shard Information - DescribeUMemBlockInfo

Overview

Pull UDRedis Shard Information

💡 In the return parameters, BlockSlotBegin/BlockSlotEnd are currently supported by some data centers, and will be supported by all data centers in the future.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUMemBlockInfo`.	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	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
SpaceId	string	UMem Memory Resource ID	Yes
Offset	int	The starting offset for pagination display, the default value is 0.	Yes
Limit	int	Number of items displayed per page, the default value is 10	Yes

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
DataSet	array[UMemBlockInfo]	Distributed Redis Shard Information	No
ReadMode	string	Cluster read-write separation strategy. Enumeration values ['Custom': User-defined node weights, 'Uniform': All nodes, including the master node, average read requests, 'ReadOnly': Read requests are evenly distributed to read-only nodes].	No

Data Model

UMemBlockInfo

Field Name	Type	Description Information	Required
BlockId	string	Shard ID	Yes
BlockPort	int	Shard Port	Yes
BlockSize	int	Capacity Unit GB	Yes
BlockState	string	Instance Status Starting // Creating Creating // Initializing CreateFail // Creation Failed Fail // Creation Failed Deleting // Deleting DeleteFail // Deletion Failed Running // Running Resizing // Resizing ResizeFail // Resize Failed Configing // Configuring ConfigFail // Configuration Failed Restarting // Restarting SetPasswordFail //Setting Password Failed UpgradeMemInit //Task Initializing	Yes
BlockSlotBegin	int	Starting value of the key slot for shard maintenance	Yes
BlockSlotEnd	int	End value of the key slot for shard maintenance	Yes
BlockVip	string	Sharded IP	No
BlockUsedSize	int	Usage Unit MB	No
BlockType	string	Shard Type	No
BlockReadWeight	int		No
BlockName	string	Shard Name	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeUMemBlockInfo
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=tfmMJsli
&SpaceId=OGmgfZKi
&Offset=9
&Limit=6

Response Example

{
  "Action": "DescribeUMemBlockInfoResponse",
  "DataSet": [
    {
      "BlockId": "GhAwvlNF",
      "BlockPort": 8,
      "BlockSize": 5,
      "BlockSlotBegin": 9,
      "BlockSlotEnd": 8,
      "BlockState": "xaRcEEoZ",
      "BlockUsedSize": 3,
      "BlockVip": "ggWsZHay"
    }
  ],
  "ReadMode": "zrIdNFWx",
  "RetCode": 0
}

DescribeUMem DescribeURedisVersion