查询数据库对象
功能介绍
查询数据库对象。
约束限制：
集群guestAgent插件大于等于8.2.1.1开始支持。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/clusters/{cluster_id}/db-manager/objects
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 项目ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| cluster_id | 是 | String | 参数解释： 集群ID。获取方法请参见获取集群ID。 约束限制： 必须是有效的dws集群ID。 取值范围： 36位UUID。 默认取值： 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| type | 是 | String | 参数解释： 对象类型。 约束限制： 不涉及。 取值范围： DATABASE、SCHEMA、TABLE、VIEW、COLUMN、FUNCTION、SEQUENCE、NODEGROUP 默认取值： null |
| name | 否 | String | 参数解释： 对象名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| database | 否 | String | 参数解释： 数据库名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| schema | 否 | String | 参数解释： 模式名。 约束限制： 当对象类型为TABLE、VIEW、COLUMN、FUNCTION、SEQUENCE时必选。 取值范围： 不涉及。 默认取值： 不涉及。 |
| table | 否 | String | 参数解释： 表名。 约束限制： 对象类型为COLUMN时必选。 取值范围： 不涉及。 默认取值： 不涉及。 |
| offset | 否 | Integer | 参数解释： 分页偏移量，从0开始，页数减1。 约束限制： 不涉及。 取值范围： 大于等于0。 默认取值： 0 |
| limit | 否 | Integer | 参数解释： 分页大小。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 1000 |
| is_fine_grained_disaster | 否 | String | 参数解释： 是否细粒度容灾。 约束限制： 不涉及。 取值范围： true|false 默认取值： 不涉及。 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| type | String | 参数解释： 类型。 取值范围： DATABASE、SCHEMA、TABLE、VIEW、COLUMN、FUNCTION、SEQUENCE、NODEGROUP |
| object_list | Array of DatabaseObjectInfo objects | 参数解释： 对象列表。 取值范围： 不涉及。 |
| count | String | 参数解释： 对象总条数。 取值范围： 不涉及。 |
请求示例
查询集群的数据库列表。
GET https://{Endpoint}/v1/0536cdee2200d5912f7cc00b877980f1/clusters/a89aea88-7ea2-40bd-8ac8-8b93e169e5d6/db-manager/objects?type=DATABASE&database=&schema=&table=&name=&offset=0&limit=10 响应示例
状态码：200
查询成功。
{
"type" : "DATABASE",
"object_list" : [ {
"obj_name" : "gaussdb"
}, {
"obj_name" : "postgres"
} ],
"count" : 2
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功。 |
| 400 | 请求错误。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 404 | 找不到资源。 |
| 500 | 服务内部错误。 |
| 503 | 服务不可用。 |
