查询指定 OceanBase 集群列表下的租户列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | Oceanbase 集群 ID。 | ob317v4uif**** |
TenantName | string | 否 | 租户名称。 | pay_online |
PageSize | integer | 否 | 分页查询时设置的每页行数。
| 10 |
PageNumber | integer | 否 | 分页查询的页码。
| 1 |
TenantId | string | 否 | 租户 ID。 | ob2mr3oae0**** |
SearchKey | string | 否 | 查询列表的筛选关键字。 | pay |
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": 1,
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"Tenants": [
{
"VpcId": "vpc-bp1d2q3mhg9i23ofi****",
"Status": "ONLINE",
"PrimaryZone": "cn-hangzhou-i",
"DeployType": "multiple",
"DeployMode": "1-1-1",
"CreateTime": "2021-09-17 15:52:17.0",
"TenantName": "pay_online",
"Mem": 20,
"Cpu": 10,
"Description": "paycore database",
"TenantMode": "Oracle",
"TenantId": "t33h8y08k****",
"UnitCpu": 5,
"UnitMem": 10,
"UnitNum": 2,
"UsedDiskSize": 10,
"Charset": "utf8mb4",
"Collation": "utf8mb4_general_ci",
"EnableReadOnlyReplica": true
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-02-02 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-09-28 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2022-01-17 | OpenAPI 返回结构发生变更 | 查看变更详情 |
2021-08-19 | OpenAPI 返回结构发生变更 | 查看变更详情 |