Overview
This API is used to query the tenant address information in a specified cluster.
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}/address/info
Request parameters
Path
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the OceanBase Cloud instance. | ob317v4uif**** |
Query
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| pageNumber | Integer | No | Page number for the paginated query.
|
1 |
| pageSize | Integer | No | Number of rows per page.
|
10 |
| tenantIds | List | No | Tenant ID list. Separate multiple tenant IDs with commas. | txxx,txxx1 |
Response parameters
Name |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Whether the request was successful. | true |
| errorCode | String | Error code. | INVALID_PARAMETER |
| errorMessage | String | Error message. | Invalid parameter |
| data | Object | Business data. | — |
| 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 number of records. | 100.0 |
| extra | Object | Extended information. | {} |
data object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| dataList | Array | Dataset. | [{'id': 'resource-123456'}] |
| total | Number | Total amount of data. | 100.0 |
| hasMore | Boolean | Whether more data exists. | true |
data.dataList[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| tenantId | String | Tenant ID. | t4louaeei**** |
| ocpTenantId | Integer | Internal tenant ID in OCP. | xxxxxx |
| tenantName | String | Tenant name. | xxxxxx |
| managementMode | String | Management mode, such as DBaaS or MaaS. | DBAAS |
| gmtCreate | String | Creation time. | 2026-02-25 15:40:43+00:00 |
| createTime | String | Creation time in UTC. | 2026-02-25 15:40:43+00:00 |
| tenantMode | String | Tenant mode, such as MySQL or Oracle. | xxxxxx |
| primaryRegion | String | Primary region. | cn-hangzhou |
| primaryZone | String | Primary zone. | cn-hangzhou-i |
| status | String | Current status of the task or resource. | ONLINE |
| cpu | Integer | Number of processor cores or specification information. | 4 |
| mem | Integer | Memory size. | 16 |
| diskSize | Integer | Disk size. | 200 |
| unitCpu | Integer | Unit processor specification. | 2 |
| unitMem | Integer | Unit memory specification. | 8 |
| unitNum | Integer | Number of units. | 1 |
| unitDiskSize | Integer | Unit disk size. | 200 |
| vpcId | String | VPC ID. | vpc-xxxx**** |
| deployType | String | Deployment type. | multiple |
| description | String | Description. | Tenant for Business Transactions |
| tenantConnections | Array | Tenant connection information. | [{'addre**** |
| tenantZones | Array | Zone information. | [{'repli**** |
| tenantResource | Object | Tenant resource specification information. | — |
| tenantResource.cpu | Object | — | — |
| tenantResource.memory | Object | — | — |
| tenantResource.disk | Object | — | — |
| tenantResource.unitNum | Integer | Number of units. | 1 |
| enableBinlogService | Boolean | Whether the binlog service can be enabled. | true |
| readonlyConnectionAddable | String | Whether a read-only address can be created. Valid values: ADDABLE: can be created; DISABLED: cannot be created; INVISIBLE: not displayed. | ADDABLE |
| readwriteConnectionAddable | String | Whether a read/write splitting address can be created. Valid values: ADDABLE: can be created; DISABLED: cannot be created; INVISIBLE: not displayed. | ADDABLE |
| timeZone | String | Tenant time zone. | +08:00 |
| charset | String | Tenant character set. | utf8mb4 |
| collation | String | Character collation. | utf8mb4_general_ci |
| lowerCaseTableNamesParam | Integer | Whether table names are case-sensitive in the tenant. | 1 |
| parameterTemplate | String | Parameter template. | oltp |
| tagList | Array | Tenant tags. | [{'tagKey': 'env', 'tagValue': 'prod'}] |
| tenantCompatibilityMode | String | Tenant compatibility mode. A TP cluster returns MySQL or Oracle, and a KV cluster returns HBase or Table. | xxxxxx |
| dataMergeTime | String | Tenant major compaction time, available only for OceanBase Database V4.x clusters. | 02:00 |
| enableProxyPublicLink | Boolean | Whether public access is enabled. | false |
| odpDefaultVersion | String | Default ODP version used when a tenant address is created. | 4.2.1 |
| enableProxyService | Boolean | Whether the proxy service is enabled. | true |
| globalAddressAddable | String | Whether a global address can be created. Valid values: ADDABLE: can be created; DISABLED: cannot be created; INVISIBLE: not displayed. | ADDABLE |
| enableStandbyReadWriteSplit | String | Read/write splitting switch status for the primary and standby databases. | ENABLED |
| instanceZoneReplicas | Array | Instance zone replicas. | [{'copyI**** |
| zones | Array | Comma-separated list of zones. | — |
| tenantMaxConnections | Integer | Maximum number of tenant connections. | xxxxxx |
| ragClusterDo | Object | RAG cluster details. | — |
| ragClusterDo.gmtCreate | String | Creation time. | 2026-02-25 15:40:43+00:00 |
| ragClusterDo.gmtModified | String | Modification time. | 2026-02-26 10:40:43+00:00 |
| ragClusterDo.ragClusterId | String | RAG cluster ID. | obcluster-***** |
| ragClusterDo.ragClusterArn | String | RAG cluster ARN. | acs:oceanbase:cn-hangzhou:200006001999:rag/rag-123456 |
| ragClusterDo.instanceId | String | OceanBase cluster ID. | obcluster-***** |
| ragClusterDo.tenantId | String | Tenant ID. | t4louaeei**** |
| ragClusterDo.region | String | Region. | ap-guangzhou |
| ragClusterDo.zone | String | Zone. | cn-hangzhou-i |
| ragClusterDo.version | String | OceanBase version. | 2.2.52 |
| ragClusterDo.cloudProvider | String | Cloud provider of the resource or data source. | xxxxxx |
| ragClusterDo.status | String | Current status of the task or resource. | ONLINE |
| ragClusterDo.resourceAccount | String | Resource account. | 3 |
| ragClusterDo.uid | String | User ID. | 20000600**** |
| ragClusterDo.servicePort | String | Service port. | 2881 |
| ragClusterDo.backendServicePort | String | Backend service port. | 2881 |
| ragClusterDo.serviceDomain | String | Service access domain name. | pay-core.oceanbase.example.com |
| ragClusterDo.serviceAddress | String | Service access address. | 10.0.0.10 |
| ragClusterDo.loadBalanceId | String | Load balancing instance ID. | lb-xxxxx**** |
| ragClusterDo.lbVpcId | String | VPC ID of the load balancer. | vpc-xxxx**** |
| ragClusterDo.lbVswId | String | ID of the vSwitch where the load balancer resides. | vsw-xxxx**** |
| ragClusterDo.lbMasterZone | String | Primary zone of the load balancer. | cn-hangzhou-i |
| ragClusterDo.lbSlaveZone | String | Standby zone of the load balancer. | cn-hangzhou-i |
| enableRag | Boolean | Whether RAG is enabled. | false |
| iops | Integer | Number of read and write operations per second. | 1000 |
data.dataList[].instanceZoneReplicas[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| logicalZone | String | Logical zone. | ap-beijing-3-ro-z0 |
| replicaType | String | Replica type, for example, FULL, READONLY, or LOGONLY. | FULL |
| zoneRegionName | String | Name of the region where the replica is located. | test-name |
| zoneLogicalId | Integer | ID of the logical zone where the replica is located. | xxxxxx |
| zoneId | String | Zone ID. | cn-hangz**** |
| status | String | Current status of the task or resource. | ONLINE |
| nodeNum | Integer | Number of nodes. | 3 |
| readonlyInstanceId | String | Read-only instance ID. | obcluster-*****-ro |
| replicaResource | Object | Replica resource specification information. | — |
| replicaResource.cpu | Object | — | — |
| replicaResource.memory | Object | — | — |
| replicaResource.diskSize | Object | — | — |
| readOnlyReplicaType | Object | — | — |
data.dataList[].tagList[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| tagKey | String | Tag key. | env |
| tagValue | String | Tag value. | prod |
data.dataList[].tenantConnections[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| tenantId | String | Tenant ID. | t4louaeei**** |
| vpcId | String | VPC ID. | vpc-xxxx**** |
| userVpcOwnerId | String | Account ID of the user's VPC. | 20000600**** |
| vSwitchId | String | vSwitch ID. | vsw-xxxx**** |
| connectionZones | Array | Zone associated with the connection address. | ['cn-hangzhou-i'] |
| connectionLogicalZones | Array | Logical zones associated with the connection address. | ['cn-hangzhou-i'] |
| connectionReplicaType | String | Replica type accessed through the connection address. | FULL |
| tenantEndpointId | String | Tenant endpoint ID added in multi-cloud V5. | te-xxxxx**** |
| addressId | String | VIP service group name in multi-cloud mode. | rs-private-internet-***** |
| addressStatus | String | Connection status. | ONLINE |
| serviceType | String | Address type. | PRIVATE |
| addressType | String | Address type, such as MASTER or READONLY. | MASTER |
| networkType | String | Network type. | INTRANET |
| role | String | Connection type: read/write or read-only. For the primary address, the read/write type may also need to be distinguished. The primary address of a standby database is read-only. | READWRITE |
| userNameFormat | String | Username format used for this address: one-part, two-part, or three-part. | TWO_PART |
| useSSL | Boolean | Whether SSL is enabled. | false |
| proxyClusterInfo | Object | ODP proxy cluster information associated with the tenant connection. | — |
| proxyClusterInfo.proxyClusterId | String | ODP proxy cluster ID. | proxy-12**** |
| proxyClusterInfo.proxyMode | String | ODP proxy mode. | DEDICATED |
| proxyClusterInfo.zone | String | Zone. | cn-hangzhou-i |
| proxyClusterInfo.unitSpec | String | Unit specification. | 2C4G |
| proxyClusterInfo.unitNum | Number | Number of units. | 1.0 |
| proxyClusterInfo.sharedUnitNumLimit | Integer | Maximum number of units for the proxy service in K8s shared mode. | 3 |
| proxyClusterInfo.exclusiveUnitNumLimit | Integer | Maximum number of units for the proxy service in K8s exclusive mode. | 3 |
| proxyClusterInfo.status | String | Current status of the task or resource. | ONLINE |
| proxyClusterInfo.proxyServiceVersion | String | Architecture version. | 4.2.1.0 |
| proxyClusterInfo.proxyVersion | String | Proxy version. | 4.2.1.0 |
| proxyClusterInfo.createTime | String | Creation time in UTC. | 2026-02-25 15:40:43+00:00 |
| proxyClusterInfo.expireTime | String | Expiration time. | 2020-12-23 04:14:48+00:00 |
| proxyClusterInfo.deployMode | String | Data replica mode, in the n, n-n, or n-n-n format. |
1-1-1 |
| proxyClusterInfo.maxUnitNum | Number | Maximum number of serverless ODP units, from K8s ODPClusterSpec.maxUnitNum. |
3.0 |
| proxyClusterInfo.slaveZone | String | Standby zone. This field was added for commercial ODP and is returned only for primary-standby deployments across two or three zones. | cn-hangzhou-i |
| proxyClusterInfo.nodeDistribution | String | Node distribution. This field was added for commercial ODP and replaces deployMode. |
cn-hangzhou-i:1,cn-hangzhou-j:1 |
| proxyClusterInfo.nodeCpu | Number | Node specification. This field was added for commercial ODP and replaces unitSpec * unitNum. |
4.0 |
| proxyClusterInfo.nodeNum | Integer | Number of nodes. This field was added for commercial ODP. | 3 |
| proxyClusterInfo.deploymentArchitecture | String | Deployment architecture. This field was added for commercial ODP. Existing non-commercial ODP clusters display SINGLE_AZ_DEPLOYMENT, DUAL_AZ_DEPLOYMENT, or MULTI_AZ_DEPLOYMENT. | SINGLE_ZONE |
| proxyClusterInfo.proxyServerIds | Array | ODP proxy node IDs. | ['resour**** |
| odpVersion | String | ODP version. | 4.2.1 |
| readStrategyConfigResponse | Object | Read traffic policy configuration for tenant connection addresses. | — |
| readStrategyConfigResponse.odpVersion | String | ODP version. | 4.2.1 |
| readStrategyConfigResponse.trafficStrategy | String | Traffic policy. | ZONE_FIRST |
| readStrategyConfigResponse.replicaParams | Array | Replica selection. | — |
| readStrategyConfigResponse.disasterRecoveryReplicaParams | Array | Disaster recovery replicas. | — |
| readStrategyConfigResponse.balancedStrategy | String | Balancing strategy. | BALANCED |
| readStrategyConfigResponse.disasterRecoveryStrategy | String | Disaster recovery strategy. Specifies to automatically query the primary replica when the secondary replica is unavailable. | PRIMARY_FIRST |
| addressMasterZoneId | String | Primary zone of the address. | cn-hangz**** |
| loadBalanceType | String | Load balancing type, which is required only for Alibaba Cloud and distinguishes between NLB and CLB. | NLB |
| internetAddress | String | Public network address. | 8.8.8.8 |
| internetPort | Integer | Public network port. | 2881 |
| internetDomain | String | Public network address. | pay-core-public.oceanbase.example.com |
| internetAddressStatus | String | Public network address status. | ONLINE |
| internetMaxConnectionNum | Integer | Maximum number of public network connections. | 10000 |
| internetMaxConnectionNumLimit | Integer | Limit on the maximum number of public network connections. | 20000 |
| internetRpcPort | Integer | Public network RPC port. | 2882 |
| internetProxyClusterId | String | Public network proxy cluster ID. | proxy-12**** |
| internetLoadBalanceType | String | Load balancing type for the public network address. | NLB |
| intranetAddress | String | Private network address. | 10.0.0.10 |
| intranetPort | Integer | Private network port. | 2881 |
| intranetDomain | String | Private network address. | pay-core-private.oceanbase.example.com |
| intranetAddressStatus | String | Private network address status. | ONLINE |
| maxConnectionNum | Integer | Maximum number of private network connections. | 10000 |
| maxConnectionNumLimit | Integer | Limit on the maximum number of private network connections. | 20000 |
| intranetRpcPort | Integer | Private network RPC port. | 2882 |
| enableRPc | Boolean | Whether RPC is enabled for bypass import. | true |
| disableRpcReason | String | Reason why RPC cannot be enabled. | ODP proxy is not ready |
| intranetAddressMasterZoneId | String | Primary zone ID. | cn-hangz**** |
| intranetAddressSlaveZoneId | String | Standby zone ID. | cn-hangz**** |
| deleteSingleTunnelAddress | Boolean | Whether the primary Alibaba Cloud private network address can be deleted. | true |
| intranetProxyClusterId | String | Private network proxy cluster ID. | proxy-12**** |
| forceMigratedObproxyIntranetDeleteInternet | Boolean | If the primary endpoint for migration has both a private and public endpoint, delete the public endpoint when deleting the private endpoint. | true |
| intranetLoadBalanceType | String | Load balancing type for the private network address. | NLB |
| privateLinkList | Array | PrivateLink information. | [{'endpointId': 'ep-xxxxxx', 'status': 'CONNECTED'}] |
| intranetPeeringAddress | String | Peering address. | 10.1.0.10 |
| intranetPeeringPort | Integer | Peering address port. | 2881 |
| intranetPeeringDomain | String | Peering address domain name. | pay-core-peering.oceanbase.example.com |
| intranetPeeringAddressStatus | String | Peering address status. | ONLINE |
| intranetPeeringMaxConnectionNum | Integer | Maximum number of peering connections. | 10000 |
| peeringDstVpcId | String | VPC ID at the peer end. | vpc-peer**** |
| peeringDstCidrList | String | CIDR block at the peer end. | 10.1.0.0**** |
| peeringId | String | Peer connection ID. | pcx-xxxx**** |
| intranetPeeringProxyClusterId | String | Proxy cluster ID for the peering private network address. | proxy-12**** |
| intranetRagPort | Integer | Private network RAG port. | 8080 |
| internetRagPort | Integer | Public network RAG port. | 8080 |
| internetRagAddress | String | Public network RAG address. | pay-core-rag-public.oceanbase.example.com |
| enableRagHttp | Boolean | Whether the RAG HTTP port is enabled. | false |
| isVirtualServerGroup | Boolean | Whether this is a virtual server group or a primary-standby server group where one side was migrated in. | false |
| isMigrated | Integer | Whether one side of the cluster address was migrated. | 0 |
| userFormatConnStatus | String | Status of one-part connection strings. | ONLINE |
| userFormatConnUnsupportedReason | String | Reason why one-part access is not supported. | 2881 |
data.dataList[].tenantConnections[].connectionLogicalZones[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| data.dataList[].tenantConnections[].connectionLogicalZones[] | String | Logical zone associated with the connection address. | ---- "cn-hangzhou-i" |
data.dataList[].tenantConnections[].connectionZones[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| data.dataList[].tenantConnections[].connectionZones[] | String | Zone associated with the connection address. | ---- "cn-hangzhou-i" |
data.dataList[].tenantConnections[].privateLinkList[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| privateLinkStatus | String | PrivateLink status. | ONLINE |
| privateLinkServiceId | String | PrivateLink service ID. | resource**** |
| privateLinkEndpointId | String | PrivateLink endpoint ID. | resource**** |
| privateLinkEndpointVpcId | String | VPC ID of the PrivateLink endpoint. | vpc-xxxx**** |
| privateLinkEndpointSubnetId | String | Subnet ID of the PrivateLink endpoint. | resource**** |
| privateLinkServiceAccount | String | Primary account of the PrivateLink service. | 3 |
| privateLinkUserAccount | String | PrivateLink allowlist user account. | 3 |
| privateLinkDomain | String | Private domain name. | pay-core.oceanbase.example.com |
| intranetAddress | String | Private network address. | 10.0.0.10 |
| intranetDomain | String | Private network address. | pay-core-private.oceanbase.example.com |
| deletePrivateLink | Boolean | Whether the primary private network address can be deleted. It cannot be deleted if it is associated with a global address. | true |
data.dataList[].tenantZones[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| name | String | Zone name or zone ID. | Data Source Name |
| replicaType | String | Replica type, for example, FULL, READONLY, or LOGONLY. | FULL |
| region | String | Region. | ap-guangzhou |
| role | String | Role, such as read/write or read-only. | READWRITE |
| tenantZoneReplicas | Array | Zone replica information. | — |
data.dataList[].tenantZones[].tenantZoneReplicas[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| zoneReplicaType | String | Tenant replica type in the zone, such as FULL, READONLY, or COLUMNSTORE. | FULL |
| zoneNodes | Integer | Number of nodes covered by the replica. | 1 |
| logicZoneName | String | Name of the logical zone where the tenant replica is located. | cn-hangzhou-i |
| copyId | Integer | Ordinal number used to distinguish replicas of the same tenant in the tenant topology. | xxxxxx |
| fullCopyId | Integer | Display number of the full-featured replica, corresponding to Full-featured Replica 1 or Full-featured Replica 2 on the page. | xxxxxx |
| readOnlyCopyId | Integer | Display number of the read-only replica, corresponding to Read-only Replica 1 or Read-only Replica 2 on the page. | xxxxxx |
| tenantZoneRole | String | Tenant replica role, such as read/write replica, standby replica, or read-only replica. | cn-hangz**** |
| readOnlyReplicaType | Object | — | — |
| unitInfoList | Array | Unit resource details associated with this replica. | [{'id': 'resource-123456'}] |
data.dataList[].zones[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| zoneId | String | Zone ID. | cn-hangz**** |
| region | String | Region required by some object storage vendors, such as S3. | ap-guangzhou |
| zoneDisk | String | Displayed data disk capacity of the zone. | 200 |
| logicZoneId | String | Logical zone ID. | resource**** |
| replicaType | String | Replica type, for example, FULL, READONLY, or LOGONLY. | FULL |
| nodes | Array | List of nodes in the logical zone. | [{'id': 'resource-123456'}] |
data.dataList[].zones[].nodes[] object fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| nodeId | String | Node identifier. | xxxxxx |
| serverIp | String | Server IP address. | 10.0.0.10 |
| nodeCopyId | Integer | Ordinal number of the node replica in the topology. | xxxxxx |
| nodeStatus | String | Current running status of the node. | ONLINE |
| replicaType | String | Replica type hosted by the node, such as FULL, READONLY, or LOGONLY. | FULL |
| fullCopyId | Integer | Display ID of the full-featured replica. | xxxxxx |
| readOnlyCopyId | Integer | Display ID of the read-only replica. | xxxxxx |
| logicalZone | String | Logical zone. | ap-beijing-3-ro-z0 |
| readOnlyReplicaType | Object | — | — |
| nodeResource | Object | — | — |
Examples
Request example
curl --digest -u 'ak:sk' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/address/info \
-H 'X-Ob-Project-Id: <Project ID>' \
-G -d 'requestId=d04eabba****' -d 'pageNumber=1' -d 'pageSize=10' -d 'tenantIds[]=t4louaeei****'
Note
- A project ID uniquely identifies a project. For information about how to obtain the project ID of a cluster, see Manage projects.
- Make sure that the project ID of the instanceId matches the specified project ID.
Response example
JSON format
{
"success": true,
"errorCode": "INVALID_PARAMETER",
"errorMessage": "Invalid parameter",
"data": {
"dataList": [
{
"tenantId": "t4louaeei****",
"ocpTenantId": 1,
"tenantName": "xxxxxx",
"managementMode": "DBAAS",
"gmtCreate": "2026-02-25 15:40:43+00:00",
"createTime": "2026-02-25 15:40:43+00:00",
"tenantMode": "xxxxxx",
"primaryRegion": "cn-hangzhou",
"primaryZone": "cn-hangzhou-i",
"status": "ONLINE",
"cpu": 4,
"mem": 16,
"diskSize": 200,
"unitCpu": 2,
"unitMem": 8,
"unitNum": 1,
"unitDiskSize": 200,
"vpcId": "vpc-xxxx****",
"deployType": "multiple",
"description": "A tenant used for business transactions.",
"tenantConnections": [
{
"tenantId": "t4louaeei****",
"vpcId": "vpc-xxxx****",
"userVpcOwnerId": "20000600****",
"vSwitchId": "vsw-xxxx****",
"connectionZones": "---\n- \"cn-hangzhou-i\"",
"connectionLogicalZones": "---\n- \"cn-hangzhou-i\"",
"connectionReplicaType": "FULL",
"tenantEndpointId": "te-xxxxx****",
"addressId": "rs-private-internet-*****",
"addressStatus": "ONLINE",
"serviceType": "PRIVATE",
"addressType": "MASTER",
"networkType": "INTRANET",
"role": "READWRITE",
"userNameFormat": "TWO_PART",
"useSSL": false,
"proxyClusterInfo": {
"proxyClusterId": "proxy-12****",
"proxyMode": "DEDICATED",
"zone": "cn-hangzhou-i",
"unitSpec": "2C4G",
"unitNum": 1.0,
"sharedUnitNumLimit": 3,
"exclusiveUnitNumLimit": 3,
"status": "ONLINE",
"proxyServiceVersion": "4.2.1.0",
"proxyVersion": "4.2.1.0",
"createTime": "2026-02-25 15:40:43+00:00",
"expireTime": "2020-12-23 04:14:48+00:00",
"deployMode": "1-1-1",
"maxUnitNum": 3.0,
"slaveZone": "cn-hangzhou-i",
"nodeDistribution": "cn-hangzhou-i:1,cn-hangzhou-j:1",
"nodeCpu": 4.0,
"nodeNum": 3,
"deploymentArchitecture": "SINGLE_ZONE",
"proxyServerIds": "---\n- \"r****"
},
"odpVersion": "4.2.1",
"readStrategyConfigResponse": {
"odpVersion": "4.2.1",
"trafficStrategy": "ZONE_FIRST",
"replicaParams": [
{}
],
"disasterRecoveryReplicaParams": [
{}
],
"balancedStrategy": "BALANCED",
"disasterRecoveryStrategy": "PRIMARY_FIRST"
},
"addressMasterZoneId": "cn-hangz****",
"loadBalanceType": "NLB",
"internetAddress": "xxx.xxx.x.xxx:xxx",
"internetPort": 2881,
"internetDomain": "pay-core-public.oceanbase.example.com",
"internetAddressStatus": "ONLINE",
"internetMaxConnectionNum": 10000,
"internetMaxConnectionNumLimit": 20000,
"internetRpcPort": 2882,
"internetProxyClusterId": "proxy-12****",
"internetLoadBalanceType": "NLB",
"intranetAddress": "xxx.xxx.x.xxx:xxx",
"intranetPort": 2881,
"intranetDomain": "pay-core-private.oceanbase.example.com",
"intranetAddressStatus": "ONLINE",
"maxConnectionNum": 10000,
"maxConnectionNumLimit": 20000,
"intranetRpcPort": 2882,
"enableRPc": true,
"disableRpcReason": "ODP proxy is not ready",
"intranetAddressMasterZoneId": "cn-hangz****",
"intranetAddressSlaveZoneId": "cn-hangz****",
"deleteSingleTunnelAddress": true,
"intranetProxyClusterId": "proxy-12****",
"forceMigratedObproxyIntranetDeleteInternet": true,
"intranetLoadBalanceType": "NLB",
"privateLinkList": [
{
"privateLinkStatus": "ONLINE",
"privateLinkServiceId": "resource****",
"privateLinkEndpointId": "resource****",
"privateLinkEndpointVpcId": "vpc-xxxx****",
"privateLinkEndpointSubnetId": "resource****",
"privateLinkServiceAccount": "3",
"privateLinkUserAccount": "3",
"privateLinkDomain": "pay-core.oceanbase.example.com",
"intranetAddress": "xxx.xxx.x.xxx:xxx",
"intranetDomain": "pay-core-private.oceanbase.example.com",
"deletePrivateLink": true
}
],
"intranetPeeringAddress": "xxx.xxx.x.xxx:xxx",
"intranetPeeringPort": 2881,
"intranetPeeringDomain": "pay-core-peering.oceanbase.example.com",
"intranetPeeringAddressStatus": "ONLINE",
"intranetPeeringMaxConnectionNum": 10000,
"peeringDstVpcId": "vpc-peer****",
"peeringDstCidrList": "10.1.0.0****",
"peeringId": "pcx-xxxx****",
"intranetPeeringProxyClusterId": "proxy-12****",
"intranetRagPort": 8080,
"internetRagPort": 8080,
"internetRagAddress": "pay-core-rag-public.oceanbase.example.com",
"enableRagHttp": false,
"isVirtualServerGroup": false,
"isMigrated": 0,
"userFormatConnStatus": "ONLINE",
"userFormatConnUnsupportedReason": "2881"
}
],
"tenantZones": [
{
"name": "Data source name",
"replicaType": "FULL",
"region": "ap-guangzhou",
"role": "READWRITE",
"tenantZoneReplicas": [
{
"zoneReplicaType": "FULL",
"zoneNodes": 1,
"logicZoneName": "cn-hangzhou-i",
"copyId": 1,
"fullCopyId": 1,
"readOnlyCopyId": 1,
"tenantZoneRole": "cn-hangz****",
"readOnlyReplicaType": "xxxxxx",
"unitInfoList": [
{}
]
}
]
}
],
"tenantResource": {
"cpu": "xxxxxx",
"memory": "xxxxxx",
"disk": "xxxxxx",
"unitNum": 1
},
"enableBinlogService": true,
"readonlyConnectionAddable": "ADDABLE",
"readwriteConnectionAddable": "ADDABLE",
"timeZone": "+08:00",
"charset": "utf8mb4",
"collation": "utf8mb4_general_ci",
"lowerCaseTableNamesParam": 1,
"parameterTemplate": "oltp",
"tagList": [
{
"tagKey": "env",
"tagValue": "prod"
}
],
"tenantCompatibilityMode": "xxxxxx",
"dataMergeTime": "02:00",
"enableProxyPublicLink": false,
"odpDefaultVersion": "4.2.1",
"enableProxyService": true,
"globalAddressAddable": "ADDABLE",
"enableStandbyReadWriteSplit": "ENABLED",
"instanceZoneReplicas": [
{
"logicalZone": "ap-beijing-3-ro-z0",
"replicaType": "FULL",
"zoneRegionName": "test-name",
"zoneLogicalId": 1,
"zoneId": "cn-hangz****",
"status": "ONLINE",
"nodeNum": 3,
"readonlyInstanceId": "obcluster-*****-ro",
"replicaResource": {
"cpu": "xxxxxx",
"memory": "xxxxxx",
"diskSize": "xxxxxx"
},
"readOnlyReplicaType": "xxxxxx"
}
],
"zones": [
{
"zoneId": "cn-hangz****",
"region": "ap-guangzhou",
"zoneDisk": "200",
"logicZoneId": "resource****",
"replicaType": "FULL",
"nodes": [
{
"nodeId": "xxxxxx",
"serverIp": "xxx.xxx.x.xxx:xxx",
"nodeCopyId": 1,
"nodeStatus": "ONLINE",
"replicaType": "FULL",
"fullCopyId": 1,
"readOnlyCopyId": 1,
"logicalZone": "ap-beijing-3-ro-z0",
"readOnlyReplicaType": "xxxxxx",
"nodeResource": "xxxxxx"
}
]
}
],
"tenantMaxConnections": 1,
"ragClusterDo": {
"gmtCreate": "2026-02-25 15:40:43+00:00",
"gmtModified": "2026-02-26 10:40:43+00:00",
"ragClusterId": "obcluster-*****",
"ragClusterArn": "acs:oceanbase:cn-hangzhou:200006001999:rag/rag-123456",
"instanceId": "obcluster-*****",
"tenantId": "t4louaeei****",
"region": "ap-guangzhou",
"zone": "cn-hangzhou-i",
"version": "2.2.52",
"cloudProvider": "xxxxxx",
"status": "ONLINE",
"resourceAccount": "3",
"uid": "20000600****",
"servicePort": "2881",
"backendServicePort": "2881",
"serviceDomain": "pay-core.oceanbase.example.com",
"serviceAddress": "xxx.xxx.x.xxx:xxx",
"loadBalanceId": "lb-xxxxx****",
"lbVpcId": "vpc-xxxx****",
"lbVswId": "vsw-xxxx****",
"lbMasterZone": "cn-hangzhou-i",
"lbSlaveZone": "cn-hangzhou-i"
},
"enableRag": false,
"iops": 1000
}
],
"total": 100.0,
"hasMore": true
},
"cost": 1.0,
"server": "xxx.xxx.x.xxx:xxx",
"requestId": "d04eabba****",
"totalCount": 100.0,
"extra": "{}"
}
