HTTP API 概览
TSDB 提供了一个基于 HTTP 的应用程序编程接口，以便与外部系统集成。几乎所有 TSDB 的特性都可以通过 API 来访问，比如查询时间序列数据、管理元数据和存储数据点。TSDB 的 HTTP API 本质上是 RESTful 的，同时也提供了替代访问策略，因为...
按线上API关联
关联项说明 关联项 说明 应用 对应数据API上线时关联的应用。说明 全量新建、按应用新建、按线上API关联新建时获取到该关联项。应用需在系统设置模块创建，数据API需在统一服务模块创建并上线。服务 对应上线状态的数据API。说明 目前上报...
按应用关联
关联项说明 关联项 说明 应用 对应数据API上线时关联的应用。说明 全量新建、按应用新建、按线上API关联新建时获取到该关联项。应用需在系统设置模块创建，数据API需在统一服务模块创建并上线。服务 对应上线状态的数据API。说明 数据API需...
教程概述
本文为您介绍当需要通过DataV展示海量数据的分析结果时，如何使用DataWorks的数据服务开发数据API，并快速在DataV中调用API，最终将来自MaxCompute的数据成果展示在DataV大屏中，数据开发到数据服务再到数据分析展现一气呵成。注意 本案例...
数据服务：低成本快速发布API
DataWorks的数据服务功能模块是灵活轻量、安全稳定的数据API构建平台，旨在为企业提供全面的数据共享能力，帮助用户从发布审批、授权管控、调用计量、资源隔离等方面实现数据价值输出及共享开放。功能概述 作为数据仓库与上层应用系统间的...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
数据服务概述
相关概念 API（Application Programming Interface，应用程序编程接口）：API是让应用、软件、系统能够面向数据源进行数据交互的接口，数据服务API支持“读数据”的操作，可以从数据库、数据表中不断地进行数据查询。函数：作为API过滤器，...
基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
封装流式数据（DataHub）API
本文介绍如何封装流式数据API。前提条件 工作组管理员账号登录。已创建“信息中心（xxzx）”工作组，具体操作，请参见 新建工作组并添加成员。已在系统设置添加DataHub云计算资源，具体操作，请参见 新建云计算资源。已创建API归属应用，...
新建API消费应用
创建消费应用以备申请API时使用。本文介绍如何新建API消费...单击右上角 新建应用，将应用名称输入为“智能营销应用”，应用code为“znyxyy”，填写描述为“创建数据API消费的应用”，单击 确认。预期结果 在 应用管理 列表可查看新建的应用。
产品简介
支持数据的服务能力输出：您在使用DataWorks（大数据开发治理平台）、Dataphin（智能数据建设与治理）、DMS（数据管理）等阿里云大数据、数据库方面的产品时，可以快速将数据API通过API网关发布，实现数据的服务化输出；支持AI能力输出：您...
新建API归属应用
本文介绍如何新建API应用。前提条件 租户管理员账号登录。已创建“信息中心（xxzx）”工作组，具体操作，请参见 新建工作组并添加成员。操作步骤 登录 数据资源平台控制台。在页面右上角，单击 账号 下拉列表，选择 系统设置。在左侧导航栏...
使用DataWorks数据服务生成API
本文为您介绍如何通过DataWorks的数据服务，生成并发布数据API，用于在DataV中进行调用并展示。前提条件 在开始本案例前，您需要首先完成 准备工作。背景信息 注意 按照本文档操作后，可以获取到您数据API的AppCode、AppKey和AppSecret，请...
生成数据API
数据服务解决从数仓到应用的“最后一公里”，将数据源中的数据表快速生成数据API，在API网关进行统一管理和发布。实现低成本、易上手、安全稳定的数据共享与开放。背景信息 为了将最终分析的结果加速查询后开放出API接口对接三方服务，本次...
数据服务
加工后的数据供应用读取：通过数据工具对数据进行加工汇总后，业务应用希望读取这部分加工后的数据进行业务处理，则可通过API的方式快速输出。当需要变更读取的逻辑时，只需要调整API背后的数据逻辑，而不需要重新发布应用。目前API网关...
API调用特殊参数说明
数据资源平台提供了一系列内置的请求参数，在API的调用过程中，您可以通过这些特殊的请求参数，在数据API原有的查询逻辑上添加聚合、排序、过滤返回字段等等额外的逻辑，或者在返回结果里透出额外的信息字段等。本文为您介绍API调用的一些...
DataWorks数据服务对接DataV最佳实践
单击 发布，即可成功生成一个数据API。发布完成后，单击右上角 服务管理 查看API详情。如果您需要调用API，请进入 服务管理 API调用 页面，数据服务为您提供简单身份认证（AppCode）和加密签名身份认证（AppKey&AppSecret）两种认证方式，...
添加DataWorks数据服务数据源
本文介绍在DataV中添加DataWorks数据服务数据源，并将通过DataWorks数据表生成的API，快速地展示在DataV可视化大屏中的方法。前提条件 已准备好待添加的DataWorks数据服务数据源。背景信息 DataWorks数据服务生成的API默认不支持HTTPS协议...
API调用特殊参数
我们提供了一系列内置的请求参数，在API的调用过程中，用户可以通过这些特殊的请求参数，在数据API原有的查询逻辑上添加聚合、排序、过滤返回字段等等额外的逻辑，或者在返回结果里透出额外的信息字段等等。使用场景 交管云控平台使用 数据...
API调用特殊参数
我们提供了一系列内置的请求参数，在API的调用过程中，用户可以通过这些特殊的请求参数，在数据API原有的查询逻辑上添加聚合、排序、过滤返回字段等等额外的逻辑，或者在返回结果里透出额外的信息字段等等。使用场景 交管云控平台使用 企业...
添加DataWorks数据服务数据源
本文介绍在DataV中添加DataWorks数据服务数据源，并将通过DataWorks数据表生成的API，快速地展示在DataV可视化大屏中的方法。前提条件 已准备好待添加的DataWorks数据服务数据源。背景信息 DataWorks数据服务生成的API默认不支持HTTPS协议...
数据源配置常见问题
数据源类型 介绍 在DataV中的应用场景 API 通用的数据接口。如果您有直接可用的API，可使用DataV的API数据源连接。例如，已有站点提供的接口，或已购买的云服务搭建的接口等。具体使用操作请参见 添加API数据源。阿里云API网关 阿里云的一...
数据源配置常见问题
数据源类型 介绍 在DataV中的应用场景 API 通用的数据接口。如果您有直接可用的API，可使用DataV的API数据源连接。例如，已有站点提供的接口，或已购买的云服务搭建的接口等。具体使用操作请参见 添加API数据源。阿里云API网关 阿里云的一...
创建API数据源
通过创建API数据源能够实现Dataphin向API请求业务数据或向API请求写入数据。本文为您介绍如何创建API数据源。使用限制 Dataphin仅支持超级管理员、数据源管理员、板块架构师、项目管理员角色创建数据源。超级管理员、数据源管理员角色添加...
创建API数据源
通过创建API数据源能够实现Dataphin向API请求业务数据或向API请求写入数据。本文为您介绍如何创建API数据源。使用限制 Dataphin仅支持超级管理员、数据源管理员、板块架构师、项目管理员角色创建数据源。超级管理员、数据源管理员角色添加...
账单域API使用手册
本文从“常用API概览”、“API选择方案”、“控制台功能对应API”、“数据字段对应API汇总”、“各数据源产商品字段对比”、“典型场景最佳实践”等方面介绍账单域API，帮助您更准确地选择API、更高效地使用API，进而获取各维度的账单数据...
导入导出 API
您可以在 API 网关控制台上以 JSON 文件的形式对 API 进行批量导入及导出。说明 为减少操作耗时，建议一次性导入/导出 API 的数量不超过 100 个。导入 API 的 JSON 格式请参见模板 API Json 文件格式。批量导出 API 在 API 发布>API 管理 ...
最佳实践：API请求参数的选填设置
通过数据源封装数据API时，在某些业务场景下，需要设置API的请求参数为选填参数。当开发人员设置API的请求参数为选填参数后，调用方即可在调用API时自行选择是否要传入具体的请求参数值，实现更灵活的查询方式。本文将为您介绍如何在不同的...
OpenAPI 导航
API 名称 API 描述 CeateDrdsDB 创建数据库 DescribeDrdsDB 查询数据库 DeleteDrdsDB 删除数据库 ModifyDrdsDBPasswd 重置数据库密码 DescribeDrdsDBs 查询数据库列表 ModifyDrdsIpWhiteList 修改数据库白名单 DescribeDrdsDBIpWhiteList ...
修改名单抽奖数据
您还可以在组件 设置数据源 页面中，选择 数据源 类型为您自定义添加的动态数据源类型（如数据库、API等），使得数据接口获得的是整个抽奖池数据，即所有能参与抽奖的人员名单。通过配置动态数据源内容，可动态获取抽奖名单数据，实现公平...
修改名单抽奖数据
您还可以在组件 设置数据源 页面中，选择 数据源 类型为您自定义添加的动态数据源类型（如数据库、API等），使得数据接口获得的是整个抽奖池数据，即所有能参与抽奖的人员名单。通过配置动态数据源内容，可动态获取抽奖名单数据，实现公平...
添加API数据源
API指通用的数据接口，如果您已有可用的API接口，可在DataV中使用自己的API数据源连接。前提条件 已准备好待添加的API数据源。操作步骤 登录 DataV控制台。在 工作台 页面中，将鼠标移动至需要编辑的数据看板上，单击 编辑。重要 如果您的 ...
调用API
调用方式 调用方式 适用场景 说明 安全级别 加密签名身份认证 应用程序开发、数据采集等。该方式需要在SDK中使用数据服务中的AppKey和AppSecret。具体操作，请参见 使用SDK调用API。高 简单身份认证 一般用于可视化场景，如DataV调用。该...
配置API输出组件
配置API输出组件，可以将外部数据库中读取的数据写入到API，或从大数据平台对接的存储系统中将数据复制推送至API，进行数据整合和再加工。本文为您介绍如何配置API输出组件。前提条件 在开始执行操作前，请确认您已完成以下操作：已创建API...
配置API输出组件
配置API输出组件，可以将外部数据库中读取的数据写入到API，或从大数据平台对接的存储系统中将数据复制推送至API，进行数据整合和再加工。本文为您介绍如何配置API输出组件。前提条件 在开始执行操作前，请确认您已完成以下操作：已创建API...
添加API数据源
API指通用的数据接口，如果您已有可用的API接口，可在DataV中使用自己的API数据源连接。前提条件 已准备好待添加的API数据源。操作步骤 登录 DataV控制台。在 我的可视化 页面中，将鼠标移动至需要编辑的可视化应用上，单击 编辑。重要 ...
结构体说明
数据类型 workspace_id STRING 否 default 工作空间标识 ApiMockConfigVO 名称 类型 是否必填 示例 描述 mock_data STRING 否 mock_data MOCK 数据 ApiTestParamVO 名称 类型 是否必填 示例 描述 key STRING 否 key1 key location STRING ...
批量操作API
注意事项 批量修改API基础配置后，可一键发布API，发布API功能会对已经发布到环境上的API再次发布以更新环境上的API数据，没有发布过的API不会发布到环境。批量删除API操作需保证选中的API已下线。批量授权一次最多授权30个应用（APP）。...
RestAPI Reader最佳实践
实践2：读取一个接口数据，该接口为一个分页的RestAPI接口 示例场景：接口定义 本实践示例的场景为读取一个RESTful接口数据并写入一个MaxCompute分区表中，其中使用的示例RESTful接口为一个自建的测试GET接口，本示例的接口详情如下。...
添加Open API数据源
本文为您介绍在DataV中添加Open API数据源的方法，以及相关参数配置说明。Open API是阿里云提供的云产品开放接口的调用方式，使用Open API可以方便地调用各云产品提供的API接口，轻松实现控制及查询等功能。在DataV中，最常见的场景是使用...
- 产品推荐
- 这些文档可能帮助您