DescribeReadonlyInstances|OceanBase Cloud| docs|Distributed Database

DescribeReadonlyInstances

Last Updated：2025-12-26 07:23:34 Updated

Overview

You can call this API to query the basic information of a read-only replica instance.

API details

Constraints

The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.

Request path

GET api/v2/instances/{instanceId}/readonlyInstance

Request parameters

Path

Parameter	Type	Required	Description	Example value
instanceId	String	Yes	The ID of the instance.	obxxx

Query

Parameter	Type	Required	Description	Example value
physicalZone	String	No	The physical zone.	zone_1

Response parameters

Parameter	Type	Description	Example value
data	Object	The returned data.	-
instanceId	String	The ID of the instance.	obxxx
readonlyInstances	array	The information about the read-only replicas.	-
clusterArn	String	The ARN of the cluster.	obc:qcloud:rds:ap-beijing:20000600****:cluster:obxxx
region	String	The region.	The instance has running tenants, so this operation is not supported.
zoneArn	String	The ARN of the zone.	obc:qcloud:rds:ap-beijing:20000600****:zone:obxxx.ap-beijing-3-ro-z0
nodeNum	long	The number of nodes.	2
logDiskSize	long	The size of the log disk.	60
readOnlyReplicaType	String	The type of the read-only replica. ROW_STORE: a read-only rowstore replica COLUMN_STORE: a read-only columnstore replica Note A read-only columnstore replica is supported only in databases of V4.3.3 and later.	ROW_STORE
readonlyInstanceId	String	The ID of the read-only replica instance.	obxxx
zone	string	The physical zone.	ap-beijing-3
logicalZone	string	The logical zone.	ap-beijing-3-ro-z0
cpu	integer	The number of CPU cores.	4
mem	integer	The size of memory.	16
diskSize	integer	The size of the disk.	70
instanceClass	String	The instance specification.	4C16GB
status	String	The status of the read-only instance.	ONLINE
requestId	String	The ID of the request.	707e9d0d-f332-4255-8ef7-ce1c3f29d01r
success	Boolean	Indicates whether the request was successful.	true

Examples

Request example

curl --digest -u 'ak:sk' \
    -X GET \
    'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/readonlyInstance'

Response example

JSON format

{
    "data": {
        "instanceId": "obxxx",
        "readonlyInstances": [
            {
                "clusterArn": "obc:qcloud:rds:ap-beijing:20000600****:cluster:obxxx",
                "cpu": 4,
                "diskSize": 70,
                "instanceClass": "4C16G",
                "logDiskSize": 60,
                "logicalZone": "ap-beijing-3-ro-z0",
                "mem": 16,
                "nodeNum": 1,
                "readOnlyReplicaType": "ROW_STORE",
                "readonlyInstanceId": "obxxx",
                "region": "ap-beijing",
                "status": "ONLINE",
                "zone": "ap-beijing-3",
                "zoneArn": "obc:qcloud:rds:ap-beijing:20000600****:zone:obxxx.ap-beijing-3-ro-z0"
            },
            
        ]
    },
    "requestId": "707e9d0d-f332-4255-8ef7-ce1c3f29d01r",
    "success": true
}