docs
api
Cloud Memory(UMem)
CheckUDredisSpaceAllowance

Check remaining resources of high-performance UMem - CheckUDredisSpaceAllowance

Overview

Check remaining high-performance UMem resources, and resource pre-check before shard expansion.

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CheckUDredisSpaceAllowance.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)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 ListYes
SizeintThe capacity size for creating an instance, the target capacity size for shard expansionYes
CountstringThe number of instances to be created, [1-10]Yes
GroupIdstringResource ID, a required parameter for scaling up and downNo

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
CountintWhen creating instance resources, it indicates the number that can be created; when expanding resources, returning 1 means expansion is possible, 0 means the resources in the available zone are insufficient and cannot be expanded.Yes

Example

Request Example

https://api.surfercloud.com/?Action=CheckUDredisSpaceAllowance
&Region=baQYMUCr
&Zone=KsoovIkN
&Size=nSRPldjY
&Count=fFoecQur
&GroupId=mJadWYEV

Response Example

{
  "Action": "CheckUDredisSpaceAllowanceResponse",
  "Count": 7,
  "NeedMigrate": "zgysRHAz",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved