更新时间:2026-09-14 GMT+08:00

CLI命令参考

数据地图接口

API名称

命令

描述

操作

批量打标签(邀测)

hcloud DataArtsStudio BatchTag

批量给资产打标签接口。

去调试

获取队列(邀测)

hcloud DataArtsStudio ShowQueues

获取队列列表,展示10条数据,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

数据预览(邀测)

hcloud DataArtsStudio ShowTableData

表数据预览,展示10条数据,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

批量获取资产信息(邀测)

hcloud DataArtsStudio ListEntityDetails

批量获取资产信息列表。

去调试

空间资产目录树(邀测)

hcloud DataArtsStudio ListCategoriesTree

获取某空间下资产目录树信息。

去调试

获取目录下逻辑实体(邀测)

hcloud DataArtsStudio ListLogicEntities

获取主题目录下逻辑实体信息。

去调试

导入血缘(邀测)

hcloud DataArtsStudio ImportDataMapLineage

血缘导入接口,一次性获取所有作业算子的血缘。该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

搜索查询标签分页展示(邀测)

hcloud DataArtsStudio ShowTags

搜索查询标签分页展示,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

用户行为分析(邀测)

hcloud DataArtsStudio ParseUserBehavior

用户行为分析,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

资产搜索(邀测)

hcloud DataArtsStudio ShowDataSets

资产搜索,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

创建或修改资产(邀测)

hcloud DataArtsStudio CreateOrUpdateEntities

创建或修改资产,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

资产详情(邀测)

hcloud DataArtsStudio ShowDataDetail

资产详情接口,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

删除资产(邀测)

hcloud DataArtsStudio DeleteEntity

根据guid删除资产。

去调试

资产血缘(邀测)

hcloud DataArtsStudio ShowDatamapLineage

资产血缘接口,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

批量血缘(邀测)

hcloud DataArtsStudio ShowLineageBulk

批量血缘接口,一次性获取所有作业算子的血缘。该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

表关联作业算子列表(邀测)

hcloud DataArtsStudio ShowNodes

查询表相关的作业算子列表,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

产出信息(邀测)

hcloud DataArtsStudio ShowInstanceInfos

查询表相关的作业算子运行实例信息,该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

业务资产接口

API名称

命令

描述

操作

查询业务资产目录树

hcloud DataArtsStudio ShowBusinessAssetsTree

逐级查询业务资产目录树,包含数据规范同步过来的业务对象和逻辑实体。

去调试

查询业务资产

hcloud DataArtsStudio ShowBusinessAssets

查询业务资产,包含数据规范同步过来的业务对象和逻辑实体。

去调试

指标资产接口

API名称

命令

描述

操作

查询指标资产目录树

hcloud DataArtsStudio ShowMetricTree

查询指标资产目录树。

去调试

查询指标资产

hcloud DataArtsStudio ShowMetricAssets

指标资产查询接口。

去调试

统计资产接口

API名称

命令

描述

操作

获取技术资产统计信息

hcloud DataArtsStudio ShowTechnicalAssetsStatistic

获取技术资产统计信息。

去调试

获取业务资产统计信息

hcloud DataArtsStudio ShowBusinessAssetsStatistic

获取业务资产统计信息。

去调试

资产管理接口

API名称

命令

描述

操作

查询技术资产

hcloud DataArtsStudio ShowEntities

查询技术资产。

去调试

根据guid获取资产详情

hcloud DataArtsStudio ShowEntityInfoByGuid

根据表guid可以获取表的详情信息,表的详情信息包含column的信息,也可以根据column的guid直接获取column的信息。

去调试

添加或修改资产

hcloud DataArtsStudio CreateOrUpdateAsset

添加或修改资产。

去调试

修改资产指定属性

hcloud DataArtsStudio UpdateEntityAttribute

修改资产指定属性。

去调试

删除资产

hcloud DataArtsStudio DeleteAsset

删除资产。

去调试

资产分类接口

API名称

命令

描述

操作

批量资产关联分类

hcloud DataArtsStudio BatchAssociateClassificationToEntities

批量资产关联分类:只支持对数据表的列和OBS对象添加分类。

去调试

资产关联分类

hcloud DataArtsStudio AssociateClassificationToEntity

将一个分类关联到一个或多个指定guid的资产上。

去调试

移除资产关联的分类

hcloud DataArtsStudio DeleteClassificationFromEntities

移除资产关联分类。

去调试

资产分级接口

API名称

命令

描述

操作

批量资产关联密级

hcloud DataArtsStudio BatchAssociateSecurityLevelToEntities

批量资产关联密级:单个密级关联到多个资产上。

去调试

资产关联密级

hcloud DataArtsStudio AssociateSecurityLevelToEntitie

关联资产到密级,资产关联指定密级。

去调试

移除资产关联密级

hcloud DataArtsStudio DeleteSecurityLevelFromEntity

移除资产关联密级。

去调试

标签接口

API名称

命令

描述

操作

查询标签列表

hcloud DataArtsStudio ShowGlossaryList

查询标签列表

去调试

标签关联到资产

hcloud DataArtsStudio AddTagToAsset

标签关联到资产

去调试

添加标签

hcloud DataArtsStudio AddDesignEntityTags

根据资产(表或属性)的ID给资产打上标签。

去调试

删除标签

hcloud DataArtsStudio RemoveDesignEntityTags

根据资产(表或属性)的ID删除资产标签。

去调试

元数据采集任务接口

API名称

命令

描述

操作

查询采集任务列表

hcloud DataArtsStudio ShowTaskList

查询采集任务列表。

去调试

创建采集任务

hcloud DataArtsStudio CreateTask

创建采集任务。

去调试

查询采集任务详情

hcloud DataArtsStudio ShowTaskInfo

查询采集任务详情。

去调试

编辑采集任务

hcloud DataArtsStudio UpdateTaskInfo

编辑采集任务。

去调试

删除单个采集任务

hcloud DataArtsStudio DeleteTaskInfo

删除单个采集任务。

去调试

启动、调度、停止采集任务

hcloud DataArtsStudio ExecuteTaskAction

启动、调度、停止采集任务。

去调试

获取任务日志

hcloud DataArtsStudio ShowInstanceLog

获取任务日志。

去调试

资产信息

API名称

命令

描述

操作

表数据预览

hcloud DataArtsStudio ShowDataPreview

表数据预览

去调试

指定字段采集概要

hcloud DataArtsStudio RenewDataProfile

指定字段采集概要信息接口。

去调试

查询概要

hcloud DataArtsStudio ShowDataProfile

查询表中数据结构分布等概要信息,仅支持DWS、DLI类型数据源。

去调试

血缘信息

API名称

命令

描述

操作

无血缘关系表查询

hcloud DataArtsStudio ShowUnrelatedTable

无血缘关系表查询,请求参数classification、type_names、connection_names、query需至少指定一个。

去调试

血缘查询

hcloud DataArtsStudio ShowLineage

血缘查询。

去调试

血缘导入

hcloud DataArtsStudio ImportLineage

血缘导入。

去调试

创建血缘信息

hcloud DataArtsStudio CreateLineageInfo

创建血缘信息

去调试

元数据实时同步

API名称

命令

描述

操作

元数据实时同步接口(邀测)

hcloud DataArtsStudio BatchSyncMetadata

元数据实时同步接口,支持批量。该接口功能处于邀测阶段,后续将随功能公测逐步开放。

去调试

概览

API名称

命令

描述

操作

总览统计信息

hcloud DataArtsStudio CountOverviews

总览统计信息。

去调试

模型统计信息

hcloud DataArtsStudio CountTableModels

单个模型中的统计信息。

去调试

关系建模统计信息

hcloud DataArtsStudio CountAllModels

关系建模页面,外层的统计信息。

去调试

标准覆盖率统计信息

hcloud DataArtsStudio CountStandards

查看某个数据标准在所有模型字段中的覆盖率,即使用该标准的字段占总字段的百分比。

去调试

信息架构接口

API名称

命令

描述

操作

查询多种类型的表信息

hcloud DataArtsStudio ListAllTables

从信息架构中查询多种类型的表信息,包括逻辑实体、物理表、维度表、事实表、汇总表。

去调试

数据标准接口

API名称

命令

描述

操作

获取数据标准集合

hcloud DataArtsStudio ListAllStandards

根据查询条件分页获取数据标准集合,按修改时间降序排序。

去调试

创建数据标准

hcloud DataArtsStudio CreateStandard

创建数据标准。

去调试

删除数据标准

hcloud DataArtsStudio DeleteStandard

删除数据标准。

去调试

修改数据标准

hcloud DataArtsStudio UpdateStandard

修改数据标准。

去调试

查看数据标准详情

hcloud DataArtsStudio ShowStandardById

通过ID获取数据标准详情信息。

去调试

关联属性与数据标准

hcloud DataArtsStudio ResetLinkAttributeAndStandard

关联属性与数据标准。

去调试

数据源接口

API名称

命令

描述

操作

获取数据连接信息

hcloud DataArtsStudio SearchDwByType

获取指定类型下的数据连接信息。

去调试

码表管理接口

API名称

命令

描述

操作

查询码表列表

hcloud DataArtsStudio SearchCodeTables

查询码表列表。

去调试

创建码表

hcloud DataArtsStudio CreateCodeTable

创建码表。

去调试

删除码表

hcloud DataArtsStudio DeleteCodeTable

删除码表。

去调试

修改码表

hcloud DataArtsStudio UpdateCodeTable

修改码表。

去调试

查看码表详情

hcloud DataArtsStudio ShowCodeTableById

通过ID查看码表的详情信息。

去调试

查看码表字段值

hcloud DataArtsStudio SearchCodeTableValues

查看码表字段值。

去调试

编辑码表字段值

hcloud DataArtsStudio UpdateCodeTableValues

编辑码表字段值。

去调试

流程架构接口

API名称

命令

描述

操作

获取所有流程架构目录树

hcloud DataArtsStudio ListCatalogTree

获取所有目录树。

去调试

查询流程架构列表

hcloud DataArtsStudio SearchCatalogs

查询流程架构列表。

去调试

创建流程架构

hcloud DataArtsStudio CreateCatalog

创建流程架构。

去调试

修改流程架构

hcloud DataArtsStudio ChangeCatalog

修改流程架构。

去调试

删除流程架构

hcloud DataArtsStudio DeleteCatalog

删除流程架构。

去调试

查找流程架构详情

hcloud DataArtsStudio ShowBizCatalogDetail

查找流程架构详情。

去调试

数据标准模板接口

API名称

命令

描述

操作

查询数据标准模板

hcloud DataArtsStudio ShowStandardTemplate

查询当前工作空间下的数据标准模板。

去调试

创建数据标准模板

hcloud DataArtsStudio CreateStandardTemplate

创建当前工作空间下的数据标准模板自定义项。

去调试

修改数据标准模板

hcloud DataArtsStudio UpdateStandardTemplate

修改数据标准模板。

去调试

删除数据标准模板

hcloud DataArtsStudio DeleteStandardTemplate

删除数据标准模板。

去调试

初始化数据标准模板

hcloud DataArtsStudio InitializeStandardTemplate

初始化数据标准模板。

去调试

审批管理接口

API名称

命令

描述

操作

获取审批单

hcloud DataArtsStudio SearchApprovals

获取审批单。

去调试

撤回审批单

hcloud DataArtsStudio RollbackApproval

撤回审批单。

去调试

审批单处理

hcloud DataArtsStudio ConfirmApprovals

审批驳回/通过,单个或多个action-id=reject/resolve。

去调试

批量发布

hcloud DataArtsStudio BatchPublish

批量发布。

去调试

批量下线

hcloud DataArtsStudio BatchOffline

批量下线。

去调试

创建审批人

hcloud DataArtsStudio CreateApprover

创建审批人。

去调试

查询审批人列表

hcloud DataArtsStudio ListApprovers

查询审批人列表。

去调试

删除审批人

hcloud DataArtsStudio DeleteApprover

删除审批人。

去调试

删除实体下展

hcloud DataArtsStudio DeleteDesignLatestApproval

当已发布的实体被编辑时,其会生成下展,该接口用于删除实体的下展信息。

去调试

获取下展信息与已发布实体的差异

hcloud DataArtsStudio SearchDesignLatestApprovalDiff

当已发布的实体被编辑时,其会生成下展,该接口用于获取下展信息与已发布实体的差异。

去调试

主题管理接口

API名称

命令

描述

操作

查找主题列表

hcloud DataArtsStudio SearchSubject

通过名称(支持模糊查询)、创建者、责任人、状态、修改时间分页查找主题。

去调试

删除主题

hcloud DataArtsStudio DeleteSubject

删除主题。

去调试

创建主题

hcloud DataArtsStudio CreateSubject

创建主题。

去调试

修改主题

hcloud DataArtsStudio UpdateSubject

修改主题。

去调试

获取主题树信息

hcloud DataArtsStudio ListBusiness

获取数据资产主题树信息l1,l2,l3。

去调试

查找主题列表(新)

hcloud DataArtsStudio SearchSubjectNew

查找主题(新)。

去调试

删除主题(新)

hcloud DataArtsStudio DeleteSubjectNew

删除主题(新)。

去调试

创建主题(新)

hcloud DataArtsStudio CreateSubjectNew

创建主题(新)。

去调试

修改主题(新)

hcloud DataArtsStudio UpdateSubjectNew

修改主题(新)。

去调试

主题层级接口

API名称

命令

描述

操作

获取主题层级

hcloud DataArtsStudio ListSubjectLevels

获取主题层级。

去调试

修改或删除主题层级

hcloud DataArtsStudio ChangeSubjects

修改或删除主题层级。

去调试

目录管理

API名称

命令

描述

操作

获取所有目录

hcloud DataArtsStudio ListDirectories

获取所有目录(数据标准、码表)。

去调试

创建目录

hcloud DataArtsStudio CreateDirectory

创建目录(数据标准、码表)。

去调试

修改目录

hcloud DataArtsStudio UpdateDirectory

修改目录(数据标准、码表)。

去调试

删除目录

hcloud DataArtsStudio DeleteDirectory

删除目录(数据标准、码表)。

去调试

原子指标接口

API名称

命令

描述

操作

查找原子指标

hcloud DataArtsStudio SearchAtomicIndexes

通过中英文名称、创建者、审核人、状态、修改时间分页查找原子指标信息,中英文名称支持模糊查询。

去调试

新建原子指标

hcloud DataArtsStudio CreateDesignAtomicIndex

新建单个原子指标。

去调试

更新原子指标

hcloud DataArtsStudio UpdateDesignAtomicIndex

更新单个原子指标。

去调试

删除原子指标

hcloud DataArtsStudio DeleteDesignAtomicIndex

批量删除原子指标。

去调试

查看原子指标详情

hcloud DataArtsStudio ShowAtomicIndexById

通过ID获取原子指标详情信息。

去调试

衍生指标接口

API名称

命令

描述

操作

查找衍生指标

hcloud DataArtsStudio ListDerivativeIndexes

通过中英文名称、创建者、审核人、状态、修改时间、l3Id分页查找衍生指标信息。

去调试

新建衍生指标

hcloud DataArtsStudio CreateDesignDerivativeIndex

根据参数,新建衍生指标。

去调试

更新衍生指标

hcloud DataArtsStudio UpdateDesignDerivativeIndex

根据传入参数,更新衍生指标。

去调试

删除衍生指标

hcloud DataArtsStudio DeleteDesignDerivativeIndex

根据衍生指标ID,删除衍生指标。

去调试

查看衍生指标详情

hcloud DataArtsStudio ShowDerivativeIndexById

通过ID获取衍生详情信息。

去调试

复合指标接口

API名称

命令

描述

操作

查找复合指标

hcloud DataArtsStudio ListCompoundMetrics

通过中英文名称、创建者、审核人、状态、修改时间、l3Id分页查找复合指标信息。

去调试

新建复合指标

hcloud DataArtsStudio CreateDesignCompoundMetric

根据参数,新建复合指标。

去调试

更新复合指标

hcloud DataArtsStudio UpdateDesignCompoundMetric

根据参数,更新复合指标。

去调试

删除复合指标

hcloud DataArtsStudio DeleteDesignCompoundMetric

根据ID集合删除复合指标。

去调试

查看复合指标详情

hcloud DataArtsStudio ShowCompoundMetricById

通过ID获取复合指标详情信息。

去调试

维度接口

API名称

命令

描述

操作

查找维度

hcloud DataArtsStudio ListDimensions

通过中英文名称、描述、创建者、审核人、状态、l3Id、衍生指标idList、修改时间分页查找维度信息。

去调试

新建维度

hcloud DataArtsStudio CreateDesignDimension

根据参数新建维度。

去调试

更新维度

hcloud DataArtsStudio UpdateDesignDimension

根据参数,更新维度信息。

去调试

删除维度

hcloud DataArtsStudio DeleteDesignDimension

根据传入的维度ID,删除维度。

去调试

查看维度详情

hcloud DataArtsStudio ShowDimensionById

通过ID查看维度详情信息。

去调试

查看维度颗粒度

hcloud DataArtsStudio ListDimensionGroups

查询维度颗粒度,依据tableId查询涉及所有维度,不传tableId查询所有维度组颗粒度。

去调试

查看逆向维度表任务

hcloud DataArtsStudio CheckDimensionStatus

查看逆向维度表任务。

去调试

限定接口

API名称

命令

描述

操作

查找业务限定

hcloud DataArtsStudio ListCondition

通过中英文名称、描述、创建者、审核人、限定分组id、修改时间状态分页查找限定信息。

去调试

查看限定详情

hcloud DataArtsStudio ShowConditionById

通过ID查看限定详情信息。

去调试

维度表接口

API名称

命令

描述

操作

查找维度表

hcloud DataArtsStudio ListDimensionLogicTables

通过中英文名称、创建者、审核人、状态、修改时间分页查找维度表信息。

去调试

删除维度表

hcloud DataArtsStudio DeleteDesignDimensionLogicTable

根据维度表ID,删除维度表。

去调试

查看维度表详情

hcloud DataArtsStudio ShowDimensionLogicTableById

通过ID查看维度表的详情信息。

去调试

事实表接口

API名称

命令

描述

操作

查找事实表

hcloud DataArtsStudio ListFactLogicTables

通过中英文名称、创建者、审核人、状态、修改时间分页查找事实表信息。

去调试

删除事实表

hcloud DataArtsStudio DeleteDesignFactLogicTable

根据ID集合删除事实表。

去调试

查看事实表详情

hcloud DataArtsStudio ShowFactLogicTableById

通过ID查看事实表的详情信息。

去调试

查看逆向事实表任务

hcloud DataArtsStudio CheckFactLogicTableStatus

查看逆向事实表任务。

去调试

汇总表接口

API名称

命令

描述

操作

查找汇总表

hcloud DataArtsStudio ListAggregationLogicTables

通过中英文名称、创建者、审核人、状态、修改时间分页查找汇总表信息,中英文名称支持模糊查询。

去调试

新建汇总表

hcloud DataArtsStudio CreateDesignAggregationLogicTable

根据入参,手动创建汇总表。

去调试

更新汇总表

hcloud DataArtsStudio UpdateDesignAggregationLogicTable

更新汇总表。

去调试

删除汇总表

hcloud DataArtsStudio DeleteDesignAggregationLogicTable

批量删除汇总表,只能删除状态为草稿、已线下、已驳回的表。

去调试

查看汇总表详情

hcloud DataArtsStudio ShowAggregationLogicTableById

通过ID查看汇总表的详情信息。

去调试

业务指标接口

API名称

命令

描述

操作

查询业务指标信息

hcloud DataArtsStudio ListBizMetrics

通过名称、创建者、修改时间分页查找业务指标信息。

去调试

创建业务指标

hcloud DataArtsStudio CreateBizMetric

创建业务指标。

去调试

更新业务指标

hcloud DataArtsStudio UpdateBizMetric

更新业务指标。

去调试

删除业务指标

hcloud DataArtsStudio DeleteBizMetric

删除业务指标。

去调试

查看指标详情

hcloud DataArtsStudio ShowBizMetricById

通过ID查看指标的详情信息。

去调试

查看指标维度信息

hcloud DataArtsStudio ListBizMetricDimensions

查看指标维度信息。

去调试

查看指标责任人信息

hcloud DataArtsStudio ListBizMetricOwners

查看指标责任人信息。

去调试

获取指标关联信息

hcloud DataArtsStudio ListMetricRelations

获取当前指标图谱。

去调试

版本信息接口

API名称

命令

描述

操作

查找版本信息

hcloud DataArtsStudio SearchVersions

通过名称、创建者、修改时间查找版本信息。

去调试

比较版本信息

hcloud DataArtsStudio CompareDesignVersions

通过两个版本id,比较两者差异。

去调试

关系建模接口

API名称

命令

描述

操作

查找表模型列表

hcloud DataArtsStudio ListTableModels

通过中英文名称、创建者、审核人、状态、修改时间分页查找关系建模中的表模型信息,包括逻辑实体、物理表和其属性。

去调试

创建表模型

hcloud DataArtsStudio CreateTableModel

在关系建模中创建一个表模型,包括逻辑实体和物理表。

去调试

更新表模型

hcloud DataArtsStudio UpdateTableModel

在关系建模中更新一个表模型及其属性,包括逻辑实体和物理表。

去调试

删除表模型

hcloud DataArtsStudio DeleteTableModel

在关系建模中删除一个表模型及其属性,包括逻辑实体和物理表。

去调试

查询关系

hcloud DataArtsStudio ListRelations

通过关系名称(支持模糊查询)、创建人、开始时间、结束时间等分页查找关系信息。

去调试

查看关系详情

hcloud DataArtsStudio ShowRelationById

通过ID获取关系详情信息。

去调试

查询模型下所有关系

hcloud DataArtsStudio ListTableModelRelations

查询模型下所有关系。

去调试

查看表模型详情

hcloud DataArtsStudio ShowTableModelById

通过ID获取模型表详情信息。

去调试

获取模型

hcloud DataArtsStudio ListWorkspaces

获取当前空间下的全部模型信息。

去调试

新建模型工作区

hcloud DataArtsStudio CreateWorkspace

新建模型工作区。

去调试

更新模型工作区

hcloud DataArtsStudio UpdateWorkspace

更新模型工作区。

去调试

删除模型工作区

hcloud DataArtsStudio DeleteWorkspaces

删除模型工作区。

去调试

查询模型详情

hcloud DataArtsStudio ShowWorkspaceDetailById

查询物理模型或逻辑模型的工作区空间详情。

去调试

查询目的表和字段(待下线)

hcloud DataArtsStudio SearchFieldsForRelation

查询目的表和字段(待下线)。

去调试

导出模型中表的DDL语句

hcloud DataArtsStudio ExportDesignModelTableDdl

根据模型ID导出指定表的DDL语句。

去调试

转换逻辑模型为物理模型

hcloud DataArtsStudio BatchCreateDesignTableModelsFromLogic

转换逻辑模型为物理模型,转换成功则显示转换后的目标模型信息。

去调试

获取操作结果

hcloud DataArtsStudio ShowDesignOperationResult

获取批量操作的结果,如逻辑模型转物理模型和逆向数据库操作。

去调试

导入导出接口

API名称

命令

描述

操作

导入主题

hcloud DataArtsStudio ImportCatalogs

用于导入主题。

去调试

导入模型,关系建模,维度建模,码表,业务指标以及流程架构

hcloud DataArtsStudio ImportModels

导入模型,关系建模,维度建模,码表,业务指标以及流程架构。

去调试

查询导入结果

hcloud DataArtsStudio ImportResult

查询导入excel的处理结果(其中参数uuid获取为:/design/models/action或/design/catalogs/action接口返回结果)。

去调试

导出业务数据

hcloud DataArtsStudio ExportDesignModels

根据请求参数,导出业务数据,可以导出:码表、数据标准、原子指标、衍生指标、复合指标、汇总表、业务指标、主题、流程、逻辑模型、物理模型、维度、事实表。

去调试

获取excel导出结果

hcloud DataArtsStudio ExportDesignResult

根据请求导出业务数据(/export-model)时返回的uuid,获取excel导出结果。

去调试

自定义项接口

API名称

命令

描述

操作

查询自定义项

hcloud DataArtsStudio SearchCustomizedFields

查询自定义项(包括表自定义项、属性自定义项、主题自定义项、业务指标自定义项)。

去调试

修改自定义项

hcloud DataArtsStudio ModifyCustomizedFields

修改自定义项(包括表自定义项、属性自定义项、主题自定义项、业务指标自定义项)。

去调试

质量规则接口

API名称

命令

描述

操作

更新表的异常数据输出配置

hcloud DataArtsStudio UpdateDesignTableQuality

更新表的异常数据输出配置,包括是否生成异常数据、设置异常数据数据库或Schema、设置异常表表前缀/表后缀。

去调试

清空质量规则

hcloud DataArtsStudio RemoveDesignQualityInfos

清空表的质量规则。

去调试

数仓分层接口

API名称

命令

描述

操作

获取数仓分层信息

hcloud DataArtsStudio ListDesignDataLayers

获取数仓分层信息

去调试

修改或删除数仓分层

hcloud DataArtsStudio UpdateDesignDataLayers

修改或删除数仓分层

去调试

目录接口

API名称

命令

描述

操作

获取作业目录

hcloud DataArtsStudio ListCategory

获取作业目录。

去调试

规则模板接口

API名称

命令

描述

操作

获取规则模板列表

hcloud DataArtsStudio ListQualityTemplates

分页获取规则模板列表。

去调试

创建规则模板

hcloud DataArtsStudio CreateTemplate

创建规则模板。

去调试

获取规则模板详情

hcloud DataArtsStudio ShowTemplatesDetail

获取规则模板详情。

去调试

更新规则模板

hcloud DataArtsStudio UpdateTemplate

更新规则模板

去调试

批量删除规则模板

hcloud DataArtsStudio BatchDeleteTemplates

批量删除规则模板。

去调试

质量作业接口

API名称

命令

描述

操作

获取质量作业列表V1

hcloud DataArtsStudio ListQualityTaskLists

批量查询数据质量作业,返回质量作业列表。

去调试

获取质量作业列表

hcloud DataArtsStudio ListQualityTask

获取质量作业列表。

去调试

获取质量作业详情

hcloud DataArtsStudio ShowQualityTaskDetail

获取质量作业详情

去调试

对账作业接口

API名称

命令

描述

操作

获取对账作业列表

hcloud DataArtsStudio ListConsistencyTask

获取对账作业列表。

去调试

获取对账作业详情

hcloud DataArtsStudio ShowConsistencyTaskDetail

获取对账作业详情。

去调试

运维管理接口

API名称

命令

描述

操作

获取任务执行结果列表

hcloud DataArtsStudio ListInstances

获取任务执行结果列表。

去调试

获取实例结果

hcloud DataArtsStudio ShowInstanceResult

获取实例结果。

去调试

API管理接口

API名称

命令

描述

操作

创建API

hcloud DataArtsStudio CreateApi

创建API。

去调试

查询API列表

hcloud DataArtsStudio ListApis

查询API列表。

去调试

更新API

hcloud DataArtsStudio UpdateApi

更新API。

去调试

查询API信息

hcloud DataArtsStudio ShowApi

查询API信息。

去调试

批量删除API

hcloud DataArtsStudio DeleteApi

批量删除API。

去调试

发布API

hcloud DataArtsStudio PublishApiToInstance

发布API。API只有发布后,才能够被调用。API发布时,可以将API发送至指定网关。

去调试

API操作(下线/停用/恢复)

hcloud DataArtsStudio ExecuteApiToInstance

  • 下线API。将已发布的API下线。下线后,所有授权关系都会被解除,API将无法再被调用。
  • 停用API。将已发布的API临时下线。下线后,授权关系会保留,停用期间API将无法再被调用。
  • 恢复API。将已停用的API恢复使用。恢复后, API重新提供调用。

去调试

批量授权API(专享版)

hcloud DataArtsStudio AuthorizeApiToInstance

APP创建成功后,还不能访问API,如果想要访问某个API,需要将该API授权给APP。API主动授权成功后,在有效期内,APP即可访问该API。

去调试

调试API

hcloud DataArtsStudio DebugApi

调试API。

去调试

API授权操作(授权/取消授权/申请/续约)

hcloud DataArtsStudio AuthorizeActionApiToInstance

  • API主动授权: API审核人可发起,API主动授权成功后,在有效期内,APP即可访问该API。API授权包含授权和续约两部分功能。
    • 授权:授权会给予APP在有效期内访问API的权利。
    • 续约:续约会更新授权有效期,仅支持延长有效期,不能减少。
  • API解除授权: API审核人可发起,解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。API解除已授权的APP关系,需要为APP预留至少2天的准备时间。
  • APP解除授权: APP所有者可发起,解除API对APP的授权关系。解除授权后,APP将不再能够调用该API。APP解除自己的授权关系,无需预留准备时间。
  • APP申请授权: APP所有者可发起,APP申请API后,待API的审核人完成审核,APP即可访问该API。授权会给予APP在有效期内访问API的权利,需要API审核。
  • APP申请续约: APP所有者可发起,续约会更新授权有效期,仅支持延长有效期,不能减少,需要API审核。

去调试

查看API发布信息(专享版)

hcloud DataArtsStudio SearchPublishInfo

查看API在不同集群上的发布信息。

去调试

查看API不同操作对应的实例信息(专享版)

hcloud DataArtsStudio ListInstanceList

查看API不同操作对应的实例信息。

去调试

查看API调试信息(专享版)

hcloud DataArtsStudio SearchDebugInfo

查看API在不同集群上的调试信息。

去调试

导入包含API信息的EXCEL文件

hcloud DataArtsStudio ImportDataServiceExcel

导入包含API信息的EXCEL文件。

去调试

导出包含API信息的EXCEL文件

hcloud DataArtsStudio ExportDataServiceExcel

导出包含API信息的EXCEL文件。

去调试

全量导出包含API的EXCEL压缩文件

hcloud DataArtsStudio ExportDataServiceZip

全量导出包含API的EXCEL压缩文件。

去调试

下载EXCEL模板

hcloud DataArtsStudio ExportDataServiceExcelTemplate

下载EXCEL模板。

去调试

申请管理接口

API名称

命令

描述

操作

查询申请列表

hcloud DataArtsStudio ListApply

查询申请列表。

去调试

审核申请

hcloud DataArtsStudio BatchApproveApply

审核申请。

去调试

获取申请详情

hcloud DataArtsStudio ShowApplyDetail

获取申请详情。

去调试

消息管理接口

API名称

命令

描述

操作

查询消息列表

hcloud DataArtsStudio ListMessage

查询审核中心的通知消息列表。与申请不同,通知类消息,无法驳回,仅能在指定的时间范围内作出处理。

去调试

处理消息

hcloud DataArtsStudio ConfirmMessage

对收到的通知消息进行确认,可以在指定的时间范围内选择何时进行处理。

去调试

获取消息详情

hcloud DataArtsStudio ShowMessageDetail

获取消息详情。此功能仅用作信息详情展示,不用做业务处理,因此不展示编号等后台参数。

去调试

授权管理接口

API名称

命令

描述

操作

查询API已授权的APP

hcloud DataArtsStudio SearchAuthorizeApp

查询API已授权的APP。

去调试

查询APP已拥有授权的API

hcloud DataArtsStudio SearchBindApi

查询APP已拥有授权的API。

去调试

服务目录管理接口

API名称

命令

描述

操作

获取当前目录下的所有类型列表

hcloud DataArtsStudio ListAllCatalogList

获取当前目录下所有类型列表(包括API和目录,均以目录的数据格式形式展示)。

去调试

获取当前目录下的api列表

hcloud DataArtsStudio ListApiCatalogList

获取当前目录下的API列表。

去调试

获取当前目录下的目录列表(全量)

hcloud DataArtsStudio ListCatalogList

获取当前目录下的目录列表(全量数据,不分页,推荐仅用于生成目录树等无法分页的场景)。

去调试

更新服务目录

hcloud DataArtsStudio UpdateCatalog

更新服务目录。

去调试

查询服务目录

hcloud DataArtsStudio ShowCatalogDetail

查询服务目录。

去调试

创建服务目录

hcloud DataArtsStudio CreateServiceCatalog

创建服务目录。根目录编号为0。

去调试

批量删除目录

hcloud DataArtsStudio DeleteServiceCatalog

批量删除服务目录。

删除目录的同时会删除其下的所有子目录,不支持删除带有API的目录。

去调试

移动当前目录至新目录

hcloud DataArtsStudio MigrateCatalog

移动当前目录至新目录。

去调试

批量移动api至新目录

hcloud DataArtsStudio MigrateApi

批量移动api至新目录。

去调试

通过路径获取id

hcloud DataArtsStudio SearchIdByPath

通过路径获取id。

去调试

通过id获取路径

hcloud DataArtsStudio ShowPathById

通过id获取路径。

去调试

通过id获取路径对象

hcloud DataArtsStudio ShowPathObjectById

通过目录id获取路径对象。

去调试

查询服务目录API列表

hcloud DataArtsStudio ListDataServiceMarketApis

查询服务目录API列表。

去调试

网关管理接口

API名称

命令

描述

操作

获取网关实例(专享版)

hcloud DataArtsStudio ListApicInstances

获取网关实例(专享版)。

去调试

获取网关分组

hcloud DataArtsStudio ListApicGroups

获取网关分组。

去调试

应用管理接口

API名称

命令

描述

操作

创建应用

hcloud DataArtsStudio CreateApp

创建应用。

去调试

查询应用列表

hcloud DataArtsStudio ListApps

查询应用列表。

去调试

更新应用

hcloud DataArtsStudio UpdateApp

更新应用。

去调试

删除应用

hcloud DataArtsStudio DeleteApp

删除应用。

去调试

查询应用详情

hcloud DataArtsStudio ShowAppInfo

查询应用详情。

去调试

总览接口

API名称

命令

描述

操作

查询统计用户相关的总览开发指标

hcloud DataArtsStudio ShowApisOverview

查询统计用户相关的总览开发指标。

去调试

查询统计用户相关的总览调用指标

hcloud DataArtsStudio ShowAppsOverview

查询统计用户相关的总览调用指标。

去调试

查询api 服务调用topN

hcloud DataArtsStudio ListApisTop

查询API服务调用TopN。

去调试

查询app 服务使用topN

hcloud DataArtsStudio ListAppsTop

查询APP服务使用TopN。

去调试

查询api 统计数据详情

hcloud DataArtsStudio ShowApisDetail

查询API统计数据详情。

去调试

查询app 统计数据详情

hcloud DataArtsStudio ShowAppsDetail

查询APP统计数据详情。

去调试

查询api 仪表板数据详情

hcloud DataArtsStudio ShowApisDashboard

查询API仪表板数据详情。

去调试

查询指定api 仪表板数据详情

hcloud DataArtsStudio ShowApiDashboard

查询指定API仪表板数据详情。

去调试

查询app 仪表板数据详情

hcloud DataArtsStudio ShowAppsDashboard

查询APP仪表板数据详情。

去调试

查询指定api 应用调用topN

hcloud DataArtsStudio ListApiTopN

查询指定API应用调用TopN。

去调试

集群管理接口

API名称

命令

描述

操作

查询集群概览信息列表

hcloud DataArtsStudio ListDataServiceInstancesOverview

查询集群概览信息列表。

去调试

查询集群详情信息列表

hcloud DataArtsStudio ListDataServiceInstancesDetail

查询集群详情信息列表。

去调试

查询集群详情信息

hcloud DataArtsStudio ShowDataServiceInstance

查询集群详情信息。

去调试

查询数据服务集群访问日志列表

hcloud DataArtsStudio ListDataServiceInstanceAccesslogs

查询数据服务集群访问日志列表。

去调试

开启数据服务集群OBS日志转储

hcloud DataArtsStudio UpdateDataServiceInstanceObsLog

开启数据服务集群OBS日志转储。

去调试

开启数据服务集群LTS日志转储

hcloud DataArtsStudio UpdateDataServiceInstanceLtsLog

开启数据服务集群LTS日志转储。

去调试

实例管理接口

API名称

命令

描述

操作

获取实例列表

hcloud DataArtsStudio ListDataArtsStudioInstances

获取实例列表。

去调试

购买实例接口

API名称

命令

描述

操作

DataArtsStudio实例一键购买接口

hcloud DataArtsStudio PayForDgcOneKey

DataArtsStudio实例一键购买接口。

去调试

数据源元数据获取接口

API名称

命令

描述

操作

获取数据库列表

hcloud DataArtsStudio ListDatabases

获取数据库列表。

去调试

获取schemas

hcloud DataArtsStudio ListSchemas

获取schemas,目前只有DWS和采用postgresql驱动的RDS数据源支持schema,请在调用前确认该数据源是否支持schema字段。

去调试

获取数据源中的表

hcloud DataArtsStudio ListDataTables

获取数据源中的表。

去调试

获取数据源中表的字段

hcloud DataArtsStudio ListColumns

获取数据源中表的字段。

去调试

实例规格变更接口

API名称

命令

描述

操作

规格变更接口

hcloud DataArtsStudio ChangeResource

规格变更接口。

去调试

数据连接管理接口

API名称

命令

描述

操作

查询数据连接列表

hcloud DataArtsStudio ListDataconnections

查询数据连接列表。

去调试

创建数据连接

hcloud DataArtsStudio CreateConnections

创建数据连接。

去调试

测试创建数据连接

hcloud DataArtsStudio DebugDataconnection

测试创建数据连接。

去调试

查询单个数据连接信息

hcloud DataArtsStudio ShowDataconnection

查询单个数据连接信息。

去调试

更新数据连接信息

hcloud DataArtsStudio UpdateDataconnection

更新数据连接信息。

去调试

删除数据连接

hcloud DataArtsStudio DeleteDataconnection

删除数据连接。

去调试

工作空间管理接口

API名称

命令

描述

操作

获取工作空间列表

hcloud DataArtsStudio ListManagerWorkSpaces

获取工作空间列表。

去调试

创建工作空间

hcloud DataArtsStudio CreateManagerWorkSpace

创建工作空间。

去调试

获取指定用户所有的工作空间集合

hcloud DataArtsStudio ListWorkspacesForUser

根据userId获取该用户有权限的工作空间集合。

去调试

获取单个工作空间信息

hcloud DataArtsStudio ShowWorkSpace

获取单个工作空间信息。

去调试

工作空间用户管理接口

API名称

命令

描述

操作

获取工作空间用户角色

hcloud DataArtsStudio ListWorkspaceRoles

获取工作空间用户角色。

去调试

编辑工作空间用户或用户组

hcloud DataArtsStudio UpdateWorkSpaceUserOrGroup

编辑工作空间用户或用户组。

去调试

获取工作空间用户信息

hcloud DataArtsStudio ListWorkspaceusers

获取工作空间用户信息。

去调试

添加工作空间用户

hcloud DataArtsStudio AddWorkSpaceUsers

添加工作空间用户。

去调试

删除工作空间用户

hcloud DataArtsStudio DeleteWorkspaceusers

删除工作空间用户。

去调试

作业开发接口

API名称

命令

描述

操作

停止补数据实例

hcloud DataArtsStudio StopFactorySupplementDataInstance

停止指定的补数据实例。只有补数据实例的状态是运行中,才能停止补数据实例。

去调试

创建补数据实例

hcloud DataArtsStudio CreateFactorySupplementDataInstance

创建一个补数据实例。

去调试

查询补数据实例

hcloud DataArtsStudio ShowFactorySupplementData

查询补数据实例列表,支持分页查询。

去调试

修改作业名称

hcloud DataArtsStudio UpdateFactoryJobName

对作业名称进行重命名操作。

去调试

设置作业标签

hcloud DataArtsStudio SetFactoryJobTags

此接口可以设置作业标签。

去调试

查询告警通知记录

hcloud DataArtsStudio ListFactoryAlarmInfo

此接口可以查询指定时间段内的告警通知记录。

去调试

查询指定作业的实例列表

hcloud DataArtsStudio ListFactoryJobInstancesByName

根据作业名称精确查询作业实例列表。

去调试

重跑作业实例

hcloud DataArtsStudio RetryFactoryJobInstance

支持重跑作业实例以及上下游的作业实例。该接口功能处于邀测阶段,后续将随功能公测将逐步开放。

去调试

全局搜索

hcloud DataArtsStudio ShowFactoryFullText

全局搜索

去调试

查询单表的作业表引用详情

hcloud DataArtsStudio ListTaskTableReferenceDetail

查询表被作业(调度中)引用详情。

去调试

脚本开发接口

API名称

命令

描述

操作

查询脚本列表

hcloud DataArtsStudio ListFactoryScripts

此接口用来查询脚本列表。

去调试

数据开发-审批管理接口

API名称

命令

描述

操作

查询审批中心列表

hcloud DataArtsStudio ListFactoryWorkspacesApproval

查询审批中心列表。

去调试

权限管理接口

API名称

命令

描述

操作

创建权限集

hcloud DataArtsStudio CreateSecurityPermissionSet

创建权限集。

去调试

查询权限集列表

hcloud DataArtsStudio ListSecurityPermissionSets

查询权限集列表。

去调试

查询权限集

hcloud DataArtsStudio ShowSecurityPermissionSet

查询权限集。

去调试

删除权限集

hcloud DataArtsStudio DeleteSecurityPermissionSet

删除权限集。

去调试

更新权限集

hcloud DataArtsStudio UpdateSecurityPermissionSet

更新权限集。

去调试

添加权限集成员

hcloud DataArtsStudio CreateSecurityPermissionSetMember

添加权限集成员。

去调试

查询权限集成员列表

hcloud DataArtsStudio ListSecurityPermissionSetMembers

查询权限集成员列表。

去调试

批量添加权限集成员

hcloud DataArtsStudio BatchCreateSecurityPermissionSetMembers

批量添加权限集成员。

去调试

批量删除权限集成员

hcloud DataArtsStudio BatchDeleteSecurityPermissionSetMembers

批量删除权限集成员。

去调试

添加权限集的权限

hcloud DataArtsStudio CreateSecurityPermissionSetPermission

添加权限集的权限。

去调试

查询权限集的权限列表

hcloud DataArtsStudio ListSecurityPermissionSetPermissions

查询权限集的权限列表。

去调试

批量添加权限集的权限

hcloud DataArtsStudio BatchCreateSecurityPermissionSetPermissions

批量添加权限集的权限。

去调试

删除权限集的权限

hcloud DataArtsStudio BatchDeleteSecurityPermissionSetPermissions

删除权限集的权限。

去调试

更新权限集的权限

hcloud DataArtsStudio UpdateSecurityPermissionSetPermission

更新权限集的权限。

去调试

查询数据源可配置权限

hcloud DataArtsStudio ListSecurityDatasourceConfigurations

查询数据源可配置权限。

去调试

查询权限集中配置的url信息

hcloud DataArtsStudio ListSecurityDatasourceUrls

查询权限集中配置的url信息,例如obs、hdfs等组件中的url路径。

去调试

查询数据操作信息

hcloud DataArtsStudio ListSecurityDatasourceActions

查询数据操作信息。

去调试

查询用户表权限清单

hcloud DataArtsStudio ListSecurityMemberTablePermission

查询用户表权限清单

去调试

查询我的权限

hcloud DataArtsStudio ListSecurityMemberPermission

查询我的权限、空间账号权限

去调试

批量变更权限有效期

hcloud DataArtsStudio UpdateSecurityMemberPermissionExpireTime

批量变更权限有效期

去调试

查询用户对表的权限

hcloud DataArtsStudio ListSecurityUserTablePermission

查询用户对表的权限

去调试

识别规则接口

API名称

命令

描述

操作

查询识别规则列表

hcloud DataArtsStudio ListSecurityDataClassificationRules

查询识别规则列表。

去调试

创建识别规则

hcloud DataArtsStudio CreateSecurityDataClassificationRule

创建识别规则。

去调试

查询特定识别规则

hcloud DataArtsStudio ShowSecurityDataClassificationRule

查询特定识别规则。

去调试

删除识别规则

hcloud DataArtsStudio DeleteSecurityDataClassificationRule

删除识别规则。

去调试

修改识别规则接口

hcloud DataArtsStudio UpdateSecurityDataClassificationRule

修改识别规则接口。

去调试

批量删除识别规则接口

hcloud DataArtsStudio BatchDeleteSecurityDataClassificationRule

批量删除识别规则接口。

去调试

修改识别规则状态接口

hcloud DataArtsStudio UpdateSecurityRuleEnableStatus

修改识别规则状态接口。

去调试

创建组合识别规则

hcloud DataArtsStudio CreateSecurityDataClassificationCombineRule

创建组合识别规则

去调试

修改组合识别规则

hcloud DataArtsStudio UpdateSecurityDataClassificationCombineRule

修改组合识别规则

去调试

组合识别规则测试

hcloud DataArtsStudio CheckSecurityDataClassificationCombineRule

组合识别规则测试

去调试

规则分组接口

API名称

命令

描述

操作

查询规则组列表

hcloud DataArtsStudio ListSecurityDataClassificationRuleGroups

查询规则组列表。

去调试

创建规则分组接口

hcloud DataArtsStudio CreateSecurityDataClassificationRuleGroup

创建规则分组接口

去调试

查询规则组

hcloud DataArtsStudio ShowSecurityDataClassificationRuleGroup

查询规则组。

去调试

修改规则分组接口

hcloud DataArtsStudio UpdateSecurityDataClassificationRuleGroup

修改规则分组接口

去调试

删除规则分组接口

hcloud DataArtsStudio DeleteSecurityDataClassificationRuleGroup

删除规则分组接口

去调试

数据权限查询接口

API名称

命令

描述

操作

查询角色对一组库、表的可配置操作权限信息

hcloud DataArtsStudio ListSecurityRoleActions

查询角色对一组库、表的可配置操作权限信息。

去调试

密级管理接口

API名称

命令

描述

操作

创建数据密级

hcloud DataArtsStudio CreateSecuritySecrecyLevel

创建数据密级。

去调试

获取数据密级

hcloud DataArtsStudio ListSecuritySecrecyLevels

获取数据密级。

去调试

根据指定的id查询数据密级

hcloud DataArtsStudio ShowSecuritySecrecyLevel

根据指定的id查询数据密级。

去调试

删除指定的id的数据密级

hcloud DataArtsStudio DeleteSecuritySecrecyLevel

删除指定的id的数据密级。

去调试

根据指定的id修改数据密级

hcloud DataArtsStudio UpdateSecuritySecrecyLevel

根据指定的id修改数据密级。

去调试

批量删除数据密级

hcloud DataArtsStudio BatchDeleteSecuritySecrecyLevels

批量删除数据密级。

去调试

权限应用接口

API名称

命令

描述

操作

查询数据开发细粒度连接列表(全量)

hcloud DataArtsStudio ListSecurityDlfDataWareHouses

查询数据开发细粒度连接列表(全量)。

去调试

批量更新数据开发连接细粒度认证状态

hcloud DataArtsStudio BatchUpdateSecurityDlfDataWareHouses

批量更新数据开发连接细粒度认证状态。

去调试

测试数据开发连接细粒度连通性

hcloud DataArtsStudio DebugSecurityDlfDataWareHouses

测试数据开发连接细粒度连通性。

去调试

敏感数据结果管理接口

API名称

命令

描述

操作

查询敏感数据发现概览结果(以分类和密级为单位)

hcloud DataArtsStudio ListSecuritySensitiveDataOverviews

查询敏感数据发现概览结果(以分类和密级为单位)。

去调试

查询敏感数据发现详情

hcloud DataArtsStudio ListSecuritySensitiveDataDetails

查询敏感数据发现详情。

去调试

空间资源权限策略管理接口

API名称

命令

描述

操作

查询空间资源权限策略列表

hcloud DataArtsStudio ListSecurityResourcePermissions

查询空间资源权限策略列表

去调试

创建空间资源权限策略

hcloud DataArtsStudio CreateSecurityResourcePermissionPolicy

创建空间资源权限策略

去调试

查询单个资源权限策略

hcloud DataArtsStudio ShowSecurityResourcePermissionPolicy

查询单个资源权限策略

去调试

更新空间资源权限策略

hcloud DataArtsStudio UpdateSecurityResourcePermissionPolicy

更新空间资源权限策略

去调试

批量删除资源权限策略

hcloud DataArtsStudio BatchDeleteSecurityResourcePermissionPolicies

批量删除资源权限策略

去调试

数据安全诊断接口

API名称

命令

描述

操作

查询敏感数据保护模块诊断结果

hcloud DataArtsStudio ShowSecuritySensitiveDataDiagnoseResult

查询敏感数据保护模块诊断结果

去调试

查询未进行静态脱敏任务的表信息

hcloud DataArtsStudio ShowSecurityNoMaskingTableResult

查询未进行静态脱敏任务的表信息

去调试

查询数据源防护模块诊断结果

hcloud DataArtsStudio ShowSecurityDatasourceProtectionDiagnoseResult

查询数据源防护模块诊断结果

去调试

执行数据安全诊断

hcloud DataArtsStudio ExecuteSecurityDiagnose

执行数据安全诊断。

去调试

查询不合理的权限配置

hcloud DataArtsStudio ListSecurityUnreasonablePermissions

查询不合理的权限配置。

去调试

查询数据权限控制模块诊断结果

hcloud DataArtsStudio ShowSecurityPermissionManagementDiagnoseResult

查询数据权限控制模块诊断结果。

去调试

数据分类接口

API名称

命令

描述

操作

查询数据分类列表

hcloud DataArtsStudio ListSecurityDataCategories

查询数据分类列表。

去调试

创建数据分类

hcloud DataArtsStudio CreateSecurityDataCategory

创建数据分类。

去调试

删除数据分类

hcloud DataArtsStudio BatchDeleteSecurityDataCategories

删除数据分类。

去调试

修改数据分类

hcloud DataArtsStudio UpdateSecurityDataCategories

修改数据分类。

去调试

导入预置分类

hcloud DataArtsStudio ImportSecurityBuiltinCategoryGroups

导入预置分类。

去调试

安全管理员接口

API名称

命令

描述

操作

查看安全管理员

hcloud DataArtsStudio ShowSecurityAdmin

查看安全管理员。

去调试

创建或更新安全管理员

hcloud DataArtsStudio ModifySecurityAdmin

创建或更新安全管理员。

去调试

动态数据脱敏接口

API名称

命令

描述

操作

查询动态数据脱敏策略列表

hcloud DataArtsStudio ListSecurityDynamicMaskingPolicies

查询动态数据脱敏策略列表。

去调试

创建数据脱敏策略

hcloud DataArtsStudio CreateSecurityDynamicMaskingPolicy

创建动态数据脱敏策略。

去调试

查询某个脱敏策略的详细信息

hcloud DataArtsStudio ShowSecurityDynamicMaskingPolicy

查询某个脱敏策略的详细信息。

去调试

更新动态数据脱敏策略

hcloud DataArtsStudio UpdateSecurityDynamicMaskingPolicy

更新动态数据脱敏策略。

去调试

批量删除动态脱敏策略

hcloud DataArtsStudio BatchDeleteSecurityDynamicMaskingPolicies

批量删除动态脱敏策略。

去调试

权限审批接口

API名称

命令

描述

操作

获取审批工单列表

hcloud DataArtsStudio ListSecurityApprovals

获取审批工单列表。

去调试

审批通过工单

hcloud DataArtsStudio AcceptSecurityApplication

审批通过工单。

去调试

驳回工单

hcloud DataArtsStudio DeclineSecurityApplication

驳回工单。

去调试

批量审批通过工单

hcloud DataArtsStudio BatchApproveSecurityApplications

批量审批通过工单

去调试

批量驳回工单

hcloud DataArtsStudio BatchRejectSecurityApplications

批量驳回工单。

去调试

获取表权限审批人列表

hcloud DataArtsStudio ListSecurityTableApprovers

获取表权限审批人列表

去调试

提交表权限申请

hcloud DataArtsStudio ApplySecurityTableAuthority

提交表权限申请

去调试

数据连接管理

API名称

命令

描述

操作

数据连接跨空间授权

hcloud DataArtsStudio AuthorizeDataConnection

数据连接跨空间授权。

去调试

用户同步接口

API名称

命令

描述

操作

查询用户同步列表

hcloud DataArtsStudio ListSecurityMemberSyncTasks

查询用户同步列表。

去调试

用户同步任务接口

API名称

命令

描述

操作

查询单个用户同步任务

hcloud DataArtsStudio ShowSecurityMemberSyncTask

查询单个用户同步任务。

去调试

队列权限接口

API名称

命令

描述

操作

查询当前空间下分配的队列资源

hcloud DataArtsStudio ListSecurityAssignedQueues

查询当前空间下分配的队列资源。

去调试

分配队列资源给指定空间

hcloud DataArtsStudio CreateSecurityAssignedQueue

分配队列资源给指定空间。

去调试

修改当前空间下分配的队列资源

hcloud DataArtsStudio UpdateSecurityAssignedQueue

修改当前空间下分配的队列资源。

去调试

删除当前空间下分配的队列资源

hcloud DataArtsStudio DeleteSecurityAssignedQueue

删除当前空间下分配的队列资源。

去调试

权限申请接口

API名称

命令

描述

操作

撤回工单申请

hcloud DataArtsStudio UnpublishSecurityApplication

撤回工单申请。

去调试

监控运维

API名称

命令

描述

操作

查询实例运行状态

hcloud DataArtsStudio ListFactoryTaskOverview

此接口可以查询实例运行状态,包括当天、昨天、前天以及近7天的实例状态情况。

去调试

查询任务完成情况

hcloud DataArtsStudio ListFactoryTaskCompletion

查询任务完成情况。包括今天,昨天以及近7天的平均任务完成情况。

去调试

企业模式发布包管理

API名称

命令

描述

操作

查询发布包列表

hcloud DataArtsStudio ListFactoryReleasePackages

用于查询发布包的列表信息。

去调试

查询指定发布包详情

hcloud DataArtsStudio ShowFactoryPackageDetail

用于查询指定的发布包详情信息。

去调试

发布任务包

hcloud DataArtsStudio DeployFactoryPackages

目前支持发布包管理中相关包的发布,支持发布多个任务包。

去调试

撤销任务包

hcloud DataArtsStudio CancelFactoryPackages

目前支持发布包管理中相关包的撤销,支持撤销多个任务包。

去调试

发布包管理

API名称

命令

描述

操作

查询待发布包列表

hcloud DataArtsStudio ListFactoryPendingItems

查询待发布包列表

去调试

待发布包发布

hcloud DataArtsStudio CreateFactoryPendingItemsPackage

待发布包发布

去调试

通知管理

API名称

命令

描述

操作

查询通知规则列表

hcloud DataArtsStudio ListFactoryAlarmRules

查询通知规则列表。

去调试

基线运维

API名称

命令

描述

操作

查询事件列表

hcloud DataArtsStudio ListSearchFactoryEvents

查询事件列表。

去调试

查询基线任务列表

hcloud DataArtsStudio ListSearchFactoryBaselines

查询基线任务列表。

去调试

创建基线任务

hcloud DataArtsStudio CreateFactoryBaseline

创建基线任务。

去调试