DescribeTenant - 查询指定集群下的指定租户信息 - 云数据库 OceanBase

查看指定集群下的指定租户信息。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oceanbase:DescribeTenant	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	OceanBase 集群 ID。	ob317v4uif****
TenantId	string	是	租户 ID。	t4pnum****

返回参数

名称	类型	描述	示例值
	object	租户的详细信息。
RequestId	string	请求 ID。	EE205C00-30E4-**-**-87E3A8A2AA0C
Tenant	object	租户信息。
TenantId	string	租户 ID。	t4louaeei****
TenantName	string	租户名称。	forMySQLTenant
TenantMode	string	租户模式。当前支持： Oracle：Oracle 模式。 MySQL: MySQL 模式。	MySQL
VpcId	string	专有网络（VPC） ID。如无合适的 VPC，请根据页面提示创建一个 VPC，详情参见什么是专有网络。	vpc-bp1d2q3mhg9i23ofi****
Status	string	租户状态： ONLINE：运行中。 PENDING_CREATE：创建中。 WAITING_ALLOCATE_MASTER_ADDRESS：（备库）等待创建主地址。 ALLOCATING_MASTER_ADDRESS：主地址创建中。 DELETING_MASTER_ADDRESS：主地址删除中。 ALLOCATING_INTERNET_ADDRESS：公网地址创建中。 PENDING_OFFLINE_INTERNET_ADDRESS：公网地址删除中。 ALLOCATING_READONLY_ADDRESS：只读地址创建中。 DELETING_READONLY_ADDRESS：只读地址删除中。 ALLOCATING_READWRITE_ADDRESS：读写分离地址创建中。 DELETING_READWRITE_ADDRESS：读写分离地址删除中。 ALLOCATING_CLOGSERVICE_ADDRESS：事务日志地址创建中。 DELETING_CLOGSERVICE_ADDRESS：事务日志地址删除中。 MODIFYING_ADDRESS：地址域名修改中。 MODIFYING_PRIMARY_ZONE：主可用区切换中。 MODIFYING_READONLY_ADDRESS：只读地址修改中。 MODIFYING_READWRITE_ADDRESS：读写分离地址修改中。 SPEC_MODIFYING：规格修改中。 WHITE_LIST_MODIFYING：白名单修改中。 CREATING_BINLOG：Binlog 创建中。	ONLINE
EnableInternetAddressService	boolean	是否可开启租户公网地址。	true
PrimaryZone	string	租户的主可用区。	cn-hangzhou-h
DeployType	string	集群的部署类型。 multiple：多机房。 single：单机房。 dual：双机房。	multiple
DeployMode	string	租户的数据副本模式。对于高可用版本：三地域为 N-N-N，两可用区和单可用区均为 N-N；对于基础版为 N。说明其中 N 为单可用区内的节点数。	FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j
Description	string	租户描述信息。	paycore database
CreateTime	string	租户的创建时间。	2023-04-21 11:15:47.0
TenantResource	object	租户的资源信息。
UnitNum	integer	租户的 unit 个数。	1
Cpu	object	租户的 CPU 资源信息。
UsedCpu	float	租户已使用的 CPU 核数，单位：Core。	8
TotalCpu	float	租户总的 CPU 核数，单位：Core。	10
UnitCpu	float	租户每个 Unit 的 CPU 核数，单位：Core。	8
Memory	object	租户内存资源信息。
UsedMemory	float	租户已使用的内存，单位：GB。	30
TotalMemory	float	租户总的内存大小，单位：GB。	64
UnitMemory	float	租户每个 Unit 的内存大小，单位：GB。	32
DiskSize	object	租户磁盘资源信息。
UsedDiskSize	float	租户已使用的磁盘大小，单位：GB。	86
CapacityUnit	object	容量单元。
MaxCapacityUnit	integer	最大容量单元。	16
MinCapacityUnit	integer	最小容量单元。	1
UsedCapacit	integer	已使用容量单元。	5
LogDiskSize	object	租户日志盘资源信息。
TotalLogDisk	integer	租户总的日志盘分配大小，单位：GB。	8.0
UnitLogDisk	integer	租户每个 Unit 的日志盘分配大小，单位：GB。	8.0
TenantConnections	array<object>	租户的连接信息。
TenantConnections	object	租户的连接信息。
IntranetAddress	string	访问租户的私网连接地址。	t4nunwxr0****.oceanbase.aliyuncs.com
IntranetPort	integer	访问租户的私网连接端口。	2983
InternetAddress	string	访问租户的公网连接地址。	t4nunwxr0****-mi.oceanbase.aliyuncs.com
InternetPort	integer	访问租户的公网连接端口。	3306
VpcId	string	专有网络（VPC）ID。	vpc-bp1qiail1asmfe23t****
VSwitchId	string	虚拟交换机（VSwitch）ID。	vsw-bp1i7b94u2et716yl****
IntranetAddressMasterZoneId	string	访问租户的连接地址对应的主可用区。	cn-hangzhou-b
IntranetAddressSlaveZoneId	string	访问租户的连接地址对应的备可用区。	cn-hangzhou-g
IntranetAddressStatus	string	访问租户的私网连接地址状态。 ONLINE: 服务中。	ONLINE
ConnectionZones	array	租户连接对应的访问可用区列表。
ConnectionZones	string	租户连接对应的可用区。	cn-hangzhou-b
InternetAddressStatus	string	访问租户的公网连接开通状态。 CLOSED：关闭。 ALLOCATING_INTERNET_ADDRESS：申请中。 PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中。 ONLINE：服务中。	CLOSED
TransactionSplit	boolean	是否开启事务拆分。	false
AddressType	string	地址类型。 MASTER：主地址，可读可写。 READONLY：只读地址，只读。 READWRITE：读写分离地址，自动读写分离。 CLOGSERVICE：事务日志服务地址。	READONLY
EnableTransactionSplit	boolean	是否开启事务拆分。	false
ParallelQueryDegree	long	并行度。	1
TenantEndpointId	string	租户地址 ID。	obe-4tw51gp7****
MaxConnectionNum	long	最大连接数	5000
ConnectionReplicaType	string	链接对应的副本类型
MaxConnectionLimit	long	私网最大连接数的当前值
InternetMaxConnectionLimit	long	公网最大连接数的上限
InternetMaxConnectionNum	long	公网最大连接数的当前值
TenantZones	array<object>	租户的可用区信息。
TenantZones	object	租户的可用区信息。
TenantZoneId	string	租户可用区 ID。	cn-hangzhou-h
Region	string	租户可用区所属的地域。	cn-hangzhou
TenantZoneRole	string	租户可用区的角色。	ReadWrite
ClogServiceStatus	string	Clog 服务开启状态。 CLOSED: 关闭。 ONLINE：服务中。	ONLINE
EnableClogService	boolean	是否可使用 Clog 服务，如需开启，请工单联系。	true
Charset	string	字符集。	gb18030
Collation	string	字符序。	gb18030_chinese_ci
PrimaryZoneDeployType	string	租户主可用区部署模式。枚举值： RANDOM：RANDOM。 STATIC：STATIC。	STATIC
MasterIntranetAddressZone	string	Master 节点所在可用区。	cn-hangzhou-h
PayType	string	付费类型。	POSTPAY
InstanceType	string	实例类型。	KAFKA_PUBLIC
Series	string	实例系列。	normal
DiskType	string	磁盘类型。	cloud_essd_pl1
AvailableZones	array	可用区列表信息。
AvailableZones	string	可用区列表信息。	["cn-hangzhou-i"]
EnableReadWriteSplit	boolean	是否允许开启读写分离地址。	true
EnableParallelQuery	boolean	是否允许开通并行查询。	true
MaxParallelQueryDegree	long	并行度设置上限。	32
EnableBinlogService	boolean	是否可以申请 Binlog 服务。	true
TimeZone	string	时区。	Asia/Shanghai
DataMergeTime	string	租户合并时间，仅对 4.0 以上 OB 版本有效
ReadOnlyResource	object
UnitNum	integer	租户的 unit 个数。
Cpu	object
TotalCpu	float	租户总的 CPU 核数，单位：Core。	10
UnitCpu	float	租户每个 Unit 的 CPU 核数，单位：Core。	8
Memory	object
UsedMemory	float	租户已使用的内存，单位：GB。	30
TotalMemory	float	租户总的内存大小，单位：GB。	64
UnitMemory	float	租户每个 Unit 的内存大小，单位：GB。	32
DiskSize	object
UsedDiskSize	float	租户已使用的磁盘大小，单位：GB。	86
CapacityUnit	object
MaxCapacityUnit	integer	最大容量单元
MinCapacityUnit	integer	最小容量单元
UsedCapacit	integer	已使用容量单元
RecycleBinStatus	string	表示租户回收站状态，ON 表示开启，OFF 表示关闭
Version	string	版本信息
TenantMaxConnections	string	租户允许的最大连接数	1600
ParameterTemplate	string	参数模板	express_oltp

示例

正常返回示例

JSON格式

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Tenant": {
    "TenantId": "t4louaeei****",
    "TenantName": "forMySQLTenant",
    "TenantMode": "MySQL",
    "VpcId": "vpc-bp1d2q3mhg9i23ofi****",
    "Status": "ONLINE",
    "EnableInternetAddressService": true,
    "PrimaryZone": "cn-hangzhou-h",
    "DeployType": "multiple",
    "DeployMode": "FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j",
    "Description": "paycore database",
    "CreateTime": "2023-04-21 11:15:47.0",
    "TenantResource": {
      "UnitNum": 1,
      "Cpu": {
        "UsedCpu": 8,
        "TotalCpu": 10,
        "UnitCpu": 8
      },
      "Memory": {
        "UsedMemory": 30,
        "TotalMemory": 64,
        "UnitMemory": 32
      },
      "DiskSize": {
        "UsedDiskSize": 86
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 16,
        "MinCapacityUnit": 1,
        "UsedCapacit": 5
      },
      "LogDiskSize": {
        "TotalLogDisk": 8,
        "UnitLogDisk": 8
      }
    },
    "TenantConnections": [
      {
        "IntranetAddress": "t4nunwxr0****.oceanbase.aliyuncs.com",
        "IntranetPort": 2983,
        "InternetAddress": "t4nunwxr0****-mi.oceanbase.aliyuncs.com",
        "InternetPort": 3306,
        "VpcId": "vpc-bp1qiail1asmfe23t****",
        "VSwitchId": "vsw-bp1i7b94u2et716yl****",
        "IntranetAddressMasterZoneId": "cn-hangzhou-b",
        "IntranetAddressSlaveZoneId": "cn-hangzhou-g",
        "IntranetAddressStatus": "ONLINE",
        "ConnectionZones": [
          "cn-hangzhou-b"
        ],
        "InternetAddressStatus": "CLOSED",
        "TransactionSplit": false,
        "AddressType": "READONLY",
        "EnableTransactionSplit": false,
        "ParallelQueryDegree": 1,
        "TenantEndpointId": "obe-4tw51gp7****",
        "MaxConnectionNum": 5000,
        "ConnectionReplicaType": "",
        "ProxyClusterId": "",
        "MaxConnectionLimit": 0,
        "InternetMaxConnectionLimit": 0,
        "IntranetRpcPort": 0,
        "InternetMaxConnectionNum": 0,
        "InternetRpcPort": 0,
        "ConnectionLogicalZones": [
          ""
        ],
        "IntranetSqlPort": 0,
        "OdpVersion": ""
      }
    ],
    "TenantZones": [
      {
        "TenantZoneId": "cn-hangzhou-h",
        "Region": "cn-hangzhou",
        "TenantZoneRole": "ReadWrite",
        "TenantZoneReplicas": [
          {
            "ZoneReplicaType": "",
            "ZoneNodes": 0,
            "LogicZoneName": "",
            "ZoneCopyId": 0,
            "FullCopyId": 0,
            "ReadOnlyCopyId": "",
            "ReadOnlyReplicaType": ""
          }
        ]
      }
    ],
    "ClogServiceStatus": "ONLINE",
    "EnableClogService": true,
    "Charset": "gb18030",
    "Collation": "gb18030_chinese_ci",
    "PrimaryZoneDeployType": "STATIC",
    "MasterIntranetAddressZone": "cn-hangzhou-h",
    "PayType": "POSTPAY",
    "InstanceType": "KAFKA_PUBLIC",
    "Series": "normal",
    "DiskType": "cloud_essd_pl1",
    "AvailableZones": [
      "[\"cn-hangzhou-i\"]"
    ],
    "EnableReadWriteSplit": true,
    "EnableParallelQuery": true,
    "MaxParallelQueryDegree": 32,
    "EnableBinlogService": true,
    "TimeZone": "Asia/Shanghai",
    "DataMergeTime": "",
    "ReadOnlyResource": {
      "UnitNum": 0,
      "Cpu": {
        "UsedCpu": 0,
        "TotalCpu": 10,
        "UnitCpu": 8
      },
      "Memory": {
        "UsedMemory": 30,
        "TotalMemory": 64,
        "UnitMemory": 32
      },
      "DiskSize": {
        "UsedDiskSize": 86
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 0,
        "MinCapacityUnit": 0,
        "UsedCapacit": 0
      },
      "LogDiskSize": {
        "TotalLogDisk": 0,
        "UnitLogDisk": 0
      }
    },
    "EnableReadOnlyReplica": true,
    "RecycleBinStatus": "",
    "LowerCaseTableNames": 0,
    "Version": "",
    "OdpVersion": "",
    "TenantMaxConnections": "1600",
    "ParameterTemplate": "express_oltp"
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-08-15	OpenAPI 返回结构发生变更	查看变更详情
2024-08-01	OpenAPI 返回结构发生变更	查看变更详情
2024-06-06	OpenAPI 返回结构发生变更	查看变更详情
2024-04-15	OpenAPI 返回结构发生变更	查看变更详情
2024-02-02	OpenAPI 返回结构发生变更	查看变更详情
2023-12-26	OpenAPI 返回结构发生变更	查看变更详情
2023-10-30	OpenAPI 返回结构发生变更	查看变更详情
2023-08-25	OpenAPI 返回结构发生变更	查看变更详情
2023-08-21	OpenAPI 返回结构发生变更	查看变更详情
2023-08-09	OpenAPI 返回结构发生变更	查看变更详情
2023-07-04	OpenAPI 返回结构发生变更	查看变更详情
2023-05-17	OpenAPI 返回结构发生变更	查看变更详情
2022-09-28	OpenAPI 返回结构发生变更	查看变更详情
2021-08-19	新增 OpenAPI	查看变更详情