Display Memcache - DescribeUMemcacheGroup

Overview

Display Memcache

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUMemcacheGroup`.	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
Zone	string	Availability Zone. See Availability Zone List	No
ProjectId	string	Project ID. If not filled in, the default project is used, and the sub-account 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[UMemcacheGroupSet]	Group List, see UMemcacheGroupSet	No

Data Model

UMemcacheGroupSet

Field Name	Type	Description Information	Required
GroupId	string	Group ID	No
Name	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
Version	string	Memcache version information, default is 1.4.31	No
State	string	Status Tag Creating // Initializing CreateFail // Creation Failed Deleting // Deleting DeleteFail // Deletion Failed Running // Running Resizing // Resizing ResizeFail // Resize Failed Configing // Configuring ConfigFail // Configuration Failed Restarting // Restarting	No
CreateTime	int	Creation Time (UNIX Timestamp)	No
ModifyTime	int	Modification Time (UNIX Timestamp)	No
ExpireTime	int	Expiration Time (UNIX Timestamp)	No
ChargeType	string	Billing Type: Yearly, Monthly, Dynamic. Default is Dynamic.	No
Tag	string	Business Group Name	No

Example

Request Example


https://api.ucloud-global.com/?Action=DescribeUMemcacheGroup
&Region=cn-east-01
&GroupId=umemcache-00f986
&Offset=0
&Limit=20
&Tag=Default

Response Example


{
  "Action": "DescribeUMemcacheGroupResponse",
  "DataSet": [
    {
      "ChargeType": "Month",
      "ConfigId": "9a891891-c245-4b66-bcexxxxxxxxx",
      "CreateTime": 1522222,
      "ExpireTime": 12345,
      "GroupId": "umemcache-xxxxx",
      "ModifyTime": 1522222,
      "Name": "test1233",
      "Port": 11211,
      "Size": 2,
      "State": "Running",
      "Tag": "Default",
      "UsedSize": 0,
      "Version": "1.4.33",
      "VirtualIP": "x.xx.x.x"
    }
  ],
  "RetCode": 0
}