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 Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is CheckUDredisSpaceAllowance . | 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 |
Size | int | The capacity size for creating an instance, the target capacity size for shard expansion | Yes |
Count | string | The number of instances to be created, [1-10] | Yes |
GroupId | string | Resource ID, a required parameter for scaling up and down | 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 |
Count | int | When 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
}