获取数据库对象列表 | OceanBase 文档中心

获取数据库对象列表

更新时间：2023-08-10 11:45:58

功能说明

获取数据库对象列表。

调用说明

接口约束

调用者需要通过 OCP 应用服务鉴权。

调用者需要具备指定租户的读权限。

请求路径

GET /api/v2/ob/clusters/{id}/tenants/{tenantId}/objects

请求参数

path 参数

参数	类型	必选	示例值	描述
id	Integer	是	1	集群 ID
tenantId	Integer	是	5	租户 ID

返回结果

参数	类型	说明
data	Object	包含 contents。
├─ contents	Array	数据库对象的列表，数据库对象数据结构见下表。
successful	Boolean	请求是否成功。
timestamp	Datetime	服务端完成请求的时间戳。
duration	Integer	服务端处理请求的时间（毫秒）。
status	Integer	符合 HTTP Status 规范的编码。
traceId	String	请求的 Trace ID，用于排查问题。
server	String	响应请求的服务端的地址。

数据库对象的数据结构

参数	类型	说明
objectType	String	数据库对象类型，取值范围： * TABLE 表 * VIEW 视图 * STORED_PROCEDURE 存储过程
objectName	String	数据库对象名，即表名、视图名或存储过程名。
schemaName	String	schema 名，一般与用户名相同。

示例

请求示例

获取集群 1、租户 1000001 下的对象列表。

GET /api/v2/ob/clusters/1/tenants/2000001/objects?id=1&tenantId=2000001

返回示例

{
  "data": {
    "contents": [
      {
        "fullName": "U1.T1",
        "objectName": "T1",
        "objectType": "TABLE",
        "schemaName": "U1"
      },
      {
        "fullName": "U1.V1",
        "objectName": "V1",
        "objectType": "VIEW",
        "schemaName": "U1"
      },
      {
        "fullName": "U1.PL1",
        "objectName": "PL1",
        "objectType": "STORED_PROCEDURE",
        "schemaName": "U1"
      }
    ]
  },
  "duration": 260,
  "server": "a83ad33525",
  "status": 200,
  "successful": true,
  "timestamp": "2021-09-07T17:22:47.509+08:00",
  "traceId": "b876ed597798484f"
}