Overview
You can call this API to query the address information of all tenants.
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
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| instanceId | String | Yes | The ID of the instance. | obxxx |
Query
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
| requestId | String | Yes | The ID of the request. | b7451058-f5dd-4b15-8f5c-c75911aba392 |
| pageNumber | Integer | No | The number of the page. Default value: 1. | 1 |
| pageSize | Integer | No | The number of records on a page. Default value: 20. | 20 |
| tenantIds | List |
No | The ID of the tenant. | ["txxx", "txxx1"] |
Response parameters
| Parameter | Type | Description | Example value |
|---|---|---|---|
| data | Object | Data | - |
| dataList | Object | Data list | - |
| aiFunctionStatus | String | AI function status | CLOSE |
| cpu | Integer | Number of CPU cores | 1 |
| createTime | String | Creation time | 2025-12-25T08:23:49Z |
| diskSize | Integer | Disk size | 0 |
| enableProxyPeeringLink | Boolean | Whether to allow peering address | true |
| enableProxyPublicLink | Boolean | Whether to allow public address | true |
| enableProxyService | Boolean | Whether to allow proxy service | true |
| enableRag | Boolean | Whether to allow RAG service | false |
| enableStandbyReadWriteSplit | String | Whether to allow standby read/write split | INVISIBLE |
| gmtCreate | String | Creation time | 2025-12-25 16:23:49.0 |
| mem | Integer | Memory | 4 |
| ocpTenantId | Integer | OCP tenant ID | 12000104 |
| primaryZone | String | Tenant primary zone | ap-beijing-3 |
| status | String | Status | ONLINE |
| tenantCompatibilityMode | String | Tenant compatibility mode | MySQL |
| tenantConnections | Object | Tenant address information | - |
| addressId | String | Address ID | rs-private-intranet-vpc-xxx |
| addressMasterZoneId | String | Address primary zone | ap-beijing-3 |
| addressStatus | String | Address status | ONLINE |
| addressType | String | Address type | MASTER |
| connectionLogicalZones | Object | Connection logical zone | ap-beijing-3-z0 |
| connectionReplicaType | String | Connection replica type | FULL |
| connectionZones | Object | Connection zone | ap-beijing-3 |
| enableRPc | Boolean | Whether to allow bypass import | true |
| enableRagHttp | Boolean | Whether to allow RAG HTTP service | false |
| intranetAddressStatus | String | Intranet address status | ONLINE |
| intranetPort | Integer | Intranet port | 3306 |
| isMigrated | Integer | Whether migrated | 0 |
| isVirtualServerGroup | Boolean | Whether virtual server group | true |
| maxConnectionNum | Integer | Maximum number of connections | 5000 |
| maxConnectionNumLimit | Integer | Connection limit | 5000 |
| networkType | String | Network type | INTRANET |
| privateLinkList | Object | Private network connection information | - |
| intranetAddress | String | Address IP | xx.xx.xx.xx |
| privateLinkEndpointId | String | Endpoint ID | vpce-xxx |
| privateLinkEndpointVpcId | String | Endpoint VPC ID | vpc-xxx |
| privateLinkServiceId | String | Endpoint service ID | vpcsvc-xxx |
| privateLinkStatus | String | Private network connection status | CONNECTED |
| privateLinkUserAccount | String | Private network connection user account | 10******** |
| proxyClusterId | String | Proxy cluster ID | proxy-xxx |
| proxyClusterInfo | Object | Proxy cluster information | - |
| deployMode | String | Deployment mode | 1-1 |
| proxyClusterId | String | Cluster ID | proxy-xxx |
| proxyMode | String | Proxy mode | k8s_shared |
| proxyServiceVersion | String | Proxy architecture version | 2.0 |
| proxyVersion | String | Proxy kernel version | 4.3.1.6-22025072510 |
| status | String | Proxy status | ONLINE |
| unitNum | Integer | Proxy specification quantity | 1 |
| unitSpec | String | Proxy unit specification | 2C4G |
| zone | String | Proxy zone | ap-beijing-5,ap-beijing-3 |
| role | String | Role | READWRITE |
| serviceType | String | Address type | OBPROXY_INTRANET |
| tenantEndpointId | String | Address ID | obe-xxx |
| tenantId | String | Tenant ID | txxx |
| useSSL | Boolean | Whether to enable SSL | true |
| userNameFormat | String | Access connection string format | USER |
| tenantId | String | Tenant ID | txxx |
| tenantMaxConnections | Integer | Maximum number of tenant connections | 1600 |
| tenantMode | String | Tenant mode | MySQL |
| tenantName | String | Tenant name | test_mysql |
| tenantResource | Object | Tenant resources | - |
| cpu | Integer | Number of CPU cores | 1 |
| totalCpu | Integer | Total number of CPU cores | 1 |
| unitCpu | Integer | Number of CPU cores per unit | 1 |
| disk | Integer | Disk size | 0 |
| totalDiskSize | Integer | Total disk size | 0 |
| usedDiskSize | Integer | Used disk size | 0 |
| usedUnitDiskSize | Integer | Used disk size per unit | 0 |
| memory | Integer | Memory | 4 |
| totalMemory | Integer | Total memory | 4 |
| unitMemory | Integer | The memory size of each unit. | 4 |
| unitNum | Integer | The number of units. | 1 |
| unitCpu | Integer | The number of CPU cores of each unit. | 1 |
| unitDiskSize | Integer | The disk size of each unit. | 0 |
| unitMem | Integer | The memory size of each unit. | 4 |
| unitNum | Integer | The number of units. | 1 |
| hasMore | Boolean | Indicates whether more data exists. | false |
| total | Integer | The total number of data entries. | 2 |
| requestId | String | The ID of the request. | b7451058-f5dd-4b15-8f5c-c75911aba392 |
| success | Boolean | Indicates whether the request is successful. | true |
Examples
Request example
curl --digest -u 'ak:sk' \
-X GET \
'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/address/info' \
-G
-d 'pageNumber=xxx'
-d 'pageSize=xxx'
-d 'tenantIds=xxx'
Response example
JSON format
{
"data":{
"dataList":[
{
"aiFunctionStatus":"CLOSE",
"cpu":1,
"createTime":"2025-12-25T08:23:49Z",
"diskSize":0,
"enableProxyPeeringLink":true,
"enableProxyPublicLink":true,
"enableProxyService":true,
"enableRag":false,
"enableStandbyReadWriteSplit":"INVISIBLE",
"gmtCreate":"2025-12-25 16:23:49.0",
"mem":4,
"ocpTenantId":12000104,
"primaryZone":"ap-beijing-3",
"status":"ONLINE",
"tenantCompatibilityMode":"MySQL",
"tenantConnections":[
{
"addressId":"rs-private-intranet-vpc-xxx",
"addressMasterZoneId":"ap-beijing-3",
"addressStatus":"ONLINE",
"addressType":"MASTER",
"connectionLogicalZones":[
"ap-beijing-3-z0"
],
"connectionReplicaType":"FULL",
"connectionZones":[
"ap-beijing-3"
],
"enableRPc":true,
"enableRagHttp":false,
"intranetAddressStatus":"ONLINE",
"intranetPort":3306,
"isMigrated":0,
"isVirtualServerGroup":true,
"maxConnectionNum":5000,
"maxConnectionNumLimit":5000,
"networkType":"INTRANET",
"privateLinkList":[
{
"deletePrivateLink":true,
"intranetAddress":"172.16.0.15",
"privateLinkEndpointId":"vpce-xxx",
"privateLinkEndpointVpcId":"vpc-xxx",
"privateLinkServiceAccount":"10********",
"privateLinkServiceId":"vpcsvc-xxx",
"privateLinkStatus":"CONNECTED",
"privateLinkUserAccount":"10********"
}
],
"proxyClusterId":"proxy-xxx",
"proxyClusterInfo":{
"createTime":"2025-12-25T08:27:20Z",
"deployMode":"1-1",
"proxyClusterId":"proxy-xxx",
"proxyMode":"k8s_shared",
"proxyServiceVersion":"2.0",
"proxyVersion":"4.3.1.6-22025072510",
"status":"ONLINE",
"unitNum":1,
"unitSpec":"2C4G",
"zone":"ap-beijing-5,ap-beijing-3"
},
"role":"READWRITE",
"serviceType":"OBPROXY_INTRANET",
"tenantEndpointId":"obe-xxx",
"tenantId":"txxx",
"useSSL":true,
"userNameFormat":"USER"
}
],
"tenantId":"txxx",
"tenantMaxConnections":1600,
"tenantMode":"MySQL",
"tenantName":"test_mysql",
"tenantResource":{
"cpu":{
"totalCpu":1.0,
"unitCpu":1.0
},
"disk":{
"totalDiskSize":0.0,
"usedDiskSize":0.02,
"usedUnitDiskSize":0.0
},
"memory":{
"totalMemory":4.0,
"unitMemory":4.0
},
"unitNum":1
},
"unitCpu":1,
"unitDiskSize":0,
"unitMem":4,
"unitNum":1
},
···
],
"hasMore":false,
"total":2
},
"requestId":"b7451058-f5dd-4b15-8f5c-c75911aba392",
"success":true
}