华为云用户手册

DataArts Insight权限 默认情况下，管理员创建的 IAM 用户没有任何权限，您需要将其加入用户组，并给用户组授予策略或角色，才能使得该用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 DataArts Insight部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域对应的项目中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问DataArts Insight时，需要先切换至授权区域。 权限类别：根据授权精程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于华为云各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对DataArts Insight服务，管理员能够控制IAM用户仅能对某一类云服务器资源进行指定的管理操作。DataArts Insight支持的API授权项参考《权限策略和授权项》。 表1 DataArts Insight系统权限 系统角色/策略名称 描述 类别 DataArts Insight FullAccess DataArts Insight管理员权限，拥有该权限的用户具有DataArts Insight所有权限，如管理DataArts Insight项目、新建资源等。 系统策略 DataArts Insight DevelopAccess DataArts Insight开发者权限，拥有该权限的用户可以新建数据源、数据集、仪表板、大屏。 系统策略 DataArts Insight AnalysisAccess DataArts Insight分析师权限，拥有该权限的用户可以使用已创建的数据集创建仪表板、大屏等。 系统角色 DataArts Insight ReadOnlyAccess DataArts Insight只读权限，拥有该权限的用户仅能查看DataArts Insight的仪表板、大屏等资源。 系统角色 表2列出了DataArts Insight常用操作与系统权限的授权关系，您可以参照该表选择合适的系统策略。 表2 DataArts Insight常用操作与系统权限的关系 资源 操作 DataArts Insight FullAccess DataArts Insight DevelopAccess DataArts Insight AnalysisAccess DataArts Insight ReadOnlyAccess 项目 创建项目 Y N N N 删除项目 Y N N N 编辑项目 Y N N N 查询项目列表 Y N N N 用户标签 新建用户标签 Y N N N 更新用户标签 Y N N N 删除用户标签 Y N N N 查询用户标签列表 Y N N N 数据源 新建数据源 Y Y N N 编辑数据源 Y Y N N 查询数据源列表 Y Y N N 查询数据源详情 Y Y N N 上传文件 Y Y N N 查询文件列表 Y Y N N 删除文件 Y Y N N 数据集 新建数据集 Y Y N N 编辑数据集 Y Y N N 查询数据集列表 Y Y Y N 查询数据集详情 Y Y Y N 删除数据集 Y Y N N 开启行列权限 Y Y N N 查询权限列表 Y Y N N 更新行列权限 Y Y N N 删除行列权限 Y Y N N 仪表板 新建仪表板 Y Y Y N 编辑仪表板 Y Y Y N 查询仪表板列表 Y Y Y Y 查询仪表板详情 Y Y Y Y 删除仪表板 Y Y Y N 仪表板发布 Y Y Y N 仪表板下线 Y Y Y N 导出报表数据 Y Y Y Y 大屏 新建大屏 Y Y Y N 编辑大屏 Y Y Y N 查询大屏列表 Y Y Y Y 查询大屏详情 Y Y Y Y 删除大屏 Y Y Y N 大屏发布 Y Y Y N 大屏下线 Y Y Y N

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

样式 尺寸位置 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添加和本地上传图片。 缩放模式：支持报错原图大小、按比例缩放、裁剪缩放、拉伸缩放。 图片位置：支持设置为居中对齐、左对齐、右对齐、顶对齐、底对齐。

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

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位px。 X：设置图表在画布中的位置。单位为px。 Y：设置图表在画布中的位置。单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 字体：设置组件文本的字体样式。 最大字号：输入数值设置组件文字的最大字号。定义数据中value值最大的文本大小。 最小字号：输入数值设置组件文字的最小字号。定义数据中value值最小的文本大小。 间距：输入数值调整组件文字的每一行之间的间距。

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位px。 X：设置图表在画布中的位置。单位为px。 Y：设置图表在画布中的位置。单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 对齐方式：设置数字的对齐方式，可以设置为水平居中、左侧对齐、右侧对齐。 间距：设置数字与图层的间距。 始终动画：开启后，翻牌器上的数字将始终随着数据的变化而动态变化。 动画时长：输入数值或单击可设置动画一次播放的时间，时间单位为毫秒。 标题 支持是否显示翻牌器标题。 标题名：设置数字翻牌器标题名。 对齐方式：设置标题的对齐方式，可以设置为顶部居中、顶部居左、顶部居右、底部居中、底部居左、底部居右。 字体：设置文本的字体。 字号：设置文本的字号。 颜色：设置文本的字体颜色。 字体粗细：设置文本的字体粗细。 数值 小数位控制：设置小数位，支持/不支持小数位，单击“小数控制位”右侧的勾选框，表示支持，表示不支持。 千位分隔符：支持设置数值的千分位分隔符。 字体：设置标题的字体。 字号：设置标题的字号。 颜色：设置标题的字体颜色。 字体粗细：设置标题的字体粗细。 数字间隔：设置数字间的间隔。 左右对齐：设置左右对齐距离。 上下内边距：设置上下边距距离。 背景色：设置背景颜色。 边线选项：支持设置边线的样式、宽度、圆角、颜色。 增长趋势 自定义图标：支持url设置和本地上传。 内容：设置增长趋势内容。 字体：设置增长趋势字体。 字号：设置增长趋势字号。 颜色：设置增长趋势颜色。 字体粗细：设置字体增长趋势字体粗细。 减少趋势 显示减少趋势：设置支持/不支持减少趋势，单击“小数控制位”右侧的勾选框，表示支持，表示不支持。 自定义图标：支持url设置和本地上传。 内容：设置减少趋势内容。 字体：设置减少趋势字体。 字号：设置减少趋势字号。 颜色：设置减少趋势颜色。 字体粗细：设置字体减少趋势字体粗细。 前缀/后缀 内容：设置前缀&后缀内容。 字体：设置前缀&后缀字体。 字号：设置前缀&后缀字号。 颜色：设置前缀&后缀颜色。 字体粗细：设置字体前缀&后缀字体粗细。

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位px。 X：设置图表在画布中的位置。单位为px。 Y：设置图表在画布中的位置。单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 背景颜色：日期选择器的背景颜色，用户自定义。 边框颜色：日期选择器的边框颜色，用户自定义。 样式：边框的呈现类型，包含实线、虚线、电划线。 宽度：边框的宽度设置。 圆角：边框的圆角设置。 字号：设置进度条的字体大小。 颜色：设置进度条字体颜色。 格式化：设置日期呈现的格式。

约束限制 仅管理员可以执行资源迁移相关操作。 仅同一区域下的跨项目迁移支持携带资源包的相关权限配置进行迁移，当前仅支持“分享协作”权限同步迁移。 导入仪表板、数据大屏、嵌入式分析、智能分析助手时会自动导入关联的数据源和数据集。 新环境导入资源包后，需重新配置数据源的访问密码，否则数据源无法访问。 数据源资源重复导入时，仅支持相同类型的数据源导入替换。 替换导入时，如果新的项目无资源包，默认按新增导入。 同一环境切换项目可直接“跨项目导入”，无需导出到本地。 具有DataartsInsight FullAccess权限的用户可以操作指标迁移。 跨环境不支持协同权限迁移，仅同账号跨项目支持协同权限连带迁移。

操作场景 DataArts Insight数据集提供的行级授权支持对字段值设置查看范围，缩小字段值的可见范围，对字段值进行授权。 当需要限制某些字段的查看范围时，您可以设置行级权限，缩小字段值的可见范围。 行级授权模式包含条件组合授权和标签授权两种方式。 条件组合授权模式适用于组织成员较少的场景，本文为您介绍如何进行条件组合授权。 用户标签授权适用于用户/用户组数量较多的情况下，通过用户标签授权实现对同一标签用户的统一授权。操作指导请参考用户标签授权。

样式 本章节介绍图片的样式各项配置项的含义。 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位px。 X：设置图表在画布中的位置。单位为px。 Y：设置图表在画布中的位置。单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 全局样式 图片：选择图片，您可以通过如下三种方式加载图片到大屏中。 在“图片”后显示“url”的框中输入图片的地址。 单击“图片”下方的虚线框，选择图片。 直接拖动图片至“图片”下方的虚线框中。 图片选择后，您也可以进行编辑和删除操作。单击图片区域的可以删除当前图片，单击可以修改当前图片。 请合理谨慎使用背景图片功能，该功能可能是你的背景图数据泄露。 缩放模式：单击下拉选项，可以设置图片的缩放模式。可设置为默认、按比例缩放、裁剪缩放、拉伸缩放。 图片位置：单击下拉选项，可以设置图片的位置。可设置为居中对齐、左对齐、右对齐、顶对齐、底对齐。 图2 全局样式

获取钉钉群的webhookurl 您已在目标钉钉群中，完成钉钉机器人的添加。 选择目标钉钉群，单击右上角的图标。 在群设置面板中单击智能群助手。 在智能群助手面板单击添加机器人。 在群机器人对话框单击自定义。 在机器人详情对话框单击添加。 在添加机器人对话框中编辑机器人信息。 单击头像右下角的图标来编辑头像。 在机器人名字的输入框内输入机器人名字。 在安全设置中，完成必要的安全设置（至少选择1种），勾选我已阅读并同意《自定义机器人服务及免责条款》，单击完成。 在添加机器人对话框中复制生成的Webhook地址。

样式 尺寸位置 W：设置图表的宽，单位为px。 H：设置图表的高，单位px。 X：设置图表在画布中的位置。单位为px。 Y：设置图表在画布中的位置。单位为px。 不透明度：设置图表在画布上的透明度，可通过滑动条进行设置，也可手动输入百分比，比例越大透明程度越低。 图1 尺寸位置 文本样式 标题设置：用户自定义设置。 字体：设置文本的字体。 字号：设置文本的字号。 文本间距：设置文本的文本间距 颜色：设置文本的字体颜色。 字体粗细：设置文本的字体粗细。 对齐方式：设置文本的对齐方式，可以设置为左侧、右侧、水平居中。 上下对齐：设置文本的上下对齐方式，可以设置为居中、上对齐、下对齐。

步骤4：新建仪表板 在步骤3：创建数据集保存完数据集后，页面给出了创建仪表板的按钮。单击“新建仪表板”。 新建可视化图表，本示例以折线图为例。其他可视化图表的创建请参考用户指南可视化控件。 在字段编辑区域，选择数据的“维度”和“度量” 例如查看不同商品类别购买的用户数。您可以按需调整图表类型和数据度量以绘制不同类型的图表。 图3 制作折线图 单击“更新”之后就可以得到需要的图表内容。 图4 不同商品类别购买的用户数 您可以按需调整图表类型和数据度量以绘制不同类型的图表。例如查看不同商品购买的用户数和消费用户的平均年龄段。 图5 不同商品购买的用户数和消费用户的平均年龄段 单击右侧的“保存”保存智能报表。 输入仪表板的名称，单击“确定”保存成功。 也可通过单击“保存并发布”，保存并发布仪表板。发布后支持查看仪表板。

请求示例 保存或修改资源分享协作属性值。 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" }

响应示例 状态码： 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" }

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 表2 错误码 状态码 错误码 错误信息 - 20010003 IAM权限异常。 404 24010003 资源不存在。 400 24010043 当前资源缺少协同权限。 400 24150000 工作空间名称不合法，只能包含字母、数字、下划线、中划线、中文字符，且长度不超过32个字符。 400 24150001 该工作空间名称已被使用，请换个名称重新尝试。 400 24150002 默认工作空间不允许删除。 400 24150003 操作失败！工作空间数量超出上限。 400 24150004 操作失败，请检查工作空间状态是否正常。 400 24150005 工作空间不存在。 400 24150010 工作空间成员不能为空，请重新选择。 400 24150011 工作空间成员至少需保留一个角色。 400 24150012 工作空间的所有者不可以被删除。 400 24150020 用户组不能为空，请重新选择。 400 24150021 工作空间内存存储容量信息异常。 400 24150022 未使用的容量是[{0}]字节，不足以释放[{1}]字节。

错误响应Body体格式说明 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "xxx", "error_code": "DataArtsInsight.20010003" } 其中，error_code表示错误码，error_msg表示错误描述信息。 表1 异常相应说明 名称 参数类型 说明 error_code String 错误码。 error_msg String 错误详细信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String X-Workspace-Id X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 导出包名称。 resources 是 Array of objects 导出资源明细。 表4 resources 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型： datasource：数据源。 dataset：数据集。 metric：指标。 dashboard：仪表板。 screen：大屏。 subject：智能分析助手。 embedAnalysis：嵌入分析。 resource_id 是 String 资源ID。

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。 响应示例如下，例如DataArts Insight服务部署的区域为“cn-north-4”，应消息体中查找“name”为“cn-north-4”，其中projects下的“id”即为项目ID。

请求示例 批量保存、修改、删除指定自研的协同授权规则。 POST https://{endpoint}/v1/xxxx3ab4dac4055888643b331axxxx/authorization/cooperate-authorization/rules/batch-save [ { "auth_id" : "de9cb4xxxx4b0ba2887b80dc18d273", "auth_level" : "user", "authority" : "edit", "resource_id" : "d0d7919c-xxxx-462e-xxxx-da82bf8be44e", "resource_type" : "dashboard" }, { "auth_id" : "de9cb4axxxxa2887b80dc18d273", "auth_level" : "user", "authority" : "edit,export", "resource_id" : "d0d7919c-4e87-xxxx-xxxx-da82bf8be44e", "resource_type" : "dashboard" } ]

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。 最小长度：0 最大长度：8192 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of CooperateAuthorizationRuleDto objects 协同授权规则信息。 表4 CooperateAuthorizationRuleDto 参数 是否必选 参数类型 描述 auth_id 否 String 授权主体的用户或用户组ID。 最小长度：0 最大长度：128 auth_level 否 String 授权主体级别。 user：用户 group：用户组 最小长度：0 最大长度：128 authority 否 String 权限点，枚举值： edit、export：编辑和导出权限 edit：编辑权限 export：导出权限 read：查看权限 use：使用权限 说明： 权限之间有依赖关系， 授予edit权限，自动关联授予use、read权限； 授予了export权限，自动关联授予use、read权限。 export、edit二者之前无依赖关系。 最小长度：0 最大长度：128 resource_id 否 String 资源ID。 最小长度：0 最大长度：128 resource_type 否 String 资源类型： Datasource：数据源 Dataset：数据集 Dashboard：仪表板 Screen：大屏 Subject:智能分析助手 最小长度：0 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID。 X-Auth-Token 是 String 用户Token。 Content-Type 是 String 固定值，指定请求体类型和字符集。 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 资源包文件。 import_strategy 是 String 导入策略，replace|addNew。 replace_rule 否 String 替换规则，默认值为BY_ID，取值范围：BY_ID、BY_NAME 最小长度：0 最大长度：100 枚举值： BY_ID BY_NAME

Token认证 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

AK/SK认证 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK/SK签名认证方式仅支持消息体大小为12M以内的请求，12M以上的请求请使用Token认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的私有访问密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。 详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

响应示例 状态码： 200 查询资源列表成功。 { "count" : 1, "page_data" : [ { "id" : "e2xxxx66f-81bxxxxxx9c38-80xxx0fxx9c84", "name" : "未命名大屏1", "create_user_name" : "dat***ig***", "create_date" : 1707215155901, "update_user_name" : "dat***ig***", "update_date" : 1707215155901, "status" : 0 } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 page_data Array of 表5 objects 分页数据。 表5 ResourceVO 参数 参数类型 描述 id String - name String 资源名称。 create_user_name String 创建者。 create_date Integer 创建日期。 update_user_name String 更新者。 update_date Integer 更新日期。 status Integer 发布状态。

URI GET /v1/{project_id}/resources/{resource_type} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参考获取项目ID。 最小长度：0 最大长度：128 resource_type 是 String 资源类型。 最小长度：0 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移值。 最小值：0 缺省值：0 limit 否 Integer 返回列表数量。 最小值：10 缺省值：10 sort_key 否 String 排序字段。 sort_dir 否 String 排序类别： desc：倒序。 asc：正序。 缺省值：asc

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 最小长度：0 最大长度：128 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 最小长度：0 最大长度：8192

请求示例 在项目下创建工作空间。 /v1/{project_id}/instances/{instance_id}/workspaces { "configs" : { "mode" : "0", "field_show_type" : "0", "only_admin_create_datasource" : "0", "works_authorized" : "0", "works_public" : "1", "works_view" : "0" }, "name" : "测试name", "description" : "这是一段测试描述", "eps_id" : "0" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 工作空间名称。 最小长度：0 最大长度：1024 description 否 String 工作空间描述。 最小长度：0 最大长度：10240 eps_id 是 String 工作空间所属企业项目ID。 最小长度：0 最大长度：128