All Products
Search
Document Center

ApsaraDB for OceanBase:DescribeAvailableMemResource

Last Updated:Dec 02, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
oceanbase:DescribeAvailableMemResourceget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the OceanBase cluster.

ob317v4uif****
TenantIdstringNo

The ID of the tenant.

ob2mr3oae0****
UnitNumlongYes

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
CpuNumlongYes

The number of CPU cores.

14

Response parameters

ParameterTypeDescriptionExample
object

The return result of the request.

RequestIdstring

The ID of the request.

EE205C00-30E4-****-****-87E3A8A2AA0C
Dataobject

The available memory size.

MinMemlong

The minimum memory size required for each resource unit, in GB.

5
MaxMemlong

The maximum memory size for each resource unit, in GB.

10
UsedMemlong

The number of resource units in the tenant.

2
SafeMemstring

The maximum allowed memory usage, in GB.

10.0

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2023-10-30The response structure of the API has changedView Change Details
2021-08-19Add OperationView Change Details