全部产品
Search
文档中心

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

更新时间:Dec 02, 2024

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

OceanBase 集群 ID。

ob317v4uif****
TenantIdstring

租户 ID。

t4pnum****

返回参数

名称类型描述示例值
object

租户的详细信息。

RequestIdstring

请求 ID。

EE205C00-30E4-****-****-87E3A8A2AA0C
Tenantobject

租户信息。

TenantIdstring

租户 ID。

t4louaeei****
TenantNamestring

租户名称。

forMySQLTenant
TenantModestring

租户模式。
当前支持:

  • Oracle:Oracle 模式。
  • MySQL: MySQL 模式。
MySQL
VpcIdstring

专有网络(VPC) ID。 如无合适的 VPC,请根据页面提示创建一个 VPC,详情参见什么是专有网络。

vpc-bp1d2q3mhg9i23ofi****
Statusstring

租户状态:

  • 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
EnableInternetAddressServiceboolean

是否可开启租户公网地址。

true
PrimaryZonestring

租户的主可用区。

cn-hangzhou-h
DeployTypestring

集群的部署类型。

  • multiple:多机房。
  • single:单机房。
  • dual:双机房。
multiple
DeployModestring

租户的数据副本模式。

  • 对于高可用版本:三地域为 N-N-N,两可用区和单可用区均为 N-N;
  • 对于基础版为 N。
说明
其中 N 为单可用区内的节点数。
FULL{1}@cn-hangzhou-h,FULL{1}@cn-hangzhou-i,FULL{1}@cn-hangzhou-j
Descriptionstring

租户描述信息。

paycore database
CreateTimestring

租户的创建时间。

2023-04-21 11:15:47.0
TenantResourceobject

租户的资源信息。

UnitNuminteger

租户的 unit 个数。

1
Cpuobject

租户的 CPU 资源信息。

UsedCpufloat

租户已使用的 CPU 核数,单位:Core。

8
TotalCpufloat

租户总的 CPU 核数,单位:Core。

10
UnitCpufloat

租户每个 Unit 的 CPU 核数,单位:Core。

8
Memoryobject

租户内存资源信息。

UsedMemoryfloat

租户已使用的内存,单位:GB。

30
TotalMemoryfloat

租户总的内存大小,单位:GB。

64
UnitMemoryfloat

租户每个 Unit 的内存大小,单位:GB。

32
DiskSizeobject

租户磁盘资源信息。

UsedDiskSizefloat

租户已使用的磁盘大小,单位:GB。

86
CapacityUnitobject

容量单元。

MaxCapacityUnitinteger

最大容量单元。

16
MinCapacityUnitinteger

最小容量单元。

1
UsedCapacitinteger

已使用容量单元。

5
LogDiskSizeobject

租户日志盘资源信息。

TotalLogDiskinteger

租户总的日志盘分配大小,单位:GB。

8.0
UnitLogDiskinteger

租户每个 Unit 的日志盘分配大小,单位:GB。

8.0
TenantConnectionsarray<object>

租户的连接信息。

TenantConnectionsobject

租户的连接信息。

IntranetAddressstring

访问租户的私网连接地址。

t4nunwxr0****.oceanbase.aliyuncs.com
IntranetPortinteger

访问租户的私网连接端口。

2983
InternetAddressstring

访问租户的公网连接地址。

t4nunwxr0****-mi.oceanbase.aliyuncs.com
InternetPortinteger

访问租户的公网连接端口。

3306
VpcIdstring

专有网络(VPC)ID。

vpc-bp1qiail1asmfe23t****
VSwitchIdstring

虚拟交换机(VSwitch)ID。

vsw-bp1i7b94u2et716yl****
IntranetAddressMasterZoneIdstring

访问租户的连接地址对应的主可用区。

cn-hangzhou-b
IntranetAddressSlaveZoneIdstring

访问租户的连接地址对应的备可用区。

cn-hangzhou-g
IntranetAddressStatusstring

访问租户的私网连接地址状态。 ONLINE: 服务中。

ONLINE
ConnectionZonesarray

租户连接对应的访问可用区列表。

ConnectionZonesstring

租户连接对应的可用区。

cn-hangzhou-b
InternetAddressStatusstring

访问租户的公网连接开通状态。

  • CLOSED:关闭。
  • ALLOCATING_INTERNET_ADDRESS:申请中。
  • PENDING_OFFLINE_INTERNET_ADDRESS: 公网地址关闭中。
  • ONLINE:服务中。
CLOSED
TransactionSplitboolean

是否开启事务拆分。

false
AddressTypestring

地址类型。

  • MASTER:主地址,可读可写。

  • READONLY:只读地址,只读。

  • READWRITE:读写分离地址,自动读写分离。

  • CLOGSERVICE:事务日志服务地址。

READONLY
EnableTransactionSplitboolean

是否开启事务拆分。

false
ParallelQueryDegreelong

并行度。

1
TenantEndpointIdstring

租户地址 ID。

obe-4tw51gp7****
MaxConnectionNumlong

最大连接数。

5000
ConnectionReplicaTypestring

链接对应的副本类型。

FULL
ProxyClusterIdstring

ODP 集群 ID。

proxy-xxxxxxx
MaxConnectionLimitlong

私网最大连接数的当前值

1000
InternetMaxConnectionLimitlong

公网最大连接数的上限

4000
IntranetRpcPortinteger

私网旁路导入端口

3307
InternetMaxConnectionNumlong

公网最大连接数的当前值

2500
InternetRpcPortinteger

公网旁路导入端口

3307
ConnectionLogicalZonesarray

地址所在的逻辑 zone

ConnectionLogicalZonesstring

地址所在的逻辑 zone 信息

cn-bejing-3-z0,cn-bejing-4-z0
IntranetSqlPortinteger

私网 SQL 端口

3306
OdpVersionstring

ODP 版本

4.3.1-xxxxxxxxx
TenantZonesarray<object>

租户的可用区信息。

TenantZonesobject

租户的可用区信息。

TenantZoneIdstring

租户可用区 ID。

cn-hangzhou-h
Regionstring

租户可用区所属的地域。

cn-hangzhou
TenantZoneRolestring

租户可用区的角色。

ReadWrite
TenantZoneReplicasarray<object>

租户可用区副本信息。

TenantZoneReplicasobject

租户可用区副本信息。

ZoneReplicaTypestring

可用区副本类型。

FULL
ZoneNodeslong

可用区节点。

1
LogicZoneNamestring

逻辑可用区名称。

cn-shanghai-f-z0
ZoneCopyIdinteger

可用区副本 ID。

2
FullCopyIdinteger

全功能副本 ID。

3
ReadOnlyCopyIdstring

只读副本 ID。

3
ReadOnlyReplicaTypestring

只读副本类型。

ROW_STORE
ClogServiceStatusstring

Clog 服务开启状态。

  • CLOSED: 关闭。
  • ONLINE:服务中。
ONLINE
EnableClogServiceboolean

是否可使用 Clog 服务,如需开启,请工单联系。

true
Charsetstring

字符集。

gb18030
Collationstring

字符序。

gb18030_chinese_ci
PrimaryZoneDeployTypestring

租户主可用区部署模式。

枚举值:
  • RANDOMRANDOM
  • STATICSTATIC
STATIC
MasterIntranetAddressZonestring

Master 节点所在可用区。

cn-hangzhou-h
PayTypestring

付费类型。

POSTPAY
InstanceTypestring

实例类型。

KAFKA_PUBLIC
Seriesstring

实例系列。

normal
DiskTypestring

磁盘类型。

cloud_essd_pl1
AvailableZonesarray

可用区列表信息。

AvailableZonesstring

可用区列表信息。

["cn-hangzhou-i"]
EnableReadWriteSplitboolean

是否允许开启读写分离地址。

true
EnableParallelQueryboolean

是否允许开通并行查询。

true
MaxParallelQueryDegreelong

并行度设置上限。

32
EnableBinlogServiceboolean

是否可以申请 Binlog 服务。

true
TimeZonestring

时区。

Asia/Shanghai
DataMergeTimestring

租户合并时间,仅支持 OceanBase V4.0.0 及之后的版本。

02:36Z
ReadOnlyResourceobject

只读资源信息。

UnitNuminteger

租户的 unit 个数。

2
Cpuobject

集群中每个副本节点的 CPU,单位:Core。

UsedCpufloat

集群已使用的 CPU,单位:Core。

8
TotalCpufloat

租户总的 CPU 核数,单位:Core。

10
UnitCpufloat

租户每个 Unit 的 CPU 核数,单位:Core。

8
Memoryobject

集群内存信息。

UsedMemoryfloat

租户已使用的内存,单位:GB。

30
TotalMemoryfloat

租户总的内存大小,单位:GB。

64
UnitMemoryfloat

租户每个 Unit 的内存大小,单位:GB。

32
DiskSizeobject

数据盘大小规格。

UsedDiskSizefloat

租户已使用的磁盘大小,单位:GB。

86
CapacityUnitobject

容量单元信息。

MaxCapacityUnitinteger

最大容量单元。

16
MinCapacityUnitinteger

最小容量单元。

1
UsedCapacitinteger

已使用容量单元。

5
LogDiskSizeobject

日志盘大小信息。

TotalLogDiskinteger

总日志盘大小,单位:GB。

8.0
UnitLogDiskinteger

日志盘单元。

8.0
EnableReadOnlyReplicaboolean

是否支持只读副本

true
RecycleBinStatusstring

表示租户回收站状态,ON 表示开启,OFF 表示关闭

ON
LowerCaseTableNamesinteger

表名是否区分大小写,取值范围如下:

  • 1:不区分大小写
  • 0:区分大小写
1
Versionstring

版本信息

4.2.1
OdpVersionstring

ODP 版本

4.3.1-xxxxxxxxx
TenantMaxConnectionsstring

租户允许的最大连接数

1600
ParameterTemplatestring

参数模板

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": "FULL",
        "ProxyClusterId": "proxy-xxxxxxx",
        "MaxConnectionLimit": 1000,
        "InternetMaxConnectionLimit": 4000,
        "IntranetRpcPort": 3307,
        "InternetMaxConnectionNum": 2500,
        "InternetRpcPort": 3307,
        "ConnectionLogicalZones": [
          "cn-bejing-3-z0,cn-bejing-4-z0"
        ],
        "IntranetSqlPort": 3306,
        "OdpVersion": "4.3.1-xxxxxxxxx"
      }
    ],
    "TenantZones": [
      {
        "TenantZoneId": "cn-hangzhou-h",
        "Region": "cn-hangzhou",
        "TenantZoneRole": "ReadWrite",
        "TenantZoneReplicas": [
          {
            "ZoneReplicaType": "FULL",
            "ZoneNodes": 1,
            "LogicZoneName": "cn-shanghai-f-z0",
            "ZoneCopyId": 2,
            "FullCopyId": 3,
            "ReadOnlyCopyId": "3",
            "ReadOnlyReplicaType": "ROW_STORE"
          }
        ]
      }
    ],
    "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": "02:36Z",
    "ReadOnlyResource": {
      "UnitNum": 2,
      "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
      }
    },
    "EnableReadOnlyReplica": true,
    "RecycleBinStatus": "ON",
    "LowerCaseTableNames": 1,
    "Version": "4.2.1",
    "OdpVersion": "4.3.1-xxxxxxxxx",
    "TenantMaxConnections": "1600",
    "ParameterTemplate": "express_oltp"
  }
}

错误码

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

变更历史

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