Skip to Content
Cloud Memory(UMem) DescribeUMemSpace

Query Space - DescribeUMemSpace

Overview

Get UMem Memory Space List

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeUMemSpace.Yes
PublicKeystringThe user’s public key can be obtained from Console Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
OffsetintData offset, default is 0No
LimitintReturn data length, default is 20No
SpaceIdstringMemory Space ID (If no ID, then retrieve all)No
ProtocolstringProtocol Type: memcache, redisNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataSetarray[UMemSpaceSet]JSON formatted UMem memory space instance list, see UMemSpaceSet for details.No
TotalCountintTotal count based on filter conditionsNo

Data Model

UMemSpaceSet

Field NameTypeDescription InformationRequired
ZonestringAvailability Zone, see Availability Zone ListNo
Tagstringinstance tagYes
RewriteTimeintOperation and Maintenance Time
0 //0 o’clock
1 //1 o’clock
And so on
Yes
SpaceIdstringMemory Space IDNo
SubnetIdstringSubnet IDNo
VPCIdstringVPC IDNo
NamestringMemory Space NameNo
CreateTimeintCreation TimeNo
ExpireTimeintExpiration DateNo
TypestringSpace Type: single (no hot backup), double (hot backup)No
ProtocolstringProtocol Type: memcache, redisNo
SizeintCapacity Unit GBNo
UsedSizeintUsage Unit MBNo
StatestringStarting: Creating Running: Running Fail: FailureNo
ChargeTypestringYearly, Monthly, Dynamic, TrialNo
Addressarray[UMemSpaceAddressSet]Please refer to UMemSpaceAddressSet for IP port information.No
SupportAofRollbackbooleanDoes the instance support rollback?No
AofRollbackEnablebooleanIs the instance rollback enabled?No

UMemSpaceAddressSet

Field NameTypeDescription InformationRequired
IPstringUMem Instance Access IPNo
PortintUMem Instance Access PortNo

Example

Request Example

https://api.ucloud-global.com/?Action=DescribeUMemSpace &Region=cn-bj2 &Protocol=dSWWMtLZ

Response Example

{ "Action": "DescribeUMemSpaceResponse", "DataSet": [ { "Address": [ { "IP": "XX.19X.1XX.4XX", "Port": 11211 } ], "ChargeType": "Month", "CreateTime": 1529894002, "ExpireTime": 1530374400, "Name": "fbs_XXXX", "Protocol": "memcache", "Size": 8, "SpaceId": "umem-m3XXXXXX3", "State": "Running", "SubnetId": "subnet-iiXXXXz", "Tag": "Default", "Type": "double", "UsedSize": 0, "VPCId": "uvnet-XXXXXX4j", "Zone": "cn-bj2-04" } ], "RetCode": 0, "TotalCount": 2 }