查看指定集群下的指定租户信息。
调试
您可以在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**** |
返回参数
示例
正常返回示例
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-29 | OpenAPI 返回结构发生变更 | 查看变更详情 |
| 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 | 查看变更详情 |