华为云用户手册

样式 本章节介绍台阶图样式各项配置项的含义。 表3 尺寸位置 参数 说明 W 设置图表的宽，单位为px。 H 设置图表的高，单位为px。 X 设置图表在画布中的位置，单位为px。 Y 设置图表在画布中的位置，单位为px。 不透明度 设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 表4 全局样式 参数 说明 字体 设置图表中文字的字体。 数据点位置 设置台阶图数据点位置，支持设置为起点、中点、终点。 表5 柱子样式 参数 说明 柱子宽度 设置柱子宽度，可以通过输入数值或单击“-”或“+”调节。输入值不能为空，输入值必须在1到100之间。 柱子圆角度 设置柱子圆角度，可以通过输入数值或单击“-”或“+”调节。输入值不能为空，输入值必须在0到100之间。 系列间距 设置系列间距，可以通过输入数值或单击“-”或“+”调节。输入值不能为空，输入值必须在-100到100之间。 表6 边距 参数 说明 顶部 设置图表与图层顶部的间距，可以通过输入数值或单击“-”或“+”调节。 底部 设置图表与图层底部的间距，可以通过输入数值或单击“-”或“+”调节。 左侧 设置图表与图层左侧的间距，可以通过输入数值或单击“-”或“+”调节。 右侧 设置图表与图层右侧的间距，可以通过输入数值或单击“-”或“+”调节。 表7 X轴和Y轴 类别 参数 说明 X轴 显示/隐藏x轴 单击“显示x轴”侧的勾选框，表示显示x轴，表示隐藏x轴。 文本 设置x轴的文本样式，包括字号、字体颜色、字体粗细。 坐标轴 设置x轴的颜色。 显示/隐藏网格线 单击“网格线”右侧的勾选框，表示显示网格线，表示隐藏网格线。 Y轴 显示/隐藏y轴 单击“显示y轴”左侧的勾选框，表示显示y轴，表示隐藏y轴。 文本 设置y轴的文本样式，包括字号、字体颜色、字体粗细、角度。 坐标轴 设置y轴轴线的颜色。 网格线 显示/隐藏网格线：单击“网格线”右侧的勾选框，表示显示网格线，表示隐藏网格线。 颜色：设置网格线的颜色。

样式 设置仪表盘样式参考表2、表3。 表2 基础设置 参数 说明 卡片标题 自定义是否显示卡片标题 ，勾选后在图表左上角显示。 文本 设置文本大小和颜色，单击选择文本颜色。 对齐方式 设置对齐方式，支持左对齐和居中对齐。 下边距 设置卡片标题与图表之间的距离。 分割线 自定义是否显示分割线。支持设置分割线样式的大小和颜色、下边距大小。 卡片背景 自定义是否显示卡片背景。单击选择卡片背景颜色。 状态icon 自定义是否显示状态icon。支持设置icon的显示方式和颜色，显示方式包括始终显示和悬停显示。 表3 图表样式 参数 说明 可视化样式 支持对坐标轴的坐标线和颜色的设置。 数值设置 支持对轴标签的文本和文本颜色的设置。 数据标签 支持对网格线的粗细和颜色设置。 测量轴色彩配置 支持对尺度类型设置，有线性和对数两种功能。 刻度分区 设置仪表盘的刻度分区。 起点 起点支持设置为固定值或动态值。 终点 终点支持设置为固定值或动态值 表4 坐标轴 参数 说明 轴标签 支持对轴标签的文本字体大小进行设置。 表5 系列设置 参数 说明 选择度量 根据字段里面选择的度量选择。 语境 对系列的语境进行设置，支持中文（简体）和English 单位 单位支持自动、无、百、千、万、亿、百亿、万亿。 科学计数法 支持使用科学计数法或不支持。 使用千分位分割符 支持使用千分位分割符或不支持。 小数位 支持设置小数位或不支持。

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

样式 设置饼图样式请参见表3、表4、表5、表6。 表3 基础设置 参数 说明 卡片标题 自定义是否显示卡片标题 ，勾选后在图表左上角显示。 文本 设置文本大小和颜色，单击选择文本颜色。 对齐方式 设置对齐方式，支持左对齐和居中对齐。 下边距 设置卡片标题与图表之间的距离。 分割线 自定义是否显示分割线。支持设置分割线样式的大小和颜色、下边距大小。 卡片背景 自定义是否显示卡片背景。单击选择卡片背景颜色。 状态icon 自定义是否显示状态icon。支持设置icon的显示方式和颜色，显示方式包括始终显示和悬停显示。 表4 图表样式 参数 说明 可视化样式 包括环形和饼图两种类型。 显示图例 支持显示或不显示，设置为不显示下述参数则不支持设置。 文本 设置文本字体大小。 位置 设置图例的位置，支持设置为下方和上方。 色板 支持设置为系统或自定义。 数值设置 支持对数值的语境、单位、科学计数法、使用千分位分割符、小数位的设置。 圆盘占比 圆盘大小设置。 内径占比 圆盘内径占比的大小。 合并数据为其他 当不勾选框时，无法可合并数据；勾选框时，可合并数据，其他数据占比可通过调整分类数量设置。 显示总计 当勾选框时，显示总计，不勾选时不显示总计。总计名称、文本、数值用户可设置。 开启Tooltip 当不勾选框时，不显示Tooltip，当勾选框时，显示Tooltip。 表5 系列设置 参数 说明 系列值 系列值根据维度选择。用户可自定义系列字段名称。 度量 根据字段中选择的度量值选择。 语境 对系列的语境进行设置，支持中文（简体）和English 单位 单位支持自动、无、百、千、万、亿、百亿、万亿。 科学计数法 支持使用科学计数法或不支持。 使用千分位分割符 支持使用千分位分割符或不支持。 小数位 支持设置小数位或不支持。 表6 条件格式 参数 说明 请选择系列 选择需要设置高亮效果的度量，通过后续的文本设置将实现对度量中的部分值设置高亮效果，通常用于需要单独显示某部分数据的场景，例如将低于某个阈值的异常值设置为高亮效果。 文本 设置高亮效果的数值范围、高亮颜色、光晕闪烁频率、光晕最大透明度、光晕大小，具体请参见场景示例。 在数据集中设置度量的数值显示格式，饼图不会同步显示。 功能设置：当不勾选框时；不展示指标筛选，当勾选框时，展示指标筛选，可在图表画布右上角进行操作。

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

响应示例 状态码： 200 OK。 { "create_date" : 1682576908274, "create_user" : "aoeusth", "create_user_name" : "xxxx", "update_date" : 1683343425273, "update_user" : "aeousth", "update_user_name" : "xxxx", "id" : "xxxxx1f0-dea2-472c-aa9c-25928f74xxxx", "resource_type" : "dataset", "resource_id" : "xxxx406b-8662-4adb-a028-a55cxxxx1166", "auth_switch_config" : { "edit" : false, "read" : true }, "owner" : "xxxxx4a863a94b0ba2887b80dcxxxx3", "project_id" : "9c3043axxxac4055888643b331a0bxxx", "workspace_id" : "66a2c96809ad4f62ba09e6b6eeaa2146" }

URI GET /v1/{project_id}/authorization/cooperate-authorization/properties 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 resource_id 是 String 资源ID。 resource_type 是 String 参数解释： 资源类型枚举值，用于指定授权对象的类型。 示例：datasource，指定授权对象类型为数据源。 约束限制： 不涉及 取值范围： 以下枚举值： datasource：数据源； dataset：数据集； metric：指标； dashboard：仪表板； screen：大屏； embedAnalysis：嵌入分析； portal：数据门户； subject：智能分析助手。 默认取值： 不涉及

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 user_id_list 是 Array of strings 用户id列表。 sys_role 是 Integer 用户角色： 0未激活； 1通用角色； 2只读用户。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of 表5 objects - 表5 UserQuotaVo 参数 参数类型 描述 user_id String 用户id。 account_name String 用户名称。 user_type String 用户类型：IAM、SELF-BUILT、DEFAULT sys_role Integer 用户角色： 0未激活； 1通用角色； 2只读用户。 effective_time Long 生效时间戳。

URI GET /v1/{project_id}/quota-users/all 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 account_name 否 String 用户名（模糊查询）。 sys_role_list 否 Array 系统角色 0未激活； 1通用用户； 2只读用户。

样式 设置中国地图样式参考表1 样式参数 表1 样式参数 参数 参数说明 尺寸位置 设置图表的宽（W）和高（H），单位为px。设置图表在画布中的位置，单位为px。 设置图表在画布上的透明度，比例越大透明程度越低。 全局样式 地图中心：通过设置顶部、左侧的数值大小调整地图中心在图层中的位置。 地图缩放：设置地图中心在图层中的缩放比例，输入值必须在0.1到50之间。 填充设置 透明度：设置填充的透明度，输入值必须在0到1之间。 边线选项：设置边线的颜色和宽度。 视觉映射 通过配置视觉映射，地图上的数据可以被划分为不同的颜色区间，进而直观地展示数据的分布。 当勾选框时，显示视觉映射。支持设置视觉映射图例的方向、宽度、高度、左侧、底部、间距等。 映射类型：单击下拉选项设置视觉映射的映射类型，包括连续型和自定义范围。 连续性：根据数据最大值、最小值自动划分不同的颜色区间，支持设置最大值、最小值、范围外的颜色。 自定义范围：需要自定义数值范围、数值颜色和对应文本。 标签 当勾选框时，显示标签。 显示全量：勾选后显示所有区域的名称。 显示度量：显示“字段”标签页中选择的度量字段。 设置标签的字体、颜色、字号、字体粗细。 选中样式 设置鼠标选中区域的填充颜色和字体颜色， 提示框 当勾选框时，显示提示框。同理设置提示框内是否显示数据值、数据名。 设置提示框的内边距、背景色、边框颜色、边框宽度、文本、字体粗细、自定义大小。 设置完成后单击页面右上角“预览”进行查看，当鼠标悬停在特定区域时显示对应的提示框。 开启缩放 支持设置是否开启缩放。 开启平移 支持设置是否开启平移。

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 字体：可设置的字体类型。 数量：可设置字体的数量。 序列号 显示/隐藏序列号：单击“序列号”右侧的勾选框，表示显示序列号，表示隐藏序列号。 字号：用户自定义字号，设置范围10~100之间。 颜色：单击颜色编辑器设置背景色，用户自定义。 字体粗细：单击下拉选项设置序列号这一列中文本的字体粗细样式。 列宽占比（%）：输入数值设置序列号这一列的宽度。 内容 文本：设置组件文本的样式，包括字号、颜色和字体粗细。 跑马灯：勾选跑马灯右侧的时，组件文本会按照跑马灯效果轮播。 柱子样式 背景：设置柱子的背景颜色。 颜色：单击颜色编辑器设置柱子的颜色。 高度：输入数值或单击设置柱子的高度。 流光 颜色：单击颜色编辑器设置流光的颜色。 长度：流光的长度。 高度：流光的高度。 值标签： 显示或隐藏值标签：勾选显示时，数据中value字段的值将以标签的形式显示在图表中。 字号：值标签的字体大小。 颜色：值标签的字体颜色。 字体粗细：值标签的字体粗细。

请求示例 POST https://{endpoint}/v1/{project_id}/datasets/save { "id" : "string", "caption" : "id", "status" : "string", "description" : "string", "ds_id" : "string", "ds_name" : "string", "ds_type" : "string", "table_type" : "table|sql", "resource_code" : "string", "physical_schema" : { "tables" : [ { "database_name" : "db_test", "is_fact_table" : false, "schema_name" : "public", "sql_text" : "SELECT * FROM FACT_GDP", "table_name" : "t_test", "table_type" : "table" } ] }, "logical_schema" : { "field_schema" : { "columns" : [ { "caption" : "age", "origin_column_name" : "age", "schema_name" : "public", "table_name" : "modern_bi_0xxxx1c590b14d9xxxx35227166f7f02" } ] }, "variables" : [ { "default_values" : [ "aaa", "bbb" ], "format" : "yyyy-MM-dd", "name" : "limit", "type" : "STRING", "use_scope" : "dataset" } ], "relations" : [ { "source_database_name" : "string", "source_schema" : "string", "source_table_name" : "string", "target_database_name" : "string", "target_schema" : "string", "target_table_name" : "string", "join_type" : "string", "relation" : "string", "joins" : [ { "condition" : "equal-to", "source_key" : "city", "target_key" : "city" } ] } ] } }

响应参数 状态码： 200 表12 响应Body参数 参数 参数类型 描述 caption String 数据集语义化名称。 domain_id String 租户ID。 ds_id String 数据源ID。 ds_type String 数据源类型。 id String 数据集ID。 logical_schema 表13 object 数据集逻辑schema。 physical_schema 表22 object 数据集物理schema。 project_id String 项目ID。 version String 数据集版本：默认为2.0，1.0|2.0。 workspace_id String 工作空间ID。 create_date Long 创建时间戳。 create_user String 创建者ID。 create_user_name String 创建者名称。 update_date Long 更新时间戳。 update_user String 更新者ID。 update_user_name String 更新者名称。 resource_code String 数据集资源标识。 表13 LogicalSchema 参数 参数类型 描述 field_schema 表14 object 字段schema。 relations Array of 表19 objects 物理表关系。 variables Array of 表21 objects SQL变量列表。 表14 DatasetFieldSchemaVO 参数 参数类型 描述 dimensions Array of 表15 objects 维度。 measures Array of 表18 objects 度量。 表15 DimensionVo 参数 参数类型 描述 caption String 维度语义化名。 cube_id String 维度所属物理表ID。 description String 维度描述。 id String 维度ID。 hierarchies Array of 表16 objects 维度层级。 表16 Hierarchy 参数 参数类型 描述 caption String 层级结构语义化名。 levels Array of 表17 objects 层级结构level。 表17 LevelVO 参数 参数类型 描述 caption String 语义化名。 column_formula String level表达式。 data_type String 字段类型，STRING|DATE|DATETIME。 枚举值： STRING|DATE|DATETIME expansion_type Integer 扩展字段类型：0-普通扩展字段；1-聚合扩展字段。 id String ID。 is_expansion Integer 是否为扩展字段：0-不是、1-是。 枚举值： 0 1 level_type String level类型。 origin_column_name String 原始字段名称。 origin_column_type String 原始字段类型。 origin_data_type String 转换前的数据类型，STRING|DATE|DATETIME。 枚举值： STRING|DATE|DATETIME 表18 MeasureVo 参数 参数类型 描述 caption String 度量语义化名。 column_formula String 度量字段表达式。 cube_id String 字段所属物理表id data_type String 数据类型，STRING|NUMBER|DATE|DATETIME。 枚举值： STRING|NUMBER|DATE|DATETIME expansion_type Integer 扩展字段类型，0-普通扩展字段 1-聚合扩展字段。 id String 度量ID。 is_expansion Integer 是否为扩展字段：0-不是，1-是。 origin_column_name String 原始字段名称。 origin_column_type String 原始字段类型。 origin_data_type String 转换前的数据类型，STRING|NUMBER|DATE|DATETIME。 枚举值： STRING|NUMBER|DATE|DATETIME 表19 DatasetRelationVO 参数 参数类型 描述 join_type String 关联类型，left join|right join|inner join。 joins Array of 表20 objects 关联键。 relation String 关系类型，one-to-one|one-to-many|many-to-one。 source String 源表ID。 target String 目标表ID。 表20 DatasetJoinVO 参数 参数类型 描述 condition String 关系，equal-to。 source_key String 源字段id。 source_type String 源字段类型：dimension|measure。 target_key String 目标字段ID。 target_type String 目标字段类型：dimension|measure。 表21 SqlVariable 参数 参数类型 描述 default_values Array of objects 变量默认值。 format String 变量格式，针对日期时间类型变量有效。 name String 变量名称。 type String 参数解释： 变量类型，目前支持文本、数值、日期、系统变量等类型。 约束限制： 不涉及 取值范围： 以下枚举值： STRING：普通文本类型，组装执行sql时“输入值”使用单引号包裹，如：'value'； NUMBER：整数或小数类型，组装执行sql时，直接拼接输入值； YEARREGION：日期-年类型； QUARTERREGION 日期-年季类型； MONTHREGION 日期-年月类型； DATEREGION 日期-年月日类型； YMDHMSREGION 日期-年月日时分秒类型； SYSTEM：系统变量，无法指定具体值，由系统后台填写，如：“访问用户名称”后台将当前访问用户名作为值组装执行sql。 默认取值： 不涉及 use_scope String 变量作用域，dataset|global。 表22 PhysicalSchema 参数 参数类型 描述 tables Array of 表23 objects 物理表信息。 数组长度：0-2147483647 表23 DatasetTableVO 参数 参数类型 描述 id String 表ID。 database_name String 数据库。 schema_name String schema名称。 table_name String 表名。 table_type String 数据集类型。 sql_text String 查询SQL。 is_fact_table Boolean 是否为端点表。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 数据集ID。 caption 是 String 数据集语义化名称。 status 否 String 数据集状态：0，1。 description 否 String 数据集描述。 ds_id 是 String 数据源ID。 ds_name 否 String 数据源名称。 ds_type 否 String 数据源类型。 table_type 是 String 数据集类型： table：不含自定义SQL表的数据集。 sql：含自定义SQL表的数据集。 resource_code 否 String 数据集资源标识。 physical_schema 是 表4 object 数据集物理schema。 logical_schema 是 表6 object 数据集逻辑schema。 表4 PhysicalOpenApiSchema 参数 是否必选 参数类型 描述 tables 是 Array of 表5 objects 物理表信息。 表5 DatasetTableOpenApiVO 参数 是否必选 参数类型 描述 database_name 是 String 数据库。 is_fact_table 是 Boolean 是否为端点表。 schema_name 否 String 模式。 sql_text 否 String 查询SQL。 table_name 是 String 表名。 table_type 是 String 表类型： table：物理表。 sql：自定义SQL表。 表6 LogicalSchemaOpenApiVO 参数 是否必选 参数类型 描述 filed_schema 否 表7 object 字段选择信息。 variables 否 Array of 表9 objects SQL变量列表。 relations 否 Array of 表10 objects 物理表关系。 表7 DatasetFieldSchemaOpenApiVO 参数 是否必选 参数类型 描述 columns 否 Array of 表8 objects 字段选择列表和字段名称赋值。 表8 ColumnOpenApiVO 参数 是否必选 参数类型 描述 caption 是 String 字段名称。 origin_column_name 是 String 字段物理名称，即表中名称。 schema_name 否 String 字段所属schema。 table_name 是 String 字段所属名 表9 SqlVariable 参数 是否必选 参数类型 描述 default_values 否 Array of objects 变量默认值。 format 否 String 变量格式，针对日期时间类型变量有效。 name 是 String 变量名称 type 是 String 参数解释： 变量类型，目前支持文本、数值、日期、系统变量等类型。 约束限制： 不涉及 取值范围： 以下枚举值： STRING：普通文本类型，组装执行sql时“输入值”使用单引号包裹，如：'value'； NUMBER：整数或小数类型，组装执行sql时，直接拼接输入值； YEARREGION：日期-年类型； QUARTERREGION 日期-年季类型； MONTHREGION 日期-年月类型； DATEREGION 日期-年月日类型； YMDHMSREGION 日期-年月日时分秒类型； SYSTEM：系统变量，无法指定具体值，由系统后台填写，如：“访问用户名称”后台将当前访问用户名作为值组装执行sql。 默认取值： 不涉及 use_scope 是 String 变量作用域，dataset|global。 表10 DatasetRelationOpenApiVO 参数 是否必选 参数类型 描述 source_database_name 是 String 源表所属数据库名称。 source_schema 否 String 源表所属schema名称。 source_table_name 是 String 源表名称。 target_database_name 是 String 目标表所属数据库名称。 target_schema 否 String 目标表所属schema名称。 target_table_name 是 String 目标表名称。 join_type 是 String 关联类型。 relation 是 String 关系类型。 joins 是 Array of 表11 objects 关联键 表11 DatasetJoinOpenApiVO 参数 是否必选 参数类型 描述 condition 是 String 关联关系，默认equal-to。 source_key 是 String 源表字段。 target_key 是 String 目标表字段。

样式 本章节介绍自定义地图的样式各配置项的含义。 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 地图中心：设置地图中心在图层中的位置。 顶部：设置地图中心的顶部，输入值必须在0到200之间。 左侧：设置地图中心的左侧，输入值必须在0到200之间。 缩放范围：设置地图中心在图层中的缩放比例，输入值必须在0.1到50之间。 边界数据来源：地图数据的来源方式，有链接和素材两种类型。 链接：从其他地方复制链接粘贴此处，可以获取边界数据。 素材：用户自定义素材，或者从其他地方获取到的json文件，上传获取边界数据。 图2 全局样式 填充设置 透明度：设置填充的透明度，输入值必须在0到1之间。 边线选择：设置边线的颜色和宽度。 填充颜色：设置填充的颜色。 宽度：设置填充的宽度，输入值必须在0到10之间。 图3 填充设置 视觉映射 显示/隐藏视觉映射：单击“标签”右侧的勾选框，表示显示视觉映射，表示隐藏视觉映射。 方向：单击下拉选项设置视觉映射的映射方向，可以设置为水平或垂直。 映射类型：单击下拉选项设置视觉映射的映射类型，可以设置为连续型或自定义范围。 宽度：设置视觉映射的宽度。 高度：设置视觉映射的高度。 左侧：设置视觉映射时距离图层左侧的距离。 底部：设置视觉映射时距离图层底部的距离。 间距：设置映射之间间距。 文字：设置视觉映射时文本的字体颜色和字号大小。 映射类型：支持连续型金额自定义范围设置。范围支持对数值范围、数值颜色、对应文本设置。 范围外：支持对范围外颜色进行设置。 图4 视觉映射 标签 显示标签：勾选后地图显示标签，不勾选，地图不显示标签。 显示全量：勾选后，不显示标签的区域也会显示。 显示度量：显示字段中选择的度量字段。 字体：用户可自定义设置标签的字体。 颜色：用户可自定义设置标签的字体颜色。 字号：用户可自定义设置标签的字体字号，范围10~100之间。 字体粗细：用户可以设置标签字体的粗细，类型有Normal、Bold、Bolder、Lighter。 选中样式 颜色：单击颜色编辑器设置颜色。 数据值：单击“数据值”右侧的勾选框，表示显示数据值，表示隐藏数据值。 数据名：单击“数据名”右侧的勾选框，表示显示数据名，表示隐藏数据名。 文本样式：设置文本的颜色、字号和字体粗细样式 提示框内边距：设置提示框的内边距，输入值不能小于0。 提示框背景色：设置提示框的背景颜色。 提示框自定义大小：设置提示框的大小。 提示框边框颜色：设置提示框的边框颜色。 提示框边框宽度：设置提示框的边框宽度，输入值不能小于0。 图5 选中样式 开启缩放：支持设置是否开启缩放。 开启平移：支持设置是否开启平移。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 page_data Array of objects 分页列表内容。详细参数类型请参考CooperateAuthorizationRuleVO 。 count Integer 总条数。 表5 CooperateAuthorizationRuleVO 参数 参数类型 描述 auth_id String 授权主体ID。 auth_level String 授权主体级别。 user：用户 group：用户组 auth_name String 授权主体名称。 authed Boolean 是否已授权。 authority String 权限点，枚举值。 edit、export：编辑和导出权限 edit：编辑权限 export：导出权限 read：查看权限 use：使用权限 说明： 权限之间有依赖关系， 授予edit权限，自动关联授予use、read权限； 授予了export权限，自动关联授予use、read权限。 export、edit二者之前无依赖关系。 create_date Long 创建时间。 create_user String 创建人ID。 create_user_name String 创建人姓名。 id String 授权记录的ID，无实际含义。 is_owner Boolean 是否是资源拥有者。 resource_id String 资源ID。 resource_type String 参数解释： 资源类型枚举值，用于指定授权对象的类型。 示例：datasource，指定授权对象类型为数据源。 约束限制： 不涉及 取值范围： 以下枚举值： datasource：数据源； dataset：数据集； metric：指标； dashboard：仪表板； screen：大屏； embedAnalysis：嵌入分析； portal：数据门户； subject：智能分析助手。 默认取值： 不涉及 sort Integer 排序字段，无实际含义。 update_date Long 修改时间。 update_user String 修改人ID。 update_user_name String 修改人姓名。

请求示例 获取协同授权列表。 GET https://{endpoint}/v1/xxxx3ab4dac4055888643b331axxxx/authorization/cooperate-authorization/rules?resource_type=dataset&resource_id=f8e5406b-8662-4adb-a028-a55c76ae1166&auth_level=user&filer_authed=false&limit=20&offset=0&sort_dir=asc

响应示例 状态码： 200 OK。 { "page_data" : [ { "create_date" : 1690593374608, "create_user" : "xxxxxf45cea249a2aa648a20e46xxxxx", "create_user_name" : "xxxxxx", "update_date" : 1690593374608, "update_user" : "558def45cea249a2aa648a20e46xxxxx", "update_user_name" : "xxxxx", "id" : "73281a3b-a828-494a-bb0d-e88c688a5e81", "resource_type" : "dashboard", "resource_id" : "e3158b30-30bc-495a-b0d8-59e66e1xxxxx", "auth_level" : "user", "auth_id" : "xxxxf45cea249a2aa648a20e46xxxx", "auth_name" : "xxxxxx", "is_owner" : true, "authed" : true, "sort" : 4, "authority" : "edit" }, { "create_date" : 1690593374608, "create_user" : "xxxxxf45cea249a2aa648a20e46xxxxx", "create_user_name" : "xxxxxx", "update_date" : 1690593374608, "update_user" : "558def45cea249a2aa648a20e46xxxxx", "update_user_name" : "xxxxx", "id" : "73281a3b-a828-494a-bb0d-e88c688a5e81", "resource_type" : "dashboard", "resource_id" : "e3158b30-30bc-495a-b0d8-59e66e1xxxxx", "auth_level" : "user", "auth_id" : "xxxxf45cea249a2aa648a20e46xxxx", "auth_name" : "xxxxxx", "is_owner" : true, "authed" : true, "sort" : 4, "authority" : "edit,export" } ], "count" : 2147483647 }

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

URI GET /v1/{project_id}/authorization/cooperate-authorization/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 auth_level 否 String 授权主体级别。 user：用户 group：用户组 filter_authed 否 Boolean 是否过滤已经授权的实体，默认true，仅显示授权用户和用户组信息。 预留字段。 resource_id 是 String 资源ID。 resource_type 是 String 参数解释： 资源类型枚举值，用于指定授权对象的类型。 示例：datasource，指定授权对象类型为数据源。 约束限制： 不涉及 取值范围： 以下枚举值： datasource：数据源； dataset：数据集； metric：指标； dashboard：仪表板； screen：大屏； embedAnalysis：嵌入分析； portal：数据门户； subject：智能分析助手。 默认取值： 不涉及 auth_name 否 String 授权主体名称。 limit 否 Integer 分页大小。 offset 否 Integer 偏移量。 sort_dir 否 String asc: 升序， desc: 降序。

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图2 尺寸位置 边框（样式） 填充 样式：边框支持丰富多种的样式设置。 自定义边框： 图片添加方式：图片可通过url或本地上传的形式添加。 边框宽度：可以通过上方、右侧、下方、左侧来调整图片展示样式，取值范围0~500之间。 边框偏移：可以通过上方、右侧、下方、左侧来调整图片展示样式，取值范围0~500之间。 装饰（样式） 缩放模式：支持保持原图大小、按比例缩放、拉伸缩放。 样式：支持丰富多种样式设置。 背景图 效果 背景色：设置自定义背景组件的背景颜色。 羽化：设置自定义组件的羽化，输入值必须在0到100之间。 图3 无羽化效果 图4 羽化效果 模糊度：设置自定义组件的模糊度，输入值必须在0到100之间。 亮度：设置自定义组件的亮度，输入值必须在0到200之间。 色相旋转：设置自定义组件的色相旋转，输入值必须在0到360之间。 不透明度：设置自定义组件的不透明度，输入值必须在0到100之间。 边线选项 样式：支持实线、虚线、点划线的设置。 宽度：设置边线的宽度，输入值不能小于0。 颜色：设置边线的颜色。 圆角 左上角：设置圆角的左上侧，输入值不能小于0。 右上角：设置圆角的右上侧，输入值不能小于0。 右下角：设置圆角的右下侧，输入值不能小于0。 左下角：设置圆角的左下侧，输入值不能小于0。 图5 圆角都为0效果 图6 圆角都为90效果 填充 使用素材：添加预置背景图，方便高频复用背景图。 自定义背景： 图片：支持url添加和本地上传图片。 缩放模式：支持报错原图大小、按比例缩放、裁剪缩放、拉伸缩放。 图片位置：支持设置为居中对齐、左对齐、右对齐、顶对齐、底对齐。

样式 表3 尺寸位置 参数 说明 W 设置图表的宽，单位为px。 H 设置图表的高，单位为px。 X 设置图表在画布中的位置，单位为px。 Y 设置图表在画布中的位置，单位为px。 不透明度 设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 表4 全局样式 参数 说明 字体 设置图表中文字的字体。 数据展示 设置玫瑰图的展示样式，支持半径和面积设置。 表5 标签属性 参数 说明 显示/隐藏标签属性 单击“显示标签属性”左侧的勾选框，表示显示，表示隐藏。 标签距中间 设置标签距中间的距离。 轴距长度 设置标签的轴距长度。 字号 设置标签字体大小。 字体粗细 设置标签的字体粗细。 显示/隐藏数据名 单击“数据名”右侧的勾选框，表示显示，表示隐藏。 显示/隐藏显示度量名 单击“显示度量名”右侧的勾选框，表示显示，表示隐藏。 显示/隐藏数据值 单击“数据值”右侧的勾选框，表示显示，表示隐藏。 显示/隐藏比例显示 单击“比例显示”右侧的勾选框，表示显示，表示隐藏。 表6 饼图属性 参数 说明 内半径 设置内半径，输入不能为空，且输入值在0到100之间。 外半径 设置外半径，输入不能为空，且输入值在0到100之间。 水平位置 设置水平位置，输入不能为空，且输入值在0到100之间。 垂直位置 设置垂直位置，输入不能为空，且输入值在0到100之间。 表7 图例 参数 说明 显示/隐藏图例 单击“显示图例”左侧的勾选框，表示显示图例，表示隐藏图例。 文本 设置图例的文本样式，包括字号、字体颜色、字体粗细。 布局 设置图例的位置，支持顶部居中、顶部居左、顶部居右、底部居中、底部居左、底部居右。 表8 提示信息 参数 说明 显示/隐藏提示信息 勾选表示预览或查看发布组件时显示的提示信息；不勾选表示预览或查看发布组件时不显示提示信息。 颜色 设置提示信息的字体颜色。 字号 设置提示信息的字号大小。 字体粗细 设置提示信息的字体粗细样式。 表9 视觉映射和系列 参数 说明 视觉映射 显示/隐藏视觉映射：单击“视觉映射”左侧的勾选框，表示显示，表示隐藏。 最大值：设置视觉映射的最大值。 最小值：设置视觉映射的最小组。 映射类型：支持连续型和分段型（等值）设置。 方向：支持垂直和水平设置。 宽度：的设置宽度，输入不能为空，且输入值在0到50之间。 高度：设置映射高度，输入不能为空，且输入值在1到200之间。 左侧：设置映射左侧，输入不能为空，且输入值在0到100之间。 底部：设置映射底部，输入不能为空，且输入值在0到100之间。 文字：支持设置颜色和字号。 系列 配色方案：支持默认色、经典、舒适、智能、数据、艺术、SaaS规范的配色方案。 系列：支持对系列颜色的配置（纯色和渐变色）。渐变色可设置起点、终点颜色，起点终点颜色也可互换。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 数据数量。 page_data Array of 表5 objects 数据。 表5 DatasetListVO 参数 参数类型 描述 create_date Long 创建时间。 create_user String 创建人ID。 create_user_name String 创建人姓名。 description String 描述。 id String ID name String 名称。 permission_list Array of strings 当前用户拥有的协同授权权限点。 edit，export，use，read。 project_id String 项目ID。 type String 数据集类型： table：物理表组成的数据集。 sql：含自定义SQL表的数据集。 update_date Long 修改时间。 update_user String 修改人ID。 update_user_name String 修改人姓名。 workspace_id String 工作空间ID。 ds_name String 绑定的数据源名称。 ds_type String 绑定的数据源类型：MYSQL、POSTGRESQL、DWS、OPENGAUSS、CLICKHOUSE、API、DORIS ds_id String 绑定的数据源ID。 routing_strategy String 查询数据时的路由策略。Direct：直连；Accelerator：内存引擎。 resource_code String 数据集资源标识。

响应示例 状态码：200 查询数据集和目录列表成功。 { "count" : 216, "page_data" : [ { "id" : "4df79d49-444c-xxxxx-28f9cfeac554", "name" : "保存数据集", "type" : "table", "permission_list" : [ "edit", "use" ], "workspace_id" : "e77ff0dxxxxxxx1b59fac2cc12faa146f", "project_id" : "34ba64e53a02xxxxxxx75669a8cc17bd", "create_user" : "558def45cexxxxxxxxa20e463e017", "create_user_name" : "xxxxxxxxx", "create_date" : 1704533906073, "update_user" : "558def4xxxxxxxxx648a20e463e017", "update_user_name" : "xxxxxxxx", "update_date" : 1704533906073, "description" : null, "ds_id" : "ff8080818xxxxxxf101886aab31a900e1", "ds_type" : "DWS", "ds_name" : "dws04_public", "routing_strategy" : "Direct", "resource_code" : "xxx" } ] }

URI GET /v1/{project_id}/datasets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 数据集名称。 sort_dir 否 String 是否降序。 sort_key 否 String 排序字段。 limit 否 Integer 返回条目数。不传该参数时，默认查询前10条信息。取值范围：[0,1000] 默认值：10。 offset 否 Integer 返回条目的起始offset。取值范围：[0,1000] 默认值：0。

样式 本章节介绍折线柱图的样式的各项配置的含义。 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 字体：设置图表中文字的字体。 图2 全局样式 折线样式：平滑曲线值范围0~1。 柱子样式 柱子宽度：设置柱子宽度，可以通过输入数值或单击“-”或“+”调节。输入值不能为空，输入值必须在1到100之间。 柱子圆角度：设置柱子圆角度，可以通过输入数值或单击“-”或“+”调节。输入值不能为空，输入值必须在0到100之间。 系列间距：设置系列间距，可以通过输入数值或单击“-”或“+”调节。输入值不能为空，输入值必须在-100到100之间。 图3 柱子样式 边距 顶部：设置图表与图层顶部的间距，可以通过输入数值或单击“-”或“+”调节。 底部：设置图表与图层底部的间距，可以通过输入数值或单击“-”或“+”调节。 左侧：设置图表与图层左侧的间距，可以通过输入数值或单击“-”或“+”调节。 右侧：设置图表与图层右侧的间距，可以通过输入数值或单击“-”或“+”调节。 图4 边距 x轴 显示/隐藏x轴：单击“显示x轴”侧的勾选框，表示显示x轴，表示隐藏x轴。 文本：设置x轴的文本样式，包括字号、字体颜色、字体粗细。 轴标签：显示轴标签的角度，取值范围-90~90。 轴线颜色：设置x轴的颜色。 显示/隐藏网格线：单击“网格线”右侧的勾选框，表示显示网格线，表示隐藏网格线。 y轴 显示/隐藏y轴：单击“显示y轴”左侧的勾选框，表示显示y轴，表示隐藏y轴。 文本：设置y轴的文本样式，包括字号、字体颜色、字体粗细。 轴标签：设置y轴的标签，支持对显示格式、最小值、最大值、分割数设置。 显示格式支持设置自动、取整、保留一位小数、保留两位小数、保留三位小数、保留四位小数、保留五位小数。 最小值支持自动取整和数据最小值。 最大值支持自动取整和数据最大值。 分割数输入值不能小于1。 轴单位：设置y轴的单位和颜色。 坐标轴：设置y轴轴线的颜色。 显示/隐藏网格线：单击“网格线”右侧的勾选框，表示显示网格线，表示隐藏网格线。 图例 显示/隐藏图例：单击“显示图例”左侧的勾选框，表示显示图例，表示隐藏图例。 文本：设置图例的文本样式，包括字号、字体颜色、字体粗细。 布局：设置图例的位置，支持顶部居中、顶部居左、顶部居右、底部居中、底部居左、底部居右。 图5 图例 提示信息 显示/隐藏提示信息：勾选表示预览或查看发布组件时显示的提示信息；不勾选表示预览或查看发布组件时不显示提示信息。 触发类型：设置提示信息的触发类型，可以选择坐标轴或数据项。 颜色：设置提示信息的字体颜色。 字号：设置提示信息的字号大小。 字体粗细：设置提示信息的字体粗细样式。 图6 提示信息 动画 显示/隐藏动画：单击“显示动画”左侧的勾选框，表示开启图表的动画效果；表示预不开启图表的动画效果。 入场动画：组件第一次渲染动画的时长，单位为ms。 入场动画输入值不能为0，默认值是1000ms。 动画效果：动画的缓动效果，系统提供多种常见的动画缓动效果供您选择。 各系列依次动画：开启后，各系列依次动画显示。未开启时，所有的系列同时动画显示。 更新动画：组件数据更新时的动画时长，单位为ms。 是否从之前位置开始：开启后，组件数据更新时，从上一个数据的位置开始播放动画；关闭后，组件数据更新时，从初始位置开始播放动画。 图7 动画 数值设置：支持对数值的语境、单位、科学计数法、使用千分位分割符、小数位的设置。

请求示例 数据源新增。 POST /v1/{project_id}/connections 新增公网连接类型数据源 { "name": "dws02", "server_list": "xx.xx.x.xx:xxxx", "database_name": "gaussdb", "user_name": "xxxxx", "password": "xxxxxxx", "config": { "ssl": true }, "source": "public", "type": "DWS" } 新增DWS云数据源 { "name": "dws04_instance", "description": "测试新增", "source": "dws", "type": "DWS", "database_name": "xxxxx", "user_name": "xxxx", "password": "xxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxxxxxx" }, "config": { "ssl": false } } 新增RDS的MySQL云数据源 { "name": "mysql_instance", "description": "测试新增", "source": "rds", "type": "MySQL", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxxxxxx" }, "config": { "ssl": false } } 新增 GaussDB ForMySQL云数据源 { "name": "gaussdb_mysql_instance", "description": "测试新增", "source": "gaussdb", "type": "MySQL", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxx" }, "config": { "ssl": false } } 新增OpenGauss云数据源 { "name": "gaussdb_instance", "description": "测试新增", "source": "gaussdb", "type": "OpenGauss", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxx" }, "config": { "ssl": false } } 新增PostgreSQL云数据源 { "name": "postgre_instance", "description": "测试新增", "source": "rds", "type": "PostgreSQL", "database_name": "xxxxx", "user_name": "xxxxx", "password": "xxxxx", "region_id": "xxxx", "cluster": { "id": "xxxxxxxx" }, "config": { "ssl": false } }

步骤3：保存或保存并发布大屏 完成大屏字段和样式配置并单击“更新”后，单击大屏编辑页面右上侧的“保存并发布”或“保存”。 保存：保存大屏之后，在大屏页面大屏不具有查看大屏功能。 在保存的页面输入大屏的名称。 图8 保存并发布 大屏名称不能为空，只能包含中文、英文、数字、空格、下划线(_)和中划线(-)，且开头和结尾不能有空格，输入长度为1-32个字符。 收藏：收藏大屏后，可在产品首页“我的收藏”快速找到大屏。 保存并发布：保存并发布大屏之后，在大屏页面大屏具有查看功能。在保存并发布的页面输入大屏的名称。

操作流程 图1 评测智能分析助手操作流程 表1 评测智能分析助手操作流程说明 步骤 说明 步骤一：上传评测集 上传的评测集中包含询问智能分析助手的问题，后续的测评将基于这些问题展开。 步骤二：评测标注 评测标注能够快速、准确评估当前智能分析助手端到端效果以及各模块效果。 步骤三：对比评测结果（可选） 在同一评测集下选择两个智能分析助手进行评测标注，用于对比不同助手之间的问答准确率，进而有针对性地优化助手配置。 步骤四：管理BadCase BadCase可以有效跟踪评测标注过程中标注为错误的问题，方便后续的问题处理和改进工作。