DescribeTenantAddressInfo|OceanBase Cloud| docs|Distributed Database

DescribeTenantAddressInfo

Last Updated：2026-01-29 07:18:30 Updated

Overview

You can call this API to query the tenant address information of 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 cluster.	ob317v4uif****

Query

Name	Type	Required	Description	Example value
pageNumber	Integer	No	The page number for the paginated query. The minimum value is 1. The default value is 1.	1
pageSize	Integer	No	The number of rows to return on each page. The maximum value is 100. The default value is 10.	10
tenantIds	List	No	The list of tenant IDs. Separate multiple tenant IDs with commas.	txxx,txxx1

Response parameters

Name	Type	Description	Example value
data	object	The tenant address information, including the dataList attribute.
dataList	object[]	The list of tenant address information.
tenantId	String	The tenant ID.	txxx
tenantName	String	The tenant name.	mix
managementMode	String	The management mode. DBaaS: normal mode. MaaS: management mode.	DBaaS
gmtCreate	String	The tenant creation time.	2025-06-02 22:12:10.0
tenantMode	String	The tenant mode. Oracle: Oracle mode. MySQL: MySQL mode.	MySQL
primaryZone	String	The primary zone of the tenant.	ap-beijing-5
status	String	The tenant status. PENDING_CREATE: Creating RESTORE: Restoring ONLINE: Running SPEC_MODIFYING: Modifying the specifications ALLOCATING_INTERNET_ADDRESS: Allocating a public IP address PENDING_OFFLINE_INTERNET_ADDRESS: Closing the public IP address PRIMARY_ZONE_MODIFYING: Switching the primary zone PARAMETER_MODIFYING: Modifying the parameters WHITE_LIST_MODIFYING: Modifying the allowlist	ONLINE
cpu	Integer	The total number of CPU cores of the tenant.	1
mem	Integer	The total memory size of the tenant, in GiB.	4
unitCpu	Integer	The number of CPU cores of each unit of the tenant, in cores.	1
unitMem	Integer	The memory size of each unit of the tenant, in GiB.	4
unitNum	Integer	The number of units of the tenant.	1
unitDiskSize	Integer	The disk size of each unit of the tenant, in GiB.	0
vpcId	String	The VPC ID.	vpc-dgbjsyp2
deployType	String	The deployment type.	single
description	String	The description of the tenant.
tenantConnections	Array	The list of tenant connection information.
tenantZones	Array	The list of tenant zones.
tenantResource	Object	The resource information of the tenant.
enableBinlogService	Boolean	Specifies whether to enable the binlog service.	false
readonlyConnectionAddable	String	Specifies whether to enable the read-only address. ADDABLE: enabled DISABLED: disabled INVISIBLE: invisible	ADDABLE
readwriteConnectionAddable	String	Specifies whether to enable the read/write separation address. ADDABLE: enabled DISABLED: disabled INVISIBLE: invisible	ADDABLE
timeZone	String	The tenant time zone.	+08:00
charset	String	The character set of the tenant.	utf8mb4
collation	String	The collation of the tenant.	utf8mb4_general_ci
lowerCaseTableNamesParam	Integer	The table name case sensitivity of the tenant.	0
parameterTemplate	String	The parameter template.
tagList	Array	The list of tenant tags.
tenantCompatibilityMode	String	The tenant compatibility mode. TP cluster: MySQL/Oracle KV cluster: HBase/Table	MySQL
dataMergeTime	String	The data merge time.	18:00Z
enableProxyPublicLink	Boolean	Specifies whether to enable the public network.	true
odpDefaultVersion	String	The default odpVersion when you create a tenant.
globalAddressAddable	String	Specifies whether to enable the global address.	ADDABLE
enableStandbyReadWriteSplit	String	The status of the read/write separation between the primary and standby databases.	INVISIBLE
tenantMaxConnections	Integer	The maximum number of connections allowed for the tenant.	1600
ragClusterDo	Object	The RAG information.
enableRag	Boolean	Specifies whether to enable RAG.	false
hasMore	Boolean	Specifies whether there are more data.	false
total	Integer	The total number of records.	1
success	boolean	Indicates whether the request was successful.	true/false
requestId	String	The request ID.	c55eb7e5-800b-4c77-8895-f24a4dfe8a5e

tenantConnections

Name	Type	Description	Example value
addressId	String	The ID of the address.	rs-private-internet-vpc-xxx
addressMasterZoneId	String	The ID of the primary zone of the address.	ap-beijing-5
addressStatus	String	The status of the address.	ONLINE
addressType	String	The type of the address. MASTER: the primary address READONLY: the read-only address READWRITE: the read/write address	MASTER
connectionZones	Array	The list of zones to which the address is connected.	["ap-beijing-5"]
enableRPc	Boolean	Specifies whether to enable RPC.	false
enableRagHttp	Boolean	Specifies whether to enable RAG HTTP.	false
internetAddressStatus	String	The status of the public IP address.	ONLINE
internetDomain	String	The public domain name.	txxx.qcloud-ap-beijing-internet.oceanbase.cloud
internetMaxConnectionNum	Integer	The maximum number of public connections.	5000
internetMaxConnectionNumLimit	Integer	The maximum number of public connections allowed.	5000
internetPort	Integer	The public port.	3306
intranetAddressStatus	String	The status of the private IP address.	ONLINE
intranetPort	Integer	The private port.	3306
isMigrated	Integer	Indicates whether the address has been migrated.	0
isVirtualServerGroup	Boolean	Indicates whether the address belongs to a virtual server group.	true
networkType	String	The type of the network. INTERNET: public network INTRANET: private network	INTERNET
maxConnectionNum	Integer	The maximum number of connections.	5000
maxConnectionNumLimit	Integer	The maximum number of connections allowed.	5000
privateLinkList	Array	The list of PrivateLink addresses.
proxyClusterId	String	The ID of the proxy cluster.	proxy-xxx
proxyClusterInfo	Object	The information about the proxy cluster.
role	String	The role of the address. READWRITE: read/write READONLY: read-only	READWRITE
serviceType	String	The type of the service. OBPROXY_INTERNET: public proxy OBPROXY_INTRANET: private proxy OBPROXY_READONLY: read-only proxy OBPROXY_READWRITE: read/write proxy	OBPROXY_INTERNET
tenantEndpointId	String	The ID of the tenant endpoint.	obe-xxx
useSSL	Boolean	Indicates whether to use SSL.	true
userNameFormat	String	The format of the username. USER_AND_TENANT: username and tenant name USER: username only	USER_AND_TENANT

proxyClusterInfo

Name	Type	Description	Example value
createTime	String	The time when the proxy cluster was created.	2025-06-10T10:05:11Z
proxyClusterId	String	The ID of the proxy cluster.	proxy-xxx
proxyMode	String	The proxy mode.	k8s_shared
proxyServiceVersion	String	The version of the proxy service.	2.0
proxyVersion	String	The version of the proxy.	4.3.1.5-62025052214
status	String	The status.	ONLINE
unitNum	Integer	The number of units.	1
unitSpec	String	The specifications of the unit.	2C4G
zone	String	The zone.	ap-beijing-5,ap-beijing-7

tenantResource

Name	Type	Description	Example value
cpu	Object	The information about the CPU resources.
totalCpu	Float	The total CPU, in cores.	1.0
unitCpu	Float	The CPU of each unit, in cores.	1.0
disk	Object	The information about the disk resources.
totalDiskSize	Float	The total disk size, in GiB.	0.0
usedDiskSize	Float	The size of the used disk, in GiB.	2.35
usedUnitDiskSize	Float	The size of the used disk of each unit, in GiB.	0.0
memory	Object	The information about the memory resources.
totalMemory	Float	The total memory, in GiB.	4.0
unitMemory	Float	The memory of each unit, in GiB.	4.0
unitNum	Integer	The number of units.	1

privateLinkList

Name	Type	Description	Example value
deletePrivateLink	Boolean	Specifies whether to delete the PrivateLink.	true
intranetAddress	String	The intranet address.	xxx.xx.x.xxx
privateLinkEndpointId	String	The ID of the PrivateLink endpoint.	vpce-0doacptl
privateLinkEndpointVpcId	String	The ID of the VPC of the PrivateLink endpoint.	vpc-xxx
privateLinkServiceAccount	String	The service account of the PrivateLink.	100031039273
privateLinkServiceId	String	The ID of the PrivateLink service.	vpcsvc-6dnrs1xk
privateLinkStatus	String	The status of the PrivateLink. CONNECTED: Connected SERVICE_CREATING: The service is being created	CONNECTED
privateLinkUserAccount	String	The user account of the PrivateLink.	1000********

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 'pageNumber=1' -d 'pageSize=10' -d 'tenantIds=txxx'

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

{
	"data":{
		"dataList":[
			{
				"cpu":1,
				"createTime":"2025-06-02T14:12:10Z",
				"diskSize":0,
				"enableProxyPublicLink":true,
				"enableRag":false,
				"enableStandbyReadWriteSplit":"INVISIBLE",
				"gmtCreate":"2025-06-02 22:12:10.0",
				"mem":4,
				"ocpTenantId":6003824,
				"primaryZone":"ap-beijing-5",
				"status":"ONLINE",
				"tenantCompatibilityMode":"MySQL",
				"tenantConnections":[
					{
						"addressId":"rs-private-internet-vpc-xxx",
						"addressMasterZoneId":"ap-beijing-5",
						"addressStatus":"ONLINE",
						"addressType":"MASTER",
						"connectionZones":[
							"ap-beijing-5"
						],
						"enableRPc":false,
						"enableRagHttp":false,
						"internetAddressStatus":"ONLINE",
						"internetDomain":"txxx.qcloud-ap-beijing-internet.oceanbase.cloud",
						"internetMaxConnectionNum":5000,
						"internetMaxConnectionNumLimit":5000,
						"internetPort":3306,
						"isMigrated":0,
						"isVirtualServerGroup":true,
						"networkType":"INTERNET",
						"proxyClusterInfo":{

						},
						"role":"READWRITE",
						"serviceType":"OBPROXY_INTERNET",
						"tenantEndpointId":"obe-xxx",
						"tenantId":"txxx",
						"useSSL":true,
						"userNameFormat":"USER_AND_TENANT"
					},
					{
						"addressId":"rs-private-intranet-vpc-xxx",
						"addressMasterZoneId":"ap-beijing-5",
						"addressStatus":"ONLINE",
						"addressType":"MASTER",
						"connectionZones":[
							"ap-beijing-5"
						],
						"enableRPc":false,
						"enableRagHttp":false,
						"intranetAddressStatus":"ONLINE",
						"intranetPort":3306,
						"isMigrated":0,
						"isVirtualServerGroup":true,
						"maxConnectionNum":5000,
						"maxConnectionNumLimit":5000,
						"networkType":"INTRANET",
						"privateLinkList":[
							{
								"deletePrivateLink":true,
								"intranetAddress":"xxx.xx.x.xxx",
								"privateLinkEndpointId":"vpce-0doacptl",
								"privateLinkEndpointVpcId":"vpc-xxx",
								"privateLinkServiceAccount":"100031039273",
								"privateLinkServiceId":"vpcsvc-6dnrs1xk",
								"privateLinkStatus":"CONNECTED",
								"privateLinkUserAccount":"1000********"
							}
						],
						"proxyClusterInfo":{

						},
						"role":"READWRITE",
						"serviceType":"OBPROXY_INTRANET",
						"tenantEndpointId":"obe-xxx",
						"tenantId":"txxx",
						"useSSL":true,
						"userNameFormat":"USER_AND_TENANT"
					},
					{
						"addressId":"rs-private-intranet-vpc-xxx",
						"addressMasterZoneId":"ap-beijing-7",
						"addressStatus":"ONLINE",
						"addressType":"READONLY",
						"connectionZones":[
							"ap-beijing-7"
						],
						"intranetAddressStatus":"ONLINE",
						"intranetPort":3306,
						"isMigrated":0,
						"isVirtualServerGroup":true,
						"maxConnectionNum":5000,
						"maxConnectionNumLimit":5000,
						"networkType":"INTRANET",
						"privateLinkList":[
							{
								"intranetAddress":"xxx.xx.x.xxx",
								"privateLinkEndpointId":"vpce-8wytu8tt",
								"privateLinkEndpointVpcId":"vpc-xxx",
								"privateLinkServiceAccount":"100031039273",
								"privateLinkServiceId":"vpcsvc-59hhy542",
								"privateLinkStatus":"CONNECTED",
								"privateLinkUserAccount":"1000********"
							}
						],
						"proxyClusterId":"proxy-xxx",
						"proxyClusterInfo":{
							"createTime":"2025-06-10T10:05:11Z",
							"proxyClusterId":"proxy-xxx",
							"proxyMode":"k8s_shared",
							"proxyServiceVersion":"2.0",
							"proxyVersion":"4.3.1.5-62025052214",
							"status":"ONLINE",
							"unitNum":1,
							"unitSpec":"2C4G",
							"zone":"ap-beijing-5,ap-beijing-7"
						},
						"role":"READONLY",
						"serviceType":"OBPROXY_READONLY",
						"tenantEndpointId":"obe-6tagdx6vroxs",
						"tenantId":"txxx",
						"useSSL":true,
						"userNameFormat":"USER"
					},
					{
						"addressId":"rs-private-intranet-vpc-xxx",
						"addressMasterZoneId":"ap-beijing-5",
						"addressStatus":"PENDING_CREATE",
						"addressType":"READWRITE",
						"connectionZones":[
							"ap-beijing-5"
						],
						"intranetAddressStatus":"PENDING_CREATE",
						"intranetPort":3306,
						"isMigrated":0,
						"networkType":"INTRANET",
						"privateLinkList":[
							{
								"privateLinkStatus":"SERVICE_CREATING",
								"privateLinkUserAccount":"1000********"
							}
						],
						"role":"READWRITE",
						"serviceType":"OBPROXY_READWRITE",
						"tenantEndpointId":"",
						"tenantId":"txxx",
						"useSSL":true,
						"userNameFormat":"USER_AND_TENANT"
					}
				],
				"tenantId":"txxx",
				"tenantMaxConnections":1600,
				"tenantMode":"MySQL",
				"tenantName":"HBN",
				"tenantResource":{
					"cpu":{
						"totalCpu":1.0,
						"unitCpu":1.0
					},
					"disk":{
						"totalDiskSize":0.0,
						"usedDiskSize":2.35,
						"usedUnitDiskSize":0.0
					},
					"memory":{
						"totalMemory":4.0,
						"unitMemory":4.0
					},
					"unitNum":1
				},
				"unitCpu":1,
				"unitDiskSize":0,
				"unitMem":4,
				"unitNum":1
			}
		],
		"hasMore":false,
		"total":1
	},
	"requestId":"c55eb7e5-800b-4c77-8895-f24a4dfe8a5e",
	"success":true
}