华为云用户手册

URI GET /v1/{project_id}/resources/{resource_type} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 resource_type 是 String 参数解释： 资源类型枚举值，用于指定授权对象的类型。 示例：datasource，指定授权对象类型为数据源。 约束限制： 不涉及 取值范围： 以下枚举值： datasource：数据源； dataset：数据集； metric：指标； dashboard：仪表板； screen：大屏； embedAnalysis：嵌入分析； portal：数据门户； subject：智能分析助手。 默认取值： 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移值。 limit 否 Integer 返回列表数量。 sort_key 否 String 排序字段。 sort_dir 否 String 排序类别： desc：倒序。 asc：正序。

样式 本章节介绍饼状图的样式的各项配置的含义。 表3 尺寸位置 参数 说明 W 设置图表的宽，单位为px。 H 设置图表的高，单位为px。 X 设置图表在画布中的位置，单位为px。 Y 设置图表在画布中的位置，单位为px。 不透明度 设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 表4 全局样式 参数 说明 字体 设置图表中文字的字体。 表5 标签属性 参数 说明 显示/隐藏标签属性 单击“显示标签属性”左侧的勾选框，表示显示，表示隐藏。 标签距中间 设置标签距中间的距离。 轴距长度 设置标签的轴距长度。 字号 设置标签字体大小。 字体粗细 设置标签的字体粗细。 显示/隐藏数据名 单击“数据名”右侧的勾选框，表示显示，表示隐藏。 显示/隐藏显示度量名 单击“显示度量名”右侧的勾选框，表示显示，表示隐藏。 显示/隐藏数据值 单击“数据值”右侧的勾选框，表示显示，表示隐藏。 显示/隐藏比例显示 单击“比例显示”右侧的勾选框，表示显示，表示隐藏。 表6 饼图属性 参数 说明 内半径 设置内半径，输入不能为空，且输入值在0到100之间。 外半径 设置外半径，输入不能为空，且输入值在0到100之间。 水平位置 设置水平位置，输入不能为空，且输入值在0到100之间。 垂直位置 设置垂直位置，输入不能为空，且输入值在0到100之间。 表7 图例 参数 说明 显示/隐藏图例 单击“图例”右侧的勾选框，表示显示图例，表示隐藏图例。 显示度量名 是否显示度量名。 数据值 是否显示数据值。 比例显示 是否显示比例。 文本 设置图例的文本样式，包括字号、字体颜色、字体粗细。 布局 支持对方向、位置、左右间距、上下间距、图例间隔的设置。 图例标记 支持对标记类型、标记宽度、标记高度设置。 表8 提示信息 参数 说明 显示/隐藏提示信息 勾选表示预览或查看发布组件时显示的提示信息；不勾选表示预览或查看发布组件时不显示提示信息。 颜色 设置提示信息的字体颜色。 字号 设置提示信息的字号大小。 字体粗细 设置提示信息的字体粗细样式。 表9 动画 参数 说明 显示/隐藏动画 单击“显示动画”左侧的勾选框，表示开启图表的动画效果；表示预不开启图表的动画效果。 入场动画 组件第一次渲染动画的时长，单位为ms。 说明： 入场动画输入值不能为0，默认值是1000ms。 动画效果 动画的缓动效果，系统提供多种常见的动画缓动效果供您选择。 各系列依次动画 开启后，各系列依次动画显示。未开启时，所有的系列同时动画显示。 更新动画 组件数据更新时的动画时长，单位为ms。 是否从之前位置开始 开启后，组件数据更新时，从上一个数据的位置开始播放动画；关闭后，组件数据更新时，从初始位置开始播放动画。 表10 边线选项和系列 参数 说明 边线选项 颜色：设置边线的颜色。 宽度：设置边线的宽度，输入不能为空，且输入值在0到10之间。 透明度：设置边线的透明度。输入值不能为，且输入值必须在0到1之间。 系列 配色方案：支持默认色、经典、舒适、智能、数据、艺术、SaaS规范的配色方案。 系列：支持对系列颜色的配置（纯色和渐变色）。渐变色可设置起点、终点颜色，起点终点颜色也可互换。

URI GET /v1/{project_id}/quota-users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 account_name 否 String 用户名（模糊搜索）。 sys_role 否 String 系统角色： 1通用角色； 2只读用户。 type 否 String 角色类型： IAM 、SELF-BUILT sort_key 否 String 排序字段：effectiveTime、accountName sort_dir 否 String 排序方式：desc、asc offset 否 Integer 页数，默认0。 limit 否 Integer 每页数据数，默认10。

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

样式 如何设置交叉表的样式参数，请参考以下表格。 表2 基础设置 参数 说明 卡片标题 卡片支持有和无标题的设置。设置卡片的标题，在卡片的左上角展示。 无标题：当未勾选框时，为无标题格式。 有标题：当勾选框时，为有标题格式。 文本 设置文本字体的大小和字体颜色。可通过输入修改字体大小也可通过和修改字体的大小。 说明： 输入不能为空，且输入值必须在14到32之间。 对齐方式 支持左对齐和居中对齐方式。 下边距 设置交叉表标题与图表之间的距离。可通过输入修改边距的大小也可通过和修改边距的大小。 说明： 输入不能为空，且输入值必须在0到32之间。 分割线 卡片支持无和有分割线的设置。 无分割线：当未勾选框时，为无分割线格式。 有分割线：当勾选框时，为有分割线格式。支持对分割线的样式和下框边距进行设置。分割线样式和下边框支持输入设置，也可通过和进行设置。 说明： 分割线样式的输入不能为空，且输入值必须在0到8之间。在设置样式之后才可以设置下边距，分割线的下边距输入不能为空，且输入值必须在0到32之间。 卡片背景 卡片背景支持有背景和无背景设置。 无背景：当未勾选框时，为无背景格式。 有背景：当勾选框时，为有背景格式。支持背景颜色的设置。 状态icon 可以设置icon的显示方式和颜色，支持始终显示和悬停显示。卡片icon支持有状态icon和无状态icon设置。 无背景：当未勾选框时，为无状态icon。 有背景：当勾选框时，为有状态icon。 可视化样式 展示方式有平铺展示、树形展示、自定义树展示。 分页 设置交叉表格上的数据分页展示的个数，支持在图表内设置。支持设置的个数有以下：10、20、50。 数值设置 支持对数值的语境、单位、科学计数法、使用千分位分割符、小数位的设置。 表头 表头包含列汇总和行汇总。 列汇总 展示方式：右侧和左侧。 列总计、列小计：当勾选框时，列总计、列小计可以自定义名称。 行汇总 展示方式：底部和顶部。 列总计、列小计：当勾选框时，列总计、列小计可以自定义名称。 指标展示分组：开启指标分组时，指标排序以指标分组中的顺序为准。 系列配置 支持对度量进行设置。 语境：对系列的语境进行设置，支持中文（简体）和English 单位：单位支持自动、无、百、千、万、亿、百亿、万亿。 科学计数法：支持使用科学计数法或不支持。 使用千分位分隔符：支持使用千分位分割符。 小数位：支持设置小数位，取值范围0~10。

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

请求示例 自然语言查数。 POST https://{endpoint}/v1/{project_id}/nl-query { "message_content" : "去年11月公司的收入是多少", "dialog_id" : "66xxxx02x5axxx9xx12fxxx9c2xxxx6d", "subject_id" : "xa4axxx4-9xx9-4xx2-9xxx-3axxxxf4a5c3" }

响应示例 状态码： 200 nl-query请求返回体。 { "query_data" : [ [ { "caption" : "收入", "data_type" : "NUMBER", "level_type" : null, "cell_raw_value" : null, "cell_value" : "收入", "model_type" : "measure", "cell_converted_value" : null }, { "caption" : "收入", "data_type" : "NUMBER", "level_type" : null, "cell_raw_value" : "423xxx214.32", "cell_value" : "423xxx214.32", "model_type" : "measure", "cell_converted_value" : null } ] ], "sql_text" : "SELECT xxx AS xxx FROM xxx.xxx AS xxx", "insight" : "查询结果: 去年11月公司的收入为xxx。建议探索的方向：xxx。业务建议：xxx。" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 表3 请求Body参数 参数 是否必选 参数类型 描述 subject_id 是 String 智能分析助手ID。 dialog_id 是 String 对话ID。如果不想触发多轮问答能力，需每次调用请求时传入不同的dialog_id。 message_content 是 String 查询问题。 need_insight 否 Boolean 是否需要智能见解。

请求参数 表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列表。

操作步骤 登录智能数据洞察控制台。 单击管理控制台左上角的，选择区域。 单击左下角的企业项目选择企业项目。 选择项目。 选择待授权的大屏。 单击大屏操作列“更多”，在弹出的页面内单击“分享协作”。 在协同授权配置页面编辑大屏权限。 选择授予的权限。 编辑授权：打开后可赋予成员编辑权限，支持编辑和删除大屏，同时支持基于大屏进行数据分析。 开启大屏的编辑权限，默认关联开启大屏的使用/查看权限。 导出授权：打开后可赋予成员使用权限。支持对大屏的分析，同时支持基于大屏进行数据分析。 查看权限：打开后可赋予成员使用权限，仅支持基于大屏进行数据分析。 选择授权的对象。 用户：给当前用户编辑大屏的权限。 用户组：当给该用户组授权后，整个组内的用户都将获得该大屏的相关权限。 按需勾选需要授权的用户和用户组，完成数据源授权。 图1 协同授权配置页面

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 对齐方式：设置数字的对齐方式，可以设置为水平居中、左侧对齐、右侧对齐。 上下对齐：包含居中、上对齐、下对齐的三种对齐方式。 始终动画：开启后，翻牌器上的数字将始终随着数据的变化而动态变化。 动画时长：输入数值或单击可设置动画一次播放的时间，时间单位为毫秒。 字体：设置文本的字体。 字号：设置文本的字号。 颜色：设置文本的字体颜色。 字体粗细：设置文本的字体粗细。 超长是否缩略显示：支持显示超长是否缩略。显示与不显示，用户自定义。 范围设置 新增范围： 数值范围：支持设置数值范围，可设置为数值区间、负无穷-数值、数值-正无穷。 数值颜色:设置数值的颜色。 图标选择：设置图标。 数值显示：设置支持/不支持数值显示，单击“数值显示”右侧的勾选框，表示支持，表示不支持。 文本显示：设置支持/不支持文本显示，单击“数值显示”右侧的勾选框，表示支持，表示不支持。 图标显示：设置支持/不支持图标显示，单击“数值显示”右侧的勾选框，表示支持，表示不支持。 单位 显示单位：设置支持/不支持显示单位，单击“显示单位”左侧的勾选框，表示支持，表示不支持。 内容：设置单位内容。 字体：设置内容字体。 字号：设置内容字号。 不随数值变化：设置支持/不支持不随数值变化，单击“不随数值变化”右侧的勾选框，表示支持，表示不支持。 颜色：设置数值变化的颜色变化。 字体粗细：设置单位的字体粗细。

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

URI GET /v1/{project_id}/tags/download 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID。获取方法请参见获取项目ID。 约束限制： 不涉及 取值范围： 不涉及 默认取值： 不涉及 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 参数解释： 用户类型。 约束限制： 不涉及 取值范围： user：用户 userGroup：用户组 默认取值： 不涉及

样式 本章节介绍柱状图样式的各配置项的含义。 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 字体：设置图表中文字的字体。 图2 全局样式 柱子样式 柱子宽度：设置柱子宽度，可以通过输入数值或单击“-”或“+”调节。输入值不能为空，输入值必须在1到100之间。 柱子圆角度：设置柱子圆角度，可以通过输入数值或单击“-”或“+”调节。输入值不能为空，输入值必须在0到100之间。 系列间距：设置系列间距，可以通过输入数值或单击“-”或“+”调节。输入值不能为空，输入值必须在-100到100之间。 图3 柱子样式 边距 顶部：设置图表与图层顶部的间距，可以通过输入数值或单击“-”或“+”调节。 底部：设置图表与图层底部的间距，可以通过输入数值或单击“-”或“+”调节。 左侧：设置图表与图层左侧的间距，可以通过输入数值或单击“-”或“+”调节。 右侧：设置图表与图层右侧的间距，可以通过输入数值或单击“-”或“+”调节。 图4 边距 值标签 显示/隐藏值标签：单击“显示值标签”左侧的勾选框，表示显示，表示隐藏。 字号：设置值标签的字号大小。 颜色：设置值标签的颜色。 字体粗细：设置值标签的字体粗细。 位置：设置值标签的位置。 标签间隔数：用户可以设置柱状图上方的标签间隔。 图5 值标签 x轴 显示/隐藏x轴：单击“x轴”右侧的勾选框，表示显示x轴，表示隐藏x轴。 轴标签：支持设置字号、颜色、字体粗细、角度。 数据类型：坐标轴对应的字段的数据类型，可以选择数值型、类目型、时间型。 自动间隔：设置是否自动间隔。 标签间隔：设置标签之间的间隔数。 最小标签：设置是否支持最小标签。 最大标签：设置是否支持最大标签。 缩放：设置是否缩放。 文本溢出：设置是否文本溢出，支持设置溢出宽度。 坐标轴：设置x轴的颜色。 显示/隐藏网格线：单击“网格线”右侧的勾选框，表示显示x轴网格线，表示隐藏网格线。 图6 x轴 y轴 显示/隐藏y轴：单击“y轴”右侧的勾选框，表示显示x轴，表示隐藏x轴。 文本：支持设置字号、颜色、字体粗细、角度。 轴标签：支持设显示格式、最小值、最大值、分割数的设置。 轴单位：设置是否显示轴单位，单位支持颜色和单位名称的设置。 坐标轴：设置y轴的颜色。 显示/隐藏网格线：单击“网格线”右侧的勾选框，表示显示y轴网格线，表示隐藏网格线。 图7 y轴 图例 显示/隐藏图例：单击“图例”右侧的勾选框，表示显示图例，表示隐藏图例。 文本：设置图例的文本样式，包括字号、字体颜色、字体粗细。 布局：设置图例的方向、位置、左右间距、上下间距、图例间距。 图8 图例 提示信息 显示/隐藏提示信息：勾选表示预览或查看发布组件时显示的提示信息；不勾选表示预览或查看发布组件时不显示提示信息。 触发类型：包含数据项和坐标轴两项。 交互效果：交互效果有半透明和放大两种类型。 颜色：设置提示信息的字体颜色。 字号：设置提示信息的字号大小。 字体粗细：设置提示信息的字体粗细样式。 图9 提示信息 动画 显示/隐藏动画：单击“动画”右侧的勾选框，表示开启图表的动画效果；表示预不开启图表的动画效果。 入场动画：组件第一次渲染动画的时长，单位为ms。 动画效果：动画的缓动效果，系统提供多种常见的动画缓动效果供您选择。 各系列依次动画：开启后，各系列依次动画显示。未开启时，所有的系列同时动画显示。 更新动画：组件数据更新时的动画时长，单位为ms。 是否从之前位置开始：开启后，组件数据更新时，从上一个数据的位置开始播放动画；关闭后，组件数据更新时，从初始位置开始播放动画。 图10 动画 系列转类目 显示系列转类目：设置是否支持显示系列转类目。 数值设置：支持对数值的语境、单位、科学计数法、使用千分位分割符、小数位的设置。 条件格式 选择配置字段。 条件选择：有与固定值比较和与动态值比较两种方式。 配置筛选条件种类：包含大于号、大于等于号、等号、小于等于号、小于号、不等号、大于A小于等于B、大于等于A小于B、大于A小于B、大于等于A小于等于B，固定对比值自定义，动态字段比值根据系统选择。 颜色场景：设置好筛选条件后，单击颜色按钮，自定义颜色。 添加规则：单击“+”，增加筛选条件。 删除：单击“-”，删除筛选条件。 系列：支持设置系列的颜色。

响应示例 导入任务详情。 { "id" : "2406a337-xxxx-a5b2-b01a61d2043b", "name" : "string", "domain_id" : "ad9e2f08-xxxx-87eb-1f9619b6c313", "project_id" : "string", "workspace_id" : "12913c92-xxxx-b8fd-a72af3945b61", "import_param" : "", "obs_bucket" : "test", "obs_object_key" : "test.zip", "import_detail" : "导入成功【 导出资源清单 】 数据源: 1 ;【 导入参数清单 】: 目标工作空间: 示例工作空间 ; 是否替换: false ;是否携带权限信息：false", "status" : 1, "error_msg" : "string", "import_type" : "import|crossSpaceImport", "create_user" : "string", "create_user_name" : "string", "create_date" : 9223372036854776000, "update_date" : 9223372036854776000 }

响应参数 表3 响应Body参数 参数 参数类型 描述 id String 任务ID。 name String 导入名称。 domain_id String domainID。 project_id String 项目ID。 workspace_id String 工作空间ID。 import_param String 导入参数清单。 obs_bucket String obs桶名称。 obs_object_key String obs对象路径。 import_detail String 导入明细。 status Integer 结果状态：-1:未激活 0：待处理 1：成功；2：失败；3：部分成功 4：处理中。 枚举值： -1 0 1 2 3 4 error_msg String 任务失败原因。 import_type String import：资源包导入；crossSpaceImport：跨空间一键导入。 create_user String 创建者ID。 create_user_name String 创建者名称。 create_date Long 创建时间戳。 update_date Long 更新时间戳。

样式 设置簇状柱状图样式请参见表3、表4、表5、表6、表7 条件格式。 表3 基础设置 参数 说明 卡片标题 自定义是否显示卡片标题 ，勾选后在图表左上角显示。 文本 设置文本大小和颜色，单击选择文本颜色。 对齐方式 设置对齐方式，支持左对齐和居中对齐。 下边距 设置卡片标题与图表之间的距离。 分割线 自定义是否显示分割线。支持设置分割线样式的大小和颜色、下边距大小。 卡片背景 自定义是否显示卡片背景。单击选择卡片背景颜色。 状态icon 自定义是否显示状态icon。支持设置icon的显示方式和颜色，显示方式包括始终显示和悬停显示。 表4 图表样式 参数 说明 显示图例 设置图示图例，不支持：当未勾选框时，为无法设置图示图例。支持：当勾选框时，支持设置图示图例。 文本 设置图例显示时的文本字体大小。 位置 设置图例显示时的显示位置，支持下方和上方设置。 色板 设置图例的色板，支持系统和自定义设置。 语境 设置数值内的语境，支持中文（简体）和English。 单位 设置数值的单位，支持设置为无、自动、百、千、万、亿、亿万。 科学计数法 设置是否支持数值的科学计数法。 使用千分位分割符 设置数值是否使用千分位分割符。 小数位 设置数值是否支持小数位展示。 表5 坐标轴 参数 说明 显示标题和单位 自定义是否显示标题和单位。支持设置轴标题、单位、位置、文本。 自动设置数值范围 通过设置最大值和最小值，控制图表的数据显示范围。 显示坐标轴 自定义是否显示坐标轴。支持设置坐标线的字体大小和颜色。 显示轴标签 自定义是否显示轴标签。支持设置轴标签的字体大小、颜色和显示格式。 显示网格线 自定义是否显示网格线。支持设置网格线的粗细和颜色。 显示刻度线 自定义是否显示网格线刻度线。 尺度类型 X轴支持序数类型，Y轴支持序数类型 缩略坐标轴标签 缩略X坐标轴标签。 表6 功能配置 参数 说明 缩略轴 自定义是否开启缩略轴。 缩略轴背景数据 设置缩略轴背景数据显示。 空值处理 设置空值处理规则：删除、智能删除、置零、空值断开。 表7 条件格式 参数 说明 请选择系列 选择需要设置高亮效果的度量，通过后续的文本设置将实现对度量中的部分值设置高亮效果，通常用于需要单独显示某部分数据的场景，例如将低于某个阈值的异常值设置为高亮效果。 文本 设置高亮效果的数值范围、高亮颜色、光晕闪烁频率、光晕最大透明度、光晕大小，具体请参见场景示例。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 embed_id 是 String 嵌入分析id。 user_id 是 String 用户id。 group_ids 否 Array of strings 用户组id列表。 ticket_num 否 Integer ticket使用次数。 session_auto_renew 否 Boolean 是否允许session自动延期。 缺省值：false

响应示例 状态码： 200 查询资源血缘关系成功。 { "resources" : [ { "resource_id" : "96334c9923****0a0035dff29a7582b", "resource_name" : "测试数据门户", "resource_type" : "portal", "relations" : [ { "resource_id" : "2545c456-****-a6d4-dd8419cac54a", "resource_name" : "大屏", "resource_type" : "screen", "relations" : [ ] }, { "resource_id" : "12e25f5f-4*****-8468-bdf69c25438f", "resource_name" : "仪表板", "resource_type" : "dashboard", "relations" : [ { "resource_id" : "980bc5e2-******4-a168-4d344065bcb3", "resource_name" : "数据集", "resource_type" : "dataset", "relations" : [ { "resource_id" : "c4d84a8******ba190c5cabf75dfe", "resource_name" : "datasource", "resource_type" : "datasource", "relations" : [ ] } ] } ] } ] } ], "workspace_id" : "e10aa3****e713d779c65e74" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 resources Array of ResourceRelationDetailVO objects 资源血缘关系列表。 workspace_id String 工作空间ID。获取方法请参见获取工作空间ID。 表6 ResourceRelationDetailVO 参数 参数类型 描述 resource_id String 资源ID。 resource_name String 资源名称。 resource_type String 参数解释： 资源类型枚举值，用于指定授权对象的类型。 示例：datasource，指定授权对象类型为数据源。 约束限制： 不涉及 取值范围： 以下枚举值： datasource：数据源； dataset：数据集； metric：指标； dashboard：仪表板； screen：大屏； embedAnalysis：嵌入分析； portal：数据门户； subject：智能分析助手。 默认取值： 不涉及 relations Array of ResourceRelationDetailVO objects 依赖资源列表。

请求示例 查询资源血缘关系。 POST https://{endpoint}/v1/0e****127d****6b7****95750da/resources/relationships { "resources" : [ { "resource_type" : "portal", "resource_id" : "96334c9****4510a0035dff29a7582b" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。获取方法请参见获取工作空间ID。 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 resources 是 Array of resources objects 待查询血缘关系的资源信息列表。 表4 resources 参数 是否必选 参数类型 描述 resource_type 是 String 参数解释： 资源类型枚举值，用于指定授权对象的类型。 示例：datasource，指定授权对象类型为数据源。 约束限制： 不涉及 取值范围： 以下枚举值： datasource：数据源； dataset：数据集； metric：指标； dashboard：仪表板； screen：大屏； embedAnalysis：嵌入分析； portal：数据门户； subject：智能分析助手。 默认取值： 不涉及 resource_id 是 String 资源ID。

样式 设置气泡图的样式参数。 表3 基础设置 参数 说明 卡片标题 卡片支持有和无标题的设置。设置卡片的标题，在卡片的左上角展示。 无标题：当未勾选框时，为无标题格式。 有标题：当勾选框时，为有标题格式。 文本 设置文本字体的大小和字体颜色。可通过输入修改字体大小也可通过和修改字体的大小。 说明： 输入不能为空，且输入值必须在14到32之间。 对齐方式 支持左对齐和居中对齐方式。 下边距 设置气泡图标题与图表之间的距离。可通过输入修改边距的大小也可通过和修改边距的大小。 说明： 输入不能为空，且输入值必须在0到32之间。 分割线 卡片支持无和有分割线的设置。 无分割线：当未勾选框时，为无分割线格式。 有分割线：当勾选框时，为有分割线格式。支持对分割线的样式和下框边距进行设置。分割线样式和下边框支持输入设置，也可通过和进行设置。 说明： 分割线样式的输入不能为空，且输入值必须在0到8之间。在设置样式之后才可以设置下边距，分割线的下边距输入不能为空，且输入值必须在0到32之间。 卡片背景 卡片背景支持有背景和无背景设置。 无背景：当未勾选框时，为无背景格式。 有背景：当勾选框时，为有背景格式。支持背景颜色的设置。 状态icon 可以设置icon的显示方式和颜色，支持始终显示和悬停显示。卡片icon支持有状态icon和无状态icon设置。 无背景：当未勾选框时，为无状态icon。 有背景：当勾选框时，为有状态icon。 表4 图表样式 参数 说明 显示图例 支持显示或不显示，设置为不显示下述参数则不支持设置。 文本 设置文本字体大小。 位置 设置图例的位置，支持设置为下方和上方。 色板 支持设置为系统或自定义。 数值设置 支持对数值的语境、单位、科学计数法、使用千分位分割符、小数位的设置。 表5 坐标轴 轴类别 参数 说明 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轴的网格线的分格数和颜色。 显示刻度线 设置是否显示刻度线。 当未勾选框时，为不显示刻度线。 当勾选框时，显示刻度线。 尺度类型 对数尺度展示数据范围需都大于0或都小于0 支持的类型：线性和对数。 缩略坐标轴标签 缩略Y坐标轴标签。 功能设置：支持对空值处理设置，有删除、智能删除、置零功能选择。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String description name 是 String name type 是 String 参数解释： 标签类型，分为用户标签及用户组标签。 约束限制： 不涉及 取值范围： 以下枚举值： user：用户类型标签； userGroup：用户组类型标签。 默认取值： 不涉及 default_value_type 是 String 默认标签值类型，默认为NULL。 NULL：为空； ALL：所有值； ENUM：枚举值，default_value必须有枚举值配置。

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位为px。 X：设置图表在画布中的位置，单位为px。 Y：设置图表在画布中的位置，单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 字体：设置仪表盘显示字体大小。 仪表盘大小：通过此参数设置仪表盘大小。 分割数：设置仪表盘刻度。 标题 标题：设置仪表盘的标题。 字号：标题字号大小设置。 字体粗细：标题字体粗细设置。 颜色：标题颜色设置，用户自定义。 轴线颜色：通过此参数设置轴线的颜色、范围。 轴线属性 坐标轴：设置轴线粗细。 轴刻度：通过此参数设置轴刻度长度、粗细以及颜色。 分割线：通过此参数可设置分割线的长度、粗细和颜色。 轴标签：通过此参数可设置轴标签的大小、字号、字体粗细、颜色、位置。 指针：设置指针属性，仪表盘可显示与不显示指针，如果显示，可设置指针长度、宽度以及颜色。 标签值 数值转换为%：支持用户设置数值转化。 单位/字号/字体粗细/颜色：用户可自定义设置。 位置：支持位置的设置。水平、垂直位置取值范围-100~100。

请求示例 创建嵌入分析。 POST https://{endpoint}/v1/{project_id}/embeddings { "id" : "6cb08a50xxxxxxxxxxxxxxxxxxxxxx", "name" : "新建嵌入分析", "resource_type" : "dashboard", "resource_id" : "866a519fxxxxxxxxxxxxxxxx", "root_resource_id" : "866a519fxxxxxxxxxxxxxxxx", "config" : "ticket=ec85f874axxxxxxxxxxxxxxxxxxxxxxxxxxxx", "auth_type" : 1 }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 嵌入分析id。传入该参数则使用传入的id，否则生成新id。 name 是 String 嵌入分析名称。 resource_type 是 String 参数解释： 资源类型枚举值，用于指定授权对象的类型。 示例：datasource，指定授权对象类型为数据源。 约束限制： 不涉及 取值范围： 以下枚举值： datasource：数据源； dataset：数据集； metric：指标； dashboard：仪表板； screen：大屏； embedAnalysis：嵌入分析； portal：数据门户； subject：智能分析助手。 默认取值： 不涉及 resource_id 是 String 嵌入分析对应的资源id，如仪表板或者大屏的id。 root_resource_id 是 String 嵌入分析对应的根资源id。仪表板或者大屏的根资源id为其本身id。 auth_type 否 String 嵌入分析的访问类型。0：登录访问；1：ticket认证。默认取值为0。 config 否 String 嵌入分析配置参数。如'ticket=xxxx'，则指定嵌入分析链接里对应的ticket值。

样式 设置词云图样式参考表2、表3。 表2 基础设置 参数 说明 卡片标题 卡片支持有和无标题的设置。设置卡片的标题，在卡片的左上角展示。 无标题：当未勾选框时，为无标题格式。 有标题：当勾选框时，为有标题格式。 文本 设置文本字体的大小和字体颜色。可通过输入修改字体大小也可通过和修改字体的大小。 说明： 输入不能为空，且输入值必须在14到32之间。 对齐方式 支持左对齐和居中对齐方式。 下边距 设置词云图标题与图表之间的距离。可通过输入修改边距的大小也可通过和修改边距的大小。 说明： 输入不能为空，且输入值必须在0到32之间。 分割线 卡片支持无和有分割线的设置。 无分割线：当未勾选框时，为无分割线格式。 有分割线：当勾选框时，为有分割线格式。支持对分割线的样式和下框边距进行设置。分割线样式和下边框支持输入设置，也可通过和进行设置。 说明： 分割线样式的输入不能为空，且输入值必须在0到8之间。在设置样式之后才可以设置下边距，分割线的下边距输入不能为空，且输入值必须在0到32之间。 卡片背景 卡片背景支持有背景和无背景设置。 无背景：当未勾选框时，为无背景格式。 有背景：当勾选框时，为有背景格式。支持背景颜色的设置。 状态icon 可以设置icon的显示方式和颜色，支持始终显示和悬停显示。卡片icon支持有状态icon和无状态icon设置。 无背景：当未勾选框时，为无状态icon。 有背景：当勾选框时，为有状态icon。 表3 图表样式参数 参数 说明 配色 设置词云图的配色，支持系统配色。 词云形状 设置词云图的形状。 计算模式 支持设置为相对大小和突出重点。 自定义词大小范围 支持设置自定义词的大小。 说明： 不够选则使用系统默认范围12-60，如果文本设置太大系统会自动调整为可显示范围。 文字纵向显示 设置词云图的词组纵向显示。 数值设置 支持设置数值的语境、单位、科学计数法、使用千分位分隔符、小数位。 开启Tooltip提示 支持设置Tooltip的背景色、维度文本、指标文本、数值。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 resource_id String 资源ID。 root_resource_id String 根ID。 resource_type String 参数解释： 资源类型枚举值，用于指定授权对象的类型。 示例：datasource，指定授权对象类型为数据源。 约束限制： 不涉及 取值范围： 以下枚举值： datasource：数据源； dataset：数据集； metric：指标； dashboard：仪表板； screen：大屏； embedAnalysis：嵌入分析； portal：数据门户； subject：智能分析助手。 默认取值： 不涉及 workspace_id String 工作空间ID。