Overview
You can call this API to query the details of an OceanBase Cloud database instance.
API details
Constraints
The caller must have an AccessKey for accessing multi-cloud APIs. For information about how to obtain the AccessKey ID and AccessKey Secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}
Request parameters
Query
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | string | Yes | The ID of the request. This ID is used for tracing. | dc302d76-66b5-48d8-ab53-a035******** |
Path
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | string | Yes | The ID of the OceanBase cluster. | obcluster-***** |
Body
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| None |
Response parameters
Parameter |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the operation succeeded. | true |
| errorCode | String | Error code. | INVALID_PARAMETER |
| errorMessage | String | Error message. | Invalid parameter |
| data | Object | Business data (object). | None |
| cost | Number | Time consumed. | 1.0 |
| server | String | Server address, typically the IP address of an OBServer node. | 10.0.0.10 |
| requestId | String | Request ID. | d04eabba**** |
| totalCount | Number | Total records. | 100.0 |
| extra | Object | Extended information. | {} |
data object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| region | String | For some object storage vendors, this field must be specified. For example, for S3, this field is required. | ap-guangzhou |
| vpcId | String | VPC identifier. | vpc-xxxx**** |
| instanceId | String | The ID of the OceanBase cluster. | obcluster-***** |
| instanceName | String | The name of the cluster. | test-clu**** |
| instanceClass | String | The specifications of the cluster. | xxxxxx |
| series | String | The series of the instance. | NORMAL |
| payType | String | The billing method. | POSTPAID |
| createTime | String | Creation time. | 2026-02-25 15:40:43+00:00 |
| expireTime | String | Expiration time. | 2020-12-23 04:14:48+00:00 |
| availableZones | Array | Availability zones. | ["h"] |
| version | String | OB version. | 2.2.52 |
| obRpmVersion | String | OB RPM version. | 4.2.1.0-100020042023102310 |
| deployType | String | Deployment type. Valid values: single (Single-IDC Deployment), multiple (Multi-IDC Deployment), and dual (Dual-IDC Deployment). |
single |
| diskType | String | Storage type. cloud_essd_pl1: ESSD cloud disk; ephemeral_ssd: local SSD. |
cloud_essd |
| deployMode | String | Deployment mode. | 1-1-1 |
| replicaMode | String | Number of full-featured replicas. Valid values: 2 and 3. |
2 |
| dataMergeTime | String | Data major compaction time. | 02:00 |
| status | String | The current status of the task or resource. | ONLINE |
| resource | Object | The resource specification information, including CPU, memory, disk, and node resources. | None |
| resource.cpu | Object | The number or specification of processor cores. | None |
| resource.cpu.totalCpu | Number | The total number of CPU cores. | 4.0 |
| resource.cpu.usedCpu | Number | The number of CPU cores in use. | 4.0 |
| resource.cpu.originalTotalCpu | Number | The total number of CPU cores before the change. | 4.0 |
| resource.cpu.unitCpu | Number | The unit processor specification. | 2.0 |
| resource.memory | Object | The memory information in the resource specification. | None |
| resource.memory.totalMemory | Number | The total memory size. | 16.0 |
| resource.memory.usedMemory | Number | The size of memory in use. | 16.0 |
| resource.memory.originalTotalMemory | Number | The total memory size before the change. | 16.0 |
| resource.memory.unitMemory | Number | The unit memory size (GB). | 8.0 |
| resource.memory.hostActualMemory | Number | The actual memory size of the host, in GiB. | 16.0 |
| resource.memory.systemMemory | Number | Memory occupied by the system on a Premium Edition host, in GiB. The value is calculated as hostActualMemory - totalMemory. |
16.0 |
| resource.memory.originalHostActualMemory | Number | The actual memory size of the host corresponding to the original specification, in GiB. | 16.0 |
| resource.diskSize | Object | Disk size. | None |
| resource.diskSize.totalDiskSize | Number | Total disk capacity. | 200.0 |
| resource.diskSize.usedDiskSize | Number | The size of the used disk. | 200.0 |
| resource.diskSize.originalTotalDiskSize | Number | Total disk capacity before the change. | 200.0 |
| resource.diskSize.totalDataSize | Number | Total data size. | 200.0 |
| resource.diskSize.unitDiskSize | Number | Unit disk size. | 200.0 |
| resource.diskSize.availableDiskSize | Number | The size of storage space that users can actually use (unit: GB). Calculation formula: getAvailableDiskSize(unitDiskSize, nodeCount, obVersion, shareStorageCluster). |
200.0 |
| cloudProvider | String | The cloud service provider where the resource or data source is located. | xxxxxx |
| instanceType | String | Instance type. | DEDICATE**** |
| instanceRole | String | Instance role, for example, primary instance or standby instance. | xxxxxx |
| primaryInstanceId | String | 2022-05-10. The ID of the primary database. This parameter is valid only when instanceRole=PHYSICAL_STANDBY. | obcluste**** |
| standbyInstanceIds | Array | 2022-05-10. The IDs of the standby databases. This parameter is valid only when instanceRole=PRIMARY. | ["obclus****"] |
| customTenantLogTransferMethod | String | The customer-defined cross-cloud log synchronization method in the standby database. This parameter is valid only when instanceRole=PHYSICAL_STANDBY. Valid values: NETWORK and ARCHIVE_LOG. | xxxxxx |
| saleChannel | String | Sales channel: overseas: overseas self-operated channel; domestic: domestic self-operated channel; aliyun_domestic: Alibaba Cloud China Station; huawei_mp_domestic: Huawei Cloud China Station; aws_mp_domestic: AWS China Station; aws-mp: AWS Overseas Station; aliyun_overseas: Alibaba Cloud Overseas Station; gcp_mp: GCP Marketplace. | domestic |
| managementMode | String | Management mode. | DBAAS |
| tagList | Array | The list of tags of the cluster instance. | [{"tagKey": "env", "tagValue": "prod"}] |
| nodeNum | Integer | The number of nodes. | 3 |
| cpuArchitecture | String | The CPU architecture. | 4 |
| projectId | String | The project ID. | hxq3ztx3377nby3v87ry**** |
| stopTime | String | The stop time. | 2026-02-26 10:40:43+00:00 |
| storageArchitecture | String | The storage architecture.
|
standardStorage |
| storageDiskType | String | The storage type. Currently, only the TP mode supports selecting a storage type, and only OBPL1 is supported. | OBPL1 |
| originalDeployMode | String | Original deployment mode. | 1-1-1 |
| inTempCapacityStatus | Boolean | Whether the system is in a temporary configuration change state. | true |
data.availableZones[] element fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| data.availableZones[] | String | Availability zone. | "h" |
data.standbyInstanceIds[] element fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| data.standbyInstanceIds[] | String | 2022-05-10. The ID of the standby database. This parameter is valid only when instanceRole=PRIMARY. | "o****" |
data.tagList[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| tagKey | String | Tag key. | env |
| tagValue | String | Tag value. | prod |
Examples
Request example
curl --request GET \
--digest -u '<AccessKey ID>:<AccessKey Secret>' \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}?requestId={requestId}' \
-H 'X-Ob-Project-Id: <Project ID>'
Note
- A project ID uniquely identifies a project. For information about how to obtain the project ID of an instance, see Manage projects.
- Make sure that the project ID corresponding to the specified instanceId is consistent with the specified project ID.
Response example
JSON format
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": {
"region": "ap-guangzhou",
"vpcId": "vpc-xxxx****",
"instanceId": "obcluster-*****",
"instanceName": "test-clu****",
"instanceClass": "xxxxxx",
"series": "NORMAL",
"payType": "POSTPAID",
"createTime": "2026-02-25 15:40:43+00:00",
"expireTime": "2020-12-23 04:14:48+00:00",
"availableZones": "---\n- \"h\"",
"version": "2.2.52",
"obRpmVersion": "4.2.1.0-100020042023102310",
"deployType": "single",
"diskType": "cloud_essd",
"deployMode": "1-1-1",
"replicaMode": "2",
"dataMergeTime": "02:00",
"status": "ONLINE",
"resource": {
"cpu": {
"totalCpu": 4.0,
"usedCpu": 4.0,
"originalTotalCpu": 4.0,
"unitCpu": 2.0
},
"memory": {
"totalMemory": 16.0,
"usedMemory": 16.0,
"originalTotalMemory": 16.0,
"unitMemory": 8.0,
"hostActualMemory": 16.0,
"systemMemory": 16.0,
"originalHostActualMemory": 16.0
},
"diskSize": {
"totalDiskSize": 200.0,
"usedDiskSize": 200.0,
"originalTotalDiskSize": 200.0,
"totalDataSize": 200.0,
"unitDiskSize": 200.0,
"availableDiskSize": 200.0
}
},
"cloudProvider": "xxxxxx",
"instanceType": "DEDICATE****",
"instanceRole": "xxxxxx",
"primaryInstanceId": "obcluste****",
"standbyInstanceIds": "---\n- \"o****",
"customTenantLogTransferMethod": "xxxxxx",
"saleChannel": "domestic",
"managementMode": "DBAAS",
"tagList": [
{
"tagKey": "env",
"tagValue": "prod"
}
],
"nodeNum": 3,
"cpuArchitecture": "4",
"projectId": "hxq3ztx3377nby3v87ry****",
"stopTime": "2026-02-26 10:40:43+00:00",
"storageArchitecture": "standardStorage",
"storageDiskType": "OBPL1",
"originalDeployMode": "1-1-1",
"inTempCapacityStatus": true
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}