全部产品
Search
文档中心

云数据库 OceanBase:DescribeAvailableMemResource - 查询内存资源信息

更新时间:Oct 23, 2024

查询 OceanBase 租户的内存资源信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oceanbase:DescribeAvailableMemResourceget
  • 全部资源
    *

请求参数

名称类型必填描述示例值
InstanceIdstring

Oceanbase 集群 ID。

ob317v4uif****
TenantIdstring

租户 ID。

ob2mr3oae0****
UnitNumlong

租户的资源分布节点数。
其与集群的部署模式相耦合,如集群模式为 2-2-2,则最后分布节点数最多为 2 个。

2
CpuNumlong

cpu 数量。

14

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
Dataobject

可用的内存资源信息。

MinMemlong

单个 unit 最小需要申请的内存大小,单位:GB。

5
MaxMemlong

单个 unit 最大可申请的内存大小,单位:GB。

10
UsedMemlong

租户的 unit 个数。

2
SafeMemstring

内存安全水位。

10.0

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-30OpenAPI 返回结构发生变更查看变更详情
2021-08-19新增 OpenAPI查看变更详情