Overview
You can call this API to query a tenant address.
API details
Constraints
The caller must have an AccessKey for accessing APIs of OceanBase Cloud. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
GET /api/v2/instances/{instanceId}/tenants/{tenantId}/address
Request parameters
Path
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| instanceId | string | Yes | OceanBase instance ID. | ob317v4uif**** |
| tenantId | string | Yes | Tenant ID. | ob2mr3oae0**** |
Query
| Name | Type | Required | Description | Example Value |
|---|---|---|---|---|
| requestId | String | Yes | Request ID. | 6e87d618-854e-4ca1-ae1f-babc******** |
Response parameters
| Name | Type | Description | Example value |
|---|---|---|---|
| tenantId | String | Tenant ID | ob2mr3oae0**** |
| tenantEndpointId | String | Tenant endpoint ID | obe-6zfga5hc**** |
| addressId | String | Address ID | rs-private-internet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTERNET-t6zffysc2bg2o-**** |
| addressStatus | String | Address status. | ONLINE |
| connectionZones | List |
Zones connected. | ["cn-southwest-2a"] |
| serviceType | String | Service type. | OBPROXY_INTRANET, OBPROXY_INTERNET, OBPROXY_READONLY, OBPROXY_READWRITE |
| addressType | String | Address type. | MASTER, READONLY, READWRITE |
| networkType | String | Network type. | internet, intranet |
| role | String | Connection type. In some cases, the primary address is distinguished by the read/write type, and the primary address of the standby database is read-only. | READWRITE, READONLY |
| userNameFormat | String | Username format. | USER |
| useSSL | Boolean | Whether to enable. | true |
| proxyClusterId | String | Proxy cluster ID. | pxy-cluster-12345**** |
| proxyClusterInfo | String | Proxy cluster information. | Proxy cluster details. |
| internetAddress | String | Public IP address. | **... |
| internetPort | Integer | Public port. | 3306 |
| internetDomain | String | Public domain name. | t6zffysc2****.huawei-cn-southwest-2-internet.oceanbase.cloud |
| internetAddressStatus | String | Public IP address status. | ONLINE, OFFLINE, PENDING |
| internetMaxConnectionNum | Integer | Maximum connections of public network. | 5,000 |
| internetMaxConnectionNumLimit | Integer | Modification limit of maximum connections of public network. | 5,000 |
| internetRpcPort | Integer | Public RPC port. | 2,881 |
| internetProxyClusterId | String | Public proxy cluster ID. | pxy-internet-12345**** |
| vpcId | String | VPC ID. | vpc-bp12********** |
| userVpcOwnerId | String | VPC owner ID. | 123**********3456 |
| vSwitchId | String | Vswitch ID. | vsw-bp123******* |
| intranetDomain | String | Private domain name. | t6zffysc2****.huawei-cn-southwest-2-intranet.oceanbase.cloud |
| intranetAddress | String | Private IP address | ...* |
| intranetAddressStatus | String | Private IP address status | ONLINE, OFFLINE, PENDING |
| intranetPort | Integer | Private network port. | 3,306 |
| maxConnectionNum | Integer | Maximum connections of private network. | 10,000 |
| maxConnectionNumLimit | Integer | Modification limit of maximum connections of private network. | 10,000 |
| intranetRpcPort | Integer | Private network RPC port | 2,881 |
| privateLinkList | List | Private link service configuration list | Private link service configuration list |
| enableRPc | Boolean | Whether RPC is enabled for the primary address. This parameter is returned for the primary address in direct import. | true |
| odpVersion | String | ODP version. This parameter is returned for read/write and read-only addresses. | 4.2.1 |
| readStrategyConfigResponse | Object | Traffic strategy configuration. This parameter is returned for read/write and read-only addresses. | Configuration of read-write separation and load balancing strategies. |
Examples
Request example
curl --digest -u 'ak:sk' \
--request GET \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/address'\
-H 'X-Ob-Project-Id: <Project ID>'\
-G -d 'addressId=xxx'
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
Query public IP address
{ "data": [ { "addressId": "rs-private-internet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTERNET-t6zffysc2****-****", "addressStatus": "ONLINE", "addressType": "MASTER", "connectionZones": [ "cn-southwest-2a" ], "enableRPc": true, "internetAddressStatus": "ONLINE", "internetDomain": "t6zffysc2****.huawei-cn-southwest-2-internet.oceanbase.cloud", "internetMaxConnectionNum": 5000, "internetMaxConnectionNumLimit": 5000, "internetPort": 3306, "networkType": "INTERNET", "proxyClusterId": "proxy-6zfgafjc****", "proxyClusterInfo": { "createTime": "2025-08-11T08:31:24Z", "deployMode": "1-1", "proxyClusterId": "proxy-6zfgafjc****", "proxyMode": "k8s_shared", "proxyServiceVersion": "2.0", "proxyVersion": "4.3.1.5-62025052214", "status": "ONLINE", "unitNum": 1, "unitSpec": "2C4G", "zone": "cn-southwest-2a,cn-southwest-2d" }, "role": "READWRITE", "serviceType": "OBPROXY_INTERNET", "tenantEndpointId": "obe-6zfga5hc****", "tenantId": "t6zffysc2****", "useSSL": true, "userNameFormat": "USER" } ], "requestId": "6e87d618-854e-4ca1-ae1f-babcffd70000", "success": true }Query private network PrivateLink endpoint
{ "data": [ { "addressId": "rs-private-intranet-751bc080-d862-4917-972e-48ae3d22****-OBPROXY-INTRANET-t6zffysc2****-****", "addressStatus": "PENDING_CREATE", "addressType": "MASTER", "connectionZones": [ "cn-southwest-2a" ], "enableRPc": true, "intranetAddressStatus": "ONLINE", "intranetPort": 3306, "maxConnectionNum": 5000, "maxConnectionNumLimit": 5000, "networkType": "INTRANET", "privateLinkList": [ { "deletePrivateLink": true, "privateLinkServiceId": "cn-southwest-2.pl_t6zffysc2****.30043e04-ff7a-4aad-9a74-8ddd4771****", "privateLinkStatus": "SERVICE_CREATED", "privateLinkUserAccount": "f151faba4a2a4fb3b4ecdf4128b****" } ], "proxyClusterId": "proxy-6zfgafj****", "proxyClusterInfo": { "createTime": "2025-08-11T08:31:24Z", "deployMode": "1-1", "proxyClusterId": "proxy-6zfgafjc****", "proxyMode": "k8s_shared", "proxyServiceVersion": "2.0", "proxyVersion": "4.3.1.5-62025052214", "status": "ONLINE", "unitNum": 2, "unitSpec": "2C4G", "zone": "cn-southwest-2a,cn-southwest-2d" }, "role": "READWRITE", "serviceType": "OBPROXY_INTRANET", "tenantEndpointId": "obe-6zfga5hc****", "tenantId": "t6zffysc2****", "useSSL": true, "userNameFormat": "USER" } ], "requestId": "6e87d618-854e-4ca1-ae1f-babcffd70000", "success": true }