DescribeAvailableMemResource - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to query the available memory resource of an OceanBase Database tenant.

Debugging

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the OceanBase cluster.	ob317v4uif****
TenantId	string	No	The ID of the tenant.	ob2mr3oae0****
UnitNum	long	Yes	The number of resource distribution nodes in the tenant. The number is determined by the deployment mode of the cluster. If the cluster is deployed in 2-2-2 mode, the maximum number of resource distribution nodes is 2.	2
CpuNum	long	Yes	The number of CPU cores.	14

Parameter	Type	Description	Example
	object	The return result of the request.
RequestId	string	The ID of the request.	EE205C00-30E4-**-**-87E3A8A2AA0C
Data	object	The available memory size.
MinMem	long	The minimum memory size required for each resource unit, in GB.	5
MaxMem	long	The maximum memory size for each resource unit, in GB.	10
UsedMem	long	The number of resource units in the tenant.	2
SafeMem	string	The maximum allowed memory usage, in GB.	10.0

Sample success responses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Data": {
    "MinMem": 5,
    "MaxMem": 10,
    "UsedMem": 2,
    "SafeMem": "10.0"
  }
}

For a list of error codes, visit the Service error codes.

Change time

Summary of changes

Operation

2023-10-30

The response structure of the API has changed

Change item	Change content
Output Parameters	The response structure of the API has changed.

2021-08-19

Add Operation