文档首页/ 数据管理服务 DAS/ API参考/ API/ 云DBA/ 查询数据库对象列表 - GetDbObjList
更新时间：2026-09-02 GMT+08:00
查看PDF
分享

查询数据库对象列表 - GetDbObjList

功能介绍

查询数据库对象列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    das:connection:list

    list

    connection

    -

    das:connections:list

    -

URI

GET /v3/{project_id}/connections/{connection_id}/get-db-obj-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

connection_id

是

String

参数解释：

连接ID。用户使用数据库账号与数据库建立的连接ID（数据库用户ID由创建实例连接创建）。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

db_name

否

String

参数解释：

数据库名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

db_id

否

String

参数解释：

数据库ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

schema_name

否

String

参数解释：

schema名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

table_name

否

String

参数解释：

表名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

table_id

否

String

参数解释：

表ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

obj_name

否

String

参数解释：

对象名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

keywords

否

String

参数解释：

搜索关键词。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cur_page

否

String

参数解释：

页码。

约束限制：

不涉及。

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

per_page

否

String

参数解释：

每页记录数。

约束限制：

不涉及。

取值范围：

[0, 100]，实际取决于查询。

默认取值：

不涉及。

order_by

否

String

参数解释：

主排序字段。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

order

否

String

参数解释：

主排序字段顺序。

约束限制：

不涉及。

取值范围：

  • asc：正序
  • desc：倒序

默认取值：

不涉及。

extra_order_by

否

String

参数解释：

次排序字段。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

extra_order

否

String

参数解释：

次排序字段顺序。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

obj_type

否

String

参数解释：

对象类型。

约束限制：

不涉及。

取值范围：

  • database
  • schema
  • table

默认取值：

不涉及。

ret_type

否

String

参数解释：

返回类型。

约束限制：

不涉及。

取值范围：

  • list：列表
  • tree：树状图

默认取值：

不涉及。

is_sys

否

String

参数解释：

是否为系统级对象。

约束限制：

不涉及。

取值范围：

  • true
  • false

默认取值：

不涉及。

ret_type

否

String

参数解释：

返回类型。

约束限制：

不涉及。

取值范围：

  • list：列表
  • tree：树状图

默认取值：

不涉及。

obj_sub_type

否

String

参数解释：

对象子类型。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

node_type

否

String

参数解释：

节点类型。

约束限制：

不涉及。

取值范围：

  • master：主节点
  • slave：备节点

默认取值：

不涉及。

node_id

否

String

参数解释：

节点ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

data

Array of objects

参数解释：

数据库对象信息列表。

total

Long

参数解释：

列表大小。

取值范围：

不涉及。

object_type

String

参数解释：

对象类型。

取值范围：

不涉及。

请求示例

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections/179e525e-0e9c-4dcc-9dd7-ee2f36121e23/get-db-obj-list?cur_page=1&per_page=10&db_name=test_db&keywords=&order=&order_by=&extra_order=&extra_order_by=&obj_type=table

响应示例

状态码： 200

Success.

{
    "data": [
],
    "total": 0,
    "object_type": "database"
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 云DBA

相关文档