DescribeTenantAddress|OceanBase Cloud |docs|OceanBase Documentations

DescribeTenantAddress

Last Updated：2026-09-22 07:23:31 Updated

Overview

You can call this API to query the list of network connection addresses of a specified tenant, including the details of private and public addresses.

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

Parameter	Type	Required	Description	Example value
instanceId	String	Yes	OceanBase cluster ID.	obcluster-*****
tenantId	String	Yes	Tenant ID.	t4louaeei****

Query

Parameter	Type	Required	Description	Example value
requestId	String	Yes	Request ID used for tracking.	d04eabba****
addressId	String	Yes	Connection address or service address identifier.	rs-private-internet-*****

Response parameters

Field	Type	Description	Example value
success	Boolean	Whether the request succeeded.	true
errorCode	String	Error code.	INVALID_PARAMETER
errorMessage	String	Error message.	Invalid parameter
data	Array	Response data.	N/A
cost	Number	Time taken.	1.0
server	String	Server address, usually 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	Additional information.	{}

`data[]` object fields

Field	Type	Description	Example value
tenantId	String	Tenant ID.	t4louaeei****
vpcId	String	VPC ID.	vpc-xxxx****
userVpcOwnerId	String	ID of the account that owns the VPC.	20000600****
vSwitchId	String	vSwitch ID.	vsw-xxxx****
connectionZones	Array	Zones associated with the connection.	["zone-a"]
tenantEndpointId	String	Tenant endpoint ID.	te-xxxxx****
addressId	String	Connection address or service address identifier.	rs-private-internet-*****
addressStatus	String	Connection status.	ONLINE
serviceType	String	Service type.	PRIVATE
addressType	String	Address type: MASTER or READONLY.	MASTER
networkType	String	Network type.	INTRANET
role	String	Connection type: READWRITE for read/write or READONLY for read-only. In some cases, the primary address also needs a read/write type. The primary address of a standby database is read-only.	READWRITE
userNameFormat	String	Username format for this address: one-part or two-part.	TWO_PART
useSSL	Boolean	Whether SSL is enabled.	false
proxyClusterId	String	ODP proxy cluster ID.	proxy-12****
proxyClusterInfo	Object	ODP proxy cluster associated with the tenant connection.	N/A
proxyClusterInfo.proxyClusterId	String	ODP proxy cluster ID.	proxy-12****
proxyClusterInfo.proxyMode	String	ODP proxy mode.	DEDICATED
proxyClusterInfo.zone	String	Zone.	zone-a
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 task or resource status.	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-25T15:40:43+00:00
proxyClusterInfo.expireTime	String	Expiration time.	2020-12-23T04:14:48+00:00
proxyClusterInfo.deployMode	String	Data replica layout (n/n-n/n-n-n).	1-1-1
proxyClusterInfo.maxUnitNum	Number	Maximum number of units for Serverless ODP scaling.	3.0
proxyClusterInfo.slaveZone	String	Zone of the standby node. Returned only for primary-standby deployments across two or three zones.	zone-a
proxyClusterInfo.nodeDistribution	String	Node distribution. Replaces deployMode.	zone-a:1,zone-b:1
proxyClusterInfo.nodeCpu	Number	Node specification. Replaces unitSpec * unitNum.	4.0
proxyClusterInfo.nodeNum	Integer	Number of nodes.	3
proxyClusterInfo.deploymentArchitecture	String	Deployment architecture. Existing ODP clusters that have not migrated to the commercial offering return SINGLE_AZ_DEPLOYMENT, DUAL_AZ_DEPLOYMENT, or MULTI_AZ_DEPLOYMENT.	SINGLE_ZONE
proxyClusterInfo.proxyServerIds	Array	List of ODP proxy node IDs.	["resource-123456"]
proxyClusterInfo.enableArchitectureUpgrade	Boolean	Architecture upgrade enablement flag.	true
odpVersion	String	ODP version.	4.2.1
readStrategyConfigResponse	Object	Read traffic policy configuration for the tenant connection address.	N/A
readStrategyConfigResponse.odpVersion	String	ODP version.	4.2.1
readStrategyConfigResponse.trafficStrategy	String	Traffic policy.	ZONE_FIRST
readStrategyConfigResponse.replicaParams	Array	Selected replicas.	N/A
readStrategyConfigResponse.disasterRecoveryReplicaParams	Array	Disaster recovery replicas.	N/A
readStrategyConfigResponse.balancedStrategy	String	Balancing policy.	BALANCED
readStrategyConfigResponse.disasterRecoveryStrategy	String	Disaster recovery policy. Queries the primary replica automatically when a replica is unavailable.	PRIMARY_FIRST
internetAddress	String	Public address.	8.8.8.8
internetPort	Integer	Public port.	2881
internetDomain	String	Public address.	pay-core-public.oceanbase.example.com
internetAddressStatus	String	Public address status.	ONLINE
internetMaxConnectionNum	Integer	Maximum number of public connections.	10000
internetMaxConnectionNumLimit	Integer	Upper limit on the maximum number of public connections.	20000
internetRpcPort	Integer	Public RPC port.	2882
internetProxyClusterId	String	Public proxy cluster ID.	proxy-12****
intranetAddress	String	Private address.	10.0.0.10
intranetPort	Integer	Private port.	2881
intranetDomain	String	Private address.	pay-core-private.oceanbase.example.com
intranetAddressStatus	String	Private address status.	ONLINE
maxConnectionNum	Integer	Maximum number of private connections.	10000
maxConnectionNumLimit	Integer	Upper limit for adjusting the maximum number of private connections.	20000
intranetRpcPort	Integer	Private RPC port.	2882
enableRPc	Boolean	Whether RPC is enabled for Direct Load.	true
intranetAddressMasterZoneId	String	Primary zone ID.	zone-a
intranetAddressSlaveZoneId	String	Standby zone ID.	zone-b
intranetProxyClusterId	String	Private proxy cluster ID.	proxy-12****
privateLinkList	Array	List of PrivateLink configurations.	[{"endpointId": "ep-xxxxxx", "status": "CONNECTED"}]

`data[].privateLinkList[]` object fields

Field	Type	Description	Example value
privateLinkStatus	String	PrivateLink provisioning status.	ONLINE
privateLinkServiceId	String	PrivateLink service ID.	resource****
privateLinkEndpointId	String	PrivateLink endpoint ID.	resource****
privateLinkEndpointVpcId	String	ID of the VPC that contains the PrivateLink endpoint.	vpc-xxxx****
privateLinkEndpointSubnetId	String	ID of the subnet that contains the PrivateLink endpoint.	resource****
privateLinkServiceAccount	String	Primary account for the PrivateLink service.	3
privateLinkUserAccount	String	Account on the PrivateLink allowlist.	3
privateLinkDomain	String	Private domain name.	pay-core.oceanbase.example.com
intranetAddress	String	Private address.	10.0.0.10
intranetDomain	String	Private address.	pay-core-private.oceanbase.example.com
deletePrivateLink	Boolean	Whether the private primary address can be deleted. It cannot be deleted if it is associated with a global address.	true

Examples

Request example

curl --digest \
  -u '<Your AccessKey ID:AccessKey Secret>' \
  --request GET \
  --url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/address?requestId={requestId}&addressId={addressId}' \
  -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": null,
    "errorMessage": null,
    "data": [
        {
            "tenantId": "t4louaeei****",
            "vpcId": "vpc-xxxx****",
            "userVpcOwnerId": "20000600****",
            "vSwitchId": "vsw-xxxx****",
            "connectionZones": [
                "zone-a"
            ],
            "tenantEndpointId": "te-xxxxx****",
            "addressId": "rs-private-internet-*****",
            "addressStatus": "ONLINE",
            "serviceType": "PRIVATE",
            "addressType": "MASTER",
            "networkType": "INTRANET",
            "role": "READWRITE",
            "userNameFormat": "TWO_PART",
            "useSSL": false,
            "proxyClusterId": "proxy-12****",
            "proxyClusterInfo": {
                "proxyClusterId": "proxy-12****",
                "proxyMode": "DEDICATED",
                "zone": "zone-a",
                "unitSpec": "2C4G",
                "unitNum": 1.0,
                "sharedUnitNumLimit": 3,
                "exclusiveUnitNumLimit": 3,
                "status": "ONLINE",
                "proxyServiceVersion": "4.2.1.0",
                "proxyVersion": "4.2.1.0",
                "createTime": "2026-02-25T15:40:43+00:00",
                "expireTime": "2020-12-23T04:14:48+00:00",
                "deployMode": "1-1-1",
                "maxUnitNum": 3.0,
                "slaveZone": "zone-a",
                "nodeDistribution": "zone-a:1,zone-b:1",
                "nodeCpu": 4.0,
                "nodeNum": 3,
                "deploymentArchitecture": "SINGLE_ZONE",
                "proxyServerIds": [
                    "resource-123456"
                ],
                "enableArchitectureUpgrade": true
            },
            "odpVersion": "4.2.1",
            "readStrategyConfigResponse": {
                "odpVersion": "4.2.1",
                "trafficStrategy": "ZONE_FIRST",
                "replicaParams": [
                    {
                        "value": "prod",
                        "weight": 1,
                        "readOnlyReplicaType": "FULL"
                    }
                ],
                "disasterRecoveryReplicaParams": [
                    {
                        "value": "prod",
                        "weight": 1,
                        "readOnlyReplicaType": "FULL"
                    }
                ],
                "balancedStrategy": "BALANCED",
                "disasterRecoveryStrategy": "PRIMARY_FIRST"
            },
            "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****",
            "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,
            "intranetAddressMasterZoneId": "zone-a",
            "intranetAddressSlaveZoneId": "zone-b",
            "intranetProxyClusterId": "proxy-12****",
            "privateLinkList": [
                {
                    "endpointId": "ep-xxxxxx",
                    "status": "CONNECTED",
                    "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
                }
            ]
        }
    ],
    "cost": 1.0,
    "server": "10.0.0.10",
    "requestId": "d04eabba****",
    "totalCount": 100.0,
    "extra": {}
}

OceanBase

Customer Stories

Documentation