Quick BI CLI 命令参考手册

常见操作速查

# 看看有哪些工作空间
quickbi workspace list

# 查看空间下的报表
quickbi works list <workspaceId>

# 查看报表分享给了谁
quickbi share list <worksId>

# 查看数据集行级权限
quickbi row-permission switch-info -c <cubeId>

# 搜索用户
quickbi user list -k 张三

# 生成嵌入链接
quickbi embed create-ticket --works-id <id> --works-type PAGE

组织管理（47 个子命令）

权限管理（35 个子命令）

资源管理（27 个子命令）

嵌入分析（16 个子命令）

数据服务（5 个子命令）

统计与配置（4 个子命令）

workspace - 工作空间

工作空间是 Quick BI 中数据源、数据集、报表的组织单元。

# 列出工作空间
quickbi workspace list
quickbi workspace list -k "数据分析部"          # 按名称搜索
quickbi workspace list -u <userId>               # 查某个用户所属空间

# 创建 / 删除
quickbi workspace create -n "新空间" -d "描述"
quickbi workspace delete <workspaceId>

# 成员管理
quickbi workspace add-user <workspaceId> -m <userId> -r analyst
quickbi workspace remove-user <workspaceId> <userId>

空间角色（-r）：

• admin — 管理员，可管理成员和空间

• developer — 开发者，可创建和编辑报表

• analyst — 分析师，可查看和分析数据

• viewer — 查看者，仅可查看报表

user - 用户

管理组织内的用户成员。

# 查询
quickbi user list                     # 列出全部
quickbi user list -k 张三             # 按名称搜索
quickbi user get <userId>             # 查看详情
quickbi user exists <userId>          # 判断是否属于组织

# 创建（新员工入职）
quickbi user create \
  --account-name zhangsan \
  --account-type 3 \
  --nick-name 张三 \
  --user-type 3 \
  -r 111111113

# 更新 / 删除
quickbi user update <userId> [options]
quickbi user delete <userId>
quickbi user force-delete [options]   # 强制删除并转移资源

# 按账号查找
quickbi user query-by-account --account zhangsan --account-type 3
quickbi user query-by-mobile [options]

参数参考：

user-group - 用户组

用户组为树状结构，用于批量管理权限。报表分享和行级权限均可按用户组授权。

# 查看
quickbi user-group list               # 查看用户组树
quickbi user-group search [options]   # 关键字搜索
quickbi user-group get-by-ids [options]
quickbi user-group list-by-user [options]   # 查看用户属于哪些组

# 创建 / 更新 / 删除
quickbi user-group create --name "华东团队" --parent-id <parentId>
quickbi user-group update [options]
quickbi user-group delete <groupId>   # 仅叶子节点可删除

# 成员管理
quickbi user-group list-members <groupId>
quickbi user-group add-members <groupId> --user-ids uid1,uid2
quickbi user-group remove-member [options]
quickbi user-group add-to-groups --user-id <uid> --group-ids gid1,gid2

# 批量退出
quickbi user-group batch-withdraw [options]
quickbi user-group withdraw-all [options]

user-label - 用户标签

用户标签常配合行级权限 SIMPLE 模式使用，实现"不同用户看不同数据"。

# 标签管理
quickbi user-label list                         # 查看所有标签
quickbi user-label create --tag-name 地区 --tag-value 华东
quickbi user-label batch-create [options]
quickbi user-label update [options]
quickbi user-label delete <tagId>

# 用户标签值
quickbi user-label get-user-tags <userId>
quickbi user-label update-user-tags <userId> --tag-id <id> --tag-value 华东
quickbi user-label batch-update [options]

# 反查
quickbi user-label get-users --tag-id <id> --tag-value 华东

# 动态标签
quickbi user-label list-dynamic [options]
quickbi user-label clear-dynamic-cache [options]

与行级权限配合流程：

1. 创建标签（如"地区"）

2. 为用户设置标签值（如"华东"）

3. 在 row-permission set-rule 中使用 SIMPLE 模式，映射字段到标签

4. 用户查询数据时自动按标签值过滤

role - 角色

quickbi role org list                 # 查看所有组织角色
quickbi role org get <roleId>         # 角色详情
quickbi role org users <roleId>       # 角色下的用户

quickbi role workspace list -w <workspaceId>
quickbi role workspace get <roleId>
quickbi role workspace users <roleId>

row-permission - 行列权限

控制用户能看到哪些数据行（行级）和哪些字段（列级）。

# 查看权限状态
quickbi row-permission switch-info -c <cubeId>

# 开启 / 关闭
quickbi row-permission switch -c <cubeId> -t ROW_LEVEL --is-open 1
quickbi row-permission switch -c <cubeId> -t COLUMN_LEVEL --is-open 0

# 查看规则
quickbi row-permission list -c <cubeId> -t ROW_LEVEL

# 设置规则
quickbi row-permission set-rule \
  -c <cubeId> -t ROW_LEVEL \
  -m COMPLEX -s 2 \
  --users uid1,uid2 \
  --rule-content-type ROW_FIELD \
  --rule-content-json '<json>'

# 删除规则
quickbi row-permission delete-rule -c <cubeId> -r <ruleId>

# 规则人群增减
quickbi row-permission add-rule-users -c <cubeId> -r <ruleId> --users uid1,uid2
quickbi row-permission remove-rule-users -c <cubeId> -r <ruleId> --users uid1

# 未命中策略
quickbi row-permission set-extra -c <cubeId> -t ROW_LEVEL -p NONE

# 白名单（绕过所有规则）
quickbi row-permission whitelist-list -c <cubeId> -t ROW_LEVEL
quickbi row-permission whitelist-save -c <cubeId> -t ROW_LEVEL --users uid1,uid2
quickbi row-permission whitelist-modify -c <cubeId> -t ROW_LEVEL \
  -o ADD --target-type USER --target-ids uid3

# 列级字段授权
quickbi row-permission column-authorize \
  -u <userId> -c <cubeId> --column-ids col1,col2 --auth-type 2
  

参数参考：

share - 分享授权

管理报表的分享与协同授权。

# 查看分享情况
quickbi share list <worksId>                    # 作品的分享记录
quickbi share list-by-user <userId>             # 用户被分享的所有作品
quickbi share list-auth \
  --resource-id <id> --works-type dashboard \
  --share-to-type 0 --has-auth true             # 协同授权记录

# 添加分享
quickbi share add <worksId> \
  --share-to <userId> --share-to-type 0 \
  --expire-date 2026-12-31 --auth-point 1

# 协同授权
quickbi share authorize \
  --resource-type dashboard --resource-id <id> \
  --authorized-id <userId> --authorize-scope 0 --auth-points 1

# 修改授权属性
quickbi share set-attributes \
  --resource-type dashboard --resource-id <id> \
  --use-permission-type 2

# 取消 / 删除
quickbi share cancel --report-id <id> --share-to-ids uid1,uid2 --share-to-type 0
quickbi share delete <shareId>
quickbi share unauthorize --resource-type dashboard --resource-id <id> --user-id <uid>

参数参考：

portal - 门户授权

管理数据门户的菜单授权与可见性。

# 查看
quickbi portal list-menus <portalId>            # 菜单列表
quickbi portal list-permissions <portalId>      # 各菜单授权详情
quickbi portal list-whitelist [options]

# 单菜单授权
quickbi portal authorize-single <portalId> <menuId> [options]
quickbi portal authorize-menu <portalId> <menuId> [options]

# 批量授权 / 取消
quickbi portal batch-authorize \
  --dataportal-id <id> --menu-ids m1,m2 --user-ids u1,u2
quickbi portal batch-unauthorize \
  --dataportal-id <id> --menu-ids m1,m2 --user-ids u1,u2

# 取消单菜单授权
quickbi portal unauthorize-single <portalId> <menuId> [options]
quickbi portal unauthorize-menu <portalId> [options]

# 可见方式
quickbi portal set-visible [options]

菜单类型：0 仪表板, 1 外链, 2 电子表格, 4 目录, 5 填报, 6 自助取数

权限点：1 仅查看, 3 查看及导出

approval - 审批

对接外部审批系统，管理填报入库审批。

# 查看审批
quickbi approval list --user-id <uid> --status 0    # 待审批
quickbi approval list --user-id <uid> --status 1    # 已通过

# 审批回调
quickbi approval callback --application-id <id> --status 1 --reason "同意"

# 填报入库审批
quickbi approval config-receipt --works-id <id> --enable true --user-ids uid1,uid2
quickbi approval get-receipt [options]

审批状态：0 待审批, 1 已通过, 2 已拒绝

works - 作品

管理 QuickBI 报表作品（仪表板、电子表格、数据大屏等）。

# 查询作品
quickbi works list-org                                  # 组织下所有作品
quickbi works list-org --type PAGE --status 1           # 已发布的仪表板
quickbi works list <workspaceId>                        # 空间下作品
quickbi works get <worksId>                             # 作品详情
quickbi works list-authorized <userId>                  # 用户有权查看的作品

# 血缘与权限
quickbi works bloodline <worksId>                       # 作品关联的数据集
quickbi works check-readable --user-id <uid> --works-id <wid>

# 嵌入管理
quickbi works embed-config                              # 组织嵌入配额
quickbi works embed-status <worksId>                    # 是否已开通嵌入
quickbi works embed-update <worksId> --third-party 1    # 开通嵌入
quickbi works embed-list -k "销售"                      # 已嵌入报表列表

# 导出与下载记录
quickbi works offline-downloads <userId> --start-time "2026-01-01 00:00:00"
quickbi works export-records --user-id <uid> --start-time "2026-01-01 00:00:00"

# 性能监控
quickbi works component-performance --query-type sevenDays -w <wsId>
quickbi works report-performance --query-type sevenDays -w <wsId>

参数参考：

dataset - 数据集

数据集是报表的数据基础，基于数据源中的物理表创建。

# 查询
quickbi dataset list -w <workspaceId>
quickbi dataset list -w <workspaceId> -k "销售"    # 按名称搜索
quickbi dataset get <datasetId>                     # 详情

# 创建
quickbi dataset create \
  -w <workspaceId> --ds-id <datasourceId> \
  --table orders -n "订单数据集"

# 性能优化
quickbi dataset clear-cache --ids cube1,cube2       # 清除缓存
quickbi dataset accelerate <cubeId>                 # 触发抽取加速
quickbi dataset performance -w <wsId> --query-type sevenDays

性能指标字段：costTimeAvg（平均耗时ms）, queryCount（查询次数）, cacheQueryCount（缓存命中）, queryTimeoutCount（超时次数）

datasource - 数据源

quickbi datasource add [options]    # 新建数据源（MySQL/PostgreSQL/ODPS 等）

favorite - 收藏

quickbi favorite list <userId>
quickbi favorite add <userId> -w <worksId>
quickbi favorite remove -u <userId> -w <worksId>

homepage - 首页

quickbi homepage list-favorites -u <userId>         # 收藏列表
quickbi homepage list-shared -u <userId>            # 分享给我
quickbi homepage list-recent -u <userId> -m 1       # 常用（按访问次数）
quickbi homepage list-recent -u <userId> -m 2       # 最近足迹（按时间）

embed - 嵌入

管理三方嵌入票据，实现报表的免密/公开访问。

# 创建嵌入票据（自动返回嵌入链接）
quickbi embed create-ticket \
  --works-id <worksId> --works-type PAGE \
  --expire-time 1440 --ticket-num 240

# 票据管理
quickbi embed get-ticket <ticket>                   # 查看票据详情
quickbi embed delete-ticket <ticket>                # 删除票据
quickbi embed update-ticket-num <ticket> [options]  # 更新票据数量
quickbi embed delay-expire <ticket> --expire-time 1440  # 延长有效期

# 手动构建链接
quickbi embed build-url [options]

# Copilot（智能小Q）嵌入
quickbi embed create-copilot-ticket [options]
quickbi embed modify-copilot-config [options]
quickbi embed list-copilot-config [options]
quickbi embed list-data-range [options]

嵌入链接格式：https://<域名>/<路径>?<ID参数>=xxx&accessTicket=xxx

区块嵌入：在 URL 后追加 &cmptId=<组件ID>

smartq - 智能问数

管理智能问数（自然语言查询）的配置和授权。前置条件：已创建数据源和数据集。

quickbi smartq cubes [options]          # 查看问数数据集列表
quickbi smartq authorize [options]      # 管理问数授权

data-service - 数据服务

将数据集发布为 API 接口供外部系统调用。仅适用于独立部署用户。

quickbi data-service list                               # 查看 API 列表
quickbi data-service list -n "订单查询"                  # 按名称搜索
quickbi data-service query -s <sid>                      # 执行查询
quickbi data-service query -s <sid> -c '{"region":"华东"}'  # 带条件查询

subscription - 订阅

管理报表邮件订阅和推送任务。

quickbi subscription list                   # 查看订阅任务
quickbi subscription run -m <mailId>        # 手动触发
quickbi subscription status -m <mailId>     # 查看执行状态

任务状态：SENT 发送成功, FAILED 发送失败, PROCESSING 处理中

stats - 统计

# 查询审计日志
quickbi stats audit-log -t dataView --start-date 20260401 --end-date 20260403

日志类型（-t）：dataView 访问类, function 操作类, permission 权限类

config - 配置

管理 CLI 本地配置（凭证、端点等）。

quickbi config list                                 # 查看所有配置
quickbi config get endpoint                         # 查看单项
quickbi config set endpoint https://bi.example.com  # 设置

新员工入职

# 1. 创建用户
quickbi user create --account-name zhangsan --account-type 3 \
  --nick-name 张三 --user-type 3 -r 111111113

# 2. 加入工作空间
quickbi workspace add-user <workspaceId> -m <userId> -r analyst

# 3. 加入用户组
quickbi user-group add-members <groupId> --user-ids <userId>

员工离职权限回收

# 1. 查看被分享的作品
quickbi share list-by-user <userId>

# 2. 查看所属用户组
quickbi user-group list-by-user [options]

# 3. 退出所有用户组
quickbi user-group withdraw-all [options]

# 4. 从空间移除
quickbi workspace remove-user <workspaceId> <userId>

# 5. 删除用户
quickbi user delete <userId>

报表嵌入到第三方系统

# 1. 查找报表
quickbi works list <workspaceId> --type PAGE

# 2. 开通嵌入
quickbi works embed-update <worksId> --third-party 1

# 3. 创建票据（自动返回嵌入链接）
quickbi embed create-ticket --works-id <worksId> --works-type PAGE --expire-time 43200

数据集权限巡检

# 1. 查看空间下的数据集
quickbi dataset list -w <workspaceId>

# 2. 检查行级权限开关
quickbi row-permission switch-info -c <cubeId>

# 3. 查看权限规则
quickbi row-permission list -c <cubeId> -t ROW_LEVEL

# 4. 查看白名单
quickbi row-permission whitelist-list -c <cubeId> -t ROW_LEVEL