DescribeInstance - 查询集群信息 - 云数据库 OceanBase

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:DescribeInstance	get	Instance acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
PageNumber	integer	否	分页查询的页码。起始值：1。默认值：1。	1

返回参数

名称	类型	描述	示例值
	object	请求的返回结果。
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Instance	object	OceanBase 集群信息。
InstanceId	string	OceanBase 集群 ID。	ob317v4uif****
InstanceName	string	OceanBase 集群名称。	ob4test
InstanceClass	string	集群规格信息。当前支持以下套餐： 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
Series	string	实例的系列。 normal（默认）：标准集群版（云盘）。 normal_ssd：标准集群版（本地盘）。 history：历史库集群版。 normal_kv: obkv 集群。 normal_hg：信创集群。	Normal
PayType	string	OceanBase 集群的付费类型。 PREPAY：预付费。 POSTPAY：按量付费。	PREPAY
CreateTime	string	集群的创建时间（UTC 时间）。	2021-10-19T07:13:41Z
ExpireTime	string	集群过期时间（UTC 格式）。	2021-10-17T16:00:00Z
Version	string	OBServer 版本信息。	2.2.77
DeployType	string	集群的部署类型。 multiple：多机房。 single：单机房。 dual：双机房。	multiple
DeployMode	string	集群的数据副本模式。单机房为 n。双机房为 n-n。多机房为 n-n-n。说明其中，n 为各机房的 OBServer 节点数。	1-1-1
DiskType	string	集群部署的存储类型。默认为 cloud_essd_pl1：ESSD 云盘。	cloud_essd_pl1
MaintainTime	string	集群的每天例行维护时间，UTC 时间。	19:00Z-20:00Z
DataMergeTime	string	集群的数据合并时间。	02:00
AutoRenewal	boolean	是否开启自动续费。该参数只在预付费（PREPAY）集群有意义。	true
IsTrustEcs	boolean	是否使用可信 ecs。	true
Status	string	集群状态。 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
Resource	object	集群的资源信息。
Cpu	object	集群的 CPU 资源信息。
TotalCpu	long	集群总 CPU，单位：核数。	14
UsedCpu	long	集群已使用的 CPU，单位：核数。	10
UnitCpu	long	集群中每个副本节点的 CPU，单位：核数。	10
OriginalTotalCpu	long	原始 CPU。	14
Memory	object	集群的内存资源信息。
TotalMemory	long	集群总内存，单位：GB。	70
UsedMemory	long	集群已使用的内存，单位：GB。	10
UnitMemory	long	集群中每个副本的内存，单位：GB	10
OriginalTotalMemory	long	原始内存。	72
DiskSize	object	集群的存储资源信息。
TotalDiskSize	long	集群总存储空间，单位：GB。	200
UsedDiskSize	long	集群已使用的存储空间，单位：GB。	100
UnitDiskSize	long	集群每个副本的存储空间，单位：GB	200
DataUsedSize	double	数据盘大小规格，单位 GB。	200
MaxDiskUsedPercent	double	磁盘使用率最大值（百分比）。	0.14
MaxDiskUsedObServer	array	磁盘服务器使用率最大值。
MaxDiskUsedObServer	string	磁盘服务器使用率最大值。	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	long	原始磁盘。	200
MaxDiskSize	double	最大可创建磁盘大小。	80000
UnitCount	long	集群的资源 Unit 数量。	1
LogDiskSize	object	集群的日志盘资源信息。
TotalDiskSize	long	集群总日志盘空间，单位 GB。	400
UnitDiskSize	long	集群每个副本的日志存储空间，单位：GB。	200
LogAssignedSize	string	分配的日志存储空间，单位：GB。	0.0
MaxLogAssignedObServer	array	分配的服务器最大存储空间信息。
MaxLogAssignedObServer	string	分配的日志服务器最大存储空间列表。	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	分配的最大日志存储空间百分比。	6.68
OriginalTotalDiskSize	integer	日志盘原始大小。	200
CapacityUnit	object	容量单元。
MaxCapacityUnit	integer	最大容量单元。	4
MinCapacityUnit	integer	最小容量单元。	1
UsedCapacityUnit	string	已用容量单位。	2
AutoUpgradeObVersion	boolean	是否开启自动升级 OBServer 版本。	true
ObRpmVersion	string	OBServer 详细版本信息。	2.2.77-20210526202046
IsLatestObVersion	boolean	OBServer 版本是否为最新版本。	true
AvailableZones	array	可用区列表。
AvailableZones	string	可用区列表。	cn-hangzhou-i
EnableUpgradeLogDisk	boolean	是否允许升级日志盘规格。	false
Zones	array	实例所属的可用区 ID。更多详情，请参见 DescribeZones 获取可用区列表。
Zones	string	实例所属的可用区 ID。更多详情，请参见 DescribeZones 获取可用区列表。	cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
InstanceRole	string	实例角色。	NORMAL
NodeNum	string	集群节点个数信息。如果部署模式为 n-n-n，则节点个数为 n * 3。	6
ReplicaMode	string	全功能型副本数。返回值仅包含 3 和 2。 3：表示 3 个全功能型副本。 2：表示 2 个全功能型副本。三可用区部署时，只支持 3 个全功能型副本，双可用区部署时，仅支持 2 个全功能型副本，单可用区部署时，可以支持 2 个或者 3 个全功能型副本。	2
IsolationOptimization	boolean	是否开启 Cgroup。	false
EnableIsolationOptimization	boolean	是否允许开通隔离优化。	false
InTempCapacityStatus	boolean	临时容量状态。	false
DataDiskAutoScale	boolean	是否开启数据自动协调。说明此参数已废弃。	-
TenantCreatable	object	可创建的租户。
EnableCreateTenant	boolean	集群是否允许创建租户。	true
DisableCreateTenantReason	string	集群不允许创建租户的原因。	CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT
DataDiskAutoScaleConfig	object	数据盘自动协调配置。
AutoScale	boolean	是否开启。	true
Upperbound	long	扩容上限。	16
UpperThreshold	long	日常扩容阈值。	80
UpperMergeThreshold	long	合并扩容阈值。	90
MaxDiskSize	long	磁盘最大值。	80000
ScaleStepInNormal	long	日常扩容步长。	50
ScaleStepInMerge	long	合并扩容步长。	100
UpperScaleStrategy	string	扩容策略（RAW/PERCENTAGE）
UpperScaleStep	string	扩容步长
EnableProxyService	boolean	是否 Enable 代理服务。 true false	true
ProxyServiceStatus	string	代理服务状态。	ONLINE
ProxyClusterId	string	Proxy 集群 ID。说明仅 EnableProxyService 为 true 时，才会包含该参数。	proxy-56****a6tg2o
CpuArchitecture	string	集群的 CPU 架构。	X86
ReadOnlyResource	object	集群的资源信息
Cpu	object	集群的 CPU 资源信息
TotalCpu	long	集群总 CPU，单位：核数	14
UsedCpu	long	集群已使用的 CPU，单位：核数	10
UnitCpu	long	集群中每个副本节点的 CPU，单位：核数	10
OriginalTotalCpu	long	原始 CPU	14
Memory	object	集群的内存资源信息
TotalMemory	long	集群总内存，单位：GB	70
UsedMemory	long	集群已使用的内存，单位：GB	10
UnitMemory	long	集群中每个副本的内存，单位：GB	10
OriginalTotalMemory	long	原始内存	72
DiskSize	object	集群的存储资源信息
TotalDiskSize	long	集群总存储空间，单位：GB	200
UsedDiskSize	long	集群已使用的存储空间，单位：GB	100
UnitDiskSize	long	集群每个副本的存储空间，单位：GB	200
DataUsedSize	double	已使用的存储空间，单位：GB。	200
MaxDiskUsedPercent	double	磁盘使用率最大值（百分比）。	0.14
MaxDiskUsedObServer	array	磁盘服务器使用率最大值。
MaxDiskUsedObServer	string	磁盘服务器使用率最大值。	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	long	原始磁盘。	200
MaxDiskSize	double	最大可创建磁盘大小。	80000
UnitCount	long	集群的资源 Unit 数量。	1
LogDiskSize	object	集群的日志盘资源信息。
TotalDiskSize	long	集群总日志盘空间，单位：GB。	400
UnitDiskSize	long	集群每个副本的日志存储空间，单位：GB	200
LogAssignedSize	string	已分配的日志存储空间.。	0.0
MaxLogAssignedObServer	array	已分配的最大 OBServer。
MaxLogAssignedObServer	string	已分配的最大 OBServer。	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	已分配的最大日志百分比。	6.68
CapacityUnit	object	容量单元。
MaxCapacityUnit	integer	最大容量单元。	4
MinCapacityUnit	integer	最小容量单元。	1
UsedCapacityUnit	string	已用容量单位。	2
UnitSpec	string	代理服务的单元规格
SharedUnitNumLimit	integer	共享模式代理服务的单元数量上限
ExclusiveUnitNumLimit	integer	独占模式代理服务的单元数量上限
PrimaryInstance	string	主实例 Id	ob3h8ytroxxxxx
PrimaryRegion	string	主实例 Region	cn-hangzhou
SpecType	string	规格类型
AllowModifyInternetAddressConnectionLimit	boolean	是否允许修改公网最大连接数
AllowCreateProxySqlFirewallRule	boolean	是否允许使用 ODP SQL 防火墙

示例

正常返回示例

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,
    "PrimaryInstance": "ob3h8ytroxxxxx",
    "PrimaryRegion": "cn-hangzhou",
    "SpecType": "",
    "AllowModifyInternetAddressConnectionLimit": true,
    "AllowCreateProxySqlFirewallRule": true
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-09-19	OpenAPI 入参发生变更	查看变更详情
2024-08-15	OpenAPI 返回结构发生变更	查看变更详情
2024-06-06	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-04-15	OpenAPI 返回结构发生变更	查看变更详情
2024-02-02	OpenAPI 返回结构发生变更	查看变更详情
2023-12-26	OpenAPI 返回结构发生变更	查看变更详情
2023-12-07	OpenAPI 返回结构发生变更	查看变更详情
2023-11-20	OpenAPI 返回结构发生变更	查看变更详情
2023-10-30	OpenAPI 返回结构发生变更	查看变更详情
2023-08-21	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-04	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-05-17	OpenAPI 返回结构发生变更	查看变更详情
2023-03-21	API 内部配置变更，不影响调用	查看变更详情
2022-08-15	OpenAPI 返回结构发生变更	查看变更详情
2021-08-19	OpenAPI 返回结构发生变更	查看变更详情
2021-08-19	新增 OpenAPI	查看变更详情
2021-08-19	OpenAPI 描述信息更新、OpenAPI 返回结构发生变更	查看变更详情