# API概览 本章节介绍了目前DataArts Insight所提供的API列表。 表1DataArts Insight API列表 | 类型 | 说明 | |:---|:---| | [协同授权] | 获取指定的数据源、数据集、仪表板、大屏的资源的详细信息。并对资源协同授权。 | | [工作空间] | 查询工作空间详情、创建工作空间、修改和删除工作空间的API操作指导。 | | [用户标签] | 创建用户标签、编辑用户标签、删除用户标签、保存用户标签内容、获取用户标签值和获取用户标签头的API操作指导。 | | [数据集权限] | 获取数据集权限列表、配置数据集权限、打开/关闭数据集权限、删除权限和获取数据集权限配置信息的API操作指导。 | | [数据集] | 查询数据集和目录列表、获取数据集详情、删除数据集和保存或修改数据集的API操作指导。 | | [嵌入分析] | 获取分享的嵌入分析信息的API操作指导。 | | [Ticket管理] | 获取ticket的API操作指导，用于嵌入分析的认证。 | | [导入导出参数] | 配置导入导出参数的API操作指导。 | | [产品实例] | 查询用户已开通产品实例列表的API操作指导。 | | [资源迁移] | API导出资源包、获取导入任务详情和API导入资源包文件的API操作指导。 | | [资源公共查询] | 查询仪表板或者大屏列表的API操作指导。 | | [数据源] | 数据源更新、获取数据源详情、删除数据源、获取数据源列表和数据源新增的API操作指导。 | | [通行证管理] | 获取用户列表、更新用户通行证状态、增加配额关联用户、获取已分配通行证的用户列表和删除用户分配信息的API操作指导。 | | [仪表板] | 新建仪表板、更新仪表板、批量发布仪表板、批量下线仪表板和批量删除仪表板的API操作指导。 | | [大屏] | 获取大屏组件列表和获取大屏指定组件数据的API操作指导。 | | [智能分析助手] | 查询智能分析助手列表和自然语言查数的API操作指导。 | #### 协同授权 表2协同授权 | API | 说明 | |:---|:---| | [获取资源属性值](https://support.huaweicloud.com/api-dataartsinsight/ListAuthProperties.html) | 获取指定的数据源、数据集、仪表板、大屏的资源的详细信息。 | | [保存或修改资源属性值](https://support.huaweicloud.com/api-dataartsinsight/SaveOrUpdateAuthProperties.html) | 保存或修改资源属性值。 | | [获取协同授权列表](https://support.huaweicloud.com/api-dataartsinsight/ListAuthed.html) | 协同授权列表。 | | [批量保存、修改、删除协同授权](https://support.huaweicloud.com/api-dataartsinsight/BatchSaveAuth.html) | 批量保存、修改、删除指定自研的协同授权规则。 | #### 工作空间 表3工作空间 | API | 说明 | |:---|:---| | [查询工作空间](https://support.huaweicloud.com/api-dataartsinsight/ListWorkspaces.html) | 查询工作空间列表。 | | [创建工作空间](https://support.huaweicloud.com/api-dataartsinsight/CreateWorkspace.html) | 创建工作空间。 | | [修改工作空间](https://support.huaweicloud.com/api-dataartsinsight/UpdateWorkspace.html) | 修改工作空间。 | | [删除工作空间](https://support.huaweicloud.com/api-dataartsinsight/DeleteWorkspace.html) | 删除工作空间。 | #### 用户标签 表4用户标签 | API | 说明 | |:---|:---| | [创建用户标签](https://support.huaweicloud.com/api-dataartsinsight/CreateUserTag.html) | 创建用户标签。 | | [编辑用户标签](https://support.huaweicloud.com/api-dataartsinsight/UpdateUserTag.html) | 编辑用户标签。 | | [删除用户标签](https://support.huaweicloud.com/api-dataartsinsight/DeleteUserTag.html) | 删除用户标签。 | | [保存用户标签内容(按用户)](https://support.huaweicloud.com/api-dataartsinsight/SaveUserTagValue.html) | 保存用户标签内容(按用户)。 | | [获取用户标签值](https://support.huaweicloud.com/api-dataartsinsight/ListUserTagValue.html) | 获取用户标签值。 | | [获取用户标签头](https://support.huaweicloud.com/api-dataartsinsight/ListUserTagHead.html) | 获取用户标签头。 | | [下载用户标签](https://support.huaweicloud.com/api-dataartsinsight/DownloadUserTag.html) | 下载用户标签到Excel，用于需要批量编辑用户标签的场景。 | | [导入用户标签](https://support.huaweicloud.com/api-dataartsinsight/ImportUserTag.html) | 批量修改用户或用户组标签。 | #### 数据集权限 表5数据集权限 | API | 说明 | |:---|:---| | [获取数据集权限列表](https://support.huaweicloud.com/api-dataartsinsight/ListPermission.html) | 获取数据集权限列表。 | | [配置数据集权限](https://support.huaweicloud.com/api-dataartsinsight/CreateAndUpdatePermission.html) | 配置数据集权限。 | | [打开/关闭权限](https://support.huaweicloud.com/api-dataartsinsight/UpdatePermissionConfig.html) | 打开/关闭数据集权限。 | | [删除数据集权限](https://support.huaweicloud.com/api-dataartsinsight/DeleteRule.html) | 删除数据集权限。 | | [获取数据集权限配置信息](https://support.huaweicloud.com/api-dataartsinsight/ListPermissionConfig.html) | 获取数据集权限配置信息。 | #### 数据集 表6数据集 | API | 说明 | |:---|:---| | [查询数据集和目录列表](https://support.huaweicloud.com/api-dataartsinsight/ListCubeAndCatalogList.html) | 查询数据集列表。 | | [获取数据集详情](https://support.huaweicloud.com/api-dataartsinsight/ShowDatasetDetail.html) | 获取数据集详情。 | | [保存或修改数据集](https://support.huaweicloud.com/api-dataartsinsight/SaveDatasetForOpenApi.html) | 保存或修改数据集。 | | [删除数据集](https://support.huaweicloud.com/api-dataartsinsight/DeleteDataset.html) | 删除数据集。 | #### 嵌入分析 表7嵌入分析 | API | 说明 | |:---|:---| | [获取分享的嵌入分析信息](https://support.huaweicloud.com/api-dataartsinsight/ShowEmbedSharedInfo.html) | 获取分享的嵌入分析信息 | | [创建嵌入分析](https://support.huaweicloud.com/api-dataartsinsight/CreateEmbedding.html) | 创建嵌入分析。 | #### Ticket管理 表8Ticket管理 | API | 说明 | |:---|:---| | [创建Ticket](https://support.huaweicloud.com/api-dataartsinsight/CreateTickets.html) | 创建Ticket。 | | [获取ticket列表](https://support.huaweicloud.com/api-dataartsinsight/ListTickets.html) | 获取Ticket列表。注意结果仅返回还在有效期内的Ticket列表。 | #### 导入导出参数 表9导入导出参数 | API | 说明 | |:---|:---| | [配置导入导出参数](https://support.huaweicloud.com/api-dataartsinsight/CreateAndUpdateExportConfig.html) | 配置导入导出参数 | #### 产品实例 表10产品实例 | API | 说明 | |:---|:---| | [查询用户已开通产品实例列表](https://support.huaweicloud.com/api-dataartsinsight/ListInstances.html) | 查询用户已开通产品实例列表 | #### 资源迁移 表11资源迁移 | API | 说明 | |:---|:---| | [API导出资源包](https://support.huaweicloud.com/api-dataartsinsight/ExportResourcePackage.html) | API导出资源包。 | | [获取导入任务详情](https://support.huaweicloud.com/api-dataartsinsight/ShowImportResourceTaskDetail.html) | 获取导入任务详情。 | | [API 导入资源包文件](https://support.huaweicloud.com/api-dataartsinsight/ImportResourcePackage.html) | API 导入资源包文件。 | #### 资源公共查询 表12资源公共查询 | API | 说明 | |:---|:---| | [查询仪表板或者大屏列表](https://support.huaweicloud.com/api-dataartsinsight/ListResources.html) | 仪表板和大屏资源统一。 | | [查询资源血缘关系](https://support.huaweicloud.com/api-dataartsinsight/ShowResourceRelationships.html) | 查询资源血缘关系。 | #### 数据源 表13数据源 | API | 说明 | |:---|:---| | [数据源更新](https://support.huaweicloud.com/api-dataartsinsight/UpdateDataConnection.html) | 数据源更新。 | | [获取数据源详情](https://support.huaweicloud.com/api-dataartsinsight/ShowDataConnectionByConnectionId.html) | 获取数据源详情。 | | [删除数据源](https://support.huaweicloud.com/api-dataartsinsight/DeleteDataConnectionByConnectionId.html) | 删除数据源。 | | [获取数据源列表](https://support.huaweicloud.com/api-dataartsinsight/ListDataConnection.html) | 获取数据源列表。 | | [数据源新增](https://support.huaweicloud.com/api-dataartsinsight/CreateDataConnection.html) | 数据源新增。 | | [验证终端节点服务并创建终端节点](https://support.huaweicloud.com/api-dataartsinsight/VerifyAndCreateVpcEp.html) | 验证终端节点服务并创建终端节点。 | #### 通行证管理 表14通行证管理 | API | 说明 | |:---|:---| | [获取用户列表（包含已分配、未激活、IAM全用户列表）](https://support.huaweicloud.com/api-dataartsinsight/ListQuotaUsersAndIamUsers.html) | 获取用户列表（包含已分配、未激活、IAM全用户列表） | | [更新用户通行证状态](https://support.huaweicloud.com/api-dataartsinsight/SaveQuotaUsers.html) | 更新用户通行证状态 | | [增加配额关联用户，用于联邦登录等场景](https://support.huaweicloud.com/api-dataartsinsight/AddQuotaUser.html) | 增加配额关联用户，用于联邦登录等场景 | | [获取已分配通行证的用户列表（不包含未激活）](https://support.huaweicloud.com/api-dataartsinsight/ListQuotaUserList.html) | 获取已分配通行证的用户列表（不包含未激活） | | [删除用户分配信息](https://support.huaweicloud.com/api-dataartsinsight/DeleteQuotaUser.html) | 删除用户分配信息 | #### 仪表板 表15仪表板 | API | 说明 | |:---|:---| | [新建仪表板](https://support.huaweicloud.com/api-dataartsinsight/CreateDashboard.html) | 新建仪表板。 | | [更新仪表板](https://support.huaweicloud.com/api-dataartsinsight/UpdateDashboard.html) | 更新仪表板。 | | [批量发布仪表板](https://support.huaweicloud.com/api-dataartsinsight/BatchPublishDashboard.html) | 批量发布仪表板。 | | [批量下线仪表板](https://support.huaweicloud.com/api-dataartsinsight/BatchOfflineDashboard.html) | 批量下线仪表板。 | | [批量删除仪表板](https://support.huaweicloud.com/api-dataartsinsight/BatchDeleteDashboard.html) | 批量删除仪表板。 | #### 大屏 表16大屏 | API | 说明 | |:---|:---| | [获取大屏组件列表](https://support.huaweicloud.com/api-dataartsinsight/ListScreenNodes.html) | 获取大屏组件列表。 | | [获取大屏指定组件数据](https://support.huaweicloud.com/api-dataartsinsight/ShowScreenNodeQueryData.html) | 获取大屏指定组件数据。 | | [新建大屏](https://support.huaweicloud.com/api-dataartsinsight/CreateScreen.html) | 新建大屏。 | | [更新大屏](https://support.huaweicloud.com/api-dataartsinsight/UpdateScreen.html) | 更新大屏。 | | [批量发布大屏](https://support.huaweicloud.com/api-dataartsinsight/BatchPublishScreen.html) | 批量发布大屏。 | | [批量下线大屏](https://support.huaweicloud.com/api-dataartsinsight/BatchOfflineScreen.html) | 批量下线大屏。 | | [批量删除大屏](https://support.huaweicloud.com/api-dataartsinsight/BatchDeleteScreen.html) | 批量删除大屏。 | #### 智能分析助手 表17智能分析助手 | API | 说明 | |:---|:---| | [智能分析助手列表查询接口](https://support.huaweicloud.com/api-dataartsinsight/ListSubjects.html) | 查询智能分析助手列表。 | | [自然语言查数接口](https://support.huaweicloud.com/api-dataartsinsight/InvokeNlQuery.html) | 自然语言查数接口。输入为自然语言数据查询问题，返回查询到的数据和对应的SQL。 |