文档

DescribeDatabases - 查询数据库列表

更新时间:

查询租户下的数据库列表。

调试

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

授权信息

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

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

请求参数

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

租户 ID。

t4pnum****
PageNumberinteger

分页查询的页码。

  • 起始值:1。
  • 默认值:1。
1
PageSizeinteger

分页查询时设置的每页行数。

  • 最大值:100
  • 默认值:10
10
DatabaseNamestring

数据库名称。 不能使用某些预留关键字,如 test、mysql。

sms_pre
SearchKeystring

查询列表的删选关键字。

pay
WithTablesboolean

是否返回数据库中的表信息。
默认值:false。

说明 如果表的数量过大则可能导致接口超时。
true
InstanceIdstring

集群 ID。

ob****n0abo9uo

返回参数

名称类型描述示例值
object

请求的返回结果。

TotalCountinteger

租户中的数据库总数。

1
Databasesobject []

租户中的数据库列表。

Statusstring

数据库的状态。

  • ONLINE: 运行中。
  • DELETING: 删除中。
ONLINE
Descriptionstring

数据库的描述信息。

test db
Encodingstring

数据库的编码。目前支持 utf8mb4、gbk 等编码。

utf8mb4
DbTypestring

数据库类型。

mysql
DatabaseNamestring

数据库名称。

sms_pre
CreateTimestring

创建时间。

2022-02-21 15:41:06
Usersobject []

对该数据库赋权的账号列表信息。

UserTypestring

账号类型。

  • Admin:超级账户。
  • Normal:普通账户。
Normal
Rolestring

账号赋予该库的角色权限。 对于 MySQL 模式,角色为数据库(Database)级别,其有以下几类:

  • ReadWrite:读写权限,包括 ALL PRIVILEGES;
  • ReadOnly:只读权限,包括 SELECT;
  • DDL: DDL 权限,包括 CREATE,DROP,ALTER,SHOW VIEW,CREATE VIEW;
  • DML: DML 权限,包括 SELECT,INSERT,UPDATE,DELETE,SHOW VIEW。
ReadOnly
UserNamestring

账号名称。

user_pay_ro
Privilegesstring

用户授予数据库自定义权限时,privileges 返回自定义的权限内容,以逗号 "," 分割;其余时间 privileges 不返回数据。

select,delete,update
TenantIdstring

租户 ID。

t4pnum****
Tablesobject []

数据库表列表信息。

TableNamestring

数据库表名。

testTables
RequiredSizedouble

所需容量,单位:GB。

5.67 GB
DataSizedouble

实际数据大小,单位:GB。

注意 该字段后期后台不再输出, 请使用 RequiredSize。

5.67 GB
Collationstring

字符序。

utf8mb4_general_ci
InstanceIdstring

所属集群 ID。

obsdh2f****
TenantNamestring

租户名。

tenantABC
RequestIdstring

请求 ID。

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

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "Databases": [
    {
      "Status": "ONLINE",
      "Description": "test db",
      "Encoding": "utf8mb4",
      "DbType": "mysql",
      "DatabaseName": "sms_pre",
      "CreateTime": "2022-02-21 15:41:06",
      "Users": [
        {
          "UserType": "Normal",
          "Role": "ReadOnly",
          "UserName": "user_pay_ro",
          "Privileges": "select,delete,update"
        }
      ],
      "TenantId": "t4pnum****",
      "Tables": [
        {
          "TableName": "testTables"
        }
      ],
      "RequiredSize": 0,
      "DataSize": 0,
      "Collation": "utf8mb4_general_ci",
      "InstanceId": "obsdh2f****",
      "TenantName": "tenantABC"
    }
  ],
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-10-30OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:InstanceId
出参OpenAPI 返回结构发生变更
2023-07-04OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-09-28OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2022-01-17OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈