查询一个 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} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Action | string | 是 | 系统规定参数。 | DescribeInstance |
| InstanceId | string | 是 | OceanBase 集群 ID。 | ob317v4uif**** |
| PageNumber | integer | 否 | 分页查询的页码。
| 1 |
返回参数
示例
正常返回示例
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,
"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": "RAW",
"UpperScaleStep": 5
},
"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,
"MaxLogAssignedObServer": [
[
"i-bp1g****",
"i-bp11****",
"i-bp19****"
]
],
"MaxLogAssignedPercent": 6.68
},
"CapacityUnit": {
"MaxCapacityUnit": 4,
"MinCapacityUnit": 1,
"UsedCapacityUnit": 2
}
},
"UnitSpec": "2C4G",
"SharedUnitNumLimit": 3,
"ExclusiveUnitNumLimit": 1,
"EnableReadOnlyReplica": true,
"EnableReadOnlyReplicaManagement": false,
"PrimaryInstance": "ob3h8ytroxxxxx",
"PrimaryRegion": "cn-hangzhou",
"SpecType": "dedicatedspec",
"AllowModifyInternetAddressConnectionLimit": false,
"AllowCreateProxySqlFirewallRule": false,
"Iops": 10000,
"InstanceType": "",
"MigrationInfo": {
"Migratable": true,
"CheckResult": {
"Level": "",
"Code": "",
"CodeName": "",
"Module": "",
"ModuleName": "",
"SubModule": "",
"SubModuleName": ""
}
}
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2025-08-05 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2025-07-03 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 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 返回结构发生变更 | 查看变更详情 |