获取数据库

适用场景

当你想读取数据库对象本身、标题、描述和属性 schema 时，使用这个接口。它适合在执行数据库查询或构建字段映射前先做一次 schema 对齐。

接口信息

权限要求

需要 databases.read。

请求参数

响应结果

{
  "object": "database",
  "id": "66666666-6666-4666-8666-666666666666",
  "title": [
    {
      "type": "text",
      "text": {
        "content": "任务看板",
        "link": null
      },
      "plain_text": "任务看板",
      "href": null
    }
  ],
  "properties": {
    "Name": {
      "id": "title",
      "type": "title",
      "name": "Name"
    }
  }
}

行为说明

• properties 描述的是数据库 schema，不是某一行页面记录的属性值。
• 你可以把它理解成字段定义、选项和约束的集合。
• 如果要读取每条记录，请继续使用数据库查询接口。

错误提示

• 400 validation_error：目标对象不是数据库。
• 401 unauthorized：token 无效或已过期。
• 403 forbidden：缺少 databases.read 或无权访问该数据库。
• 404 not_found：数据库不存在。

相关文档

前置阅读

• 认证与权限

下一步

• 查询数据库
• 更新数据库

相关参考

• 对象模型
• 页面属性模型