ai_member_xiaobian/.agents/skills/lark-base/references/lark-base-dashboard-block-get.md
2026-05-15 10:57:05 +08:00

1.7 KiB
Raw Blame History

base +dashboard-block-get

前置条件: 先阅读 lark-base-dashboard.md 了解整体工作流。

获取仪表盘中单个组件的详情(包含 data_config 完整配置。常用于1) 查看组件的完整配置2) 编辑组件前了解当前配置。

推荐命令

lark-cli base +dashboard-block-get \
  --base-token bascn***************CtadY \
  --dashboard-id blkxxx \
  --block-id chtxxxxxxxx

参数

参数 必填 说明
--base-token <token> Base Token
--dashboard-id <id> 仪表盘 ID
--block-id <id> Block ID
--user-id-type <type> 用户 ID 类型open_id / union_id / user_id
--format <fmt> 输出格式
--dry-run 预览 API 调用,不执行

返回示例

{
  "block": {
    "block_id": "chtxxxxxxxx",
    "name": "柱状图",
    "type": "column",
    "data_config": {
      "table_name": "电商交易明细",
      "series": [{"field_name": "营销费用", "rollup": "SUM"}],
      "group_by": [{"field_name": "品类", "mode": "integrated"}]
    },
    "layout": {"x": 0, "y": 0, "w": 6, "h": 4}
  }
}

返回重点

字段 说明
block.block_id 组件 ID
block.name 组件名称
block.type 组件类型(如 column/line/pie
block.data_config 数据配置(新建/编辑组件时可基于此字段修改)
block.layout 布局信息只读x/y/w/h 坐标和尺寸)

参考