DescribeTenantAddressProxyInfo - 查询租户地址代理服务信息-云数据库 OceanBase 版（文档停止维护）(OceanBase)-阿里云帮助中心

本接口用户调用获取租户地址代理服务信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	集群 id（必填）	ob********
TenantId	string	否	租户 id（非必填）	t********

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Data	array<object>	查询对象信息。
Data	object	返回数据。
TenantId	string	租户 ID。	t********
TenantName	string	租户名称。	forMySQLTenant
TenantConnections	array<object>	租户地址信息。
TenantConnections	object	返回数据。
TenantEndpointId	string	租户地址 ID。	obe-********
AddressType	string	地址类型	MASTER
IntranetAddress	string	私网地址域名	xx.xx.xx.xx
IntranetPort	integer	私网地址服务端口	3306
IntranetAddressStatus	string	私网地址状态	ONLINE
MaxConnectionNum	long	私网地址最大连接数	1500
IntranetAddressMasterZoneId	string	私网地址主可用区	cn-hangzhou-j
IntranetAddressSlaveZoneId	string	私网地址备可用区	cn-hangzhou-i
InternetAddress	string	公网地址域名	t4nun********-mi.oceanbase.aliyuncs.com
InternetPort	integer	公网地址服务端口	3306
InternetAddressStatus	string	公网地址状态	CLOSED
InternetMaxConnectionNum	long	公网地址最大连接数	1500
VpcId	string	VPC 网络	vpc-********
VSwitchId	string	VSwitch 交换机	vsw-********
MaxConnectionLimit	long	私网地址最大连接数的上限	50000
InternetMaxConnectionLimit	string	公网最大连接数的上限	4000
ProxyClusterInfo	object	代理服务信息
Status	string	代理集群状态	ONLINE
Zone	string	代理部署可用区列表（逗号分隔）	cn-hangzhou-j,cn-hangzhou-k
UnitNum	integer	代理规格	2
ExclusiveUnitNumLimit	integer	代理独享规格数量上限	10
CreateTime	string	代理集群创建时间（ISO 8601 格式）	2026-01-12T03:34:22Z
ProxyVersion	string	代理内核版本	4.3.1.9-32025112117
ProxyClusterId	string	代理集群 id	ob********
AllowModifyServerNum	boolean	是否允许修改服务器组数量	false
SharedUnitNumLimit	integer	代理共享规格数量上限	4
DeployMode	string	代理部署模式	2-2
UnitSpec	string	代理基本规格（如 2C4G 表示 2 核 4GB 内存）	2C4G
ProxyServiceVersion	string	代理架构版本	1.0
ProxyMode	string	代理模式	fusion
ServerNumLimit	integer	服务器组数量上限值	15
AllowModifyProxyMode	boolean	是否允许修改代理模式	true
EnableExclusiveNodeMode	boolean	是否展示独占节点模式	false
NeedUpdateProxyMode	boolean	是否需要更新代理架构	true
IsExclusiveNodeMode	boolean	是否为独占节点模式	false
TotalCount	long	总数。	10

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Data": [
    {
      "TenantId": "t********",
      "TenantName": "forMySQLTenant",
      "TenantConnections": [
        {
          "TenantEndpointId": "obe-********",
          "AddressType": "MASTER",
          "IntranetAddress": "xx.xx.xx.xx",
          "IntranetPort": 3306,
          "IntranetAddressStatus": "ONLINE",
          "MaxConnectionNum": 1500,
          "IntranetAddressMasterZoneId": "cn-hangzhou-j",
          "IntranetAddressSlaveZoneId": "cn-hangzhou-i",
          "InternetAddress": "t4nun********-mi.oceanbase.aliyuncs.com",
          "InternetPort": 3306,
          "InternetAddressStatus": "CLOSED",
          "InternetMaxConnectionNum": 1500,
          "VpcId": "vpc-********",
          "VSwitchId": "vsw-********",
          "MaxConnectionLimit": 50000,
          "InternetMaxConnectionLimit": 4000,
          "ProxyClusterInfo": {
            "Status": "ONLINE",
            "Zone": "cn-hangzhou-j,cn-hangzhou-k",
            "UnitNum": 2,
            "ExclusiveUnitNumLimit": 10,
            "CreateTime": "2026-01-12T03:34:22Z",
            "ProxyVersion": "4.3.1.9-32025112117",
            "ProxyClusterId": "ob********",
            "AllowModifyServerNum": false,
            "SharedUnitNumLimit": 4,
            "DeployMode": "2-2",
            "UnitSpec": "2C4G",
            "ProxyServiceVersion": 1,
            "ProxyMode": "fusion",
            "ServerNumLimit": 15,
            "AllowModifyProxyMode": true,
            "EnableExclusiveNodeMode": false,
            "NeedUpdateProxyMode": true,
            "IsExclusiveNodeMode": false
          }
        }
      ]
    }
  ],
  "TotalCount": 10
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2026-03-20	新增 OpenAPI	查看变更详情