更新时间:2024-04-19 GMT+08:00
分享

API概览

DataArts Studio提供的接口为符合RESTful API设计规范的自研接口。通过DataArts Studio的自研接口,您可以完整使用DataArts Studio的所有功能。

数据集成接口

表1 数据集成接口说明

类型

API

说明

用户流量限制(单位时间内的单个用户请求次数上限)

集群管理

创建集群

创建CDM集群。

5次/min

查询集群列表

查询并显示集群列表。

120次/min

查询集群详情

查询集群详情。

120次/min

重启集群

重启CDM集群。

20次/min

删除集群

删除指定CDM集群。

20次/min

启动集群

开启指定CDM集群。

20次/min

连接管理

创建连接

连接指定的数据源。

120次/min

查询连接

查询连接列表。

120次/min

修改连接

修改连接的参数。

120次/min

删除连接

删除指定连接。

120次/min

作业管理

指定集群创建作业

在指定的CDM集群上创建数据迁移任务,作业不会启动。

1200次/min

随机集群创建作业并执行

在指定的CDM集群列表中,随机选择一个开机状态的集群,在该集群中创建作业并执行作业。

120次/min

查询作业

查询并显示作业列表。

120次/min

修改作业

修改作业的参数。

120次/min

启动作业

启动数据迁移的任务。

1200次/min

停止作业

停止运行中的作业。

1200次/min

查询作业状态

查询并显示作业的运行状态。

120次/min

查询作业执行历史

查询并显示作业执行的历史状态。

120次/min

删除作业

删除指定作业。

120次/min

数据开发接口

表2 数据开发接口说明

类型

说明

连接管理API(待下线)

可实现创建、编辑、删除、导出连接,查询连接列表,查询连接详情等操作。对应用户指南手册的“数据开发 > 数据管理 > 创建数据连接”操作。

脚本开发API

可实现删除、执行脚本等操作。对应用户指南手册的“数据开发 > 脚本开发”操作。

资源管理API

可实现删除资源等操作。对应用户指南手册的“数据开发 > 配置管理 > 管理资源”操作。

作业开发API

可实现删除作业、查询作业文件等操作 。对应用户指南手册的“数据开发 > 作业开发”操作。

管理中心接口

表3 管理中心接口说明

类型

说明

数据连接管理

可实现创建连接等操作。

购买实例

可进行实例购买操作。

工作空间管理

可实现创建工作空间等操作。

实例管理

可实现获取实例列表操作。

工作空间用户管理

可实现添加工作空间用户等操作。

数据源元数据获取

可实现获取数据库列表、获取schemas、获取数据源中的表、获取数据源中表的字段等操作。

实例规格变更

可进行实例规格变更操作。

数据架构接口

表4 数据架构接口说明

类型

说明

概览

可实现查看总体统计信息的操作。

信息架构接口

可实现查询多种类型的表信息。

数据标准接口

可实现创建数据标准与管理数据标准、关联属性与数据标准等操作。

数据源接口

可实现获取数据连接信息等操作。

码表管理接口

可实现新建码表与管理码表等操作。

流程架构接口

可实现新建目录、管理目录、查找流程架构等操作。

数据标准模板接口

可实现创建数据标准模板与管理数据标准模板等操作。

审批管理接口

可实现管理审批人、审批单的创建与处理等操作 。

主题管理接口

可实现创建主题与管理主题等操作。

主题层级接口

可实现获取、修改、删除主题层级等操作。

目录管理

可实现获取目录等操作。

原子指标接口

可实现查找原子指标等操作。

衍生指标接口

可实现查找衍生指标等操作。

复合指标接口

可实现查找复合指标等操作。

维度接口

可实现查找维度、查看维度详情等操作。

限定接口

可实现查找业务限定、查看限定详情等操作。

维度表接口

可实现查找维度表、查看维度表详情等操作。

事实表接口

可实现查找事实表、查看事实表详情等操作。

汇总表接口

可实现查找汇总表、查看汇总表详情等操作。

业务指标接口

可实现查询业务指标、查看业务指标详情等操作。

版本信息接口

可实现通过名称、创建者、修改时间查找版本信息等操作。

关系建模接口

可实现查找模型实体、查看关系详情、查看表模型等操作。

导入导出接口

可实现导入模型、关系建模、维度建模、码表、业务指标以及流程架构等操作,支持查询导入结果。

自定义项接口

可实现查询自定义项、修改自定义项等操作。

标签接口

可实现添加或删除标签。

质量规则接口

可实现质量规则的异常表的数据输出配置及清空质量规则。

数据质量接口

表5 数据质量接口说明

类型

说明

目录接口

可实现获取目录列表等操作。

规则模板接口

可实现获取规则模板列表与获取指定规则模板详情等操作。

质量作业接口

可实现获取质量作业列表与获取作业详情等操作。

对账作业接口

可实现获取对账作业列表与获取作业详情等操作。

运维管理接口

可实现获取任务执行结果等操作。

质量报告接口

可实现获取质量报告等操作。

导入导出接口

可实现导入和导出等操作。

数据目录接口

表6 数据目录接口说明

类型

说明

业务资产接口

可实现查询业务资产等操作。

指标资产接口

可实现查询指标资产等操作。

统计资产接口

可实现获取业务资产或技术资产统计信息等操作。

血缘信息

可实现导入血缘、获取资产血缘信息等操作

资产管理接口

可实现查看资产详情、查询技术资产等操作。

标签接口

可实现查询资产标签、关联标签等操作。

资产分类接口

可实现关联、移除资产分类等操作。

资产分级接口

可实现关联、移除资产密级等操作。

资产信息

可实现查询资产概要等操作。

元数据采集任务接口

可实现资产采集任务相关的操作。

数据地图接口

可实现数据地图组件的相关操作。

元数据实时同步

可进行元数据实时同步的相关操作。

数据服务接口

表7 数据服务接口说明

类型

说明

API管理

可实现创建API、调试API、发布API、管理API、授权API等操作。

授权管理

可实现查询API已授权的APP、查询APP已拥有授权的API等操作。

申请管理

可实现查询审核中心的申请列表、审核申请、获取申请详情等操作。

消息管理

可实现查询消息列表、处理消息、获取消息详情等操作。

服务目录管理

可实现创建服务目录、管理服务目录等操作 。

网关管理

可实现获取网关实例列表、获取网关分组列表等操作。

应用管理

可实现创建应用、管理应用等操作。

总览接口

可实现查询API开发、调用总览指标,或查询topN API等操作。

数据安全接口

表8 数据安全接口说明

类型

说明

权限管理接口

可实现创建、管理权限集等操作。

识别规则接口

可实现创建、查询识别规则等操作。

规则分组接口

可实现查询规则组合规则的操作。

数据权限查询接口

可实现查询角色可配置的操作权限信息等操作。

数据密级管理接口

可实现创建、修改、删除或获取数据密级信息等操作。

权限应用接口

可实现查询数据开发连接列表、测试数据开发联通性、更新状态等操作。

敏感数据结果管理接口

可实现查询敏感数据结果等操作。

分享:

    相关文档

    相关产品