华为云用户手册

响应示例 状态码： 200 { "root_resource_id" : "0cc302c0-xxxxxxx-8bdf-0f726fb36eb4", "resource_type" : "screen", "resource_id" : "2befed28-xxxxx-83df-dbc88e47ee12", "workspace_id" : "b8cbb94cce8xxxxxxx7d8e5498af5dd" }

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式：可设置组件的字体类型。 基础图表样式 合并数据为其他：勾选“合并数据为其他”，矩形树图显示数据区块为设置合并后区块数量；不勾选显示数据区块为字段中“查询返回数限制”的数量。 合并区块数量：用户可自定义设置，设置数量不能少于2个数据区块。如果设置的合并数量大于矩形树“查询返回数限制”的数值，矩形树显示数据块数则按照“查询返回数限制”数量显示。 区 域名 称：用户可根据使用场景自定义设置。 标签 文本：可设置标签的字号、颜色、字体粗细。字号设置范围10~100。 占比：支持矩形树图占比色设置。设置占比小数位显示范围0~10。 度量：支持矩形树图设置度量显示与不显示。 数值设置：支持对数值的语境、单位、科学计数法、使用千分位分割符、小数位的设置。 提示信息 显示/隐藏提示信息：勾选表示预览或查看发布组件时显示的提示信息；不勾选表示预览或查看发布组件时不显示提示信息。 可设置提示信息的字号大小、颜色、字体粗细。字号范围10~100。 系列 配色方案：支持默认色、经典、舒适、智能、数据、艺术、SaaS规范的配色方案。 图2 配色方案 系列：支持对系列颜色的配置（纯色）。 图3 系列颜色配置 总计 显示/隐藏总计：单击“显示总计”左侧的勾选框，表示显示总计，表示不显示总计。 自定义名称：用户可根据使用场景自定义总计名称。 可设置总计名称、数值的字号大小、颜色、字体粗细。字号范围10~100。

样式 设置样式 表2 基础设置 参数 说明 卡片标题 卡片支持有和无标题的设置。设置卡片的标题，在卡片的左上角展示。 无标题：当未勾选框时，为无标题格式。 有标题：当勾选框时，为有标题格式。 文本 设置文本字体的大小和字体颜色。可通过输入修改字体大小也可通过和修改字体的大小。 说明： 输入不能为空，且输入值必须在14到32之间。 对齐方式 支持左对齐和居中对齐方式。 下边距 设置折线柱状图标题与图表之间的距离。可通过输入修改边距的大小也可通过和修改边距的大小。 说明： 输入不能为空，且输入值必须在0到32之间。 分割线 卡片支持无和有分割线的设置。 无分割线：当未勾选框时，为无分割线格式。 有分割线：当勾选框时，为有分割线格式。支持对分割线的样式和下框边距进行设置。分割线样式和下边框支持输入设置，也可通过和进行设置。 说明： 分割线样式的输入不能为空，且输入值必须在0到8之间。在设置样式之后才可以设置下边距，分割线的下边距输入不能为空，且输入值必须在0到32之间。 卡片背景 卡片背景支持有背景和无背景设置。 无背景：当未勾选框时，为无背景格式。 有背景：当勾选框时，为有背景格式。支持背景颜色的设置。 状态icon 可以设置icon的显示方式和颜色，支持始终显示和悬停显示。卡片icon支持有状态icon和无状态icon设置。 无背景：当未勾选框时，为无状态icon。 有背景：当勾选框时，为有状态icon。 表3 图表样式 参数 说明 显示图例 设置图示图例，不支持：当未勾选框时，为无法设置图示图例。支持：当勾选框时，支持设置图示图例。 文本 设置图例显示时的文本字体大小。 位置 设置图例显示时的显示位置，支持下方和上方设置。 色板 设置图例的色板，支持系统和自定义设置。 语境 设置数值内的语境，支持中文（简体）和English。 单位 设置数值的单位，支持设置为无、自动、百、千、万、亿、亿万。 科学计数法 设置是否支持数值的科学计数法。 使用千分位分割符 设置数值是否使用千分位分割符。 小数位 设置数值是否支持小数位展示。 表4 坐标轴 参数 说明 显示标题和单位 自定义是否显示标题和单位。支持设置轴标题、单位、位置、文本。 自动设置数值范围 通过设置最大值和最小值，控制图表的数据显示范围。 显示坐标轴 自定义是否显示坐标轴。支持设置坐标线的字体大小和颜色。 显示轴标签 自定义是否显示轴标签。支持设置轴标签的字体大小、颜色和显示格式。 显示网格线 自定义是否显示网格线。支持设置网格线的粗细和颜色。 显示刻度线 自定义是否显示网格线刻度线。 尺度类型 X轴支持序数类型，Y轴支持序数类型 缩略坐标轴标签 缩略X坐标轴标签。 表5 功能配置 功能配置 说明 缩略轴 设置是否开启缩略轴。 缩略轴背景数据 设置缩略轴背景数据显示。 空值处理 设置空值处理规则： 删除、智能删除、置零、空值断开。

操作步骤 在仪表板导航栏单击，新建折线柱状图模板。 在数据列选择数据集。 设置字段、样式、高级相关参数。 单击“更新”，系统自动更新图表。 图1 折线柱状图 单击右侧的“保存”或“保存并发布”，保存图表组成的仪表板。 单击右侧的“保存”，输入仪表板的名称，单击“确定”保存成功，不支持仪表板的查看功能，支持删除仪表板。 单击“保存并发布”，不仅保存了仪表板也发布了仪表板。支持仪表板查看功能，如果要删除仪表板需要先将仪表进行下线操作。 在弹出的仪表板页面输入仪表板名称。

字段 在“数据”标签页选择数据集，并将所需的“维度”、“度量”双击或拖拽至“字段”标签页。 表1 字段参数 参数 参数说明 字段显示内容 单击列内字段的，选择“字段显示内容”单击，在弹出页面对字段显示内容进行修改。单击“确定”完成对字段显示内容的修改。 聚合方式 选择“聚合方式”单击，支持设置无聚合、求和、计数、去重计数、最大值、最小值、平均值、总体标准差、样本标准差、样本方差、区间起始值、区间结束值。 钻取 支持对维度字段进行钻取功能的设置。如按照时间维度，可以从年份粒度下钻到季度/月份/周/天/小时/分钟/秒粒度查看数据情况。 单击列内字段，将要钻取的目标位置的字段拖拽至“钻取”内。 单击更新，测试钻取功能是否设置成功。 说明： 只支持维度字段下钻，不支持度量字段下钻。 只有一个字段可以作为下钻的起点。 钻取的是时间时，自动将它的细分时间置入下钻顺序列表，并将它们放进排序字段中（已在排序中的字段不再加入）。 已下钻的字段需高亮下钻图标，将维度中的钻取字段删掉，则整个钻取功能框都消失。

响应示例 状态码： 200 数据源详情。 { "id" : "xxxxxxx3796649a185b012a96xxxxxxx", "name" : "xxx_gaussdbtest", "host" : "xxx.xx.x.xx", "port" : 8000, "server_list" : "xxx.xx.x.xx:xxxx", "database_name" : "gaussdb", "user_name" : "modernbi", "test_url" : "jdbc:gaussdb://xxx.xx.xx.xx:xxxx/gaussdb?socketTimeout=120&loginTimeout=5&ssl=true", "project_id" : "xxxxxxxb4dac4055888643b33xxxxxxx", "domain_id" : "xxxxxxxf3c90428fb22606b64xxxxxxx", "work_space_id" : "xxxxxxxea0764ffa850664804xxxxxxx", "extra" : "[{\"ip\": \"xxx.xx.x.xx\", \"port\": xxxx, \"channelType\": \"eip\"}]", "config" : { "ssl" : true }, "type" : "DWS", "source" : "dws", "mode" : "multi-node", "default_schema" : "public", "creation_user" : "xxxxxa863a94b0ba2887b80dxxxxx", "creation_date" : 1700114987113, "creation_user_name" : "test_name", "update_user" : "xxxxxxxa863a94b0ba2887b80dcxxxxxxx", "update_user_name" : "test_name", "update_date" : 1701071948929 }

响应示例 状态码： 200 数据源列表详情。 { "count" : 100, "page_data" : [ { "id" : "xxxxxxx796649a185b012a96xxxxxxx", "name" : "test_name", "host" : "xxx.xx.x.xx", "port" : 80, "server_list" : "xxx.xx.x.xx:xxxx", "database_name" : "db_name", "user_name" : "test_name", "test_url" : "jdbc:gaussdb://xxx.xx.x.xx:xxxx/gaussdb?socketTimeout=120&loginTimeout=5&ssl=true", "project_id" : "xxxxxxxb4dac4055888643b331axxxxxxx", "domain_id" : "xxxxxxxcf3c90428fb22606b64dxxxxxxx", "work_space_id" : "xxxxxxxa5ea0764ffa850664804b9xxxxxxx", "extra" : "[{\"ip\": \"xxx.xx.x.xx\", \"port\": xxxx, \"channelType\": \"eip\"}]", "config" : { "ssl" : true }, "type" : "DWS", "source" : "dws", "mode" : "multi-node", "default_schema" : "public", "creation_user" : "xxxxxxx63a94b0ba2887b8xxxxxxx", "creation_date" : 1700114987113, "creation_user_name" : "ei_dlv_l00456193_01", "update_user" : "xxxxxxxa863a94b0ba2887b80dxxxxxxx", "update_user_name" : "name1", "update_date" : 1701071948929 } ] }

URI GET /v1/{project_id}/connections 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 all 否 Boolean 是否返回全部数据源列表。 limit 否 Integer 返回最大条数。 offset 否 Integer 偏移量。 name 否 String 数据源搜索值（按名称模糊匹配）。 type 否 String 参数解释： 数据源类型。 示例：MySQL，指定当前对接的数据源类型为MySQL，涉及查询时会使用MySQL驱动包。 约束限制： 不涉及 取值范围： 以下枚举值： MySQL； DWS： GaussDB (DWS)对应的数据源类型； PostgreSQL； OpenGauss：GaussDB对应的数据源类型； Doris； HIVE； ClickHouse； API：API数据对应数据源类型。 默认取值： 不涉及 sort_key 否 String 排序字段：支持name、creation_date、update_date。 sort_dir 否 String 排序类型：ASC、DESC。 枚举值： ASC DESC

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 参数解释： 工作空间ID。获取方法请参见获取工作空间ID。 约束限制： 不涉及 取值范围： 只能使用中英文字符，字符长度32位。 默认取值： 不涉及 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用 IAM 服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token 认证鉴权。 约束限制： 不涉及 取值范围： 非空。 默认取值： 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 ids 是 Array of strings 参数解释： 执行批量操作大屏ID列表。 约束限制： 不涉及 取值范围： 字符串列表，大小限制为1~1000。 默认取值： 不涉及

样式 本章节介绍环形进度条样式各配置项的含义。 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 进度条 内半径：设置内半径，输入不能为空，且输入值在0到100之间。 外半径：设置外半径，输入不能为空，且输入值在0到100之间。 背景色：设置进度条的背景色。 进度条颜色：设置进度条的颜色。 占比 显示/隐藏占比：单击“占比”左侧的勾选框，表示显示，表示隐藏。 小数位：设置小数位，输入不能为空，且输入值在0到10之间 占比文本：支持字体、数值颜色、数值字号、字体粗细的设置。 偏移：支持水平偏移和垂直偏移的设置。 值标签 显示/隐藏值标签：单击“显示值标签”左侧的勾选框，表示显示，表示隐藏。 当前值名称：设置当前值名称。 目标值名称：设置目标值名称。 对齐方式：支持设置为左右排列和上下排列。 排列方式：支持设置为顶部、右侧、内部、左侧、底部、左上角、左下角、右上角、右下角。 文本：支持对值标签的字体、颜色、字号、字体粗细的设置。 提示信息：设置是否显示提示信息。 动画 显示/隐藏动画：单击“动画”右侧的勾选框，表示开启图表的动画效果；表示预不开启图表的动画效果。 入场动画：组件第一次渲染动画的时长，单位为ms。 动画效果：动画的缓动效果，系统提供多种常见的动画缓动效果供您选择。 各系列依次动画：开启后，各系列依次动画显示。未开启时，所有的系列同时动画显示。 更新动画：组件数据更新时的动画时长，单位为ms。 是否从之前位置开始：开启后，组件数据更新时，从上一个数据的位置开始播放动画；关闭后，组件数据更新时，从初始位置开始播放动画。

响应示例 { "count" : 3, "page_data" : [ { "id" : "xxxxfdff-xxxb-xxxx-8f52-e15e35axxxxx", "name" : "COLUMN", "dataset_id" : "xxxxd682-e129-xxxx-ad8e-673f02xxxxxx", "is_open" : true, "permission_type" : "COLUMN", "rule_type" : "MASK", "rule_scope" : "ALL", "project_id" : "xxxx703a500dxxxxfb3c00f9fxxxxx", "workspace_Id" : "xxxx6703a50xxxxx2fb3c00f9fxxxxxx", "rule_user" : { "users" : [ ], "user_groups" : [ ] }, "rule_content" : { "last" : 1, "first" : 1, "mask_type" : "RETAIN_FIRST_N_LAST_M", "column_ids" : [ "xxxxe9d6-6xxx-4126-bxxx-36fcxxxxce54.amount" ], "special_words" : [ "xxx" ] }, "display_fields" : { "user_map" : { }, "group_map" : { }, "field_map" : { "xxxxe9d6-xxxe-4126-bd51-36fc0ee3ce54.amount" : "amount" } } }, { "id" : "xxxxda33-dace-xxxx-8xxx-c6dfaxxxxxf1", "name" : "USER_TAG", "dataset_id" : "xxxxxd13-cxxx-4xxx-b657-829axxxxx20e", "is_open" : true, "permission_type" : "ROW", "rule_type" : "BY_TAG", "rule_scope" : "ALL", "rule_user" : { "users" : [ ], "user_groups" : [ ] }, "rule_content" : { "condition_node" : null, "logic_operator" : "AND", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "xxxx3355-xxxx-4340-9b5d-0bd856xxxxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxxx722-b74c-4xxx-9630-43ca65xxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null }, { "condition_node" : { "value" : { "values" : [ "xxxxx355-4ffa-xxxx-9b5d-0bd856xxxxx" ], "value_type" : "TAG_USER_GROUP", "value_names" : [ "userGroup2" ] }, "column_id" : "xxxxx22-b74c-4752-xxx0-xxxx65d0d12c.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "" }, "logic_operator" : null } ] }, "display_fields" : null }, { "id" : " xxx14b04-ef3d-4ebc-a9ee-c651f563d67c", "name" : "测试", "dataset_id" : "xxxx4d13-c2a3-426f-b657-829addaxxxxx", "is_open" : true, "permission_type" : "ROW", "rule_type" : "BY_CONDITION", "rule_scope" : "SPECIFIED", "rule_user" : { "users" : [ "xxxxxxxed1b94534xxxxx3de304axxxx", "xxxx987b3dc4xxxx68b8dff1e7xxxxx", "774d5axxxxxb4950aabc8651308xxxxx" ], "user_groups" : [ ] }, "rule_content" : { "condition_node" : null, "logic_operator" : "AND", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "123" ], "value_type" : "CONDITION" }, "column_id" : "xxxx6722-b74c-4752-9xxx-43ca65d0d12xxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "CONTAIN" }, "logic_operator" : null }, { "condition_node" : null, "logic_operator" : "OR", "sub_conditions" : [ { "condition_node" : { "value" : { "values" : [ "qwe" ], "value_type" : "CONDITION" }, "column_id" : "xxxx722-b74c-4752-xxxx-43ca65dxxxxx.buyer_name", "is_measure" : false, "column_name" : "buyer_name", "relation_operator" : "CONTAIN" }, "logic_operator" : null } ] } ] }, "display_fields" : { "user_map" : { "xxxx987b3dc4xxxxxxb8dff1e73xxxx" : "auth_test", "xxxxxac55eeb4950axxxx6513080xxxx" : "chenxiantao", "xxxxx57ed1b9453xxxx943de304xxxxx" : "abac_test" }, "group_map" : { }, "field_map" : null } } ] }

URI GET /v1/{project_id}/datasets/{dataset_id}/permissions 表1 路径参数 参数 是否必选 参数类型 描述 dataset_id 是 String 数据集ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 permission_type 是 String 权限类别： ROW：行级权限；COLUMN：列级权限。 offset 是 Integer 偏移值。分页的偏移值，0代表不偏移，也就是第一页，1代表偏移1，指的第二页。 limit 是 Integer 返回列表数量。 sort_key 否 String 排序字段isOpen，是否开启行列权限。 sort_dir 否 String 排序类别：desc、asc。desc代表减序，asc代表升序。

样式 设置热力图样式参考表2、表3。 表2 基础设置 参数 说明 卡片标题 卡片支持有和无标题的设置。设置卡片的标题，在卡片的左上角展示。 无标题：当未勾选框时，为无标题格式。 有标题：当勾选框时，为有标题格式。 文本 设置文本字体的大小和字体颜色。可通过输入修改字体大小也可通过和修改字体的大小。 说明： 输入不能为空，且输入值必须在14到32之间。 对齐方式 支持左对齐和居中对齐方式。 下边距 设置热力图标题与图表之间的距离。可通过输入修改边距的大小也可通过和修改边距的大小。 说明： 输入不能为空，且输入值必须在0到32之间。 分割线 卡片支持无和有分割线的设置。 无分割线：当未勾选框时，为无分割线格式。 有分割线：当勾选框时，为有分割线格式。支持对分割线的样式和下框边距进行设置。分割线样式和下边框支持输入设置，也可通过和进行设置。 说明： 分割线样式的输入不能为空，且输入值必须在0到8之间。在设置样式之后才可以设置下边距，分割线的下边距输入不能为空，且输入值必须在0到32之间。 卡片背景 卡片背景支持有背景和无背景设置。 无背景：当未勾选框时，为无背景格式。 有背景：当勾选框时，为有背景格式。支持背景颜色的设置。 状态icon 可以设置icon的显示方式和颜色，支持始终显示和悬停显示。卡片icon支持有状态icon和无状态icon设置。 无背景：当未勾选框时，为无状态icon。 有背景：当勾选框时，为有状态icon。 表3 图表样式参数 参数 说明 分区规则 支持设置为连续型区间、等分区间、自定义区间，等分区间支持取整操作。 配色 设置热力图的配色。 透明度 设置热力图的透明度。 开启Tooltip 当勾选框时，鼠标箭头移动到热力图上显示Tooltip，不勾则不显示Tooltip。 背景颜色用户自定义。 维度文本/指标文本/数值文本大小、颜色用户自定义。 显示图例 支持对显示图例的文本和位置设置，文本支持对字体大小和颜色的设置，位置支持下方和上方设置。 表4 坐标轴 轴类别 参数 说明 X轴 显示标题和单位 设置是否显示X轴的轴标题单位。 当未勾选框时，为不显示X轴的标题和单位。 当勾选框时，支持对X轴的标题、文本，轴标题自动获取或自定义输入，单位可自定义输入，文本支持设置字体大小和颜色。 显示坐标轴 设置是否显示坐标轴。 当未勾选框时，为不显示X轴的坐标轴。 当勾选框时，支持对X轴坐标线的字体大小和颜色设置。 显示轴标签 设置是否显示X轴的轴标签。 当未勾选框时，为不显示X轴的轴标签。 当勾选框时，支持对X轴的轴标签的文本字体大小和颜色设置，也可设置X轴标签的角度。 显示网格线 设置是否显示X轴的网格线。 当未勾选框时，为不显示X轴的网格线。 当勾选框时，支持设置X轴的网格线的分格数和颜色。 显示刻度线 设置是否显示刻度线。 当未勾选框时，为不显示刻度线。 当勾选框时，显示刻度线。 缩略坐标轴标签 缩略X坐标轴标签。 Y轴 显示标题和单位 设置是否显示Y轴的轴标题单位。 当未勾选框时，为不显示Y轴的标题和单位。 当勾选框时，支持对Y轴的标题、位置、文本，轴标题自动获取或自定义输入，轴标题的位置可设置为轴上方或轴左侧，单位可自定义输入，文本支持设置字体大小和颜色。 显示坐标轴 设置是否显示坐标轴。 当未勾选框时，为不显示Y轴的坐标轴。 当勾选框时，支持对Y轴坐标线的字体大小和颜色设置。 显示轴标签 设置是否显示Y轴的轴标签。 当未勾选框时，为不显示Y轴的轴标签。 当勾选框时，支持对Y轴的轴标签的文本字体大小和颜色设置。 显示网格线 设置是否显示Y轴的网格线。 当未勾选框时，为不显示Y轴的网格线。 当勾选框时，支持设置Y轴的网格线的分格数和颜色。 显示刻度线 设置是否显示刻度线。 当未勾选框时，为不显示刻度线。 当勾选框时，显示刻度线。 缩略坐标轴标签 缩略Y坐标轴标签。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 参数解释： 工作空间ID。获取方法请参见获取工作空间ID。 约束限制： 不涉及 取值范围： 只能使用中英文字符，字符长度32位。 默认取值： 不涉及 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token 认证鉴权 约束限制： 不涉及 取值范围： 非空 默认取值： 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 参数解释： 大屏主键。 约束限制： 不涉及 取值范围： 只能使用中英文字符，字符长度32位。 默认取值： 不涉及 name 是 String 参数解释： 大屏名称。 约束限制： 不涉及 取值范围： 只允许输入长度为1到32位由数字、中文、英文、空格、下划线（_）或中划线（-）组成的字符，且开头和结尾不能有空格。 默认取值： 不涉及

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 大屏ID。 name String 大屏名称。 pages Array of ScreenPageOpenApiVO objects 大屏Page列表。 表5 ScreenPageOpenApiVO 参数 参数类型 描述 id String Page ID。 name String Page名称。 nodes Array of ScreenNodeOpenApiVO objects Page内组件列表。 表6 ScreenNodeOpenApiVO 参数 参数类型 描述 id String 组件ID。 name String 组件名称。 type String 组件类型。 hidden Boolean 组件是否隐藏。 target_nodes Array of target_nodes objects 交互事件关联组件。 表7 target_nodes 参数 参数类型 描述 id String 关联组件ID。 field_id String 关联组件字段ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 连接实例ID。 create_date Long 连接实例创建时间戳。 create_user String 创建者ID。 create_user_name String 创建者名称。 update_date Integer 连接实例更新时间戳。 update_user String 更新者ID。 update_user_name String 更新者名称。 project_id String 项目ID。 domain_id String 用户domainID。 ds_type String 参数解释： 数据源类型。 示例：MySQL，指定当前对接的数据源类型为MySQL，涉及查询时会使用MySQL驱动包。 约束限制： 不涉及 取值范围： 以下枚举值： MySQL； DWS：GaussDB(DWS)对应的数据源类型； PostgreSQL； OpenGauss：GaussDB对应的数据源类型； Doris； HIVE； ClickHouse； API：API数据对应数据源类型。 默认取值： 不涉及 vpc_ep_server_id String 终端节点服务ID。 vpc_ep_server_name String 终端节点服务名称。 vpc_ep_client_id String 终端节点ID。 vpc_ep_client_status String 终端节点状态。 accepted：已接受 pendingAcceptance：待审批 scene String 网络场景。 dii-app_to_data-source：DataArtsInsight至数据源vpcep通道场景。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 ds_type 是 String 参数解释： 数据源类型。 示例：MySQL，指定当前对接的数据源类型为MySQL，涉及查询时会使用MySQL驱动包。 约束限制： 不涉及 取值范围： 以下枚举值： MySQL； DWS：GaussDB(DWS)对应的数据源类型； PostgreSQL； OpenGauss：GaussDB对应的数据源类型； Doris； HIVE； ClickHouse； API：API数据对应数据源类型。 默认取值： 不涉及 vpc_ep_server_name 否 String 终端节点服务名称。终端节点服务ID为空时必填。 vpc_ep_server_id 否 String 终端节点服务ID。终端节点服务名称为空时必填。

响应示例 状态码： 200 验证成功结果。 { "create_date" : 1714962072863, "create_user" : "xxxxx", "create_user_name" : "xxxx", "update_date" : 1714962072863, "update_user" : "xxxx", "update_user_name" : "xxxx", "id" : "8a8080c08xxxxxf4bb485240001", "project_id" : "9c3043axxxx88643b3xxxxxx27", "domain_id" : "d22f8axxx428fb2260xxxxx823", "ds_type" : "DWS", "vpc_ep_server_id" : "xxxxx-31cf-4e27-xxxxx-4b71db9b82fb", "vpc_ep_server_name" : "cn-xxxx-x.DII-xxxx-LB.716b4ee7-xxxx-4e27-852e-xxxxxxx", "vpc_ep_client_id" : "xxxxxx-62be-4479-xxxxx-7379d6dafc40", "vpc_ep_client_status" : "accepted", "scene" : "dii-app_to_data-source" }

样式 本章节介绍线状图样式各项配置的含义。 表3 尺寸位置 参数 说明 W 设置图表的宽，单位为px。 H 设置图表的高，单位为px。 X 设置图表在画布中的位置，单位为px。 Y 设置图表在画布中的位置，单位为px。 不透明度 设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 表4 全局样式和折线样式 参数 说明 字体 设置图表中文字的字体。 平滑曲线 平滑曲线值范围0~1。 表5 边距 参数 说明 顶部 设置图表与图层顶部的间距，可以通过输入数值或单击“-”或“+”调节。 底部 设置图表与图层底部的间距，可以通过输入数值或单击“-”或“+”调节。 左侧 设置图表与图层左侧的间距，可以通过输入数值或单击“-”或“+”调节。 右侧 设置图表与图层右侧的间距，可以通过输入数值或单击“-”或“+”调节。 表6 X轴和Y轴 类别 参数 说明 X轴 显示/隐藏x轴 单击“显示x轴”侧的勾选框，表示显示x轴，表示隐藏x轴。 文本 设置x轴的文本样式，包括字号、字体颜色、字体粗细、角度等参数。 数据类型：坐标轴对应的字段的数据类型，可以选择数值型、类目型、时间型。 分割数：当“数据类型”为“数值型”或“时间型”时，显示标签的数量会根据设置的“分割数”做自适应显示。当“数据类型”配置为其他值时，该配置项不生效。 轴线颜色：设置x轴的颜色。 缩放 设置X轴的缩放比例。结束值的取值范围依赖于开始值。 显示/隐藏网格线 单击“网格线”右侧的勾选框，表示显示网格线，表示隐藏网格线。设置网格线的线条格式，其中包含实线、虚线、点划线，网格线的颜色也可配置。 Y轴 显示/隐藏y轴 单击“显示y轴”左侧的勾选框，表示显示y轴，表示隐藏y轴。 文本 设置y轴的文本样式，包括字号、字体颜色、字体粗细、角度。 轴标签 设置y轴的标签，支持对显示格式、最小值、最大值、分割数设置。 显示格式支持设置自动、取整、保留一位小数、保留两位小数、保留三位小数、保留四位小数、保留五位小数。 最小值支持自动取整和数据最小值。 最大值支持自动取整和数据最大值。 分割数输入值不能小于1。 轴单位 设置y轴的单位和颜色。 网格线 显示/隐藏网格线：单击“网格线”右侧的勾选框，表示显示网格线，表示隐藏网格线。 线条格式：设置网格线的线条格式，其中包含实线、虚线、点划线，网格线的颜色也支持配置。 表7 图例 参数 说明 显示/隐藏图例 单击“显示图例”左侧的勾选框，表示显示图例，表示隐藏图例。 文本 设置图例的文本样式，包括字号、字体颜色、字体粗细。 布局 设置图例的位置，支持顶部居中、顶部居左、顶部居右、底部居中、底部居左、底部居右。 表8 提示信息 参数 说明 显示/隐藏提示信息 勾选表示预览或查看发布组件时显示的提示信息；不勾选表示预览或查看发布组件时不显示提示信息。 触发类型 设置提示信息的触发类型，可以选择坐标轴或数据项。 颜色 设置提示信息的字体颜色。 字号 设置提示信息的字号大小。 字体粗细 设置提示信息的字体粗细样式。 表9 动画 参数 说明 显示/隐藏动画 单击“显示动画”左侧的勾选框，表示开启图表的动画效果；表示预不开启图表的动画效果。 入场动画 组件第一次渲染动画的时长，单位为ms。 说明： 入场动画输入值不能为0，默认值是1000ms。 动画效果 动画的缓动效果，系统提供多种常见的动画缓动效果供您选择。 各系列依次动画 开启后，各系列依次动画显示。未开启时，所有的系列同时动画显示。 更新动画 组件数据更新时的动画时长，单位为ms。 是否从之前位置开始 开启后，组件数据更新时，从上一个数据的位置开始播放动画；关闭后，组件数据更新时，从初始位置开始播放动画。 表10 数值设置和系列 参数 说明 数值设置 支持对数值的语境、单位、科学计数法、使用千分位分割符、小数位的设置。 系列 配色方案：支持默认色、经典、舒适、智能、数据、艺术、SaaS规范的配色方案。 系列：支持对系列颜色的配置（纯色和渐变色）。渐变色可设置起点、终点颜色，起点终点颜色也可互换。

样式 设置漏斗图样式参考表2、表3。 表2 基础设置 参数 说明 卡片标题 自定义是否显示卡片标题 ，勾选后在图表左上角显示。 文本 设置文本大小和颜色，单击选择文本颜色。 对齐方式 设置对齐方式，支持左对齐和居中对齐。 下边距 设置卡片标题与图表之间的距离。 分割线 自定义是否显示分割线。支持设置分割线样式的大小和颜色、下边距大小。 卡片背景 自定义是否显示卡片背景。单击选择卡片背景颜色。 状态icon 自定义是否显示状态icon。支持设置icon的显示方式和颜色，显示方式包括始终显示和悬停显示。 表3 图表样式 参数 说明 可视化样式 设置漏斗图的配色，支持系统配色和自定义配色。设置漏斗图的布局、位置和内边距。 范围 设置漏斗图的数值范围和宽度占比。 数值设置 设置语境、单位、数值表现形式。 设置图例的文本大小、方向和位置。 设置类别标签的位置和文本大小。 设置数据标签的内容、转化率的计算方式、文本大小。 开启Tooltip提示 支持设置Tooltip的内容、背景色、维度文本、指标文本、数值。开启后，鼠标移动至图表时，会显示提示信息。 表4 系列设置 参数 说明 请选择系列 选择系列。 别名 设置所选系列的别名。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id String 仪表板ID。 name String 仪表板名称。 create_user_name String 创建者。 create_date Long 创建时间。 update_user_name String 更新者。 update_date Long 更新时间戳。 status Integer 仪表板状态： 0：未发布。 1：已发布。 2：已下线。 枚举值： 0 1 2

响应示例 状态码： 200 创建仪表板成功。 { "id" : "009b3d3e-xxxx-4cc3-xxxx-dc54cd42424d", "name" : "新仪表板", "create_user_name" : "xxxx", "create_date" : 1706062051243, "update_user_name" : "xxxx", "update_date" : 1706062051243, "status" : 0 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 仪表板名称。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 数据条数。 page_data Array of UserTagVo objects 数据。 表5 UserTagVo 参数 参数类型 描述 tag_description String tagDescription tag_id String tagId tag_name String tagName tag_type String 参数解释： 标签类型，分为用户标签及用户组标签。 约束限制： 不涉及 取值范围： 以下枚举值： user：用户类型标签； userGroup：用户组类型标签。 默认取值： 不涉及

URI GET /v1/{project_id}/tags/head 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String project_id 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 参数解释： 标签类型，分为用户标签及用户组标签。 约束限制： 不涉及 取值范围： 以下枚举值： user：用户类型标签； userGroup：用户组类型标签。 默认取值： 不涉及 offset 否 Integer 返回条目的起始offset，默认值0。 limit 否 Integer 返回条目数，默认值10。

样式 表2 尺寸位置 参数 说明 W 设置图表的宽，单位为px。 H 设置图表的高，单位为px。 X 设置图表在画布中的位置，单位为px。 Y 设置图表在画布中的位置，单位为px。 不透明度 设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 表3 全局样式 参数 说明 表格布局 可以调整表格的比例，包含自动调整、按比例分配两种类型。 分页展示 支持设置表格行数、字体类型、字体颜色、字体大小、字体粗细等配置项。 筛选 勾选筛选，表头出现，可以对数据进行筛选。 排序 对数据进行排序： 使用维度排序：拖拽维度字段进排序槽位，自动将维度字段添加到维度槽位并在图表中显示。 使用度量排序：图表中默认不显示排序槽位中的度量字段，如需显示，请再次拖动度量字段到度量槽位。 导出 勾选后表格上方出现“导出表格”、“导出记录”按钮，支持将大屏中的表格导出至本地。 导出表格：单击“导出表格”后，输入任务名称和存储期限，创建导出表格任务。 导出记录：创建的导出任务在导出记录中查看，单击“下载”即可导出表格至本地。 说明： 不支持导出表格时，“导出表格”、“导出记录”按钮置灰。 管理员、开发者和分析师拥有使用这一功能的权限，而只读用户则无法进行表格导出。 经过脱敏处理的数据不支持导出，数据脱敏设置请参见脱敏规则。 分享协作时，被分享的成员需具备大屏导出权限才能使用该功能，如何授予导出权限请参见分享大屏。 支持导出全量数据，不受表格展示条数限制的影响，条数限制设置请参见查询返回数限制。 存储期限可以通过导入导出设置中的最大保存期限自定义，具体设置请参见OBS桶设置。 边框线 设置表格边框的粗细和颜色。 表4 表头 参数 说明 显示/隐藏表头 单击“表头”右侧的勾选框，表示显示表头，表示隐藏表头。 表头行高 输入数值，设置表头行高。 背景色 单击颜色编辑器设置表头的背景色。 对齐方式 单击下拉选项设置表头文本的对齐方式，可选择为水平居中、左侧、右侧。 文本 设置字体类型、字体颜色、字号、字体粗细。 表头展示分组 可设置表格展示多行表头，组合上限为50。 添加分组：勾选表头展示分组，单击“”，进入编辑表头分组页面，单击添加分组左边+，添加分组。 分组命名：单击分组右边，给分组命名。 设置分组内容：鼠标按住列往分组中拖拽。 删除分组：单击分组右边，删除分组，分组内的列不会被删除。 显示/隐藏表头分组：单击“表头”右侧的勾选框，表示显示表头分组，表示隐藏表头分组。 改变分组顺序：在表头分组页面拖拽分组可改变分组顺序。 表5 行配置 参数 说明 行高 设置行高，输入值不能小于45。 奇行背景色 单击颜色编辑器设置奇行表格的背景色。 偶行背景色 单击颜色编辑器设置偶行表格的背景色。 选中背景颜色 选中联动字段所在行的颜色，可自定义颜色。 对齐方式 行配置对齐方式类型有水平居中左侧右侧。 自动换行 设置是否自动换行，设置后单元格内容超出单元格宽度时，会自动换行显示内容。 文本 设置行的字体、字体颜色、字号、字体类型。 行分割线 设置行分割线样式、粗细、颜色。 表6 系列设置 参数 说明 请选择系列 支持表格的表头和列内容独立对齐方式配置，根据需求选择系列。 自动对齐方式 勾选此选项，表头对齐、内容对齐才可以设置。 表头对齐 设置表头对齐方式。对齐方式：自动、左对齐、居中、右对齐。 内容对齐 设置内容对齐方式。对齐方式：自动、左对齐、居中、右对齐。 表7 条件格式 参数 参数描述 条件格式 请选择系列：配置字段根据图表展示的字段选择。 快捷样式。 指在已经有的样式里面选择快捷图标。 颜色翻转：打开颜色翻转，快捷图标颜色对换，关闭颜色翻转，快捷图标颜色恢复。 自定义样式： 文本 条件选择：有与固定值比较和与动态值比较两种方式。 配置筛选条件种类：包含大于号、大于等于号、等号、小于等于号、小于号、不等号、大于A小于等于B、大于等于A小于B、大于A小于B、大于等于A小于等于B，固定对比值自定义，动态字段比值根据系统选择。 颜色场景：设置好筛选条件后，单击颜色按钮，自定义颜色。 添加规则：单击“+”，增加筛选条件。 删除：单击“-”，删除筛选条件。 图标 条件选择：有与固定值比较和与动态值比较两种方式。 图标样式：预选图标，如果不满足可以在筛选条件后面单独设置。 配置筛选条件种类：包含大于号、大于等于号、等号、小于等于号、小于号、不等号、大于A小于等于B、大于等于A小于B、大于A小于B、大于等于A小于等于B，固定对比值自定义，动态字段比值根据系统选择。 添加规则：单击“+”，增加筛选条件。 删除：单击“-”，删除筛选条件。

响应示例 状态码： 200 OK。 { "auth_switch_config" : "{"read": true, "edit": true, "export": true}", "create_date" : 1688022840899, "create_user" : "de9cb4xxxxa94b0ba2887b80xxxxxxxx", "create_user_name" : "***_01", "id" : "78215911-xxxx-478b-xxxx-9cb7f0407598", "owner" : "dxxxxa863a94xxxa2887b80xxxxxxxx", "project_id" : "xxx3ab4dac40558886xxxxx1a0b227", "resource_id" : "d0xxx19c-4e87-46xx-bxx2-da82bfxxxx4e", "resource_type" : "dashboard", "update_date" : 1688023886860, "update_user" : "de9cb4a863a94b0ba2887b80xxxxxxxx", "update_user_name" : "ei_dlv_***_01", "workspace_id" : "6xxxx96809adxxxxxa09e6bxxxx2146" }

交互组件类型说明 表1 交互组件 类型 说明 数据要素 全屏 通过单击控制大屏的全屏功能。 无。 iFrame 在大屏中添加iFrame内容。 链接。 搜索 在大屏中添加搜索框。 控件变量。 单选下拉 下拉菜单中进行选择，用于数据选项较多的场景。 选项/维度、控件变量。 Tab列表 通过添加Tab控件，您可以在大屏中以标签页的形式展示多个大屏。 控件变量。 多选下拉框 下拉菜单中进行选择，用于数据选项较多的场景。 选项/维度、控件变量。

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全屏 全局样式 全屏显示：支持通过url和本地上传图片。 退出全屏：支持通过url和本地上传图片。 背景色：设置全屏功能的背景色。 圆角：设置全屏的圆角。 显示方式：支持总是和鼠标上移。 搜索 样式 提示信息：支持对文本、字体大小、颜色的设置。 字号：支持设置搜索的字号。 字体粗细：支持设置搜索字体的粗细。 字体颜色：支持设置搜索字体的颜色。 背景色：支持设置搜索的背景色。 搜按钮颜色：支持设置搜索按钮的颜色。 边框：支持设置边框的宽度、颜色、边框类型。边框类型支持实线、虚线、点划线。 单选下拉 样式 背景色：设置单选下拉的背景颜色。 边框：支持对边框的宽度、圆角、颜色、类型的设置。 箭头：支持对箭头的颜色、大小、右边距的设置。 字体样式：支持对字体的字号、字体粗细、字体颜色、卡片圆角度、背景色的设置。 结果框样式 最大高度：设置单选下拉的最大高度。 字体大小：设置单选下拉的字体大小。 字体粗细：设置单选下拉的字体的粗细。 字体颜色：设置单选下拉的字体颜色。 选项悬浮颜色:支持设置单选下拉的选项悬浮色。 选项选中颜色：支持设置单选下拉的选项选中的颜色。 背景色：支持设置单选下拉的背景色。 选择配置：勾选“允许取消选择”，单选下拉允许取消选择，且提示文本可设置；未勾选“允许取消选择”，单选下拉不允许取消选择，提示文本不可设置。 如果没有设置初始值、未勾选选择配置，则默认填入绑定字段的第一行数据；如果绑定的数据集无数据的情况下，单击下拉框展示“暂无数据”。 初始值设置：支持单选下拉设置初始值，设置方式有固定和动态获取。 固定：当初始化值方式为固定时，可设置单选下拉组件的初始字段。 不填写初始字段、允许取消选择，则为不设置默认值。 不填写初始字段、不允许取消选择，则默认填入绑定字段的第一行数据。 动态获取：当初始化值方式为动态获取时，可设置单选下拉组件的字段索引。 填入索引值将用于动态获取初始值。填入0则默认选中第一行数据。索引值超出数据范围则取最后一行数据。 不允许输入负数。 多选下拉框样式 样式 背景色：设置多选下拉的背景颜色。 边框：支持对边框的宽度、圆角、颜色、类型的设置。 箭头：支持对箭头的颜色、大小、右边距的设置。 卡片样式：支持对字体的字号、字体粗细、字体颜色、卡片圆角度、背景色的设置。 结果框样式 最大高度：设置多选下拉的最大高度。 初始值设置 初始化值：支持多选下拉框设置初始值，设置方式有固定和动态获取。 固定：当初始化值方式为固定时，可设置单选下拉组件的初始字段，多个字段之间用分号。 动态获取：当初始化值方式为动态获取时，可设置多选下拉组件的字段索引，多个索引之间用分号。 填入索引值将用于动态获取初始值，填入0则默认选中第一行数据。索引值超出数据范围则取最后一行数据。 索引值去重：如果填入两个重复的索引值，则以单个索引值为初始化值；填入多个索引值，超出实际数据范围，根据索引值规则，显示数据围内的字段。 提示文本：设置下拉选项的提示文本。 文本大小：用户可自定义设置。 Tab列表样式 全局样式 字体：设置Tab列表的字体。 行数：设置Tab列表的行数时，输入值不能小于1。 边框宽度：设置Tab列表的宽度，输入值不能小于0。 选择类型：设置Tab列表的类型，支持单选多选的设置。 Tab配置：可对tab的内容以及值进行设置。 标签配置： 字号：字号设置范围10~100之间。 字体颜色：用户自定义标签颜色。 字体粗细：字体粗细类型Normal、Bold、Bolder、Lighter。 背景颜色：标签列表的背景颜色可自定义设置。 圆角半径：标签的圆角半径可设置，取值范围0~50。 选中文字/背景/悬浮边框颜色：用户可自定义设置颜色。 单轮轮播： 轮播开关：支持设置轮播开关设置。 轮播间隔：轮播间隔用户可设置，取值范围不能小于3000。

请求示例 保存或修改资源分享协作属性值。 POST https://{endpoint}/v1/xxxxx3ab4dac4055888643b331xxxxx/authorization/cooperate-authorization/properties { "auth_switch_config" : "{"read": true, "edit": true, "export": true}", "resource_id" : "d0d7919c-xxxx-462e-xxxx-da82bf8be44e", "resource_type" : "dashboard" }