欢迎访问 OceanBase 官网获取更多信息：https://www.oceanbase.com/
功能说明
查询集群的租户列表。
调用说明
接口约束
调用者需要具备指定集群的读权限。
请求路径
GET /api/v2/ob/clusters/{clusterId}/tenants
请求参数
参数 | 类型 | 必选 | 示例值 | 描述 |
|---|---|---|---|---|
clusterId | Integer | 是 | 1 | 集群的 ID 。 |
page | Integer | 否 | 0 | 请求数据的分页页码。值从 1 开始。 默认值：1 |
size | Integer | 否 | 10 | 请求数据的分页大小。 默认值：10 最大值：2000 |
sort | String | 否 | asc,name | 排序规则。 |
name | String | 否 | foo | 集群名关键词 * 不区分大小写 * 集群名包含 |
mode | String | 否 | MYSQL | 租户模式：MYSQL、ORACLE |
locked | Boolean | 否 | true | 是否锁定 |
readonly | Boolean | 否 | Boolean | 是否只读 |
status | StringArray | 否 | CREATING | 租户的状态： * NORMAL：运行中 * CREATING：创建中 * MODIFYING：修改中 * DELETING：删除中 |
返回结果
- 基础数据结构
参数 | 类型 | 说明 |
|---|---|---|
data | Object | 请求的业务数据 |
├─ contents | Array | 租户信息的数据，详细结构参见下表。 |
├─ page | Object | 分页信息。 |
├─ totalElements | Integer | 总记录数。 |
├─ totalPage | Integer | 总页数。 |
├─ number | Integer | 当前页码。 |
├─ size | Integer | 当前页大小。 |
successful | Boolean | 请求是否成功。 |
timestamp | Datetime | 服务端完成请求的时间戳。 |
duration | Integer | 服务端处理请求的时间（毫秒）。 |
status | Integer | 符合 HTTP Status 规范的编码。 |
traceId | String | 请求的 Trace Id，用于排查问题。 |
server | String | 响应请求的服务端的地址。 |
- 租户信息的数据结构
参数 | 类型 | 说明 |
|---|---|---|
id | Integer | 租户的 Id 。 |
name | String | 租户的名称。 |
clusterName | String | 租户所属集群的名称。 |
clusterId | Integer | 租户所属集群的 Id。 |
obClusterId | Integer | 租户所属集群在 OB 端的 Id。 |
clusterType | String | 租户所属集群的类型。 取值范围： * PRIMARY：主集群 * STANDBY：备集群 |
mode | String | 租户的模式。 取值范围： * ORACLE： Oracle 模式 * MYSQL： MySQL 模式 |
createTime | Datetime | 租户的创建时间。 |
primaryZone | String | 租户的 Zone 优先级。 |
zoneList | String | 租户的 Zone List。 |
locality | String | 租户的副本分布。 |
status | String | 租户的状态。 取值范围： * NORMAL：运行中 * CREATING：创建中 * MODIFYING：修改中 * DELETING：删除中 |
locked | Boolean | 租户是否处于锁定状态。 |
readonly | Boolean | 租户是否处于只读状态。 |
obVersion | String | 租户所属集群的 OB 版本。 |
description | String | 租户的描述信息。 |
示例
请求示例
查询 Id 为 8 的集群下的所有租户。
GET /api/v2/ob/clusters/8/tenants
返回示例
{
"duration":197,
"server": "a83ad33525",
"status":200,
"successful":true,
"timestamp":"2020-11-11T20:52:34.669+08:00",
"traceId":"47e0c4c4a7a24207",
"data":{
"contents":[
{
"clusterId":1,
"clusterName":"foo",
"clusterType":"PRIMARY",
"createTime":"2020-01-01T00:00:00+08:00",
"id":10,
"locality":"FULL{1}@zone1, FULL{1}@zone2, FULL{1}@zone3",
"locked":false,
"mode":"Oracle",
"name":"first",
"obClusterId":1,
"obVersion":"2.2.52",
"primaryZone":"zone2,zone3;zone1",
"readonly":false,
"status":"NORMAL",
"zoneList":"zone1;zone2;zone3"
},
{
"clusterId":2,
"clusterName":"bar",
"clusterType":"PRIMARY",
"createTime":"2020-01-02T00:00:00+08:00",
"id":11,
"locality":"FULL{1}@zone1",
"locked":true,
"mode":"MYSQL",
"name":"second",
"obClusterId":3,
"obVersion":"2.2.72",
"primaryZone":"zone1",
"readonly":false,
"status":"NORMAL",
"zoneList":"zone1"
}
],
"page":{
"number":1,
"size":10,
"totalElements":9,
"totalPages":1
}
}
}
欢迎访问 OceanBase 官网获取更多信息：https://www.oceanbase.com/
