You can call this operation to query the detailed information of an OceanBase cluster.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| oceanbase:DescribeInstance | get | *Instance acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| InstanceId | string | Yes | The ID of the OceanBase cluster. | ob317v4uif**** |
| PageNumber | integer | No | The number of the page to return.
| 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "EE205C00-30E4-XXXX-XXXX-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": "2F1A",
"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.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
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-19 | The request parameters of the API has changed | View Change Details |
| 2024-08-15 | The response structure of the API has changed | View Change Details |
| 2024-06-06 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2024-04-15 | The response structure of the API has changed | View Change Details |
| 2024-02-02 | The response structure of the API has changed | View Change Details |
| 2023-12-26 | The response structure of the API has changed | View Change Details |
| 2023-12-07 | The response structure of the API has changed | View Change Details |
| 2023-11-20 | The response structure of the API has changed | View Change Details |
| 2023-10-30 | The response structure of the API has changed | View Change Details |
| 2023-08-21 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-07-04 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-05-17 | The response structure of the API has changed | View Change Details |
| 2023-03-21 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2022-08-15 | The response structure of the API has changed | View Change Details |
| 2021-08-19 | The response structure of the API has changed | View Change Details |
| 2021-08-19 | Add Operation | View Change Details |
| 2021-08-19 | API Description Update. The response structure of the API has changed | View Change Details |