华为云用户手册

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 BatchSaveAuthRequestBody 是 Array of objects authorizedList，详细参数类型参考CooperateAuthorizationRuleDto。 表4 CooperateAuthorizationRuleDto 参数 是否必选 参数类型 描述 auth_id 否 String 授权主体的用户或用户组ID。 auth_level 否 String 授权主体级别。 user：用户 group：用户组 authority 否 String 权限点开关，即协同授权配置项。取值为true或者false，用于区分对应开关是否打开。默认值为false。 edit：编辑权限 export：导出权限 read：查看权限 use：使用权限 说明： 权限之间有依赖关系，授予edit权限，自动关联授予read和export或者use权限；授予了export权限，自动关联授予read权限。 对仪表板和大屏来说，权限点有三个， edit，export，read。 例如{"edit":false,"read": true,"export": true}， 表示打开了查看和导出的权限。 对于数据源、数据集、智能分析助手来说，权限点有两个，edit，use，对应编辑和使用权限。 例如{"use":true,"edit": false} ，表示仅打开使用权限。 resource_id 否 String 资源ID。 resource_type 否 String 资源类型： Datasource：数据源 Dataset：数据集 Dashboard：仪表板 Screen：大屏 Subject:智能分析助手 表5 请求体参数 参数 是否必选 参数类型 描述 auth_level 否 String 授权主体级别。 user：用户 group：用户组 filter_authed 否 Boolean 是否过滤已经授权的实体，默认true，仅显示授权用户和用户组信息。 预留字段。 resource_id 否 String 资源ID。 resource_type 否 String 资源类型： Datasource：数据源 Dataset：数据集 Dashboard：仪表板 Screen：大屏 Subject：问答领域

请求示例 批量保存、修改、删除项目ID为xxxx3ab4dac4055888643b331axxxxx的协同授权。 /v1/xxxx3ab4dac4055888643b331axxxx/authorization/cooperate-authorization/rules/batch-save [ { "auth_id" : "de9cb4a863a94b0ba2887b80xxxxxxxx", "auth_level" : "user", "authority" : "edit", "resource_id" : "d0d7919c-xxxx-bb32-da82bf8be44e", "resource_type" : "dashboard" } ]

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝对指定资源在特定条件下进行某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。 关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。 DataArts Insight支持自定义策略授权项如下表所示。 表1 API授权项列表 权限 对应API接口 授权项 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 保存或修改资源属性值。 POST /v1/{project_id}/authorization/cooperate-authorization/properties dataartsinsight:resource:auth - √ × 获取资源属性值 GET /v1/{project_id}/authorization/cooperate-authorization/properties dataartsinsight:resource:auth - √ × 获取协同授权规则列表 GET /v1/{project_id}/authorization/cooperate-authorization/rules dataartsinsight:resource:auth - √ × 批量保存、修改、删除指定自研的协同授权规则。 POST /v1/{project_id}/authorization/cooperate-authorization/rules/batch-save dataartsinsight:resource:auth - √ × 创建工作空间 POST /v1/{project_id}/instances/{instance_id}/workspaces dataartsinsight:workspace:create - √ × 删除工作空间 DELETE /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} dataartsinsight:workspace:delete - √ × 修改工作空间。 PUT /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} dataartsinsight:workspace:update - √ ×

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 表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 权限点开关，即协同授权配置项。取值为true或者false，用于区分对应开关是否打开。 edit：编辑权限 export：导出权限 read：查看权限 use：使用权限 说明： 权限之间有依赖关系， 授予edit权限，自动关联授予read和export或者use权限；授予了export权限，自动关联授予read权限。 对仪表板和大屏来说， 权限点有三个， edit，export，read。 例如{"edit": false,"read": true,"export": true}， 表示打开了查看和导出的权限。 对于数据源、数据集、智能分析助手来说，权限点有两个， edit，use， 对应编辑和使用权限。 例如{"use": true,"edit": false} ，表示仅打开使用权限。 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：数据源。 Dataset：数据集。 Dashboard：仪表板。 Screen：大屏 Subject：智能分析助手。 sort Integer 排序字段，无实际含义。 update_date Long 修改时间。 update_user String 修改人ID。 update_user_name String 修改人姓名。

请求示例 获取项目ID为xxxx3ab4dac4055888643b331axxxxx的协同授权列表。 /v1/xxxx3ab4dac4055888643b331axxxx/authorization/cooperate-authorization/rules?resource_type=dataset&resource_id=f8e5406b-8662-4adb-a028-a55c76ae1166&auth_level=user&filer_authed=false

响应示例 { "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" } ], "count" : 2147483647 }

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：数据源。 Dataset：数据集。 Dashboard：仪表板。 Screen：大屏。 Subject：智能分析助手。

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

终端节点 终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。 智能数据洞察的终端节点如下表所示，请您根据业务需要选择对应区域的终端节点。 表1 终端节点 区域名称 区域 终端节点（Endpoint） 华北-北京四 cn-north-4 dataartsinsight.cn-north-4.myhuaweicloud.com 华北-乌兰察布一 cn-north-9 dataartsinsight.cn-north-9.myhuaweicloud.com 华东-上海一 cn-east-3 dataartsinsight.cn-east-3.myhuaweicloud.com 华南-广州 cn-south-1 dataartsinsight.cn-south-1.myhuaweicloud.com 西南-贵阳一 cn-southwest-2 dataartsinsight.cn-southwest-2.myhuaweicloud.com 父主题： API使用前必读

URI GET /v1/{project_id}/instances/{instance_id}/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 project_id 是 String 项目ID。获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 工作空间名称。支持模糊查询。 取值范围：[0,100] offset 否 Integer 返回条目的起始offset。 取值范围：[0,2147483647] 默认值：0 limit 否 Integer 返回条目数。不传该参数时，默认查询前10条信息。 取值范围：[0,2147483647] 默认值：10

响应示例 { "count" : 17, "page_data" : [ { "configs" : { "mode": "0", "worksAuthorized": "0", "worksPublic": "1", "onlyAdminCreateDatasource": "0", "isPin": "1", "fieldShowType": "0", "worksView": "0" }, "create_time" : 1676984980510, "create_user" : "xxxxxx", "description" : "Description workspace information", "domain_id" : "xxxxxxx", "eps_id" : "xxxxxxxxxx", "id" : "xxxxxxxxxxxxx", "instance_id" : "xxxx7d17c41c414dabaa08f47c7dxxxx", "is_default" : 1, "name" : "Example workspace name", "owner_name" : "xxxxxx", "project_id" : "xxxxxxxb4dac4055888643b3xxxxxx", "update_time" : 1687167926377, "update_user" : "xxxxxxxx" } ] }

响应示例 { "configs" : { "mode" : "0", "field_show_type" : "0", "only_admin_create_datasource" : "0", "works_authorized" : "0", "works_public" : "1", "works_view" : "0" } , "create_time" : 1676984980510, "create_user" : "xxxxxx", "description" : "Description workspace information", "domain_id" : "xxxxxxx", "eps_id" : "xxxxxxxxxx", "id" : "xxxxxxxxxxxxx", "instance_id" : "xxxx7d17c41c414dabaa08f47c7dxxxx", "is_default" : 1, "name" : "Example workspace name", "owner_name" : "xxxxxx", "project_id" : "xxxxxxxb4dac4055888643b3xxxxxx", "update_time" : 1687167926377, "update_user" : "xxxxxxxx" }

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

请求示例 在项目下创建工作空间。 /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" }

项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 在我的凭证下，您可以查看项目ID。 图1 项目隔离模型

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 1 2 3 4 5 6 7 8 9 10 11 12 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 1 2 3 4 5 6 7 8 { "error":{ "code":401, "message": "The username or password is wrong.", "title": "Unauthorized" } } 其中，code表示错误码，message表示错误描述信息。

URI PUT /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 workspace_id 是 String 工作空间ID，即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 project_id 是 String 项目id。获取方法请参考获取项目ID。

请求示例 修改项目下工作空间ID为xxxxaaa59ce841f8b4cc2c1305c1xxxx的信息。 /v1/{project_id}/instances/{instance_id}/workspaces/xxxxaaa59ce841f8b4cc2c1305c1xxxx { "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" }

URI DELETE /v1/{project_id}/instances/{instance_id}/workspaces/{workspace_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。 workspace_id 是 String 工作空间ID，即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 project_id 是 String 项目ID。获取方法请参考获取项目ID。

概述 欢迎使用智能数据洞察（DataArts Insight）。 智能数据洞察（DataArts Insight）是一站式数据可视化BI开发平台，提供可视，实时，易用，安全的企业智能分析服务。适配云上云下多种数据源，提供丰富多样的可视化组件，采用拖拽式自由布局，轻松实现数据分析和报表搭建，快速定制专属数据大屏。 您可以使用本文档提供API对智能数据洞察探索进行相关操作，包括获取数据源、准备数据集、数据分析、数据大屏等。支持的全部操作请参见API概览。 在调用数据湖探索API之前，请确保已经充分了解DataArts Insight相关概念。详细信息请参见产品介绍。 父主题： API使用前必读

URI GET /v1/{project_id}/tags/value 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 用户类型（用户或用户组）。 offset 否 Integer 返回条目的起始offset，默认值0。 limit 是 Integer 返回列表数量。

响应示例 获取已开通实例列表成功 。 { "count": 1, "page_data": [ { "project_id": "9c3043ab4xxxx055888643b331a0xxxx", "region_id": "xxx", "order_id": "4xxxxd9517314ebbbe17258a9640xxxx", "instance_id": "4e7xxxx517314exxxx17258a9640c05f", "instance_name": "xxxx-4e7a0d9517314exxxx17258a9640c05f", "instance_spec_code": "DataArtsInsight.unit.enterprise.user", "order_type": "ON_DEMAND", "status": 2, "create_user": "***", "create_date": 169xxxx2604761, "domain_id": "d22f8acfxxxx428fb22606b64dc7xxxx", "eps_id": "0" } ] }

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

响应参数 表4 响应Body参数 参数 参数类型 描述 instances Array of objects 实例信息。具体请参考表5。 count Integer 数据数量。 page_data Array of objects 当前页的数据。 表5 instances 参数 参数类型 描述 project_id String 项目ID。 region_id String RegionId。 order_id String 订单ID。 instance_id String 产品实例ID。 instance_name String 产品实例名称。 resource_spec_code String 产品规格。 order_type String 订单类型： ON_DEMAND：按需。 PERIOD：包周期。 status Integer 实例状态，有以下几种状态。 1：未生效； 2：生效中； 3：已删除=退订； 4：保留期=冻结； 5：宽限期。 domain_id String 账号ID。 eps_id String 所属企业项目ID。

请求参数 表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：数据集。 dashboard：仪表板。 screen：大屏。 embedAnalysis：嵌入分析。 resource_id 是 String 资源ID。

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

响应参数 状态码： 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 发布状态。