文档

DescribeInstance - 查询集群信息

更新时间:

查询一个 OceanBase 集群的详细信息。

调试

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

授权信息

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

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

请求参数

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

OceanBase 集群 ID。

ob317v4uif****
PageNumberinteger

分页查询的页码。

  • 起始值:1。
  • 默认值:1。
1

返回参数

名称类型描述示例值
object

请求的返回结果。

RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Instanceobject

OceanBase 集群信息。

InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
InstanceNamestring

OceanBase 集群名称。

ob4test
InstanceClassstring

集群规格信息。
当前支持以下套餐:

  • 4C16GB:4 核 16GB。
  • 8C32GB:8 核 32GB。
  • 14C70GB:14 核 70GB。
  • 24C120GB:24 核 120GB。
  • 30C180GB:30 核 180GB。
  • 62C400GB:62 核 400GB。
  • 104C600GB:104 核 600GB。
  • 16C70GB:16 核 70GB。
  • 32C160GB:32 核 160GB。
  • 64C380GB:64 核 380GB。
  • 20C32GB:20 核 32GB。
  • 40C64GB:40 核 64GB。
  • 16C32GB:16 核 32GB。
  • 32C70GB:32 核 70GB。
  • 64C180GB:64 核 180GB。
  • 32C180GB:32 核 180GB。
  • 64C400GB:64 核 400GB。
14C70G
Seriesstring

实例的系列。

  • normal(默认):标准集群版(云盘)。
  • normal_ssd:标准集群版(本地盘)。
  • history:历史库集群版。
  • normal_kv: obkv 集群。
  • normal_hg:信创集群。
Normal
PayTypestring

OceanBase 集群的付费类型。

  • PREPAY:预付费。
  • POSTPAY:按量付费。
PREPAY
CreateTimestring

集群的创建时间(UTC 时间)。

2021-10-19T07:13:41Z
ExpireTimestring

集群过期时间(UTC 格式)。

2021-10-17T16:00:00Z
Versionstring

OBServer 版本信息。

2.2.77
DeployTypestring

集群的部署类型。

  • multiple:多机房。
  • single:单机房。
  • dual:双机房。
multiple
DeployModestring

集群的数据副本模式。

  • 单机房为 n。
  • 双机房为 n-n。
  • 多机房为 n-n-n。
说明
其中,n 为各机房的 OBServer 节点数。
1-1-1
DiskTypestring

集群部署的存储类型。

默认为 cloud_essd_pl1:ESSD 云盘。

cloud_essd_pl1
MaintainTimestring

集群的每天例行维护时间,UTC 时间。

19:00Z-20:00Z
DataMergeTimestring

集群的数据合并时间。

02:00
AutoRenewalboolean

是否开启自动续费。

该参数只在预付费(PREPAY)集群有意义。

true
IsTrustEcsboolean

是否使用可信 ecs。

true
Statusstring

集群状态。

  • PENDING_CREATE: 创建中。
  • ONLINE: 运行中。
  • TENANT_CREATING:租户创建中 。
  • TENANT_SPEC_MODIFYING:租户规格修改中。
  • EXPANDING: 节点扩容中。
  • REDUCING: 节点缩容中。
  • SPEC_UPGRADING:套餐规格扩容中。
  • DISK_UPGRADING:存储规格扩容中。
  • WHITE_LIST_MODIFYING: 修改白名单中。
  • PARAMETER_MODIFYING: 修改参数中。
  • SSL_MODIFYING: SSL 变更中。
  • PREPAID_EXPIRE_CLOSED: 预付费集群欠费中。
  • ARREARS_CLOSED: 后付费集群欠费中。
  • PENDING_DELETE: 删除中。 集群一般为运行中的状态(ONLINE)。
ONLINE
Resourceobject

集群的资源信息。

Cpuobject

集群的 CPU 资源信息。

TotalCpulong

集群总 CPU,单位:核数。

14
UsedCpulong

集群已使用的 CPU,单位:核数。

10
UnitCpulong

集群中每个副本节点的 CPU,单位:核数。

10
OriginalTotalCpulong

原始 CPU。

14
Memoryobject

集群的内存资源信息。

TotalMemorylong

集群总内存,单位:GB。

70
UsedMemorylong

集群已使用的内存,单位:GB。

10
UnitMemorylong

集群中每个副本的内存,单位:GB

10
OriginalTotalMemorylong

原始内存。

72
DiskSizeobject

集群的存储资源信息。

TotalDiskSizelong

集群总存储空间,单位:GB。

200
UsedDiskSizelong

集群已使用的存储空间,单位:GB。

100
UnitDiskSizelong

集群每个副本的存储空间,单位:GB

200
DataUsedSizedouble

数据盘大小规格,单位 GB。

200
MaxDiskUsedPercentdouble

磁盘使用率最大值(百分比)。

0.14
MaxDiskUsedObServerarray

磁盘服务器使用率最大值。

string

磁盘服务器使用率最大值。

i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSizelong

原始磁盘。

200
MaxDiskSizedouble

最大可创建磁盘大小。

80000
UnitCountlong

集群的资源 Unit 数量。

1
LogDiskSizeobject

集群的日志盘资源信息。

TotalDiskSizelong

集群总日志盘空间,单位 GB。

400
UnitDiskSizelong

集群每个副本的日志存储空间,单位:GB。

200
LogAssignedSizestring

分配的日志存储空间,单位:GB。

0.0
MaxLogAssignedObServerarray

分配的服务器最大存储空间信息。

string

分配的日志服务器最大存储空间列表。

["i-bp1g****","i-bp11****","i-bp19****"]
MaxLogAssignedPercentstring

分配的最大日志存储空间百分比。

6.68
OriginalTotalDiskSizeinteger

日志盘原始大小。

200
CapacityUnitobject

容量单元。

MaxCapacityUnitinteger

最大容量单元。

4
MinCapacityUnitinteger

最小容量单元。

1
UsedCapacityUnitstring

已用容量单位。

2
AutoUpgradeObVersionboolean

是否开启自动升级 OBServer 版本。

true
ObRpmVersionstring

OBServer 详细版本信息。

2.2.77-20210526202046
IsLatestObVersionboolean

OBServer 版本是否为最新版本。

true
AvailableZonesarray

可用区列表。

string

可用区列表。

cn-hangzhou-i
EnableUpgradeLogDiskboolean

是否允许升级日志盘规格。

false
Zonesarray

实例所属的可用区 ID。
更多详情,请参见 DescribeZones 获取可用区列表。

string

实例所属的可用区 ID。
更多详情,请参见 DescribeZones 获取可用区列表。

cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
InstanceRolestring

实例角色。

NORMAL
NodeNumstring

集群节点个数信息。 如果部署模式为 n-n-n,则节点个数为 n * 3。

6
ReplicaModestring

全功能型副本数。 返回值仅包含 3 和 2。

  • 3:表示 3 个全功能型副本。
  • 2:表示 2 个全功能型副本。

三可用区部署时,只支持 3 个全功能型副本,双可用区部署时,仅支持 2 个全功能型副本,单可用区部署时,可以支持 2 个或者 3 个全功能型副本。

2
IsolationOptimizationboolean

是否开启 Cgroup。

false
EnableIsolationOptimizationboolean

是否允许开通隔离优化。

false
InTempCapacityStatusboolean

临时容量状态。

false
DataDiskAutoScaleboolean

是否开启数据自动协调。

说明
此参数已废弃。
-
TenantCreatableobject

可创建的租户。

EnableCreateTenantboolean

集群是否允许创建租户。

true
DisableCreateTenantReasonstring

集群不允许创建租户的原因。

CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT
DataDiskAutoScaleConfigobject

数据盘自动协调配置。

AutoScaleboolean

是否开启。

true
Upperboundlong

扩容上限。

16
UpperThresholdlong

日常扩容阈值。

80
UpperMergeThresholdlong

合并扩容阈值。

90
MaxDiskSizelong

磁盘最大值。

80000
ScaleStepInNormallong

日常扩容步长。

50
ScaleStepInMergelong

合并扩容步长。

100
UpperScaleStrategystring

扩容策略(RAW/PERCENTAGE)

UpperScaleStepstring

扩容步长

EnableProxyServiceboolean

是否 Enable 代理服务。

  • true
  • false
true
ProxyServiceStatusstring

代理服务状态。

ONLINE
ProxyClusterIdstring

Proxy 集群 ID。

说明 仅 EnableProxyService 为 true 时,才会包含该参数。
proxy-56****a6tg2o
CpuArchitecturestring

集群的 CPU 架构。

X86
ReadOnlyResourceobject

集群的资源信息

Cpuobject

集群的 CPU 资源信息

TotalCpulong

集群总 CPU,单位:核数

14
UsedCpulong

集群已使用的 CPU,单位:核数

10
UnitCpulong

集群中每个副本节点的 CPU,单位:核数

10
OriginalTotalCpulong

原始 CPU

14
Memoryobject

集群的内存资源信息

TotalMemorylong

集群总内存,单位:GB

70
UsedMemorylong

集群已使用的内存,单位:GB

10
UnitMemorylong

集群中每个副本的内存,单位:GB

10
OriginalTotalMemorylong

原始内存

72
DiskSizeobject

集群的存储资源信息

TotalDiskSizelong

集群总存储空间,单位:GB

200
UsedDiskSizelong

集群已使用的存储空间,单位:GB

100
UnitDiskSizelong

集群每个副本的存储空间,单位:GB

200
DataUsedSizedouble

已使用的存储空间,单位:GB。

200
MaxDiskUsedPercentdouble

磁盘使用率最大值(百分比)。

0.14
MaxDiskUsedObServerarray

磁盘服务器使用率最大值。

string

磁盘服务器使用率最大值。

i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSizelong

原始磁盘。

200
MaxDiskSizedouble

最大可创建磁盘大小。

80000
UnitCountlong

集群的资源 Unit 数量。

1
LogDiskSizeobject

集群的日志盘资源信息。

TotalDiskSizelong

集群总日志盘空间,单位:GB。

400
UnitDiskSizelong

集群每个副本的日志存储空间,单位:GB

200
LogAssignedSizestring

已分配的日志存储空间.。

0.0
MaxLogAssignedObServerarray

已分配的最大 OBServer。

string

已分配的最大 OBServer。

["i-bp1g****","i-bp11****","i-bp19****"]
MaxLogAssignedPercentstring

已分配的最大日志百分比。

6.68
CapacityUnitobject

容量单元。

MaxCapacityUnitinteger

最大容量单元。

4
MinCapacityUnitinteger

最小容量单元。

1
UsedCapacityUnitstring

已用容量单位。

2
UnitSpecstring

代理服务的单元规格

SharedUnitNumLimitinteger

共享模式代理服务的单元数量上限

ExclusiveUnitNumLimitinteger

独占模式代理服务的单元数量上限

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Instance": {
    "InstanceId": "ob317v4uif****",
    "InstanceName": "ob4test",
    "InstanceClass": "14C70G",
    "Series": "Normal",
    "PayType": "PREPAY",
    "CreateTime": "2021-10-19T07:13:41Z",
    "ExpireTime": "2021-10-17T16:00:00Z",
    "Version": "2.2.77",
    "DeployType": "multiple",
    "DeployMode": "1-1-1",
    "DiskType": "cloud_essd_pl1",
    "MaintainTime": "19:00Z-20:00Z",
    "DataMergeTime": "02:00",
    "AutoRenewal": true,
    "IsTrustEcs": true,
    "Status": "ONLINE",
    "Resource": {
      "Cpu": {
        "TotalCpu": 14,
        "UsedCpu": 10,
        "UnitCpu": 10,
        "OriginalTotalCpu": 14
      },
      "Memory": {
        "TotalMemory": 70,
        "UsedMemory": 10,
        "UnitMemory": 10,
        "OriginalTotalMemory": 72
      },
      "DiskSize": {
        "TotalDiskSize": 200,
        "UsedDiskSize": 100,
        "UnitDiskSize": 200,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68",
        "OriginalTotalDiskSize": 200
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "AutoUpgradeObVersion": true,
    "ObRpmVersion": "2.2.77-20210526202046",
    "IsLatestObVersion": true,
    "AvailableZones": [
      "cn-hangzhou-i"
    ],
    "EnableUpgradeLogDisk": false,
    "Zones": [
      "cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j"
    ],
    "InstanceRole": "NORMAL",
    "NodeNum": "6",
    "ReplicaMode": "2",
    "IsolationOptimization": false,
    "EnableIsolationOptimization": false,
    "InTempCapacityStatus": false,
    "DataDiskAutoScale": true,
    "TenantCreatable": {
      "EnableCreateTenant": true,
      "DisableCreateTenantReason": "CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT"
    },
    "DataDiskAutoScaleConfig": {
      "AutoScale": true,
      "Upperbound": 16,
      "UpperThreshold": 80,
      "UpperMergeThreshold": 90,
      "MaxDiskSize": 80000,
      "ScaleStepInNormal": 50,
      "ScaleStepInMerge": 100,
      "UpperScaleStrategy": "",
      "UpperScaleStep": ""
    },
    "EnableProxyService": true,
    "ProxyServiceStatus": "ONLINE",
    "ProxyClusterId": "proxy-56****a6tg2o",
    "CpuArchitecture": "X86",
    "ReadOnlyResource": {
      "Cpu": {
        "TotalCpu": 14,
        "UsedCpu": 10,
        "UnitCpu": 10,
        "OriginalTotalCpu": 14
      },
      "Memory": {
        "TotalMemory": 70,
        "UsedMemory": 10,
        "UnitMemory": 10,
        "OriginalTotalMemory": 72
      },
      "DiskSize": {
        "TotalDiskSize": 200,
        "UsedDiskSize": 100,
        "UnitDiskSize": 200,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68"
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "UnitSpec": "",
    "SharedUnitNumLimit": 0,
    "ExclusiveUnitNumLimit": 0,
    "EnableReadOnlyReplica": true,
    "EnableReadOnlyReplicaManagement": true
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-02-02OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-26OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-07OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-11-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-10-30OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-21OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:PageNumber
出参OpenAPI 返回结构发生变更
2023-07-04OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:PageSize
    删除入参:PageNumber
出参OpenAPI 返回结构发生变更
2023-05-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-21API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-08-15OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-19OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-08-19新增 OpenAPI看变更集
2021-08-19OpenAPI 描述信息更新、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈